Enum UserVerificationMethod
- java.lang.Object
-
- java.lang.Enum<UserVerificationMethod>
-
- com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<UserVerificationMethod>
public enum UserVerificationMethod extends java.lang.Enum<UserVerificationMethod>
The USER_VERIFY constants are flags in a bitfield represented as a 32 bit long integer. They describe the methods and capabilities of a FIDO authenticator for locally verifying a user. The operational details of these methods are opaque to the server. These constants are used in the authoritative metadata for FIDO authenticators, reported and queried through the UAF Discovery APIs, and used to form authenticator policies in UAF protocol messages. Each constant has a case-sensitive string representation (in quotes), which is used in the authoritative metadata for FIDO authenticators.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description USER_VERIFY_ALL
If an authenticator sets multiple flags for the "_INTERNAL" and/or "_EXTERNAL" user verification types, it MAY also set this flag to indicate that all verification methods with respective flags set will be enforced (e.g.USER_VERIFY_EYEPRINT_INTERNAL
This flag MUST be set if the authenticator uses any form of eye biometrics for user verification.USER_VERIFY_FACEPRINT_INTERNAL
This flag MUST be set if the authenticator uses any manner of face recognition to verify the user.USER_VERIFY_FINGERPRINT_INTERNAL
This flag MUST be set if the authenticator uses any type of measurement of a fingerprint for user verification.USER_VERIFY_HANDPRINT_INTERNAL
This flag MUST be set if the authenticator uses any measurement of a full hand (including palm-print, hand geometry or vein geometry) for user verification.USER_VERIFY_LOCATION_INTERNAL
This flag MUST be set if the authenticator uses any form of location sensor or measurement for user verification.USER_VERIFY_NONE
This flag MUST be set if the authenticator will respond without any user interaction (e.g.USER_VERIFY_PASSCODE_EXTERNAL
This flag MUST be set if the authenticator uses a local-only passcode (i.e.USER_VERIFY_PASSCODE_INTERNAL
This flag MUST be set if the authenticator uses a local-only passcode (i.e.USER_VERIFY_PATTERN_EXTERNAL
This flag MUST be set if the authenticator uses a drawn pattern for user verification that might be gathered outside the authenticator boundary.USER_VERIFY_PATTERN_INTERNAL
This flag MUST be set if the authenticator uses a drawn pattern for user verification.USER_VERIFY_PRESENCE_INTERNAL
This flag MUST be set if the authenticator is able to confirm user presence in any fashion.USER_VERIFY_VOICEPRINT_INTERNAL
This flag MUST be set if the authenticator uses a voiceprint (also known as speaker recognition) for user verification.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UserVerificationMethod
fromName(java.lang.String name)
static UserVerificationMethod
fromValue(int value)
java.lang.String
getName()
int
getValue()
static UserVerificationMethod
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static UserVerificationMethod[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
USER_VERIFY_PRESENCE_INTERNAL
public static final UserVerificationMethod USER_VERIFY_PRESENCE_INTERNAL
This flag MUST be set if the authenticator is able to confirm user presence in any fashion. If this flag and no other is set for user verification, the guarantee is only that the authenticator cannot be operated without some human intervention, not necessarily that the sensing of "presence" provides any level of user verification (e.g. a device that requires a button press to activate).NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_FINGERPRINT_INTERNAL
public static final UserVerificationMethod USER_VERIFY_FINGERPRINT_INTERNAL
This flag MUST be set if the authenticator uses any type of measurement of a fingerprint for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_PASSCODE_INTERNAL
public static final UserVerificationMethod USER_VERIFY_PASSCODE_INTERNAL
This flag MUST be set if the authenticator uses a local-only passcode (i.e. a passcode not known by the server) for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_VOICEPRINT_INTERNAL
public static final UserVerificationMethod USER_VERIFY_VOICEPRINT_INTERNAL
This flag MUST be set if the authenticator uses a voiceprint (also known as speaker recognition) for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_FACEPRINT_INTERNAL
public static final UserVerificationMethod USER_VERIFY_FACEPRINT_INTERNAL
This flag MUST be set if the authenticator uses any manner of face recognition to verify the user.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_LOCATION_INTERNAL
public static final UserVerificationMethod USER_VERIFY_LOCATION_INTERNAL
This flag MUST be set if the authenticator uses any form of location sensor or measurement for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_EYEPRINT_INTERNAL
public static final UserVerificationMethod USER_VERIFY_EYEPRINT_INTERNAL
This flag MUST be set if the authenticator uses any form of eye biometrics for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_PATTERN_INTERNAL
public static final UserVerificationMethod USER_VERIFY_PATTERN_INTERNAL
This flag MUST be set if the authenticator uses a drawn pattern for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_HANDPRINT_INTERNAL
public static final UserVerificationMethod USER_VERIFY_HANDPRINT_INTERNAL
This flag MUST be set if the authenticator uses any measurement of a full hand (including palm-print, hand geometry or vein geometry) for user verification.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_PASSCODE_EXTERNAL
public static final UserVerificationMethod USER_VERIFY_PASSCODE_EXTERNAL
This flag MUST be set if the authenticator uses a local-only passcode (i.e. a passcode not known by the server) for user verification that might be gathered outside the authenticator boundary.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_PATTERN_EXTERNAL
public static final UserVerificationMethod USER_VERIFY_PATTERN_EXTERNAL
This flag MUST be set if the authenticator uses a drawn pattern for user verification that might be gathered outside the authenticator boundary.NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_NONE
public static final UserVerificationMethod USER_VERIFY_NONE
This flag MUST be set if the authenticator will respond without any user interaction (e.g. Silent Authenticator).NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
USER_VERIFY_ALL
public static final UserVerificationMethod USER_VERIFY_ALL
If an authenticator sets multiple flags for the "_INTERNAL" and/or "_EXTERNAL" user verification types, it MAY also set this flag to indicate that all verification methods with respective flags set will be enforced (e.g. faceprint AND voiceprint). If flags for multiple user verification methods are set and this flag is not set, verification with only one is necessary (e.g. fingerprint OR passcode).NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.
-
-
Method Detail
-
values
public static UserVerificationMethod[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (UserVerificationMethod c : UserVerificationMethod.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static UserVerificationMethod valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
fromValue
public static UserVerificationMethod fromValue(int value)
- Returns:
- If
value
matches anyUserVerificationMethod
constant, returns that constant instance. Otherwise throwsIllegalArgumentException
.
-
fromName
public static UserVerificationMethod fromName(java.lang.String name)
- Returns:
- If
name
matches anyUserVerificationMethod
constant, returns that constant instance. Otherwise throwsIllegalArgumentException
.
-
getValue
public int getValue()
-
getName
public java.lang.String getName()
-
-