Package com.yubico.webauthn.data

Class PublicKeyCredentialRequestOptions

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialRequestOptions

public final class PublicKeyCredentialRequestOptions
extends java.lang.Object

The PublicKeyCredentialRequestOptions dictionary supplies get() with the data it needs to generate an assertion.

Its `challenge` member must be present, while its other members are optional.

See Also:

§5.5. Options for Assertion Generation (dictionary PublicKeyCredentialRequestOptions)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

Method Summary

Modifier and Type	Method	Description
static PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<java.util.List<PublicKeyCredentialDescriptor>>	getAllowCredentials()
@NonNull ByteArray	getChallenge()	A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion.
@NonNull AssertionExtensionInputs	getExtensions()	Additional parameters requesting additional processing by the client and authenticator.
java.lang.String	getRpId()	Specifies the relying party identifier claimed by the caller.
java.util.Optional<java.lang.Long>	getTimeout()
@NonNull UserVerificationRequirement	getUserVerification()	Describes the Relying Party's requirements regarding user verification for the navigator.credentials.get() operation.
int	hashCode()
PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder	toBuilder()
java.lang.String	toCredentialsGetJson()	Serialize this PublicKeyCredentialRequestOptions value to JSON suitable for sending to the client.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getTimeout

public java.util.Optional<java.lang.Long> getTimeout()

getAllowCredentials

public java.util.Optional<java.util.List<PublicKeyCredentialDescriptor>> getAllowCredentials()

toCredentialsGetJson

public java.lang.String toCredentialsGetJson()
                                      throws com.fasterxml.jackson.core.JsonProcessingException

Serialize this PublicKeyCredentialRequestOptions value to JSON suitable for sending to the client.

Any ByteArray values in this data structure will be Base64Url encoded. Those values MUST be decoded into BufferSource values (such as Uint8Array) on the client side before calling navigator.credentials.get() .

After decoding binary values, the resulting JavaScript object is suitable for passing as an argument to navigator.credentials.get().

Returns:

a JSON value suitable for sending to the client and passing as an argument to navigator.credentials.get(), after decoding binary options from Base64Url strings.

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if JSON serialization fails.

builder

public static PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages builder()

toBuilder

public PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder toBuilder()

getChallenge

@NonNull
public @NonNull ByteArray getChallenge()

A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion. See the §13.1 Cryptographic Challenges security consideration.

getRpId

public java.lang.String getRpId()

Specifies the relying party identifier claimed by the caller.

If omitted, its value will be set by the client.

getUserVerification

@NonNull
public @NonNull UserVerificationRequirement getUserVerification()

Describes the Relying Party's requirements regarding user verification for the navigator.credentials.get() operation.

Eligible authenticators are filtered to only those capable of satisfying this requirement.

getExtensions

@NonNull
public @NonNull AssertionExtensionInputs getExtensions()

Additional parameters requesting additional processing by the client and authenticator.

For example, if transaction confirmation is sought from the user, then the prompt string might be included as an extension.

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