Package com.yubico.fido.metadata

Class MetadataStatement

java.lang.Object

com.yubico.fido.metadata.MetadataStatement

public final class MetadataStatement
extends java.lang.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(java.lang.String legalHeader, AAID aaid, AAGUID aaguid, java.util.Set<java.lang.String> attestationCertificateKeyIdentifiers, java.lang.String description, AlternativeDescriptions alternativeDescriptions, long authenticatorVersion, @NonNull ProtocolFamily protocolFamily, int schema, @NonNull java.util.Set<Version> upv, @NonNull java.util.Set<AuthenticationAlgorithm> authenticationAlgorithms, @NonNull java.util.Set<PublicKeyRepresentationFormat> publicKeyAlgAndEncodings, @NonNull java.util.Set<AuthenticatorAttestationType> attestationTypes, @NonNull java.util.Set<java.util.Set<VerificationMethodDescriptor>> userVerificationDetails, @NonNull java.util.Set<com.yubico.webauthn.extension.uvm.KeyProtectionType> keyProtection, java.lang.Boolean isKeyRestricted, java.lang.Boolean isFreshUserVerificationRequired, @NonNull java.util.Set<com.yubico.webauthn.extension.uvm.MatcherProtectionType> matcherProtection, java.lang.Integer cryptoStrength, java.util.Set<AttachmentHint> attachmentHint, @NonNull java.util.Set<TransactionConfirmationDisplayType> tcDisplay, java.lang.String tcDisplayContentType, java.util.List<DisplayPNGCharacteristicsDescriptor> tcDisplayPNGCharacteristics, @NonNull java.util.Set<java.security.cert.X509Certificate> attestationRootCertificates, java.lang.String icon, java.util.Set<ExtensionDescriptor> supportedExtensions, AuthenticatorGetInfo authenticatorGetInfo)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataStatement

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

Method Detail

getLegalHeader

public java.util.Optional<java.lang.String> getLegalHeader()

See Also:

FIDO Metadata Statement

getAaid

public java.util.Optional<AAID> getAaid()

See Also:

FIDO Metadata Statement

getAaguid

public java.util.Optional<AAGUID> getAaguid()

See Also:

FIDO Metadata Statement

getDescription

public java.util.Optional<java.lang.String> getDescription()

See Also:

FIDO Metadata Statement

getAlternativeDescriptions

public java.util.Optional<AlternativeDescriptions> getAlternativeDescriptions()

See Also:

FIDO Metadata Statement

getIsKeyRestricted

public java.util.Optional<java.lang.Boolean> getIsKeyRestricted()

See Also:

FIDO Metadata Statement

getIsFreshUserVerificationRequired

public java.util.Optional<java.lang.Boolean> getIsFreshUserVerificationRequired()

See Also:

FIDO Metadata Statement

getCryptoStrength

public java.util.Optional<java.lang.Integer> getCryptoStrength()

See Also:

FIDO Metadata Statement

getAttachmentHint

public java.util.Optional<java.util.Set<AttachmentHint>> getAttachmentHint()

See Also:

FIDO Metadata Statement

getTcDisplayContentType

public java.util.Optional<java.lang.String> getTcDisplayContentType()

See Also:

FIDO Metadata Statement

getTcDisplayPNGCharacteristics

public java.util.Optional<java.util.List<DisplayPNGCharacteristicsDescriptor>> getTcDisplayPNGCharacteristics()

See Also:

FIDO Metadata Statement

getIcon

public java.util.Optional<java.lang.String> getIcon()

See Also:

FIDO Metadata Statement

getSupportedExtensions

public java.util.Optional<java.util.Set<ExtensionDescriptor>> getSupportedExtensions()

See Also:

FIDO Metadata Statement

getAuthenticatorGetInfo

public java.util.Optional<AuthenticatorGetInfo> getAuthenticatorGetInfo()

See Also:

FIDO Metadata Statement

builder

public static MetadataStatement.MetadataStatementBuilder builder()

toBuilder

public MetadataStatement.MetadataStatementBuilder toBuilder()

getAttestationCertificateKeyIdentifiers

public java.util.Set<java.lang.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 java.util.Set<Version> getUpv()

See Also:

FIDO Metadata Statement

getAuthenticationAlgorithms

@NonNull
public @NonNull java.util.Set<AuthenticationAlgorithm> getAuthenticationAlgorithms()

See Also:

FIDO Metadata Statement

getPublicKeyAlgAndEncodings

@NonNull
public @NonNull java.util.Set<PublicKeyRepresentationFormat> getPublicKeyAlgAndEncodings()

See Also:

FIDO Metadata Statement

getAttestationTypes

@NonNull
public @NonNull java.util.Set<AuthenticatorAttestationType> getAttestationTypes()

See Also:

FIDO Metadata Statement

getUserVerificationDetails

@NonNull
public @NonNull java.util.Set<java.util.Set<VerificationMethodDescriptor>> getUserVerificationDetails()

See Also:

FIDO Metadata Statement

getKeyProtection

@NonNull
public @NonNull java.util.Set<com.yubico.webauthn.extension.uvm.KeyProtectionType> getKeyProtection()

See Also:

FIDO Metadata Statement

getMatcherProtection

@NonNull
public @NonNull java.util.Set<com.yubico.webauthn.extension.uvm.MatcherProtectionType> getMatcherProtection()

See Also:

FIDO Metadata Statement

getTcDisplay

@NonNull
public @NonNull java.util.Set<TransactionConfirmationDisplayType> getTcDisplay()

See Also:

FIDO Metadata Statement

getAttestationRootCertificates

@NonNull
public @NonNull java.util.Set<java.security.cert.X509Certificate> getAttestationRootCertificates()

See Also:

FIDO Metadata Statement

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object