Support unknown values for all enums in MDS

emlun · emlun · commit 4f7164e1a9ab · 2026-04-18T01:27:33.000+02:00
diff --git a/NEWS b/NEWS
@@ -15,10 +15,22 @@ New features:
  ** Thanks to GitHub users mmoayyed and ErlendNukke for the contribution, see
     https://github.com/Yubico/java-webauthn-server/pull/468 and
     https://github.com/Yubico/java-webauthn-server/pull/467
+* Added `UNKNOWN` constant to all enums in `com.yubico.fido.metadata`:
+ ** `AttachmentHint`
+ ** `AuthenticationAlgorithm`
+ ** `AuthenticatorAttestationType`
+ ** `CtapCertificationId`
+ ** CtapPinUvAuthProtocolVersion`
+ ** CtapVersion`
+ ** ProtocolFamily`
+ ** PublicKeyRepresentationFormat`
+ ** TransactionConfirmationDisplayType`
 
 Fixes:
 
 * Added `@since` tags to `AuthenticatorStatus` and `FidoMetadataService` javadoc.
+* All `com.yubico.fido.metadata` enums now deserialize unknown values to
+  `UNKOWN` instead of crashing the parser.
 
 
 == Version 2.8.1 ==
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AttachmentHint.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AttachmentHint.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -22,6 +23,14 @@
  */
 public enum AttachmentHint {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link AttachmentHint} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0, "UNKNOWN"),
+
   /**
    * This flag MAY be set to indicate that the authenticator is permanently attached to the FIDO
    * User Device.
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AuthenticationAlgorithm.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AuthenticationAlgorithm.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -15,6 +16,14 @@
  */
 public enum AuthenticationAlgorithm {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link AuthenticationAlgorithm} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0, "UNKNOWN"),
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/common-specs/fido-registry-v2.2-rd-20210525.html#authentication-algorithms">FIDO
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AuthenticatorAttestationType.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/AuthenticatorAttestationType.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -15,6 +16,14 @@
  */
 public enum AuthenticatorAttestationType {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link AuthenticatorAttestationType} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0, "UNKNOWN"),
+
   /**
    * Indicates full basic attestation, based on an attestation private key shared among a class of
    * authenticators (e.g. same model). Authenticators must provide its attestation signature during
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapCertificationId.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapCertificationId.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -15,6 +16,14 @@
  */
 public enum CtapCertificationId {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link CtapCertificationId} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN("UNKNOWN"),
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-feature-descriptions-certifications">Client
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapPinUvAuthProtocolVersion.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapPinUvAuthProtocolVersion.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -11,6 +12,14 @@
  */
 public enum CtapPinUvAuthProtocolVersion {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link CtapPinUvAuthProtocolVersion} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0),
+
   /**
    * Represents PIN/UV Auth Protocol One.
    *
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapVersion.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/CtapVersion.java
@@ -1,5 +1,7 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
+
 /**
  * Enumeration of CTAP versions.
  *
@@ -9,6 +11,14 @@
  */
 public enum CtapVersion {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link CtapVersion} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN,
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#authenticatorGetInfo">Client
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/ProtocolFamily.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/ProtocolFamily.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -11,6 +12,14 @@
  */
 public enum ProtocolFamily {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link ProtocolFamily} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN("UNKNOWN"),
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/mds/fido-metadata-statement-v3.0-ps-20210518.html#dom-metadatastatement-protocolfamily">FIDO
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/PublicKeyRepresentationFormat.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/PublicKeyRepresentationFormat.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -15,6 +16,14 @@
  */
 public enum PublicKeyRepresentationFormat {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link PublicKeyRepresentationFormat} value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0, "UNKNOWN"),
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/common-specs/fido-registry-v2.2-rd-20210525.html#public-key-representation-formats">FIDO
diff --git a/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/TransactionConfirmationDisplayType.java b/webauthn-server-attestation/src/main/java/com/yubico/fido/metadata/TransactionConfirmationDisplayType.java
@@ -1,5 +1,6 @@
 package com.yubico.fido.metadata;
 
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
 import com.fasterxml.jackson.annotation.JsonValue;
 
 /**
@@ -18,6 +19,15 @@
  */
 public enum TransactionConfirmationDisplayType {
 
+  /**
+   * (NOT DEFINED IN SPEC) Placeholder for any unknown {@link TransactionConfirmationDisplayType}
+   * value.
+   *
+   * @since 2.9.0
+   */
+  @JsonEnumDefaultValue
+  UNKNOWN(0, "UNKNOWN"),
+
   /**
    * @see <a
    *     href="https://fidoalliance.org/specs/common-specs/fido-registry-v2.2-rd-20210525.html#transaction-confirmation-display-types">FIDO
