Add enum parsing functions

Author: emlun

NEWS

@@ -6,6 +6,12 @@ New features:
   `RegistrationResult` and `RegisteredCredential`.
  ** Thanks to Jakob Heher (A-SIT) for the contribution, see
     https://github.com/Yubico/java-webauthn-server/pull/299
+* Added enum parsing functions:
+ ** `AuthenticatorAttachment.fromValue(String): Optional<AuthenticatorAttachment>`
+ ** `PublicKeyCredentialType.fromId(String): Optional<PublicKeyCredentialType>`
+ ** `ResidentKeyRequirement.fromValue(String): Optional<ResidentKeyRequirement>`
+ ** `TokenBindingStatus.fromValue(String): Optional<TokenBindingStatus>`
+ ** `UserVerificationRequirement.fromValue(String): Optional<UserVerificationRequirement>`
 * (Experimental) Added option `isSecurePaymentConfirmation(boolean)` to
   `FinishAssertionOptions`. When set, `RelyingParty.finishAssertion()` will
   adapt the validation logic for a Secure Payment Confirmation (SPC) response

webauthn-server-core/src/main/java/com/yubico/webauthn/data/AuthenticatorAttachment.java

@@ -26,6 +26,7 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonValue;
+import java.util.Optional;
 import java.util.stream.Stream;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
@@ -72,8 +73,23 @@ public enum AuthenticatorAttachment {
 
   @JsonValue @Getter @NonNull private final String value;
 
+  /**
+   * Attempt to parse a string as an {@link AuthenticatorAttachment}.
+   *
+   * @param value a {@link String} equal to the {@link #getValue() value} of a constant in {@link
+   *     AuthenticatorAttachment}
+   * @return The {@link AuthenticatorAttachment} instance whose {@link #getValue() value} equals
+   *     <code>value</code>, if any.
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#enumdef-authenticatorattachment">§5.4.5.
+   *     Authenticator Attachment Enumeration (enum AuthenticatorAttachment) </a>
+   */
+  public static Optional<AuthenticatorAttachment> fromValue(@NonNull String value) {
+    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
+  }
+
   @JsonCreator
   private static AuthenticatorAttachment fromJsonString(@NonNull String value) {
-    return Stream.of(values()).filter(v -> v.value.equals(value)).findAny().orElse(null);
+    return fromValue(value).orElse(null);
   }
 }

webauthn-server-core/src/main/java/com/yubico/webauthn/data/PublicKeyCredentialType.java

@@ -51,13 +51,24 @@ public enum PublicKeyCredentialType {
 
   @JsonValue @Getter @NonNull private final String id;
 
-  private static Optional<PublicKeyCredentialType> fromString(@NonNull String id) {
+  /**
+   * Attempt to parse a string as a {@link PublicKeyCredentialType}.
+   *
+   * @param id a {@link String} equal to the {@link #getId() id} of a constant in {@link
+   *     PublicKeyCredentialType}
+   * @return The {@link AuthenticatorAttachment} instance whose {@link #getId() id} equals <code>id
+   *     </code>, if any.
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#enumdef-publickeycredentialtype">§5.10.2.
+   *     Credential Type Enumeration (enum PublicKeyCredentialType)</a>
+   */
+  public static Optional<PublicKeyCredentialType> fromId(@NonNull String id) {
     return Stream.of(values()).filter(v -> v.id.equals(id)).findAny();
   }
 
   @JsonCreator
   private static PublicKeyCredentialType fromJsonString(@NonNull String id) {
-    return fromString(id)
+    return fromId(id)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(

webauthn-server-core/src/main/java/com/yubico/webauthn/data/ResidentKeyRequirement.java

@@ -105,13 +105,24 @@ public enum ResidentKeyRequirement {
 
   @JsonValue @Getter @NonNull private final String value;
 
-  private static Optional<ResidentKeyRequirement> fromString(@NonNull String value) {
+  /**
+   * Attempt to parse a string as a {@link ResidentKeyRequirement}.
+   *
+   * @param value a {@link String} equal to the {@link #getValue() value} of a constant in {@link
+   *     ResidentKeyRequirement}
+   * @return The {@link ResidentKeyRequirement} instance whose {@link #getValue() value} equals
+   *     <code>value</code>, if any.
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#enum-residentKeyRequirement">§5.4.6.
+   *     Resident Key Requirement Enumeration (enum ResidentKeyRequirement)</a>
+   */
+  public static Optional<ResidentKeyRequirement> fromValue(@NonNull String value) {
     return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
   private static ResidentKeyRequirement fromJsonString(@NonNull String value) {
-    return fromString(value)
+    return fromValue(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(

webauthn-server-core/src/main/java/com/yubico/webauthn/data/TokenBindingStatus.java

@@ -58,13 +58,24 @@ public enum TokenBindingStatus {
 
   @JsonValue @Getter @NonNull private final String value;
 
-  private static Optional<TokenBindingStatus> fromString(@NonNull String value) {
+  /**
+   * Attempt to parse a string as a {@link TokenBindingStatus}.
+   *
+   * @param value a {@link String} equal to the {@link #getValue() value} of a constant in {@link
+   *     TokenBindingStatus}
+   * @return The {@link TokenBindingStatus} instance whose {@link #getValue() value} equals <code>
+   *     value</code>, if any.
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#enumdef-tokenbindingstatus">enum
+   *     TokenBindingStatus</a>
+   */
+  public static Optional<TokenBindingStatus> fromValue(@NonNull String value) {
     return Arrays.stream(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
   static TokenBindingStatus fromJsonString(@NonNull String value) {
-    return fromString(value)
+    return fromValue(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(

webauthn-server-core/src/main/java/com/yubico/webauthn/data/UserVerificationRequirement.java

@@ -66,13 +66,24 @@ public enum UserVerificationRequirement {
 
   @JsonValue @Getter @NonNull private final String value;
 
-  private static Optional<UserVerificationRequirement> fromString(@NonNull String value) {
+  /**
+   * Attempt to parse a string as a {@link UserVerificationRequirement}.
+   *
+   * @param value a {@link String} equal to the {@link #getValue() value} of a constant in {@link
+   *     UserVerificationRequirement}
+   * @return The {@link UserVerificationRequirement} instance whose {@link #getValue() value} equals
+   *     <code>value</code>, if any.
+   * @see <a
+   *     href="https://www.w3.org/TR/2021/REC-webauthn-2-20210408/#enumdef-userverificationrequirement">§5.10.6.
+   *     User Verification Requirement Enumeration (enum UserVerificationRequirement)</a>
+   */
+  public static Optional<UserVerificationRequirement> fromValue(@NonNull String value) {
     return Stream.of(values()).filter(v -> v.value.equals(value)).findAny();
   }
 
   @JsonCreator
   private static UserVerificationRequirement fromJsonString(@NonNull String value) {
-    return fromString(value)
+    return fromValue(value)
         .orElseThrow(
             () ->
                 new IllegalArgumentException(