[java-oidc-common] branch main updated: Improve Javadoc

[Phil Smart]

This is an automated email from the git hooks/post-receive script.

philsmart pushed a commit to branch main
in repository java-oidc-common.

View the commit online:
http://git.shibboleth.net/view/?p=java-oidc-common.git;a=commit;h=93c3c37917ba4e63795c5f1a441807408d869aaf

The following commit(s) were added to refs/heads/main by this push:
       new  93c3c37   Improve Javadoc
93c3c37 is described below

commit 93c3c37917ba4e63795c5f1a441807408d869aaf
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Feb 5 14:41:30 2021 +0000

    Improve Javadoc
---
 .../net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java    | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
index a47e5ee..36dab31 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/JWSAssemblyUtils.java
@@ -53,8 +53,9 @@ public final class JWSAssemblyUtils {
      * Assemble a HMAC based JSON Web Signature token using the given algorithm, claims, and secret,
      * and return its JSON compact serialized form.
      * 
-     * <p>Note, can be used over the Nimbus {@link MACSigner} on occasions where an algorithm to 
-     * secret key compatibility issues exist e.g. using a HS512 HMAC with too small a secret key</p>
+     * <p>Note, does not check key to algorithm compatibility, use Nimbus's {@link MACSigner} directly for the 
+     * additional safety checks it has. This can therefore be used over the Nimbus signer on occasions 
+     * where an algorithm to secret key incompatibility exists e.g. using a HS512 HMAC with too small a secret key.</p>
      * 
      * @param algorithm the JWA algorithm, **must** be one from the HMAC family.
      * @param claimsSet the JSON claims that form the payload.
@@ -77,8 +78,9 @@ public final class JWSAssemblyUtils {
     /**
     * Assemble a HMAC based JSON Web Signature token (JWS) using the given algorithm, claims, and secret.
     * 
-    * <p>Note, can be used over the Nimbus {@link MACSigner} on occasions where an algorithm to 
-    * secret key compatibility issues exist e.g. using a HS512 HMAC with too small a secret key</p>
+    * <p>Note, does not check key to algorithm compatibility, use Nimbus's {@link MACSigner} directly for the 
+    * additional safety checks it has. This can therefore be used over the Nimbus signer on occasions 
+    * where an algorithm to secret key incompatibility exists e.g. using a HS512 HMAC with too small a secret key.</p>
     * 
     * @param algorithm the JWA algorithm, **must** be one from the HMAC family.
     * @param claimsSet the claims that form the payload.

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.