Package com.yubico.webauthn

Class RegisteredCredential.RegisteredCredentialBuilder

java.lang.Object

com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder

Enclosing class:

RegisteredCredential

public static class RegisteredCredential.RegisteredCredentialBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages

Method Summary

Modifier and Type	Method	Description
RegisteredCredential	build()
RegisteredCredential.RegisteredCredentialBuilder	credentialId(@NonNull ByteArray credentialId)	The credential ID of the credential.
RegisteredCredential.RegisteredCredentialBuilder	publicKeyCose(@NonNull ByteArray publicKeyCose)	The credential public key encoded in COSE_Key format, as defined in Section 7 of RFC 8152.
RegisteredCredential.RegisteredCredentialBuilder	signatureCount(long signatureCount)	The stored signature count of the credential.
java.lang.String	toString()
RegisteredCredential.RegisteredCredentialBuilder	userHandle(@NonNull ByteArray userHandle)	The user handle of the user the credential is registered to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

credentialId

public RegisteredCredential.RegisteredCredentialBuilder credentialId(@NonNull
                                                                     @NonNull ByteArray credentialId)

The credential ID of the credential.

Returns:

this.

See Also:

Credential ID, RegistrationResult.getKeyId(), PublicKeyCredentialDescriptor.getId()

userHandle

public RegisteredCredential.RegisteredCredentialBuilder userHandle(@NonNull
                                                                   @NonNull ByteArray userHandle)

The user handle of the user the credential is registered to.

Returns:

this.

See Also:

User Handle, UserIdentity.getId()

publicKeyCose

public RegisteredCredential.RegisteredCredentialBuilder publicKeyCose(@NonNull
                                                                      @NonNull ByteArray publicKeyCose)

The credential public key encoded in COSE_Key format, as defined in Section 7 of RFC 8152.

This is used to verify the signature in authentication assertions.

Returns:

this.

See Also:

AttestedCredentialData.getCredentialPublicKey(), RegistrationResult.getPublicKeyCose()

signatureCount

public RegisteredCredential.RegisteredCredentialBuilder signatureCount(long signatureCount)

The stored signature count of the credential.

This is used to validate the signature counter in authentication assertions.

Returns:

this.

See Also:

§6.1. Authenticator Data, AuthenticatorData.getSignatureCounter(), AssertionResult.getSignatureCount()

build

public RegisteredCredential build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object