From a1f09697dc2475ff5cadc8455fa40ec34e02c2c7 Mon Sep 17 00:00:00 2001 From: Daniel Salas Date: Wed, 29 Jan 2025 20:08:38 -0700 Subject: [PATCH] fix: javadocs are now consistent with code, issue #4120 is now fixed. --- .../java/io/jans/as/client/uma/UmaPermissionService.java | 2 +- .../src/main/java/io/jans/as/client/util/KeyExporter.java | 4 ++-- .../src/main/java/io/jans/as/client/util/KeyGenerator.java | 4 ++-- .../jans/as/common/service/common/ConfigurationService.java | 3 --- .../java/io/jans/as/model/crypto/binding/TokenBinding.java | 4 ++-- .../jans/as/model/crypto/binding/TokenBindingExtension.java | 2 +- .../jans/as/model/crypto/binding/TokenBindingMessage.java | 2 +- .../io/jans/as/model/crypto/signature/EDDSAKeyFactory.java | 4 ---- .../io/jans/as/model/crypto/signature/EDDSAPublicKey.java | 2 +- jans-auth-server/pom.xml | 2 +- .../as/server/authorize/ws/rs/AuthorizeRestWebService.java | 4 ++-- .../io/jans/as/server/service/SectorIdentifierService.java | 1 - .../io/jans/as/server/ssa/ws/rs/SsaRestWebServiceImpl.java | 6 +++--- .../as/server/ssa/ws/rs/SsaRestWebServiceValidator.java | 2 +- .../io/jans/as/server/ssa/ws/rs/action/SsaCreateAction.java | 4 ++-- .../jans/as/server/uma/ws/rs/UmaResourceRegistrationWS.java | 2 +- 16 files changed, 20 insertions(+), 28 deletions(-) diff --git a/jans-auth-server/client/src/main/java/io/jans/as/client/uma/UmaPermissionService.java b/jans-auth-server/client/src/main/java/io/jans/as/client/uma/UmaPermissionService.java index 29a77125e8b..82f1ba79d10 100644 --- a/jans-auth-server/client/src/main/java/io/jans/as/client/uma/UmaPermissionService.java +++ b/jans-auth-server/client/src/main/java/io/jans/as/client/uma/UmaPermissionService.java @@ -19,7 +19,7 @@ * The endpoint at which the host registers permissions that it anticipates a * requester will shortly be asking for from the AM. This AM's endpoint is part * of resource registration API. - *

+ *

