Package com.yubico.webauthn.data

Class AuthenticatorSelectionCriteria

java.lang.Object

com.yubico.webauthn.data.AuthenticatorSelectionCriteria

public final class AuthenticatorSelectionCriteria
extends java.lang.Object

This class may be used to specify requirements regarding authenticator attributes.

See Also:

§5.4.4. Authenticator Selection Criteria (dictionary AuthenticatorSelectionCriteria)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder

Method Summary

Modifier and Type	Method	Description
static AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<AuthenticatorAttachment>	getAuthenticatorAttachment()	If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
ResidentKeyRequirement	getResidentKey()	Specifies the extent to which the Relying Party desires to create a client-side discoverable credential.
UserVerificationRequirement	getUserVerification()	Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation.
int	hashCode()
boolean	isRequireResidentKey()	Deprecated. Use getResidentKey() instead.
AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getAuthenticatorAttachment

public java.util.Optional<AuthenticatorAttachment> getAuthenticatorAttachment()

If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).

isRequireResidentKey

@Deprecated
public boolean isRequireResidentKey()

Deprecated.

Use getResidentKey() instead.

This member is retained for backwards compatibility with WebAuthn Level 1 and, for historical reasons, its naming retains the deprecated “resident” terminology for discoverable credentials.

Returns:

true if and only if getResidentKey() is ResidentKeyRequirement.REQUIRED.

See Also:

getResidentKey()

builder

public static AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder builder()

toBuilder

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder toBuilder()

getResidentKey

public ResidentKeyRequirement getResidentKey()

Specifies the extent to which the Relying Party desires to create a client-side discoverable credential. For historical reasons the naming retains the deprecated “resident” terminology.

The default is ResidentKeyRequirement.DISCOURAGED.

See Also:

ResidentKeyRequirement, §5.4.6. Resident Key Requirement Enumeration (enum ResidentKeyRequirement), Client-side discoverable Credential

getUserVerification

public UserVerificationRequirement getUserVerification()

Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation. Eligible authenticators are filtered to only those capable of satisfying this requirement.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object