Package com.yubico.webauthn.data

Class AuthenticatorRegistrationExtensionOutputs

java.lang.Object

com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs

All Implemented Interfaces:

AuthenticatorExtensionOutputs, ExtensionOutputs

public final class AuthenticatorRegistrationExtensionOutputs
extends Object
implements AuthenticatorExtensionOutputs

Contains authenticator extension outputs from a navigator.credentials.create() operation.

Note that there is no guarantee that any extension input present in RegistrationExtensionInputs will have a corresponding output present here.

The values contained here are parsed from the AuthenticatorData structure.

The client extension outputs are represented by the ClientRegistrationExtensionOutputs type.

See Also:

• §9. WebAuthn Extensions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder

Method Summary

Modifier and Type	Method	Description
static AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder	builder()
boolean	equals(Object o)
static Optional<AuthenticatorRegistrationExtensionOutputs>	fromAuthenticatorData(AuthenticatorData authData)	Parse registration authenticator extension outputs from the given authenticator data.
Set<String>	getExtensionIds()	Returns a Set of recognized extension IDs for which an extension output is present.
Optional<List<Extensions.Uvm.UvmEntry>>	getUvm()
int	hashCode()
AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

fromAuthenticatorData

public static Optional<AuthenticatorRegistrationExtensionOutputs> fromAuthenticatorData(AuthenticatorData authData)

Parse registration authenticator extension outputs from the given authenticator data.

If the authData does not contain authenticator extension outputs, this returns an empty Optional.

Otherwise, this returns a present Optional containing an AuthenticatorRegistrationExtensionOutputs value with all validly-formatted registration extension outputs supported by this library. This silently ignores authentication extension outputs, malformed extension outputs, and unsupported extensions. The raw set of extension outputs can instead be obtained via AuthenticatorData.getExtensions().

Note that a present AuthenticatorRegistrationExtensionOutputs may contain zero extension outputs.

Parameters:

authData - the authenticator data to parse extension outputs from

Returns:

an empty Optional if the authData does not contain authenticator extension outputs. Otherwise a present Optional containing parsed extension output values.

getExtensionIds

public Set<String> getExtensionIds()

Description copied from interface: ExtensionOutputs

Returns a Set of recognized extension IDs for which an extension output is present.

This only includes extension identifiers recognized by the java-webauthn-server library. Recognized extensions can be found as the properties of ClientRegistrationExtensionOutputs for registration ceremonies, and ClientAssertionExtensionOutputs for authentication ceremonies. Unknown extension identifiers are silently ignored.

Specified by:

getExtensionIds in interface ExtensionOutputs

getUvm

public Optional<List<Extensions.Uvm.UvmEntry>> getUvm()

Returns:

The authenticator extension output for the User Verification Method (uvm) extension, if any.

See Also:

• §10.3. User Verification Method extension (uvm)

builder

public static AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder builder()

toBuilder

public AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder 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