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 and Description
static class	AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder

Method Summary

Modifier and Type	Method and 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).
java.util.Optional<ResidentKeyRequirement>	getResidentKey() Specifies the extent to which the Relying Party desires to create a client-side discoverable credential.
java.util.Optional<UserVerificationRequirement>	getUserVerification() Describes the Relying Party's requirements regarding user verification for the navigator.credentials.create() operation.
int	hashCode()
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).

getResidentKey

public java.util.Optional<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.

By default, this is not set. When not set, the default in the browser is ResidentKeyRequirement.DISCOURAGED.

When this is set, PublicKeyCredentialCreationOptions.toCredentialsCreateJson() will also emit a requireResidentKey member for backwards compatibility with WebAuthn Level 1. It will be set to true if this is set to REQUIRED and false if this is set to anything else. When this is not set, a requireResidentKey member will not be emitted.

See Also:

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

getUserVerification

public java.util.Optional<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.

By default, this is not set. When not set, the default in the browser is UserVerificationRequirement.PREFERRED.

See Also:

UserVerificationRequirement, §5.8.6. User Verification Requirement Enumeration (enum UserVerificationRequirement), User Verification

builder

public static AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder builder()

toBuilder

public AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder toBuilder()

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