Document effect on finishAssertion behaviour in StartAssertionOptions.userVerification JavaDoc

Author: emlun

webauthn-server-core/src/main/java/com/yubico/webauthn/StartAssertionOptions.java

@@ -67,6 +67,11 @@ public class StartAssertionOptions {
    * The value for {@link PublicKeyCredentialRequestOptions#getUserVerification()} for this
    * authentication operation.
    *
+   * <p>If set to {@link UserVerificationRequirement#REQUIRED}, then {@link
+   * RelyingParty#finishAssertion(FinishAssertionOptions)} will enforce that <a
+   * href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> was performed
+   * in this authentication ceremony.
+   *
    * <p>The default is {@link UserVerificationRequirement#PREFERRED}.
    */
   private final UserVerificationRequirement userVerification;
@@ -103,6 +108,11 @@ public Optional<String> getUsername() {
    * The value for {@link PublicKeyCredentialRequestOptions#getUserVerification()} for this
    * authentication operation.
    *
+   * <p>If set to {@link UserVerificationRequirement#REQUIRED}, then {@link
+   * RelyingParty#finishAssertion(FinishAssertionOptions)} will enforce that <a
+   * href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> was performed
+   * in this authentication ceremony.
+   *
    * <p>The default is {@link UserVerificationRequirement#PREFERRED}.
    */
   public Optional<UserVerificationRequirement> getUserVerification() {
@@ -165,6 +175,11 @@ public StartAssertionOptionsBuilder username(@NonNull String username) {
      * The value for {@link PublicKeyCredentialRequestOptions#getUserVerification()} for this
      * authentication operation.
      *
+     * <p>If set to {@link UserVerificationRequirement#REQUIRED}, then {@link
+     * RelyingParty#finishAssertion(FinishAssertionOptions)} will enforce that <a
+     * href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> was
+     * performed in this authentication ceremony.
+     *
      * <p>The default is {@link UserVerificationRequirement#PREFERRED}.
      */
     public StartAssertionOptionsBuilder userVerification(
@@ -177,6 +192,11 @@ public StartAssertionOptionsBuilder userVerification(
      * The value for {@link PublicKeyCredentialRequestOptions#getUserVerification()} for this
      * authentication operation.
      *
+     * <p>If set to {@link UserVerificationRequirement#REQUIRED}, then {@link
+     * RelyingParty#finishAssertion(FinishAssertionOptions)} will enforce that <a
+     * href="https://www.w3.org/TR/webauthn-2/#user-verification">user verification</a> was
+     * performed in this authentication ceremony.
+     *
      * <p>The default is {@link UserVerificationRequirement#PREFERRED}.
      */
     public StartAssertionOptionsBuilder userVerification(