Package io.hanko.sdk.webauthn.protocol

Enum Class AttestationConveyancePreference

java.lang.Object

java.lang.Enum<AttestationConveyancePreference>

io.hanko.sdk.webauthn.protocol.AttestationConveyancePreference

All Implemented Interfaces:

Serializable, Comparable<AttestationConveyancePreference>, Constable

public enum AttestationConveyancePreference
extends Enum<AttestationConveyancePreference>

WebAuthn Relying Parties may use AttestationConveyancePreference to specify their preference regarding attestation conveyance during credential generation.

See Also:

Web Authentication Level 1 - 5.4.6. Attestation Conveyance Preference Enumeration

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DIRECT	This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.
INDIRECT	This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements.
NONE	This value indicates that the Relying Party is not interested in authenticator attestation.

Method Summary

Modifier and Type	Method	Description
static AttestationConveyancePreference	fromValue(String value)	Construct a AttestationConveyancePreference from a String value.
String	getConveyancePreference()	Return the conveyancePreference of the constant.
static AttestationConveyancePreference	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AttestationConveyancePreference[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final AttestationConveyancePreference NONE

This value indicates that the Relying Party is not interested in authenticator attestation. For example, in order to potentially avoid having to obtain user consent to relay identifying information to the Relying Party, or to save a roundtrip to an Attestation CA.

INDIRECT

public static final AttestationConveyancePreference INDIRECT

This value indicates that the Relying Party prefers an attestation conveyance yielding verifiable attestation statements, but allows the client to decide how to obtain such attestation statements. The client MAY replace the authenticator-generated attestation statements with attestation statements generated by an Anonymization CA, in order to protect the user's privacy, or to assist Relying Parties with attestation verification in a heterogeneous ecosystem.

DIRECT

public static final AttestationConveyancePreference DIRECT

This value indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.

Method Details

values

public static AttestationConveyancePreference[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AttestationConveyancePreference valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static AttestationConveyancePreference fromValue(String value)

Construct a AttestationConveyancePreference from a String value. Used for JSON deserialization.

Parameters:

value - the String value

Returns:

the AttestationConveyancePreference

getConveyancePreference

public String getConveyancePreference()

Return the conveyancePreference of the constant.

Returns:

the conveyancePreference value