Package com.webauthn4j.data.attestation.authenticator

Class AuthenticatorData<T extends ExtensionAuthenticatorOutput>

java.lang.Object

com.webauthn4j.data.attestation.authenticator.AuthenticatorData<T>

All Implemented Interfaces:

Serializable

public class AuthenticatorData<T extends ExtensionAuthenticatorOutput>
extends Object
implements Serializable

The authenticator data structure encodes contextual bindings made by the authenticator. These bindings are controlled by the authenticator itself, and derive their trust from the WebAuthn Relying Party's assessment of the security properties of the authenticator. In one extreme case, the authenticator may be embedded in the client, and its bindings may be no more trustworthy than the client data. At the other extreme, the authenticator may be a discrete entity with high-security hardware and software, connected to the client over a secure channel. In both cases, the Relying Party receives the authenticator data in the same format, and uses its knowledge of the authenticator to make trust decisions.

See Also:

• §6.1 Authenticator Data.
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	BIT_AT
static final byte	BIT_BE
static final byte	BIT_BS
static final byte	BIT_ED
static final byte	BIT_UP
static final byte	BIT_UV

Constructor Summary

Constructors

Constructor	Description
AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash, byte flags, long counter)
AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash, byte flags, long counter, @Nullable AttestedCredentialData attestedCredentialData)
AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash, byte flags, long counter, @Nullable AttestedCredentialData attestedCredentialData, @Nullable AuthenticationExtensionsAuthenticatorOutputs<T> extensions)
AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash, byte flags, long counter, @Nullable AuthenticationExtensionsAuthenticatorOutputs<T> extensions)

Method Summary

Modifier and Type	Method	Description
static boolean	checkFlagAT(byte flags)
static boolean	checkFlagBE(byte flags)
static boolean	checkFlagBS(byte flags)
static boolean	checkFlagED(byte flags)
static boolean	checkFlagUP(byte flags)
static boolean	checkFlagUV(byte flags)
boolean	equals(@Nullable Object o)
@Nullable AttestedCredentialData	getAttestedCredentialData()
@Nullable AuthenticationExtensionsAuthenticatorOutputs<T>	getExtensions()
byte	getFlags()
@org.checkerframework.checker.nullness.qual.NonNull byte[]	getRpIdHash()
long	getSignCount()
int	hashCode()
boolean	isFlagAT()
boolean	isFlagBE()
boolean	isFlagBS()
boolean	isFlagED()
boolean	isFlagUP()
boolean	isFlagUV()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

BIT_UP

public static final byte BIT_UP

See Also:

• Constant Field Values

BIT_UV

public static final byte BIT_UV

See Also:

• Constant Field Values

BIT_BE

public static final byte BIT_BE

See Also:

• Constant Field Values

BIT_BS

public static final byte BIT_BS

See Also:

• Constant Field Values

BIT_AT

public static final byte BIT_AT

See Also:

• Constant Field Values

BIT_ED

public static final byte BIT_ED

See Also:

• Constant Field Values

Constructor Details

AuthenticatorData

public AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash,
 byte flags,
 long counter,
 @Nullable AttestedCredentialData attestedCredentialData,
 @Nullable AuthenticationExtensionsAuthenticatorOutputs<T> extensions)

AuthenticatorData

public AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash,
 byte flags,
 long counter,
 @Nullable AttestedCredentialData attestedCredentialData)

AuthenticatorData

public AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash,
 byte flags,
 long counter,
 @Nullable AuthenticationExtensionsAuthenticatorOutputs<T> extensions)

AuthenticatorData

public AuthenticatorData(@org.checkerframework.checker.nullness.qual.NonNull byte[] rpIdHash,
 byte flags,
 long counter)

Method Details

checkFlagUP

public static boolean checkFlagUP(byte flags)

checkFlagUV

public static boolean checkFlagUV(byte flags)

checkFlagBE

public static boolean checkFlagBE(byte flags)

checkFlagBS

public static boolean checkFlagBS(byte flags)

checkFlagAT

public static boolean checkFlagAT(byte flags)

checkFlagED

public static boolean checkFlagED(byte flags)

getRpIdHash

public @org.checkerframework.checker.nullness.qual.NonNull byte[] getRpIdHash()

getFlags

public byte getFlags()

isFlagUP

public boolean isFlagUP()

isFlagUV

public boolean isFlagUV()

isFlagBE

public boolean isFlagBE()

isFlagBS

public boolean isFlagBS()

isFlagAT

public boolean isFlagAT()

isFlagED

public boolean isFlagED()

getSignCount

public long getSignCount()

getAttestedCredentialData

public @Nullable AttestedCredentialData getAttestedCredentialData()

getExtensions

public @Nullable AuthenticationExtensionsAuthenticatorOutputs<T> getExtensions()

equals

public boolean equals(@Nullable 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