Package com.yubico.webauthn.data

Class RegistrationExtensionInputs.RegistrationExtensionInputsBuilder

java.lang.Object

com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder

Enclosing class:

RegistrationExtensionInputs

public static class RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	appidExclude(AppId appidExclude)	Enable the FIDO AppID Exclusion Extension (appidExclude).
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	appidExclude(Optional<AppId> appidExclude)	Enable or disable the FIDO AppID Exclusion Extension (appidExclude).
RegistrationExtensionInputs	build()
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	credProps()	Enable the Credential Properties (credProps) Extension.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	credProps(Boolean credProps)	Enable or disable the Credential Properties (credProps) Extension.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	credProtect(Extensions.CredentialProtection.CredentialProtectionInput credProtect)	Enable the Credential Protection (credProtect) extension.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	credProtect(Optional<Extensions.CredentialProtection.CredentialProtectionInput> credProtect)	Enable or disable the Credential Protection (credProtect) extension.
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput largeBlob)	Enable the Large blob storage extension (largeBlob).
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport support)	Enable the Large blob storage extension (largeBlob).
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	prf(Extensions.Prf.PrfRegistrationInput prf)	Enable the Pseudo-random function extension (prf).
String	toString()
RegistrationExtensionInputs.RegistrationExtensionInputsBuilder	uvm()	Enable the User Verification Method Extension (uvm).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

appidExclude

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder appidExclude(Optional<AppId> appidExclude)

Enable or disable the FIDO AppID Exclusion Extension (appidExclude).

You usually do not need to call this method explicitly; if RelyingParty.getAppId() is present, then RelyingParty.startRegistration(StartRegistrationOptions) will enable this extension automatically.

If this is set to empty, then RelyingParty.startRegistration(StartRegistrationOptions) may overwrite it.

See Also:

• RelyingParty.startRegistration(StartRegistrationOptions)
• §10.2. FIDO AppID Exclusion Extension (appidExclude)

appidExclude

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder appidExclude(AppId appidExclude)

Enable the FIDO AppID Exclusion Extension (appidExclude).

You usually do not need to call this method explicitly; if RelyingParty.getAppId() is present, then RelyingParty.startRegistration(StartRegistrationOptions) will enable this extension automatically.

If this is set to null, then RelyingParty.startRegistration(StartRegistrationOptions) may overwrite it.

See Also:

• RelyingParty.startRegistration(StartRegistrationOptions)
• §10.2. FIDO AppID Exclusion Extension (appidExclude)

credProps

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder credProps()

Enable the Credential Properties (credProps) Extension.

See Also:

• §10.4. Credential Properties Extension (credProps)

credProps

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder credProps(Boolean credProps)

Enable or disable the Credential Properties (credProps) Extension.

A true argument enables the extension. A false argument disables the extension, and will not be overwritten by RelyingParty.startRegistration(StartRegistrationOptions). A null argument disables the extension, and will be overwritten by RelyingParty.startRegistration(StartRegistrationOptions).

See Also:

• RelyingParty.startRegistration(StartRegistrationOptions)
• §10.4. Credential Properties Extension (credProps)

credProtect

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder credProtect(Optional<Extensions.CredentialProtection.CredentialProtectionInput> credProtect)

Enable or disable the Credential Protection (credProtect) extension.

Since:

2.7.0

See Also:

• Extensions.CredentialProtection.CredentialProtectionInput.prefer(Extensions.CredentialProtection.CredentialProtectionPolicy)
• Extensions.CredentialProtection.CredentialProtectionInput.require(Extensions.CredentialProtection.CredentialProtectionPolicy)
• CTAP2 §12.1. Credential Protection (credProtect)

credProtect

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder credProtect(Extensions.CredentialProtection.CredentialProtectionInput credProtect)

Enable the Credential Protection (credProtect) extension.

Since:

2.7.0

See Also:

• Extensions.CredentialProtection.CredentialProtectionInput.prefer(Extensions.CredentialProtection.CredentialProtectionPolicy)
• Extensions.CredentialProtection.CredentialProtectionInput.require(Extensions.CredentialProtection.CredentialProtectionPolicy)
• CTAP2 §12.1. Credential Protection (credProtect)

largeBlob

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport support)

Enable the Large blob storage extension (largeBlob).

Alias of largeBlob(new Extensions.LargeBlob.LargeBlobRegistrationInput(support)) .

Parameters:

support - an Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport value to set as the support attribute of the largeBlob extension input.

See Also:

• largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput)
• §10.5. Large blob storage extension (largeBlob)

largeBlob

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput largeBlob)

Enable the Large blob storage extension (largeBlob).

See Also:

• largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport)
• §10.5. Large blob storage extension (largeBlob)

prf

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder prf(Extensions.Prf.PrfRegistrationInput prf)

Enable the Pseudo-random function extension (prf).

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

Use the Extensions.Prf.PrfRegistrationInput factory functions to construct the argument:

• Use Extensions.Prf.PrfRegistrationInput.enable() to request that the credential be capable of PRF evaluation, but without evaluating the PRF at this time.
• Use Extensions.Prf.PrfRegistrationInput.eval(Extensions.Prf.PrfValues) to request that the credential be capable of PRF evaluation and immediately evaluate it for the given inputs. Note that not all authenticators support this, in which case a follow-up authentication ceremony may be needed in order to evaluate the PRF.

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)

uvm

public RegistrationExtensionInputs.RegistrationExtensionInputsBuilder uvm()

Enable the User Verification Method Extension (uvm).

See Also:

• §10.3. User Verification Method Extension (uvm)

build

public RegistrationExtensionInputs build()

toString

public String toString()

Overrides:

toString in class Object