[java-idp-plugin-webauthn] 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-idp-plugin-webauthn.

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

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

commit 81315cc20808ae1f595eea329dcad08891f1f372
Author: Phil Smart <philip.smart at jisc.ac.uk>
AuthorDate: Wed May 8 10:53:08 2024 +0100

    Improve Javadoc
---
 .../admin/CredentialCreationOptionsParameters.java |  4 +--
 .../authn/webauthn/admin/RegistrationResult.java   | 38 ++++++++++++++++++----
 2 files changed, 34 insertions(+), 8 deletions(-)

diff --git a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/CredentialCreationOptionsParameters.java b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/CredentialCreationOptionsParameters.java
index 2a25f40..e310736 100644
--- a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/CredentialCreationOptionsParameters.java
+++ b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/CredentialCreationOptionsParameters.java
@@ -43,7 +43,7 @@ public class CredentialCreationOptionsParameters extends BaseOptionsParameters {
     @Nonnull @NonnullElements final Set<PublicKeyCredentialDescriptor> excludeCredentials;
     
     /** 
-     * The username of the user that is the subject of this authentication.
+     * The username (user.name) of the user that is the subject of this authentication.
      */
     @Nonnull @NotEmpty final String username;
     
@@ -65,7 +65,7 @@ public class CredentialCreationOptionsParameters extends BaseOptionsParameters {
     /** The Attestation conveyance preference.*/
     @Nonnull private final AttestationConveyancePreference attestationConveyancePreference;
     
-    /** Enable the credential properties extenions. For example, to report discoverable credentials i.e. 'passkeys'.*/
+    /** Enable the credential properties extensions. For example, to report discoverable credentials i.e. 'passkeys'.*/
     private final boolean enableCredProperties;
 
     /**
diff --git a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/RegistrationResult.java b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/RegistrationResult.java
index 81ab262..e2dcfb0 100644
--- a/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/RegistrationResult.java
+++ b/webauthn-api/src/main/java/net/shibboleth/idp/plugin/authn/webauthn/admin/RegistrationResult.java
@@ -190,26 +190,52 @@ public class RegistrationResult {
 
     /** The builder.*/
     public static final class Builder {
+        /** Is the attestation signature valid. Does it link to a trusted root attestation.*/
         private boolean attestationTrusted;
+        
+        /** The attestation type that was used for this credential.*/
         private AttestationType attestationType;
+        
+        /** The verified attestation response.*/
         private PublicKeyCredential<AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs> credential;
 
+        /** Constructor.*/
         private Builder() {
         }
 
-        public Builder withAttestationTrusted(final boolean attestationTrusted) {
-            this.attestationTrusted = attestationTrusted;
+        /**
+         * Is the attestation signature valid. Does it link to a trusted root attestation?
+         * 
+         * @param attTrust is the attestation trusted.
+         * 
+         * @return this builder
+         */
+        public Builder withAttestationTrusted(final boolean attTrust) {
+            attestationTrusted = attTrust;
             return this;
         }
 
-        public Builder withAttestationType(final AttestationType attestationType) {
-            this.attestationType = attestationType;
+        /**
+         * Set the attestation type.
+         * 
+         * @param attType the attestation type
+         * 
+         * @return this builder
+         */
+        public Builder withAttestationType(final AttestationType attType) {
+            attestationType = attType;
             return this;
         }
 
+        /**
+         * 
+         * @param cred the attestation response
+         * 
+         * @return this builder
+         */
         public Builder withCredential(
-                final PublicKeyCredential<AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs> credential) {
-            this.credential = credential;
+                final PublicKeyCredential<AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs> cred) {
+            credential = cred;
             return this;
         }
 

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