com.yubico.webauthn.data

Class RegistrationExtensionInputs

java.lang.Object

com.yubico.webauthn.data.RegistrationExtensionInputs

All Implemented Interfaces:

ExtensionInputs

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

Contains client extension inputs to a navigator.credentials.create() 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	RegistrationExtensionInputs.RegistrationExtensionInputsBuilder

Method Summary

Modifier and Type	Method and Description
static RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<AppId>	getAppidExclude()
boolean	getCredProps()
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.LargeBlobRegistrationInput>	getLargeBlob()
boolean	getUvm()
int	hashCode()
RegistrationExtensionInputs	merge(RegistrationExtensionInputs other) Merge other into this.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

merge

public RegistrationExtensionInputs merge(RegistrationExtensionInputs other)

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

Returns:

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

getAppidExclude

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

Returns:

The value of the FIDO AppID Exclusion Extension (appidExclude) input if configured, empty otherwise.

See Also:

RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.appidExclude(AppId), §10.2. FIDO AppID Exclusion Extension (appidExclude)

getCredProps

public boolean getCredProps()

Returns:

true if the Credential Properties Extension (credProps) is enabled, false otherwise.

See Also:

RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.credProps(), §10.4. Credential Properties Extension (credProps)

getLargeBlob

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

Returns:

The value of the Large blob storage extension (largeBlob) input if configured, empty otherwise.

See Also:

RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput), RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport), §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:

RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.uvm(), §10.3. User Verification Method Extension (uvm)

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

builder

public static RegistrationExtensionInputs.RegistrationExtensionInputsBuilder builder()

toBuilder

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder 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