[java-idp-plugin-webauthn] branch main updated: Javadoc and logging improvements

[Phil Smart]

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

philsmart pushed a commit to branch main
in repository java-idp-plugin-webauthn.

View the commit online:
http://git.shibboleth.net/view/?p=java-idp-plugin-webauthn.git;a=commit;h=48d7f31986c471bc1b6cd670528559769a3d7953

The following commit(s) were added to refs/heads/main by this push:
     new 48d7f31  Javadoc and logging improvements
48d7f31 is described below

commit 48d7f31986c471bc1b6cd670528559769a3d7953
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Wed May 7 16:13:16 2025 +0100

    Javadoc and logging improvements
---
 .../plugin/authn/webauthn/context/WebAuthnRegistrationContext.java    | 2 +-
 .../webauthn/admin/impl/ExtractKeyInformationFromFormRequest.java     | 2 +-
 .../authn/webauthn/admin/impl/ExtractNicknameFromFormRequest.java     | 1 +
 .../admin/impl/RegistrationContextCredentialToModifyConsumer.java     | 2 +-
 .../webauthn/storage/impl/IdPStorageServiceCredentialRespository.java | 4 ++--
 .../net/shibboleth/idp/plugin/authn/webauthn/messages.properties      | 2 +-
 6 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/context/WebAuthnRegistrationContext.java b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/context/WebAuthnRegistrationContext.java
index 328cb81..205288d 100644
--- a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/context/WebAuthnRegistrationContext.java
+++ b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/context/WebAuthnRegistrationContext.java
@@ -82,7 +82,7 @@ public final class WebAuthnRegistrationContext extends BaseWebAuthnContext {
     /** Is nickname collection enabled or disabled?.*/
     private boolean nicknameRequired;
     
-    /** The ID of a credential that is going to be modified in some way.*/
+    /** The ID of the credential that is going to be modified.*/
     @Nullable private byte[] credentialIdToModify;    
     
     
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractKeyInformationFromFormRequest.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractKeyInformationFromFormRequest.java
index 27445b6..81b0dcf 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractKeyInformationFromFormRequest.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractKeyInformationFromFormRequest.java
@@ -38,7 +38,7 @@ import net.shibboleth.shared.primitive.StringSupport;
 
 /**
  * An action that extracts the credential ID for from the incoming HTTP request and uses a {@link BiConsumer}
- * to set that back onto an appropriate context.
+ * to set it back onto an appropriate context.
  * 
  * @event {WebAuthnRegistrationEventIds#INVALID_ADMIN_ACTION}
  * @event {EventIds#INVALID_PROFILE_CTX}
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractNicknameFromFormRequest.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractNicknameFromFormRequest.java
index 7e5af84..c3ac4db 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractNicknameFromFormRequest.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/ExtractNicknameFromFormRequest.java
@@ -35,6 +35,7 @@ import net.shibboleth.shared.primitive.StringSupport;
  * a non-proceed event is signalled.
  * 
  * @event {WebAuthnRegistrationEventIds#INVALID_REGISTRATION}
+ * @event {WebAuthnRegistrationEventIds#INVALID_ADMIN_ACTION}
  * @event {AuthnEventIds#NO_CREDENTIALS}
  * @pre <pre>ProfileRequestContext.getSubcontext(WebAuthnRegistrationContext.class) != null</pre>
  * @post add a credential nickname (if present) to the registration context
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/RegistrationContextCredentialToModifyConsumer.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/RegistrationContextCredentialToModifyConsumer.java
index 7a26530..c928316 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/RegistrationContextCredentialToModifyConsumer.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/RegistrationContextCredentialToModifyConsumer.java
@@ -67,7 +67,7 @@ public class RegistrationContextCredentialToModifyConsumer extends AbstractIdent
         final WebAuthnRegistrationContext webauthnRegistrationContext = 
                 webauthnRegistrationContextLookupStrategy.apply(prc);
         if (webauthnRegistrationContext == null) {
-            log.warn("{} No WebAuthn registration context returned by lookup strategy, can not set credential "
+            log.debug("{} No WebAuthn registration context returned by lookup strategy, can not set credential "
                     + "identifier to modify",getId()); 
             return;
         } 
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRespository.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRespository.java
index 387ccf5..253dac8 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRespository.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/impl/IdPStorageServiceCredentialRespository.java
@@ -674,7 +674,7 @@ public class IdPStorageServiceCredentialRespository extends AbstractIdentifiable
                     .findFirst();
             
             if (credential.isEmpty()) {
-                log.warn("Can not update nickname for user '{}' and credential '{}'. "
+                log.debug("Cannot update nickname for user '{}' and credential '{}'. "
                         + "No existing credential found.", username, credentialId.getBase64());
                 return false;                
             }
@@ -691,7 +691,7 @@ public class IdPStorageServiceCredentialRespository extends AbstractIdentifiable
             
             if (updateCredentialSet.isEmpty()) {
                 // We are updating, so this should not be possible
-                log.debug("Can not nickname for user '{}' and credential '{}'. "
+                log.debug("Cannot update nickname for user '{}' and credential '{}'. "
                         + "Update set is empty.", username, credentialId.getBase64());
                 return false;
             }
diff --git a/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/messages.properties b/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/messages.properties
index 16ad014..02cd483 100644
--- a/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/messages.properties
+++ b/webauthn-impl/src/main/resources/net/shibboleth/idp/plugin/authn/webauthn/messages.properties
@@ -67,7 +67,7 @@ InvalidRegistration = Key registration unsuccessful
 ValidRegistration = Key was registered successfully
 KeyRemoved = Key was removed successfully
 NicknameUpdated = Nickname updated
-EmptyNickname = Nickname can not be empty
+EmptyNickname = Nickname cannot be empty
 
 # Messages to report back to the admin during key management
 SearchUsernameNotFoundAfterC14N = Error determining username to search for

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