Package com.yubico.webauthn.data

Enum Class Extensions.CredentialProtection.CredentialProtectionPolicy

java.lang.Object

java.lang.Enum<Extensions.CredentialProtection.CredentialProtectionPolicy>

com.yubico.webauthn.data.Extensions.CredentialProtection.CredentialProtectionPolicy

All Implemented Interfaces:

Serializable, Comparable<Extensions.CredentialProtection.CredentialProtectionPolicy>, Constable

Enclosing class:

Extensions.CredentialProtection

public static enum Extensions.CredentialProtection.CredentialProtectionPolicy
extends Enum<Extensions.CredentialProtection.CredentialProtectionPolicy>

Policy values for the Credential Protection (credProtect) extension.

Available values:

• UV_OPTIONAL
• UV_OPTIONAL_WITH_CREDENTIAL_ID_LIST
• UV_REQUIRED

Since:

2.7.0

See Also:

• CTAP2 §12.1. Credential Protection (credProtect)
• Extensions.CredentialProtection.CredentialProtectionInput.prefer(CredentialProtectionPolicy)
• Extensions.CredentialProtection.CredentialProtectionInput.require(CredentialProtectionPolicy)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
UV_OPTIONAL	In this configuration, performing some form of user verification is always OPTIONAL.
UV_OPTIONAL_WITH_CREDENTIAL_ID_LIST	In this configuration, performing some form of user verification is OPTIONAL when the credential is used as the second authentication factor, and REQUIRED when the credential is used as the first authentication factor.
UV_REQUIRED	In this configuration, performing some form of user verification is always REQUIRED.

Method Summary

Modifier and Type	Method	Description
static Extensions.CredentialProtection.CredentialProtectionPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Extensions.CredentialProtection.CredentialProtectionPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UV_OPTIONAL

public static final Extensions.CredentialProtection.CredentialProtectionPolicy UV_OPTIONAL

In this configuration, performing some form of user verification is always OPTIONAL. This is the default behaviour if the extension is not specified; note however that some browsers may set a different default extension input if the extension is not explicitly specified.

Since:

2.7.0

See Also:

• CTAP2 §12.1. Credential Protection (credProtect)
• User Verification

UV_OPTIONAL_WITH_CREDENTIAL_ID_LIST

public static final Extensions.CredentialProtection.CredentialProtectionPolicy UV_OPTIONAL_WITH_CREDENTIAL_ID_LIST

In this configuration, performing some form of user verification is OPTIONAL when the credential is used as the second authentication factor, and REQUIRED when the credential is used as the first authentication factor.

In technical terms, user verification is REQUIRED when allowCredentials is empty and OPTIONAL when it is non-empty. allowCredentials is non-empty when username or userHandle was set in the call to RelyingParty.startAssertion(StartAssertionOptions), and is empty when neither was set.

Since:

2.7.0

See Also:

• CTAP2 §12.1. Credential Protection (credProtect)
• User Verification

UV_REQUIRED

public static final Extensions.CredentialProtection.CredentialProtectionPolicy UV_REQUIRED

In this configuration, performing some form of user verification is always REQUIRED.

Since:

2.7.0

See Also:

• CTAP2 §12.1. Credential Protection (credProtect)
• User Verification

Method Details

values

public static Extensions.CredentialProtection.CredentialProtectionPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Extensions.CredentialProtection.CredentialProtectionPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null