Package com.yubico.webauthn.data

Class PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder

Enclosing class:

PublicKeyCredentialCreationOptions

public static class PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages

Method Summary

Modifier and Type	Method	Description
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	attestation(@NonNull AttestationConveyancePreference attestation)	Intended for use by Relying Parties that wish to express their preference for attestation conveyance.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	authenticatorSelection(@NonNull Optional<AuthenticatorSelectionCriteria> authenticatorSelection)	Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	authenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection)	Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.
PublicKeyCredentialCreationOptions	build()
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	challenge(@NonNull ByteArray challenge)	A challenge intended to be used for generating the newly created credential’s attestation object.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	excludeCredentials(Optional<Set<PublicKeyCredentialDescriptor>> excludeCredentials)	Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	excludeCredentials(Set<PublicKeyCredentialDescriptor> excludeCredentials)	Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	extensions(@NonNull RegistrationExtensionInputs extensions)	Additional parameters requesting additional processing by the client and authenticator.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	pubKeyCredParams(@NonNull List<PublicKeyCredentialParameters> pubKeyCredParams)	Information about the desired properties of the credential to be created.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	rp(@NonNull RelyingPartyIdentity rp)	Contains data about the Relying Party responsible for the request.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	timeout(long timeout)	A time, in milliseconds, that the caller is willing to wait for the call to complete.
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	timeout(@NonNull Optional<Long> timeout)	A time, in milliseconds, that the caller is willing to wait for the call to complete.
String	toString()
PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder	user(@NonNull UserIdentity user)	Contains data about the user account for which the Relying Party is requesting attestation.

Methods inherited from class java.lang.Object

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

Method Details

timeout

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder timeout(@NonNull
 @NonNull Optional<Long> timeout)

A time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client.

timeout

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder timeout(long timeout)

A time, in milliseconds, that the caller is willing to wait for the call to complete. This is treated as a hint, and MAY be overridden by the client.

excludeCredentials

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder excludeCredentials(Optional<Set<PublicKeyCredentialDescriptor>> excludeCredentials)

Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The client is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.

excludeCredentials

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder excludeCredentials(Set<PublicKeyCredentialDescriptor> excludeCredentials)

Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator. The client is requested to return an error if the new credential would be created on an authenticator that also contains one of the credentials enumerated in this parameter.

authenticatorSelection

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder authenticatorSelection(@NonNull
 @NonNull Optional<AuthenticatorSelectionCriteria> authenticatorSelection)

Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.

authenticatorSelection

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder authenticatorSelection(AuthenticatorSelectionCriteria authenticatorSelection)

Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.

rp

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder rp(@NonNull
 @NonNull RelyingPartyIdentity rp)

Contains data about the Relying Party responsible for the request.

Its value's id member specifies the RP ID the credential should be scoped to. If omitted, its value will be set by the client. See RelyingPartyIdentity for further details.

Returns:

this.

user

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder user(@NonNull
 @NonNull UserIdentity user)

Contains data about the user account for which the Relying Party is requesting attestation.

Returns:

this.

challenge

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder challenge(@NonNull
 @NonNull ByteArray challenge)

A challenge intended to be used for generating the newly created credential’s attestation object. See the §13.1 Cryptographic Challenges security consideration.

Returns:

this.

pubKeyCredParams

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder pubKeyCredParams(@NonNull
 @NonNull List<PublicKeyCredentialParameters> pubKeyCredParams)

Information about the desired properties of the credential to be created.

The sequence is ordered from most preferred to least preferred. The client makes a best-effort to create the most preferred credential that it can.

Returns:

this.

attestation

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder attestation(@NonNull
 @NonNull AttestationConveyancePreference attestation)

Intended for use by Relying Parties that wish to express their preference for attestation conveyance. The default is AttestationConveyancePreference.NONE.

Returns:

this.

extensions

public PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder extensions(@NonNull
 @NonNull RegistrationExtensionInputs extensions)

Additional parameters requesting additional processing by the client and authenticator.

For example, the caller may request that only authenticators with certain capabilities be used to create the credential, or that particular information be returned in the attestation object. Some extensions are defined in §9 WebAuthn Extensions; consult the IANA "WebAuthn Extension Identifier" registry established by [WebAuthn-Registries] for an up-to-date list of registered WebAuthn Extensions.

Returns:

this.

build

public PublicKeyCredentialCreationOptions build()

toString

public String toString()

Overrides:

toString in class Object