Package com.yubico.webauthn

Class AssertionResult

java.lang.Object

com.yubico.webauthn.AssertionResult

public final class AssertionResult
extends java.lang.Object

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.util.Optional<AuthenticatorAssertionExtensionOutputs>	getAuthenticatorExtensionOutputs()	The authenticator extension outputs, if any.
java.util.Optional<ClientAssertionExtensionOutputs>	getClientExtensionOutputs()	The client extension outputs, if any.
@NonNull ByteArray	getCredentialId()	The credential ID of the credential used for the assertion.
long	getSignatureCount()	The new signature count of the credential used for the assertion.
@NonNull ByteArray	getUserHandle()	The user handle of the authenticated user.
@NonNull java.lang.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()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getClientExtensionOutputs

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

getCredentialId

@NonNull
public @NonNull ByteArray getCredentialId()

The credential ID of the credential used for the assertion.

See Also:

Credential ID, PublicKeyCredentialRequestOptions.getAllowCredentials()

getUserHandle

@NonNull
public @NonNull ByteArray getUserHandle()

The user handle of the authenticated user.

See Also:

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

getUsername

@NonNull
public @NonNull java.lang.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(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