Package com.yubico.webauthn.extension.uvm

Enum MatcherProtectionType

java.lang.Object

java.lang.Enum<MatcherProtectionType>

com.yubico.webauthn.extension.uvm.MatcherProtectionType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MatcherProtectionType>

public enum MatcherProtectionType
extends java.lang.Enum<MatcherProtectionType>

The MATCHER_PROTECTION constants are flags in a bit field represented as a 16 bit long integer. They describe the method an authenticator uses to protect the matcher that performs user verification. These constants are reported and queried through the UAF Discovery APIs and used to form authenticator policies in UAF protocol messages. Refer to [UAFAuthnrCommands] for more details on the matcher component. Each constant has a case-sensitive string representation (in quotes), which is used in the authoritative metadata for FIDO authenticators.

See Also:

fromValue(int), fromName(String), FIDO Registry of Predefined Values §3.3 Matcher Protection Types

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATCHER_PROTECTION_ON_CHIP	This flag SHOULD be set if the authenticator's matcher is running on the chip.
MATCHER_PROTECTION_SOFTWARE	This flag MUST be set if the authenticator's matcher is running in software.
MATCHER_PROTECTION_TEE	This flag SHOULD be set if the authenticator's matcher is running inside the Trusted Execution Environment [TEE].

Method Summary

Modifier and Type	Method	Description
static MatcherProtectionType	fromName(java.lang.String name)
static MatcherProtectionType	fromValue(int value)
java.lang.String	getName()
short	getValue()
static MatcherProtectionType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MatcherProtectionType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MATCHER_PROTECTION_SOFTWARE

public static final MatcherProtectionType MATCHER_PROTECTION_SOFTWARE

This flag MUST be set if the authenticator's matcher is running in software. Exclusive in authenticator metadata with MATCHER_PROTECTION_TEE, MATCHER_PROTECTION_ON_CHIP.

NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.

See Also:

FIDO Registry of Predefined Values §3.3 Matcher Protection Types

MATCHER_PROTECTION_TEE

public static final MatcherProtectionType MATCHER_PROTECTION_TEE

This flag SHOULD be set if the authenticator's matcher is running inside the Trusted Execution Environment [TEE]. Mutually exclusive in authenticator metadata with MATCHER_PROTECTION_SOFTWARE, MATCHER_PROTECTION_ON_CHIP.

NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.

See Also:

FIDO Registry of Predefined Values §3.3 Matcher Protection Types

MATCHER_PROTECTION_ON_CHIP

public static final MatcherProtectionType MATCHER_PROTECTION_ON_CHIP

This flag SHOULD be set if the authenticator's matcher is running on the chip. Mutually exclusive in authenticator metadata with MATCHER_PROTECTION_TEE, MATCHER_PROTECTION_SOFTWARE

NOTE: The above requirements apply to authenticators; this library DOES NOT enforce them.

See Also:

FIDO Registry of Predefined Values §3.3 Matcher Protection Types

Method Detail

values

public static MatcherProtectionType[] 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 (MatcherProtectionType c : MatcherProtectionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MatcherProtectionType 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 name

java.lang.NullPointerException - if the argument is null

fromValue

public static MatcherProtectionType fromValue(int value)

Returns:

If value matches any MatcherProtectionType constant, returns that constant instance. Otherwise throws IllegalArgumentException.

fromName

public static MatcherProtectionType fromName(java.lang.String name)

Returns:

If name matches any MatcherProtectionType constant, returns that constant instance. Otherwise throws IllegalArgumentException.

getValue

public short getValue()

getName

public java.lang.String getName()