* In response to receiving an access request accompanied by an RPT that is * invalid or has insufficient authorization data, the host SHOULD register a * permission with the AS that would be sufficient for the type of access diff --git a/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyExporter.java b/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyExporter.java index 5a1bbde68cf..ccf68cf4d3c 100644 --- a/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyExporter.java +++ b/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyExporter.java @@ -30,11 +30,11 @@ /** * Export private key from JKS Command example: java -cp * KeyExporter -h - *

+ *

* KeyExporter -keystore /Users/yuriy/tmp/mykeystore.jks -keypasswd secret * -alias "2d4817e7-5fe8-4b6b-8f64-fe3723625122" * -exportfile=/Users/yuriy/tmp/mykey.pem - *

+ *

* * @author Yuriy Movchan * @version February 12, 2019 diff --git a/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyGenerator.java b/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyGenerator.java index 5ba65f54402..41a7225d74f 100644 --- a/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyGenerator.java +++ b/jans-auth-server/client/src/main/java/io/jans/as/client/util/KeyGenerator.java @@ -32,9 +32,9 @@ /** * Command example: * java -cp bcprov-jdk15on-1.54.jar:.jar:bcpkix-jdk15on-1.54.jar:commons-cli-1.2.jar:commons-codec-1.5.jar:commons-lang-2.6.jar:jettison-1.3.jar:log4j-1.2.14.jar:oxauth-model.jar:oxauth.jar KeyGenerator -h - *

+ *

* KeyGenerator -sig_keys RS256 RS384 RS512 ES256 ES256K ES384 ES512 PS256 PS384 PS512 EdDSA -enc_keys RSA1_5 RSA-OAEP RSA-OAEP-256 ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW -keystore /Users/JAVIER/tmp/mykeystore.jks -keypasswd secret -dnname "CN=Jans Auth CA Certificates" -expiration 365 - *

+ *

* Note that EdDSA is not allowed in FIPS mode * * @author Javier Rojas Blum diff --git a/jans-auth-server/common/src/main/java/io/jans/as/common/service/common/ConfigurationService.java b/jans-auth-server/common/src/main/java/io/jans/as/common/service/common/ConfigurationService.java index b0e777f58c8..681131260aa 100644 --- a/jans-auth-server/common/src/main/java/io/jans/as/common/service/common/ConfigurationService.java +++ b/jans-auth-server/common/src/main/java/io/jans/as/common/service/common/ConfigurationService.java @@ -62,7 +62,6 @@ public void updateConfiguration(GluuConfiguration configuration) { * * @param inum Configuration Inum * @return Configuration - * @throws Exception */ public GluuConfiguration getConfigurationByInum(String inum) { return persistenceEntryManager.find(GluuConfiguration.class, getDnForConfiguration(inum)); @@ -72,7 +71,6 @@ public GluuConfiguration getConfigurationByInum(String inum) { * Get configuration * * @return Configuration - * @throws Exception */ public GluuConfiguration getConfiguration() { String configurationDn = staticConfiguration.getBaseDn().getConfiguration(); @@ -88,7 +86,6 @@ public GluuConfiguration getConfiguration() { * * @param inum Inum * @return DN string for specified configuration or DN for configurations branch if inum is null - * @throws Exception */ public String getDnForConfiguration(String inum) { String baseDn = staticConfiguration.getBaseDn().getConfiguration(); diff --git a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBinding.java b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBinding.java index 1ac83bd4cd9..486bdf9534a 100644 --- a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBinding.java +++ b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBinding.java @@ -12,11 +12,11 @@ * struct { * TokenBindingType tokenbinding_type; * TokenBindingID tokenbindingid; - * opaque signature<64..2^16-1>; Signature over the concatenation + * opaque signature<64..2^16-1>; Signature over the concatenation * of tokenbinding_type, * key_parameters and exported * keying material (EKM) - * TB_Extension extensions<0..2^16-1>; + * TB_Extension extensions<0..2^16-1>; * } TokenBinding; * * @author Yuriy Zabrovarnyy diff --git a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingExtension.java b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingExtension.java index 65781c7f26e..267091d9bfd 100644 --- a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingExtension.java +++ b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingExtension.java @@ -11,7 +11,7 @@ /** * struct { * TB_ExtensionType extension_type; - * opaque extension_data<0..2^16-1>; + * opaque extension_data<0..2^16-1>; * } TB_Extension; * * @author Yuriy Zabrovarnyy diff --git a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingMessage.java b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingMessage.java index 2610a91bb34..9d38bd40922 100644 --- a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingMessage.java +++ b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/binding/TokenBindingMessage.java @@ -18,7 +18,7 @@ /** * 

  * struct {
- *     TokenBinding tokenbindings<132..2^16-1>;
+ *     TokenBinding tokenbindings<132..2^16-1>;
  * } TokenBindingMessage;
  *
* diff --git a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAKeyFactory.java b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAKeyFactory.java index 8283ea9d19d..56eca501fb5 100644 --- a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAKeyFactory.java +++ b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAKeyFactory.java @@ -123,11 +123,7 @@ public EDDSAKeyFactory(final SignatureAlgorithm signatureAlgorithm, final String * @param expirationDate * @param dnName * @return - * @throws CertificateEncodingException - * @throws InvalidKeyException * @throws IllegalStateException - * @throws NoSuchProviderException - * @throws NoSuchAlgorithmException * @throws SignatureException */ public Certificate generateV3Certificate(final Date startDate, final Date expirationDate, final String dnName) throws SignatureException { diff --git a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAPublicKey.java b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAPublicKey.java index 3617ead1981..305ee97b02f 100644 --- a/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAPublicKey.java +++ b/jans-auth-server/model/src/main/java/io/jans/as/model/crypto/signature/EDDSAPublicKey.java @@ -33,7 +33,7 @@ public class EDDSAPublicKey extends PublicKey { * Constructor * * @param signatureAlgorithm - * @param publicKeyData + * @param xEncoded */ public EDDSAPublicKey(final SignatureAlgorithm signatureAlgorithm, byte[] xEncoded) { setSignatureAlgorithm(signatureAlgorithm); diff --git a/jans-auth-server/pom.xml b/jans-auth-server/pom.xml index 05999ad6882..a9c5f16f81d 100644 --- a/jans-auth-server/pom.xml +++ b/jans-auth-server/pom.xml @@ -499,7 +499,7 @@ org.apache.maven.plugins maven-javadoc-plugin - false + diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/authorize/ws/rs/AuthorizeRestWebService.java b/jans-auth-server/server/src/main/java/io/jans/as/server/authorize/ws/rs/AuthorizeRestWebService.java index 516fe790638..d46fed5e0cd 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/authorize/ws/rs/AuthorizeRestWebService.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/authorize/ws/rs/AuthorizeRestWebService.java @@ -110,7 +110,7 @@ public interface AuthorizeRestWebService { * If the state parameter was present in the client authorization * request. The exact value received from the client. * - *

+ *

*

* When the responseType parameter is set to token: *

@@ -245,7 +245,7 @@ Response requestAuthorizationGet( * If the state parameter was present in the client authorization * request. The exact value received from the client. * - *

+ *

*

* When the responseType parameter is set to token: *

diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/service/SectorIdentifierService.java b/jans-auth-server/server/src/main/java/io/jans/as/server/service/SectorIdentifierService.java index 1fd7283cea4..e4b141583ae 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/service/SectorIdentifierService.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/service/SectorIdentifierService.java @@ -71,7 +71,6 @@ public SectorIdentifier getSectorIdentifierById(String jsId) { * * @param jsId Sector Identifier jsId * @return DN string for specified sector identifier or DN for sector identifiers branch if jsId is null - * @throws Exception */ public String getDnForSectorIdentifier(String jsId) { String sectorIdentifierDn = staticConfiguration.getBaseDn().getSectorIdentifiers(); diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceImpl.java b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceImpl.java index 787997df2eb..31681902441 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceImpl.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceImpl.java @@ -42,7 +42,7 @@ public class SsaRestWebServiceImpl implements SsaRestWebService { * Creates an SSA from the requested parameters. *

* Method calls the action where the SSA creation logic is implemented. - *

+ *

* * @param requestParams Valid json * @param httpRequest Http request object @@ -57,7 +57,7 @@ public Response create(String requestParams, HttpServletRequest httpRequest) { * Get existing active SSA based on "jti" or "org_id". *

* Method calls the action where the SSA get logic is implemented. - *

+ *

* * @param jti Unique identifier * @param orgId Organization ID @@ -73,7 +73,7 @@ public Response get(String jti, String orgId, HttpServletRequest httpRequest) { * Validate existing active SSA based on "jti". *

* Method calls the action where the SSA validate logic is implemented. - *

+ *

* * @param jti Unique identifier * @return {@link Response} with status {@code 200} (Ok) if SSA has been validated. diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceValidator.java b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceValidator.java index 51ebdfa7714..86586da7e70 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceValidator.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/SsaRestWebServiceValidator.java @@ -123,7 +123,7 @@ public Ssa getValidSsaByJti(String jti) { *

* * @param createRequest SSA Metadata - * @throws WebApplicationException with status {@code 400 (Bad Request)} with invalid_ssa_metadata key, when lifetime is invalid + * @throws WebApplicationException with status {@code 400 (Bad Request)} with invalid_ssa_metadata key, when lifetime is invalid */ public void validateSsaCreateRequest(SsaCreateRequest createRequest) { if (createRequest.getLifetime() != null && createRequest.getLifetime() < 1) { diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/action/SsaCreateAction.java b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/action/SsaCreateAction.java index 8710ada23c5..c924becd902 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/action/SsaCreateAction.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/ssa/ws/rs/action/SsaCreateAction.java @@ -87,7 +87,7 @@ public class SsaCreateAction { * request has to have at least scope "ssa.admin", * it will also return a {@link WebApplicationException} with status {@code 500} in case an uncontrolled * error occurs when processing the method. - *

+ *

*

* Response of this method can be modified using the following custom script * SSA Custom Script, @@ -95,7 +95,7 @@ public class SsaCreateAction { *

*

* SSA returned by this method is stored in the corresponding database, so it can be later retrieved, validated or revoked. - *

+ *

* * @param requestParams Valid json request * @param httpRequest Http request diff --git a/jans-auth-server/server/src/main/java/io/jans/as/server/uma/ws/rs/UmaResourceRegistrationWS.java b/jans-auth-server/server/src/main/java/io/jans/as/server/uma/ws/rs/UmaResourceRegistrationWS.java index 7f9e547d951..866581fed30 100644 --- a/jans-auth-server/server/src/main/java/io/jans/as/server/uma/ws/rs/UmaResourceRegistrationWS.java +++ b/jans-auth-server/server/src/main/java/io/jans/as/server/uma/ws/rs/UmaResourceRegistrationWS.java @@ -49,7 +49,7 @@ * The API available at the resource registration endpoint enables the resource server to put resources under * the protection of an authorization server on behalf of the resource owner and manage them over time. * Protection of a resource at the authorization server begins on successful registration and ends on successful deregistration. - *

+ *

* The resource server uses a RESTful API at the authorization server's resource registration endpoint * to create, read, update, and delete resource descriptions, along with retrieving lists of such descriptions. * The descriptions consist of JSON documents that are maintained as web resources at the authorization server.