[java-idp-plugin-webauthn] branch main updated: Fix Javadoc

Phil Smart philip.smart at jisc.ac.uk
Thu Dec 5 16:05:36 UTC 2024


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=9c1104af0bf4227344960da53b534cb6b9575d48

The following commit(s) were added to refs/heads/main by this push:
     new 9c1104a  Fix Javadoc
9c1104a is described below

commit 9c1104af0bf4227344960da53b534cb6b9575d48
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Thu Dec 5 16:05:33 2024 +0000

    Fix Javadoc
---
 .../idp/plugin/authn/webauthn/storage/EnhancedCredentialRecord.java | 2 +-
 .../admin/impl/InitializeAdminSubjectCanonicalizationContext.java   | 2 +-
 .../authn/webauthn/admin/impl/InlineEnrolmentRedirectFunction.java  | 2 +-
 .../plugin/authn/webauthn/admin/impl/LabelCredentialRecords.java    | 5 ++---
 .../authn/webauthn/admin/impl/PopulateInlineEnrolmentContext.java   | 2 +-
 .../webauthn/admin/impl/SecondFactorOnlyCredentialLabeller.java     | 6 +++---
 .../idp/plugin/authn/webauthn/impl/GenerateServerChallenge.java     | 2 +-
 .../webauthn/impl/InitializeSubjectCanonicalizationContext.java     | 2 +-
 .../idp/plugin/authn/webauthn/impl/ValidateWebAuthnAssertion.java   | 3 ++-
 9 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/EnhancedCredentialRecord.java b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/EnhancedCredentialRecord.java
