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)
@NonNull 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.
int	hashCode()
AssertionExtensionInputs.AssertionExtensionInputsBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

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

builder

public static AssertionExtensionInputs.AssertionExtensionInputsBuilder builder()

toBuilder

public AssertionExtensionInputs.AssertionExtensionInputsBuilder toBuilder()

getAppid

@NonNull
public @NonNull 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.

RelyingParty.startAssertion(StartAssertionOptions) sets this extension input automatically if the RelyingParty.RelyingPartyBuilder#appId(Optional) parameter is given when constructing the RelyingParty instance.

See Also:

§10.1. FIDO AppID Extension (appid)

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