Package com.yubico.webauthn.data

Class AuthenticatorAttestationResponse

java.lang.Object

com.yubico.webauthn.data.AuthenticatorAttestationResponse

All Implemented Interfaces:

AuthenticatorResponse

public final class AuthenticatorAttestationResponse
extends Object
implements AuthenticatorResponse

Represents the authenticator's response to a client's request for the creation of a new public key credential. It contains information about the new credential that can be used to identify it for later use, and metadata that can be used by the WebAuthn Relying Party to assess the characteristics of the credential during registration.

See Also:

• §5.2.1. Information About Public Key Credential (interface AuthenticatorAttestationResponse)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder

Method Summary

Modifier and Type	Method	Description
static AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages	builder()
boolean	equals(Object o)
@NonNull AttestationObject	getAttestation()	The attestationObject parsed as a domain object.
@NonNull ByteArray	getAttestationObject()	Contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the client.
ByteArray	getAuthenticatorData()	The authenticator data returned by the authenticator.
@NonNull CollectedClientData	getClientData()	AuthenticatorResponse.getClientDataJSON() parsed as a domain object.
@NonNull ByteArray	getClientDataJSON()	The JSON-serialized client data (see §5.10.1 Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)) passed to the authenticator by the client in the call to either navigator.credentials.create() or navigator.credentials.get().
SortedSet<AuthenticatorTransport>	getTransports()	The return value from the AuthenticatorAttestationResponse.getTransports() method.
int	hashCode()
AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yubico.webauthn.data.AuthenticatorResponse

getParsedAuthenticatorData

Method Details

getAuthenticatorData

public ByteArray getAuthenticatorData()

Description copied from interface: AuthenticatorResponse

The authenticator data returned by the authenticator. See §6.1 Authenticator Data.

Specified by:

getAuthenticatorData in interface AuthenticatorResponse

builder

public static AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages builder()

toBuilder

public AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder toBuilder()

getAttestationObject

@NonNull
public @NonNull ByteArray getAttestationObject()

Contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the client. The attestation object contains both authenticator data and an attestation statement. The former contains the AAGUID, a unique credential ID, and the credential public key. The contents of the attestation statement are determined by the attestation statement format used by the authenticator. It also contains any additional information that the Relying Party's server requires to validate the attestation statement, as well as to decode and validate the authenticator data along with the JSON-serialized client data. For more details, see §6.4 Attestation, §6.4.4 Generating an Attestation Object, and Figure 5.

getTransports

public SortedSet<AuthenticatorTransport> getTransports()

The return value from the AuthenticatorAttestationResponse.getTransports() method.

See Also:

• §5.2.1. Information About Public Key Credential (interface AuthenticatorAttestationResponse)

getAttestation

@NonNull
public @NonNull AttestationObject getAttestation()

The attestationObject parsed as a domain object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getClientDataJSON

@NonNull
public @NonNull ByteArray getClientDataJSON()

Description copied from interface: AuthenticatorResponse

The JSON-serialized client data (see §5.10.1 Client Data Used in WebAuthn Signatures (dictionary CollectedClientData)) passed to the authenticator by the client in the call to either navigator.credentials.create() or navigator.credentials.get(). The exact JSON serialization MUST be preserved, as the hash of the serialized client data has been computed over it.

Specified by:

getClientDataJSON in interface AuthenticatorResponse

getClientData

@NonNull
public @NonNull CollectedClientData getClientData()

Description copied from interface: AuthenticatorResponse

AuthenticatorResponse.getClientDataJSON() parsed as a domain object.

Specified by:

getClientData in interface AuthenticatorResponse