Package com.yubico.webauthn

Class AssertionResult

java.lang.Object

com.yubico.webauthn.AssertionResult

public final class AssertionResult
extends Object

The result of a call to RelyingParty.finishAssertion(FinishAssertionOptions).

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Optional<AuthenticatorAssertionExtensionOutputs>	getAuthenticatorExtensionOutputs()	The authenticator extension outputs, if any.
Optional<ClientAssertionExtensionOutputs>	getClientExtensionOutputs()	The client extension outputs, if any.
RegisteredCredential	getCredential()	The RegisteredCredential that was returned by CredentialRepository.lookup(ByteArray, ByteArray) and whose public key was used to successfully verify the assertion signature.
ByteArray	getCredentialId()	Deprecated. Use getCredential().getCredentialId() instead.
long	getSignatureCount()	The new signature count of the credential used for the assertion.
ByteArray	getUserHandle()	Deprecated. Use getCredential().RegisteredCredential.getUserHandle() () getUserHandle()} instead.
@NonNull String	getUsername()	The username of the authenticated user.
int	hashCode()
boolean	isSignatureCounterValid()	true if and only if at least one of the following is true: The signature counter value in the assertion was strictly greater than the stored one.
boolean	isSuccess()	true if the assertion was verified successfully.
com.yubico.webauthn.AssertionResult.AssertionResultBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getCredentialId

@Deprecated
public ByteArray getCredentialId()

Deprecated.

Use getCredential().getCredentialId() instead.

The credential ID of the credential used for the assertion.

See Also:

• Credential ID
• PublicKeyCredentialRequestOptions.getAllowCredentials()

getUserHandle

@Deprecated
public ByteArray getUserHandle()

Deprecated.

Use getCredential().RegisteredCredential.getUserHandle() () getUserHandle()} instead.

The user handle of the authenticated user.

See Also:

• User Handle
• UserIdentity.getId()
• getUsername()

getClientExtensionOutputs

public Optional<ClientAssertionExtensionOutputs> 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
• ClientAssertionExtensionOutputs
• ()

getAuthenticatorExtensionOutputs

public Optional<AuthenticatorAssertionExtensionOutputs> 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
• AuthenticatorAssertionExtensionOutputs
• getClientExtensionOutputs()

toBuilder

public com.yubico.webauthn.AssertionResult.AssertionResultBuilder toBuilder()

isSuccess

public boolean isSuccess()

true if the assertion was verified successfully.

getCredential

public RegisteredCredential getCredential()

The RegisteredCredential that was returned by CredentialRepository.lookup(ByteArray, ByteArray) and whose public key was used to successfully verify the assertion signature.

NOTE: The signature count in this object will reflect the signature counter state before the assertion operation, not the new counter value. When updating your database state, use the signature counter from getSignatureCount() instead.

getUsername

@NonNull
public @NonNull String getUsername()

The username of the authenticated user.

See Also:

• getUserHandle()

getSignatureCount

public long getSignatureCount()

The new signature count of the credential used for the assertion.

You should update this value in your database.

See Also:

• AuthenticatorData.getSignatureCounter()

isSignatureCounterValid

public boolean isSignatureCounterValid()

true if and only if at least one of the following is true:

• The signature counter value in the assertion was strictly greater than the stored one.
• The signature counter value in the assertion and the stored one were both zero.

See Also:

• §6.1. Authenticator Data
• AuthenticatorData.getSignatureCounter()
• RegisteredCredential.getSignatureCount()
• RelyingParty.RelyingPartyBuilder.validateSignatureCounter(boolean)

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