com.yubico.webauthn.data

Class AssertionExtensionInputs

java.lang.Object

com.yubico.webauthn.data.AssertionExtensionInputs

All Implemented Interfaces:

ExtensionInputs

public final class AssertionExtensionInputs
extends java.lang.Object
implements ExtensionInputs

Contains client extension inputs to a navigator.credentials.get() operation. All members are optional.

The authenticator extension inputs are derived from these client extension inputs.

See Also:

§9. WebAuthn Extensions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssertionExtensionInputs.AssertionExtensionInputsBuilder

Method Summary

Modifier and Type	Method and Description
static AssertionExtensionInputs.AssertionExtensionInputsBuilder	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<AppId>	getAppid() The input to the FIDO AppID Extension (appid).
java.util.Set<java.lang.String>	getExtensionIds() Returns a Set of the extension IDs for which an extension input is present.
java.util.Optional<Extensions.LargeBlob.LargeBlobAuthenticationInput>	getLargeBlob() The input to the Large blob storage extension (largeBlob).
boolean	getUvm()
int	hashCode()
AssertionExtensionInputs	merge(AssertionExtensionInputs other) Merge other into this.
AssertionExtensionInputs.AssertionExtensionInputsBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

merge

public AssertionExtensionInputs merge(AssertionExtensionInputs other)

Merge other into this. Non-null field values from this take precedence.

Returns:

a new AssertionExtensionInputs instance with the settings from both this and other.

getExtensionIds

public java.util.Set<java.lang.String> getExtensionIds()

Description copied from interface: ExtensionInputs

Returns a Set of the extension IDs for which an extension input is present.

Specified by:

getExtensionIds in interface ExtensionInputs

Returns:

The extension identifiers of all extensions configured.

See Also:

§9.1. Extension Identifiers

getAppid

public java.util.Optional<AppId> getAppid()

The input to the FIDO AppID Extension (appid).

This extension allows WebAuthn Relying Parties that have previously registered a credential using the legacy FIDO JavaScript APIs to request an assertion. The FIDO APIs use an alternative identifier for Relying Parties called an AppID, and any credentials created using those APIs will be scoped to that identifier. Without this extension, they would need to be re-registered in order to be scoped to an RP ID.

This extension does not allow FIDO-compatible credentials to be created. Thus, credentials created with WebAuthn are not backwards compatible with the FIDO JavaScript APIs.

See Also:

§10.1. FIDO AppID Extension (appid)

getLargeBlob

public java.util.Optional<Extensions.LargeBlob.LargeBlobAuthenticationInput> getLargeBlob()

The input to the Large blob storage extension (largeBlob).

This extension allows a Relying Party to store opaque data associated with a credential.

See Also:

Extensions.LargeBlob.LargeBlobAuthenticationInput.read(), Extensions.LargeBlob.LargeBlobAuthenticationInput.write(ByteArray), §10.5. Large blob storage extension (largeBlob)

getUvm

public boolean getUvm()

Returns:

true if the User Verification Method Extension (uvm) is enabled, false otherwise.

See Also:

AssertionExtensionInputs.AssertionExtensionInputsBuilder.uvm(), §10.3. User Verification Method Extension (uvm)

builder

public static AssertionExtensionInputs.AssertionExtensionInputsBuilder builder()

toBuilder

public AssertionExtensionInputs.AssertionExtensionInputsBuilder toBuilder()

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