Package com.yubico.fido.metadata

Class MetadataStatement

java.lang.Object

com.yubico.fido.metadata.MetadataStatement

public final class MetadataStatement
extends Object

Relying Parties can learn a subset of verifiable information for authenticators certified by the FIDO Alliance with an Authenticator Metadata statement. The Metadata statement can be acquired from the Metadata BLOB that is hosted on the Metadata Service [FIDOMetadataService].

This class does not include the field ecdaaTrustAnchors since ECDAA is deprecated in WebAuthn Level 2.

See Also:

• FIDO Metadata Statement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetadataStatement.MetadataStatementBuilder

Constructor Summary

Constructors

Constructor

Description

MetadataStatement(String legalHeader, AAID aaid, AAGUID aaguid, Set<String> attestationCertificateKeyIdentifiers, String description, AlternativeDescriptions alternativeDescriptions, long authenticatorVersion, @NonNull ProtocolFamily protocolFamily, int schema, @NonNull Set<Version> upv, @NonNull Set<AuthenticationAlgorithm> authenticationAlgorithms, @NonNull Set<PublicKeyRepresentationFormat> publicKeyAlgAndEncodings, @NonNull Set<AuthenticatorAttestationType> attestationTypes, @NonNull Set<Set<VerificationMethodDescriptor>> userVerificationDetails, @NonNull Set<KeyProtectionType> keyProtection, Boolean isKeyRestricted, Boolean isFreshUserVerificationRequired, @NonNull Set<MatcherProtectionType> matcherProtection, Integer cryptoStrength, Set<AttachmentHint> attachmentHint, @NonNull Set<TransactionConfirmationDisplayType> tcDisplay, String tcDisplayContentType, List<DisplayPNGCharacteristicsDescriptor> tcDisplayPNGCharacteristics, @NonNull Set<X509Certificate> attestationRootCertificates, String icon, Set<ExtensionDescriptor> supportedExtensions, AuthenticatorGetInfo authenticatorGetInfo)

Method Summary

Modifier and Type	Method	Description
static MetadataStatement.MetadataStatementBuilder	builder()
boolean	equals(Object o)
Optional<AAGUID>	getAaguid()
Optional<AAID>	getAaid()
Optional<AlternativeDescriptions>	getAlternativeDescriptions()
Optional<Set<AttachmentHint>>	getAttachmentHint()
Set<String>	getAttestationCertificateKeyIdentifiers()
@NonNull Set<X509Certificate>	getAttestationRootCertificates()
@NonNull Set<AuthenticatorAttestationType>	getAttestationTypes()
@NonNull Set<AuthenticationAlgorithm>	getAuthenticationAlgorithms()
Optional<AuthenticatorGetInfo>	getAuthenticatorGetInfo()
long	getAuthenticatorVersion()
Optional<Integer>	getCryptoStrength()
Optional<String>	getDescription()
Optional<String>	getIcon()
Optional<Boolean>	getIsFreshUserVerificationRequired()
Optional<Boolean>	getIsKeyRestricted()
@NonNull Set<KeyProtectionType>	getKeyProtection()
Optional<String>	getLegalHeader()
@NonNull Set<MatcherProtectionType>	getMatcherProtection()
@NonNull ProtocolFamily	getProtocolFamily()
@NonNull Set<PublicKeyRepresentationFormat>	getPublicKeyAlgAndEncodings()
int	getSchema()
Optional<Set<ExtensionDescriptor>>	getSupportedExtensions()
@NonNull Set<TransactionConfirmationDisplayType>	getTcDisplay()
Optional<String>	getTcDisplayContentType()
Optional<List<DisplayPNGCharacteristicsDescriptor>>	getTcDisplayPNGCharacteristics()
@NonNull Set<Version>	getUpv()
@NonNull Set<Set<VerificationMethodDescriptor>>	getUserVerificationDetails()
int	hashCode()
MetadataStatement.MetadataStatementBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataStatement

public MetadataStatement(String legalHeader,
 AAID aaid,
 AAGUID aaguid,
 Set<String> attestationCertificateKeyIdentifiers,
 String description,
 AlternativeDescriptions alternativeDescriptions,
 long authenticatorVersion,
 @NonNull
 @NonNull ProtocolFamily protocolFamily,
 int schema,
 @NonNull
 @NonNull Set<Version> upv,
 @NonNull
 @NonNull Set<AuthenticationAlgorithm> authenticationAlgorithms,
 @NonNull
 @NonNull Set<PublicKeyRepresentationFormat> publicKeyAlgAndEncodings,
 @NonNull
 @NonNull Set<AuthenticatorAttestationType> attestationTypes,
 @NonNull
 @NonNull Set<Set<VerificationMethodDescriptor>> userVerificationDetails,
 @NonNull
 @NonNull Set<KeyProtectionType> keyProtection,
 Boolean isKeyRestricted,
 Boolean isFreshUserVerificationRequired,
 @NonNull
 @NonNull Set<MatcherProtectionType> matcherProtection,
 Integer cryptoStrength,
 Set<AttachmentHint> attachmentHint,
 @NonNull
 @NonNull Set<TransactionConfirmationDisplayType> tcDisplay,
 String tcDisplayContentType,
 List<DisplayPNGCharacteristicsDescriptor> tcDisplayPNGCharacteristics,
 @NonNull
 @NonNull Set<X509Certificate> attestationRootCertificates,
 String icon,
 Set<ExtensionDescriptor> supportedExtensions,
 AuthenticatorGetInfo authenticatorGetInfo)

