Package com.yubico.webauthn.data

Class AssertionExtensionInputs.AssertionExtensionInputsBuilder

java.lang.Object

com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder

Enclosing class:

AssertionExtensionInputs

public static class AssertionExtensionInputs.AssertionExtensionInputsBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AssertionExtensionInputs.AssertionExtensionInputsBuilder	appid(@NonNull Optional<AppId> appid)	The input to the FIDO AppID Extension (appid).
AssertionExtensionInputs.AssertionExtensionInputsBuilder	appid(AppId appid)	The input to the FIDO AppID Extension (appid).
AssertionExtensionInputs	build()
AssertionExtensionInputs.AssertionExtensionInputsBuilder	largeBlob(Extensions.LargeBlob.LargeBlobAuthenticationInput largeBlob)	Enable the Large blob storage extension (largeBlob).
AssertionExtensionInputs.AssertionExtensionInputsBuilder	prf(Extensions.Prf.PrfAuthenticationInput prf)	Enable the Pseudo-random function extension (prf).
String	toString()
AssertionExtensionInputs.AssertionExtensionInputsBuilder	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

appid

public AssertionExtensionInputs.AssertionExtensionInputsBuilder appid(@NonNull
 @NonNull Optional<AppId> appid)

The input to the FIDO AppID Extension (appid).

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

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)

appid

public AssertionExtensionInputs.AssertionExtensionInputsBuilder appid(AppId appid)

The input to the FIDO AppID Extension (appid).

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

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)

largeBlob

public AssertionExtensionInputs.AssertionExtensionInputsBuilder largeBlob(Extensions.LargeBlob.LargeBlobAuthenticationInput largeBlob)

Enable the Large blob storage extension (largeBlob).

Suitable arguments can be obtained using Extensions.LargeBlob.LargeBlobAuthenticationInput.read() or Extensions.LargeBlob.LargeBlobAuthenticationInput.write(ByteArray).

See Also:

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

prf

public AssertionExtensionInputs.AssertionExtensionInputsBuilder prf(Extensions.Prf.PrfAuthenticationInput 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.PrfAuthenticationInput factory functions to construct the argument:

• Use Extensions.Prf.PrfAuthenticationInput.eval(Extensions.Prf.PrfValues) to use the same PRF input for all credentials.
• Use Extensions.Prf.PrfAuthenticationInput.evalByCredential(Map) to use different PRF inputs for different credentials.
• Use Extensions.Prf.PrfAuthenticationInput.evalByCredentialWithFallback(Map, Extensions.Prf.PrfValues) to use different PRF inputs for different credentials, but with a "fallback" input for credentials without their own input.

Since:

2.7.0

See Also:

• Extensions.Prf.PrfAuthenticationInput.eval(Extensions.Prf.PrfValues)
• Extensions.Prf.PrfAuthenticationInput.evalByCredential(Map)
• Extensions.Prf.PrfAuthenticationInput.evalByCredentialWithFallback(Map, Extensions.Prf.PrfValues)
• §10.1.4. Pseudo-random function extension (prf)

uvm

public AssertionExtensionInputs.AssertionExtensionInputsBuilder uvm()

Enable the User Verification Method Extension (uvm).

See Also:

• §10.3. User Verification Method Extension (uvm)

build

public AssertionExtensionInputs build()

toString

public String toString()

Overrides:

toString in class Object