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 and Description
static class	PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder

Method Summary

Modifier and Type	Method and Description
static PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages	builder()
boolean	equals(java.lang.Object o)
@NonNull java.util.Optional<java.util.List<PublicKeyCredentialDescriptor>>	getAllowCredentials() A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).
@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.
@NonNull java.util.Optional<java.lang.String>	getRpId() Specifies the relying party identifier claimed by the caller.
@NonNull java.util.Optional<java.lang.Long>	getTimeout() Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
@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	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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.

getTimeout

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

Specifies 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.

getRpId

@NonNull
public @NonNull java.util.Optional<java.lang.String> getRpId()

Specifies the relying party identifier claimed by the caller.

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

getAllowCredentials

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

A list of PublicKeyCredentialDescriptor objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list).

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