Package com.yubico.webauthn.data

Class RegistrationExtensionInputs

java.lang.Object

com.yubico.webauthn.data.RegistrationExtensionInputs

All Implemented Interfaces:

ExtensionInputs

public final class RegistrationExtensionInputs
extends 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	Description
static class	RegistrationExtensionInputs.RegistrationExtensionInputsBuilder

Method Summary

Modifier and Type	Method	Description
static RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	builder()
boolean	equals(Object o)
Optional<AppId>	getAppidExclude()
boolean	getCredProps()
Optional<Extensions.CredentialProtection.CredentialProtectionInput>	getCredProtect()
Set<String>	getExtensionIds()	Returns a Set of the extension IDs for which an extension input is present.
Optional<Extensions.LargeBlob.LargeBlobRegistrationInput>	getLargeBlob()
Optional<Extensions.Prf.PrfRegistrationInput>	getPrf()	The input to the Pseudo-random function extension (prf), if any.
boolean	getUvm()
int	hashCode()
RegistrationExtensionInputs	merge(RegistrationExtensionInputs other)	Merge other into this.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

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 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)

getCredProtect

public Optional<Extensions.CredentialProtection.CredentialProtectionInput> getCredProtect()

Returns:

The Credential Protection (credProtect) extension input, if set.

Since:

2.7.0

See Also:

• RegistrationExtensionInputs.RegistrationExtensionInputsBuilder.credProtect(Extensions.CredentialProtection.CredentialProtectionInput)
• §10.4. Credential Properties Extension (credProps)

getLargeBlob

public 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)

getPrf

public Optional<Extensions.Prf.PrfRegistrationInput> getPrf()

The input to the Pseudo-random function extension (prf), if any.

This extension allows a Relying Party to evaluate outputs from a pseudo-random function (PRF) associated with a credential.

Since:

2.7.0

See Also:

• Extensions.Prf.PrfRegistrationInput.enable()
• Extensions.Prf.PrfRegistrationInput.eval(Extensions.Prf.PrfValues)
• §10.1.4. Pseudo-random function extension (prf)

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 Set<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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object