MDS: Adjust SupportedCtapOptions parsing logic #419
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,160 +1,226 @@ | ||
| package com.yubico.fido.metadata; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonAlias; | ||
| import com.fasterxml.jackson.annotation.JsonCreator; | ||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import lombok.Builder; | ||
| import lombok.Value; | ||
|
|
||
| /** | ||
| * A fixed-keys map of CTAP2 option names to Boolean values representing whether an authenticator | ||
| * supports the respective option. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @Value | ||
| @Builder | ||
| public class SupportedCtapOptions { | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean plat; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean rk; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the device is capable of accepting PIN. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean clientPin; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean up; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the device is capable of built-in user verification. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean uv; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean pinUvAuthToken; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean noMcGaPermissionsWithClientPin; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean largeBlobs; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the authenticator is enterprise attestation capable. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean ep; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the authenticator supports the authenticatorBioEnrollment commands. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean bioEnroll; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the authenticator supports the Prototype authenticatorBioEnrollment | ||
| * (0x40) commands. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean userVerificationMgmtPreview; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean uvBioEnroll; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean authnrCfg; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean uvAcfg; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean credMgmt; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean perCredMgmtRO; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean credentialMgmtPreview; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean setMinPINLength; | ||
|
|
||
| /** | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| boolean makeCredUvNotRqd; | ||
|
|
||
| /** | ||
| * If set to <code>true</code> the authenticator supports the Always Require User Verification | ||
| * feature. | ||
| * | ||
| * @see <a | ||
| * href="https://fidoalliance.org/specs/fido-v2.2-ps-20250228/fido-client-to-authenticator-protocol-v2.2-ps-20250228.html#authenticatorGetInfo">Client | ||
| * to Authenticator Protocol (CTAP) §6.4. authenticatorGetInfo (0x04)</a> | ||
| */ | ||
| @JsonInclude(JsonInclude.Include.NON_DEFAULT) | ||
| boolean alwaysUv; | ||
|
|
||
| @JsonCreator | ||
| private SupportedCtapOptions( | ||
| @JsonProperty("plat") Boolean plat, | ||
| @JsonProperty("rk") Boolean rk, | ||
| @JsonProperty("clientPin") Boolean clientPin, | ||
| @JsonProperty("up") Boolean up, | ||
| @JsonProperty("uv") Boolean uv, | ||
| @JsonAlias("uvToken") @JsonProperty("pinUvAuthToken") Boolean pinUvAuthToken, | ||
| @JsonProperty("noMcGaPermissionsWithClientPin") Boolean noMcGaPermissionsWithClientPin, | ||
| @JsonProperty("largeBlobs") Boolean largeBlobs, | ||
| @JsonProperty("ep") Boolean ep, | ||
| @JsonProperty("bioEnroll") Boolean bioEnroll, | ||
| @JsonProperty("userVerificationMgmtPreview") Boolean userVerificationMgmtPreview, | ||
| @JsonProperty("uvBioEnroll") Boolean uvBioEnroll, | ||
| @JsonAlias("config") @JsonProperty("authnrCfg") Boolean authnrCfg, | ||
| @JsonProperty("uvAcfg") Boolean uvAcfg, | ||
| @JsonProperty("credMgmt") Boolean credMgmt, | ||
| @JsonProperty("perCredMgmtRO") Boolean perCredMgmtRO, | ||
| @JsonProperty("credentialMgmtPreview") Boolean credentialMgmtPreview, | ||
| @JsonProperty("setMinPINLength") Boolean setMinPINLength, | ||
| @JsonProperty("makeCredUvNotRqd") Boolean makeCredUvNotRqd, | ||
| @JsonProperty("alwaysUv") Boolean alwaysUv) { | ||
| this.plat = Boolean.TRUE.equals(plat); | ||
| this.rk = Boolean.TRUE.equals(rk); | ||
| this.clientPin = clientPin != null; | ||
| this.up = Boolean.TRUE.equals(up); | ||
| this.uv = uv != null; | ||
| this.pinUvAuthToken = Boolean.TRUE.equals(pinUvAuthToken); | ||
| this.noMcGaPermissionsWithClientPin = Boolean.TRUE.equals(noMcGaPermissionsWithClientPin); | ||
| this.largeBlobs = Boolean.TRUE.equals(largeBlobs); | ||
| this.ep = ep != null; | ||
| this.bioEnroll = bioEnroll != null; | ||
| this.userVerificationMgmtPreview = userVerificationMgmtPreview != null; | ||
| this.uvBioEnroll = Boolean.TRUE.equals(uvBioEnroll); | ||
| this.authnrCfg = Boolean.TRUE.equals(authnrCfg); | ||
| this.uvAcfg = Boolean.TRUE.equals(uvAcfg); | ||
| this.credMgmt = Boolean.TRUE.equals(credMgmt); | ||
| this.perCredMgmtRO = Boolean.TRUE.equals(perCredMgmtRO); | ||
| this.credentialMgmtPreview = Boolean.TRUE.equals(credentialMgmtPreview); | ||
| this.setMinPINLength = Boolean.TRUE.equals(setMinPINLength); | ||
| this.makeCredUvNotRqd = Boolean.TRUE.equals(makeCredUvNotRqd); | ||
| this.alwaysUv = alwaysUv != null; | ||
| } | ||
|
There was a problem hiding this comment. Looks like an |
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll need to update the JavaDoc for
clientPinsince the behaviour here is no longer the same as in the CTAP spec.