de.adesso.softauthn.authenticator

Class WebAuthnAuthenticatorBuilder

java.lang.Object

de.adesso.softauthn.authenticator.WebAuthnAuthenticatorBuilder

public class WebAuthnAuthenticatorBuilder
extends java.lang.Object

Builder class for WebAuthnAuthenticator.

Constructor Summary

Constructors

Constructor and Description
WebAuthnAuthenticatorBuilder()

Method Summary

Modifier and Type	Method and Description
WebAuthnAuthenticatorBuilder	aaguid(byte[] aaguid) The aaguid of the resulting authenticator.
WebAuthnAuthenticatorBuilder	attachment(com.yubico.webauthn.data.AuthenticatorAttachment attachment) Set the attachment of this authenticator.
WebAuthnAuthenticator	build() Build the WebAuthnAuthenticator object using the parameters configured in this builder.
WebAuthnAuthenticatorBuilder	credentialSelection(java.util.function.Function<? super java.util.Set<PublicKeyCredentialSource>,PublicKeyCredentialSource> credentialSelection) Set the function that will be called if multiple credentials have been found that match the requirements set by the relying party.
WebAuthnAuthenticatorBuilder	signatureCounter(SignatureCounter signatureCounter) Set the signature counter style that should be used by the authenticator.
WebAuthnAuthenticatorBuilder	supportAlgorithms(java.util.Collection<com.yubico.webauthn.data.COSEAlgorithmIdentifier> supportedAlgorithms) Set the list of supported cryptographic algorithms for this authenticator.
WebAuthnAuthenticatorBuilder	supportAlgorithms(com.yubico.webauthn.data.COSEAlgorithmIdentifier... algorithms) Set the list of supported cryptographic algorithms for this authenticator.
WebAuthnAuthenticatorBuilder	supportClientSideDiscoverablePublicKeyCredentialSources(boolean supportsClientSideDiscoverablePublicKeyCredentialSources) Set whether this authenticator should support client side discoverable credentials aka resident keys, i.e.
WebAuthnAuthenticatorBuilder	supportUserVerification(boolean supportsUserVerification) Set whether this authenticator should support user verification.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebAuthnAuthenticatorBuilder

public WebAuthnAuthenticatorBuilder()

Method Detail

aaguid

public WebAuthnAuthenticatorBuilder aaguid(byte[] aaguid)

The aaguid of the resulting authenticator.

Parameters:

aaguid - a length-16 byte array identifying the authenticator model. Default: 16 0-bytes.

Returns:

this.

attachment

public WebAuthnAuthenticatorBuilder attachment(com.yubico.webauthn.data.AuthenticatorAttachment attachment)

Set the attachment of this authenticator.

Parameters:

attachment - the attachment. Default: AuthenticatorAttachment.CROSS_PLATFORM.

Returns:

this.

supportAlgorithms

public WebAuthnAuthenticatorBuilder supportAlgorithms(com.yubico.webauthn.data.COSEAlgorithmIdentifier... algorithms)

Set the list of supported cryptographic algorithms for this authenticator. Will overwrite previous settings.

Parameters:

algorithms - The list of algorithms. Default: All supported algorithms.

Returns:

this.

supportAlgorithms

public WebAuthnAuthenticatorBuilder supportAlgorithms(java.util.Collection<com.yubico.webauthn.data.COSEAlgorithmIdentifier> supportedAlgorithms)

Set the list of supported cryptographic algorithms for this authenticator. Will overwrite previous settings.

Parameters:

supportedAlgorithms - The new collection of algorithms. Default: All supported algorithms.

Returns:

this.

supportClientSideDiscoverablePublicKeyCredentialSources

public WebAuthnAuthenticatorBuilder supportClientSideDiscoverablePublicKeyCredentialSources(boolean supportsClientSideDiscoverablePublicKeyCredentialSources)

Set whether this authenticator should support client side discoverable credentials aka resident keys, i.e. whether it can store credentials internally.

Parameters:

supportsClientSideDiscoverablePublicKeyCredentialSources - The setting. Default: true.

Returns:

this.

supportUserVerification

public WebAuthnAuthenticatorBuilder supportUserVerification(boolean supportsUserVerification)

Set whether this authenticator should support user verification.

Parameters:

supportsUserVerification - The setting. Default: true.

Returns:

this.

signatureCounter

public WebAuthnAuthenticatorBuilder signatureCounter(SignatureCounter signatureCounter)

Set the signature counter style that should be used by the authenticator.

Parameters:

signatureCounter - the signature counter object. Default: new PerCredentialSignatureCounter().

Returns:

this.

credentialSelection

public WebAuthnAuthenticatorBuilder credentialSelection(java.util.function.Function<? super java.util.Set<PublicKeyCredentialSource>,PublicKeyCredentialSource> credentialSelection)

Set the function that will be called if multiple credentials have been found that match the requirements set by the relying party.

Parameters:

credentialSelection - A function that takes a set of credential sources and emulates the selection of one by the user. Default: always select the first authenticator in the set (i.e., no defined priority)

Returns:

this.

build

public WebAuthnAuthenticator build()

Build the WebAuthnAuthenticator object using the parameters configured in this builder.

Returns:

the new authenticator object.