index 53a7f2c..07db975 100644
--- a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/EnhancedCredentialRecord.java
+++ b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/storage/EnhancedCredentialRecord.java
@@ -112,7 +112,7 @@ public class EnhancedCredentialRecord {
     /**
      * Set labels about the credential or authenticator that created it. For display only.
      * 
-     * @param labels The labels to set.
+     * @param labelsIn The labels to set.
      */
     public void setLabels(@Nonnull final List<String> labelsIn) {
         labels = CollectionSupport.copyToList(Constraint.isNotNull(labelsIn, "labels can not be null"));
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InitializeAdminSubjectCanonicalizationContext.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InitializeAdminSubjectCanonicalizationContext.java
index 9781fd0..05b0844 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InitializeAdminSubjectCanonicalizationContext.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InitializeAdminSubjectCanonicalizationContext.java
@@ -36,7 +36,7 @@ import net.shibboleth.shared.primitive.LoggerFactory;
  * An action that creates a new {@link SubjectCanonicalizationContext} out of the search username in the admin context,
  * ready for the c14n flows to canonicalize.
  * 
- * @event {@link AuthnEventIds.UNKNOWN_USERNAME}
+ * @event {@link AuthnEventIds#UNKNOWN_USERNAME}
  * @pre <pre>ProfileRequestContext.getSubcontext(WebAuthnManagementContext.class) != null</pre>
  * @post a subject canonicalization context is created under the profile request context ready for the c14n flows
  */
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InlineEnrolmentRedirectFunction.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InlineEnrolmentRedirectFunction.java
index 1f85b18..404a974 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InlineEnrolmentRedirectFunction.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/InlineEnrolmentRedirectFunction.java
@@ -35,7 +35,7 @@ import net.shibboleth.shared.logic.Constraint;
 public class InlineEnrolmentRedirectFunction extends AbstractInitializableComponent 
         implements BiFunction<RequestContext,ProfileRequestContext,String>{
     
-    /** Strategy used to locate the {@link InlineEnrolementContext}. */
+    /** Strategy used to locate the {@link InlineEnrolmentContext}. */
     @Nonnull private 
     Function<ProfileRequestContext, InlineEnrolmentContext> inlineEnrolementContextCreationStrategy;
     
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/LabelCredentialRecords.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/LabelCredentialRecords.java
index 5a9c6bc..a13b1da 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/LabelCredentialRecords.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/LabelCredentialRecords.java
@@ -50,13 +50,12 @@ public class LabelCredentialRecords extends AbstractAuthenticationAction {
     /** The labeller used to generate labels for the credential, for display only.*/
     @Nonnull @NotLive private BiFunction<EnhancedCredentialRecord, ProfileRequestContext, List<String>> labeller;
     
+    /** The credential record lookup strategy.*/
     @NonnullAfterInit 
     private Function<ProfileRequestContext, Collection<EnhancedCredentialRecord>> credentialsLookupStrategy;
     
     /**
      * Constructor.
-     *
-     * @param defaultStrategy
      */
     protected LabelCredentialRecords() {
         labeller = (cred, prc) -> CollectionSupport.emptyList();
@@ -86,7 +85,7 @@ public class LabelCredentialRecords extends AbstractAuthenticationAction {
     /**
      * Set the labeller used to generate labels for the credential, for display only.
      * 
-     * @param labeller The labeller to set.
+     * @param labellerIn The labeller to set.
      */
     public void setLabeller(@Nonnull 
             final BiFunction<EnhancedCredentialRecord, ProfileRequestContext, List<String>> labellerIn) {
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/PopulateInlineEnrolmentContext.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/PopulateInlineEnrolmentContext.java
index bece83f..93a7910 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/PopulateInlineEnrolmentContext.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/PopulateInlineEnrolmentContext.java
@@ -50,7 +50,7 @@ public class PopulateInlineEnrolmentContext extends AbstractProfileAction {
     /** Is inline enrolment enabled? Enabled by default. */
     private Predicate<ProfileRequestContext> enabled;
     
-    /** Strategy used to locate or create the {@link InlineEnrolementContext} to populate. */
+    /** Strategy used to locate or create the {@link InlineEnrolmentContext} to populate. */
     @Nonnull private 
     Function<ProfileRequestContext, InlineEnrolmentContext> inlineEnrolementContextCreationStrategy;
     
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/SecondFactorOnlyCredentialLabeller.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/SecondFactorOnlyCredentialLabeller.java
index 577d9f9..f766548 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/SecondFactorOnlyCredentialLabeller.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/impl/SecondFactorOnlyCredentialLabeller.java
@@ -48,12 +48,12 @@ import net.shibboleth.shared.primitive.StringSupport;
 public class SecondFactorOnlyCredentialLabeller 
     implements BiFunction<EnhancedCredentialRecord, ProfileRequestContext, List<String>> {
     
-    /** Class logger. */
-    @Nonnull private final Logger log = LoggerFactory.getLogger(SecondFactorOnlyCredentialLabeller.class);
-    
     /** The default label to use for second factor only credentials.*/
     @Nonnull @NotEmpty private static final String DEFAULT_LABEL = "SecondFactorOnly";
     
+    /** Class logger. */
+    @Nonnull private final Logger log = LoggerFactory.getLogger(SecondFactorOnlyCredentialLabeller.class);
+    
     /** A set of authenticators that should only be used for second factor authentication, based on their AAGUID.*/
     @Nonnull @NotLive @Unmodifiable private Set<AAGUID> secondFactorOnlyAuthenticators;
     
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/GenerateServerChallenge.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/GenerateServerChallenge.java
index 99b73da..db5811d 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/GenerateServerChallenge.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/GenerateServerChallenge.java
@@ -103,7 +103,7 @@ public class GenerateServerChallenge extends AbstractWebAuthnAction<BaseWebAuthn
     }
     
     /**
-     * Default challenge generator that generates a 32 bytes randomized challenge of sufficient entropy. Returns
+     * Default challenge generator that generates a 32 byte randomized challenge of sufficient entropy. Returns
      * {@code null} iff one can not be generated.
      */
     private static final class DefaultChallengeGenerator implements Function<ProfileRequestContext, byte[]>{
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/InitializeSubjectCanonicalizationContext.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/InitializeSubjectCanonicalizationContext.java
index f36524e..7022223 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/InitializeSubjectCanonicalizationContext.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/InitializeSubjectCanonicalizationContext.java
@@ -35,7 +35,7 @@ import net.shibboleth.shared.primitive.LoggerFactory;
  * An action that creates a new {@link SubjectCanonicalizationContext} out of the username in the base context,
  * ready for the c14n flows to canonicalize.
  * 
- * @event {@link AuthnEventIds.UNKNOWN_USERNAME}
+ * @event {@link AuthnEventIds#UNKNOWN_USERNAME}
  * @pre <pre>ProfileRequestContext.getSubcontext(WebAuthnRegistrationContext.class) != null</pre>
  * @post a subject canonicalization context is created under the profile request context ready for the c14n flows
  */
diff --git a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/ValidateWebAuthnAssertion.java b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/ValidateWebAuthnAssertion.java
index fa3c404..6757681 100644
--- a/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/ValidateWebAuthnAssertion.java
+++ b/webauthn-impl/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/impl/ValidateWebAuthnAssertion.java
@@ -297,7 +297,8 @@ public class ValidateWebAuthnAssertion extends AbstractAuditingValidationAction
                 return;
             }
 
-            final WebAuthnAuthenticationContext webAuthnCtx = authnCtx.getSubcontext(WebAuthnAuthenticationContext.class);
+            final WebAuthnAuthenticationContext webAuthnCtx = 
+                    authnCtx.getSubcontext(WebAuthnAuthenticationContext.class);
             if (webAuthnCtx == null) {
                 return;
             }           

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


More information about the commits mailing list