Method Details

getLegalHeader

public Optional<String> getLegalHeader()

See Also:

• FIDO Metadata Statement

getAaid

public Optional<AAID> getAaid()

See Also:

• FIDO Metadata Statement

getAaguid

public Optional<AAGUID> getAaguid()

See Also:

• FIDO Metadata Statement

getDescription

public Optional<String> getDescription()

See Also:

• FIDO Metadata Statement

getAlternativeDescriptions

public Optional<AlternativeDescriptions> getAlternativeDescriptions()

See Also:

• FIDO Metadata Statement

getIsKeyRestricted

public Optional<Boolean> getIsKeyRestricted()

See Also:

• FIDO Metadata Statement

getIsFreshUserVerificationRequired

public Optional<Boolean> getIsFreshUserVerificationRequired()

See Also:

• FIDO Metadata Statement

getCryptoStrength

public Optional<Integer> getCryptoStrength()

See Also:

• FIDO Metadata Statement

getAttachmentHint

public Optional<Set<AttachmentHint>> getAttachmentHint()

See Also:

• FIDO Metadata Statement

getTcDisplayContentType

public Optional<String> getTcDisplayContentType()

See Also:

• FIDO Metadata Statement

getTcDisplayPNGCharacteristics

public Optional<List<DisplayPNGCharacteristicsDescriptor>> getTcDisplayPNGCharacteristics()

See Also:

• FIDO Metadata Statement

getIcon

public Optional<String> getIcon()

See Also:

• FIDO Metadata Statement

getSupportedExtensions

public Optional<Set<ExtensionDescriptor>> getSupportedExtensions()

See Also:

• FIDO Metadata Statement

getAuthenticatorGetInfo

public Optional<AuthenticatorGetInfo> getAuthenticatorGetInfo()

See Also:

• FIDO Metadata Statement

builder

public static MetadataStatement.MetadataStatementBuilder builder()

toBuilder

public MetadataStatement.MetadataStatementBuilder toBuilder()

getAttestationCertificateKeyIdentifiers

public Set<String> getAttestationCertificateKeyIdentifiers()

See Also:

• FIDO Metadata Statement

getAuthenticatorVersion

public long getAuthenticatorVersion()

See Also:

• FIDO Metadata Statement

getProtocolFamily

@NonNull
public @NonNull ProtocolFamily getProtocolFamily()

See Also:

• FIDO Metadata Statement

getSchema

public int getSchema()

See Also:

• FIDO Metadata Statement

getUpv

@NonNull
public @NonNull Set<Version> getUpv()

See Also:

• FIDO Metadata Statement

getAuthenticationAlgorithms

@NonNull
public @NonNull Set<AuthenticationAlgorithm> getAuthenticationAlgorithms()

See Also:

• FIDO Metadata Statement

getPublicKeyAlgAndEncodings

@NonNull
public @NonNull Set<PublicKeyRepresentationFormat> getPublicKeyAlgAndEncodings()

See Also:

• FIDO Metadata Statement

getAttestationTypes

@NonNull
public @NonNull Set<AuthenticatorAttestationType> getAttestationTypes()

See Also:

• FIDO Metadata Statement

getUserVerificationDetails

@NonNull
public @NonNull Set<Set<VerificationMethodDescriptor>> getUserVerificationDetails()

See Also:

• FIDO Metadata Statement

getKeyProtection

@NonNull
public @NonNull Set<KeyProtectionType> getKeyProtection()

See Also:

• FIDO Metadata Statement

getMatcherProtection

@NonNull
public @NonNull Set<MatcherProtectionType> getMatcherProtection()

See Also:

• FIDO Metadata Statement

getTcDisplay

@NonNull
public @NonNull Set<TransactionConfirmationDisplayType> getTcDisplay()

See Also:

• FIDO Metadata Statement

getAttestationRootCertificates

@NonNull
public @NonNull Set<X509Certificate> getAttestationRootCertificates()

See Also:

• FIDO Metadata Statement

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