Package com.yubico.webauthn

Class RegistrationResult

java.lang.Object

com.yubico.webauthn.RegistrationResult

public final class RegistrationResult
extends java.lang.Object

The result of a call to RelyingParty.finishRegistration(FinishRegistrationOptions).

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
@NonNull ByteArray	getAaguid()	The aaguid reported in the of the created credential.
java.util.Optional<java.util.List<java.security.cert.X509Certificate>>	getAttestationTrustPath()
@NonNull AttestationType	getAttestationType()	The attestation type §6.4.3.
java.util.Optional<AuthenticatorRegistrationExtensionOutputs>	getAuthenticatorExtensionOutputs()	The authenticator extension outputs, if any.
java.util.Optional<ClientRegistrationExtensionOutputs>	getClientExtensionOutputs()	The client extension outputs, if any.
@NonNull PublicKeyCredentialDescriptor	getKeyId()	The credential ID and transports of the created credential.
@NonNull ByteArray	getPublicKeyCose()	The public key of the created credential.
long	getSignatureCount()	The signature count returned with the created credential.
int	hashCode()
boolean	isAttestationTrusted()	true if and only if the attestation signature was successfully linked to a trusted attestation root.
java.util.Optional<java.lang.Boolean>	isDiscoverable()	Try to determine whether the created credential is a discoverable credential, using the output from the credProps extension.
com.yubico.webauthn.RegistrationResult.RegistrationResultBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAttestationTrustPath

public java.util.Optional<java.util.List<java.security.cert.X509Certificate>> getAttestationTrustPath()

getClientExtensionOutputs

public java.util.Optional<ClientRegistrationExtensionOutputs> getClientExtensionOutputs()

The client extension outputs, if any.

This is present if and only if at least one extension output is present in the return value.

See Also:

§9.4. Client Extension Processing, ClientRegistrationExtensionOutputs, ()

getAuthenticatorExtensionOutputs

public java.util.Optional<AuthenticatorRegistrationExtensionOutputs> getAuthenticatorExtensionOutputs()

The authenticator extension outputs, if any.

This is present if and only if at least one extension output is present in the return value.

See Also:

§9.5. Authenticator Extension Processing, AuthenticatorRegistrationExtensionOutputs, getClientExtensionOutputs()

isDiscoverable

public java.util.Optional<java.lang.Boolean> isDiscoverable()

Try to determine whether the created credential is a discoverable credential, using the output from the credProps extension.

Returns:

A present true if the created credential is discoverable. A present false if the created credential is not discoverable. An empty value if it is not known whether the created credential is discoverable.

See Also:

§10.4. Credential Properties Extension (credProps), "rk" output, Discoverable Credential

toBuilder

public com.yubico.webauthn.RegistrationResult.RegistrationResultBuilder toBuilder()

getKeyId

@NonNull
public @NonNull PublicKeyCredentialDescriptor getKeyId()

The credential ID and transports of the created credential.

See Also:

Credential ID, 5.8.3. Credential Descriptor (dictionary PublicKeyCredentialDescriptor), PublicKeyCredential.getId()

getAaguid

@NonNull
public @NonNull ByteArray getAaguid()

The aaguid reported in the of the created credential.

This MAY be an AAGUID consisting of only zeroes.

isAttestationTrusted

public boolean isAttestationTrusted()

true if and only if the attestation signature was successfully linked to a trusted attestation root.

This will always be false unless the attestationTrustSource setting was configured on the RelyingParty instance.

You can ignore this if authenticator attestation is not relevant to your application.

getAttestationType

@NonNull
public @NonNull AttestationType getAttestationType()

The attestation type §6.4.3. Attestation Types that was used for the created credential.

You can ignore this if authenticator attestation is not relevant to your application.

See Also:

§6.4.3. Attestation Types

getPublicKeyCose

@NonNull
public @NonNull ByteArray getPublicKeyCose()

The public key of the created credential.

This is used in RelyingParty.finishAssertion(FinishAssertionOptions) to verify the authentication signatures.

See Also:

RegisteredCredential.getPublicKeyCose()

getSignatureCount

public long getSignatureCount()

The signature count returned with the created credential.

This is used in RelyingParty.finishAssertion(FinishAssertionOptions) to verify the validity of future signature counter values.

See Also:

()

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