[java-oidc-common] branch dev/JCOMOIDC-62 updated: Javadoc and logging improvements

Phil Smart philip.smart at jisc.ac.uk
Fri Jan 27 10:00:12 UTC 2023


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

philsmart pushed a commit to branch dev/JCOMOIDC-62
in repository java-oidc-common.

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

The following commit(s) were added to refs/heads/dev/JCOMOIDC-62 by this push:
     new af2199e  Javadoc and logging improvements
af2199e is described below

commit af2199ef1ed0aab18fc26df012537c06cd258b56
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Fri Jan 27 10:00:06 2023 +0000

    Javadoc and logging improvements
---
 .../shibboleth/oidc/security/credential/ClientSecretCredential.java | 2 +-
 .../credential/impl/ClientSecretCriterionCredentialResolver.java    | 3 ++-
 .../main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java | 6 ++++--
 .../oidc/profile/impl/PopulateJWTEncryptionParameters.java          | 6 ++++--
 4 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
index b8b0f44..b7f1c0f 100644
--- a/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
+++ b/oidc-common-crypto-api/src/main/java/net/shibboleth/oidc/security/credential/ClientSecretCredential.java
@@ -27,7 +27,7 @@ import com.nimbusds.jose.JWEAlgorithm;
 
 /**
  * Credential wrapping a client_secret. Contains methods to convert the client_secret into suitable keys used for
- * signing and encryption functions.
+ * signing and encryption.
  * 
  * <p>Note, despite its name, this is not an opensaml {@link Credential} type.</p>
  */
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
index ed25bd9..9d5dd84 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/credential/impl/ClientSecretCriterionCredentialResolver.java
@@ -120,7 +120,8 @@ public class ClientSecretCriterionCredentialResolver extends BasicJOSEObjectCred
                 throw new ResolverException("Unable to create key from client_secret, incompatible usage type");
             }
         } else {
-            throw new ResolverException("Criteria did not contain a StaticClientSecretCredentialCriterion");
+            log.debug("Criteria did not contain a StaticClientSecretCredentialCriterion");
+            return Collections.emptyList();
         }
     }
     
diff --git a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
index 62e6120..2175400 100644
--- a/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
+++ b/oidc-common-crypto-impl/src/main/java/net/shibboleth/oidc/security/impl/SignJWTHandler.java
@@ -216,9 +216,11 @@ public class SignJWTHandler extends AbstractMessageHandler {
             jwt = new SignedJWT(headerBuilder.build(), jwtClaimSetToSign);
             jwt.sign(signer);
             if (log.isDebugEnabled() && !log.isTraceEnabled()) {
-                log.debug("{} Signed JWT '{}'", getLogPrefix(), logName);
+                log.debug("{} Signed JWT '{}' using kid '{}'", getLogPrefix(), logName, 
+                        CredentialConversionUtil.resolveKid(credential));
             } else if (log.isTraceEnabled()) {
-                log.trace("{} Signed JWT '{}': {}", getLogPrefix(), logName, jwt.serialize());
+                log.trace("{} Signed JWT '{}' using kid '{}': {}", getLogPrefix(), logName, 
+                        CredentialConversionUtil.resolveKid(credential),jwt.serialize());
             }            
             
             if (jwt.getState() != State.SIGNED) {
diff --git a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/PopulateJWTEncryptionParameters.java b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/PopulateJWTEncryptionParameters.java
index fa47d4c..7659769 100644
--- a/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/PopulateJWTEncryptionParameters.java
+++ b/oidc-common-profile-impl/src/main/java/net/shibboleth/oidc/profile/impl/PopulateJWTEncryptionParameters.java
@@ -49,9 +49,9 @@ import net.shibboleth.oidc.security.jose.EncryptionParameters;
 import net.shibboleth.oidc.security.jose.EncryptionParametersResolver;
 import net.shibboleth.oidc.security.jose.context.SecurityParametersContext;
 import net.shibboleth.oidc.security.jose.criterion.ClientInformationCriterion;
+import net.shibboleth.oidc.security.jose.criterion.ClientSecretCredentialCriterion;
 import net.shibboleth.oidc.security.jose.criterion.EncryptionConfigurationCriterion;
 import net.shibboleth.oidc.security.jose.criterion.ProviderMetadataCriterion;
-import net.shibboleth.oidc.security.jose.criterion.ClientSecretCredentialCriterion;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullElements;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
@@ -355,8 +355,10 @@ public class PopulateJWTEncryptionParameters extends AbstractProfileAction {
                         profileConfiguration.getClientCredential(profileRequestContext);
                 if (credential != null) {
                     criteria.add(new ClientSecretCredentialCriterion(credential));
+                    log.debug("{} Adding client_secret credential to resolution criteria",
+                            getLogPrefix());
                 } else {
-                    log.trace("{} No credential found from the profile configuration", getLogPrefix());
+                    log.trace("{} No client_secret credential found from the profile configuration", getLogPrefix());
                 }
             } else {
                 log.trace("{} Profile configuration not available, "

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


More information about the commits mailing list