Index
All Classes and Interfaces|All Packages|Serialized Form
A
- alg(COSEAlgorithmIdentifier) - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder
-
Specifies the cryptographic signature algorithm with which the newly generated credential will be used, and thus also the type of asymmetric key pair to be generated, e.g., RSA or Elliptic Curve.
- alg(COSEAlgorithmIdentifier) - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder.MandatoryStages
-
alg
is a required parameter. - allowCredentials(Optional<List<PublicKeyCredentialDescriptor>>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
A list of
PublicKeyCredentialDescriptor
objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list). - allowCredentials(List<PublicKeyCredentialDescriptor>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
A list of
PublicKeyCredentialDescriptor
objects representing public key credentials acceptable to the caller, in descending order of the caller’s preference (the first item in the list is the most preferred credential, and so on down the list). - allowOriginPort(boolean) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
If
true
, the origin matching rule is relaxed to allow any port number. - allowOriginSubdomain(boolean) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
If
true
, the origin matching rule is relaxed to allow any subdomain, of any depth, of the values oforigins
. - allowUntrustedAttestation(boolean) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
If
false
,finishRegistration
will only allow registrations where the attestation signature can be linked to a trusted attestation root. - ANONYMIZATION_CA - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In this case, the authenticator uses an Anonymization CA which dynamically generates per-credential attestation certificates such that the attestation statements presented to Relying Parties do not provide uniquely identifiable information, e.g., that might be used for tracking purposes.
- appid(boolean) - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder
-
The extension output for the FIDO AppID Extension (
appid
). - appid(Optional<AppId>) - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
-
The input to the FIDO AppID Extension (
appid
). - appid(Optional<Boolean>) - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder
-
The extension output for the FIDO AppID Extension (
appid
). - appid(AppId) - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
-
The input to the FIDO AppID Extension (
appid
). - appId(AppId) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The extension input to set for the
appid
andappidExclude
extensions. - appId(Optional<AppId>) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The extension input to set for the
appid
andappidExclude
extensions. - Appid() - Constructor for class com.yubico.webauthn.data.Extensions.Appid
- AppId - Class in com.yubico.webauthn.extension.appid
-
A FIDO AppID verified to be syntactically valid.
- AppId(String) - Constructor for class com.yubico.webauthn.extension.appid.AppId
-
Verify that the
appId
is a valid FIDO AppID, and wrap it as anAppId
. - appidExclude(AppId) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable the FIDO AppID Exclusion Extension (
appidExclude
). - appidExclude(Boolean) - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder
- appidExclude(Optional<AppId>) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable or disable the FIDO AppID Exclusion Extension (
appidExclude
). - AppidExclude() - Constructor for class com.yubico.webauthn.data.Extensions.AppidExclude
- AssertionExtensionInputs - Class in com.yubico.webauthn.data
-
Contains client extension inputs to a
navigator.credentials.get()
operation. - AssertionExtensionInputs.AssertionExtensionInputsBuilder - Class in com.yubico.webauthn.data
- AssertionFailedException - Exception in com.yubico.webauthn.exception
- AssertionFailedException(IllegalArgumentException) - Constructor for exception com.yubico.webauthn.exception.AssertionFailedException
- AssertionFailedException(String) - Constructor for exception com.yubico.webauthn.exception.AssertionFailedException
- AssertionRequest - Class in com.yubico.webauthn
- AssertionRequest.AssertionRequestBuilder - Class in com.yubico.webauthn
- AssertionRequest.AssertionRequestBuilder.MandatoryStages - Class in com.yubico.webauthn
- AssertionResult - Class in com.yubico.webauthn
-
The result of a call to
RelyingParty.finishAssertion(FinishAssertionOptions)
. - AT - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
Attested credential data present.
- attestation(AttestationConveyancePreference) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Intended for use by Relying Parties that wish to express their preference for attestation conveyance.
- ATTESTATION_CA - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In this case, an authenticator is based on a Trusted Platform Module (TPM) and holds an authenticator-specific "endorsement key" (EK).
- attestationConveyancePreference(AttestationConveyancePreference) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The argument for the
attestation
parameter in registration operations. - attestationConveyancePreference(Optional<AttestationConveyancePreference>) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The argument for the
attestation
parameter in registration operations. - AttestationConveyancePreference - Enum Class in com.yubico.webauthn.data
-
Relying Parties may use this to specify their preference regarding attestation conveyance during credential generation.
- attestationObject(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder
- attestationObject(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages
-
attestationObject
is a required parameter. - AttestationObject - Class in com.yubico.webauthn.data
-
Authenticators MUST provide some form of attestation.
- AttestationObject(ByteArray) - Constructor for class com.yubico.webauthn.data.AttestationObject
-
Decode an
AttestationObject
object from a raw attestation object byte array. - attestationTrustSource(AttestationTrustSource) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
An
AttestationTrustSource
instance to use for looking up trust roots for authenticator attestation. - attestationTrustSource(Optional<AttestationTrustSource>) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
An
AttestationTrustSource
instance to use for looking up trust roots for authenticator attestation. - AttestationTrustSource - Interface in com.yubico.webauthn.attestation
-
Abstraction of a repository which can look up trust roots for authenticator attestation.
- AttestationTrustSource.TrustRootsResult - Class in com.yubico.webauthn.attestation
-
A result of looking up attestation trust roots for a particular attestation statement.
- AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder - Class in com.yubico.webauthn.attestation
- AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder.Step1 - Class in com.yubico.webauthn.attestation
- AttestationType - Enum Class in com.yubico.webauthn.data
-
Web Authentication supports several attestation types, defining the semantics of attestation statements and their underlying trust models.
- AttestedCredentialData - Class in com.yubico.webauthn.data
-
Attested credential data is a variable-length byte array added to the authenticator data when generating an attestation object for a given credential.
- AuthenticatorAssertionExtensionOutputs - Class in com.yubico.webauthn.data
-
Contains authenticator extension outputs from a
navigator.credentials.create()
operation. - AuthenticatorAssertionExtensionOutputs.AuthenticatorAssertionExtensionOutputsBuilder - Class in com.yubico.webauthn.data
- AuthenticatorAssertionResponse - Class in com.yubico.webauthn.data
-
Represents an authenticator's response to a client’s request for generation of a new authentication assertion given the WebAuthn Relying Party's PublicKeyCredentialRequestOptions.getChallenge() challenge} and OPTIONAL PublicKeyCredentialRequestOptions.getAllowCredentials() list of credentials} it is aware of.
- AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder - Class in com.yubico.webauthn.data
- AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step3 - Class in com.yubico.webauthn.data
- authenticatorAttachment(Optional<AuthenticatorAttachment>) - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
-
If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
- authenticatorAttachment(AuthenticatorAttachment) - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
-
If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
- authenticatorAttachment(AuthenticatorAttachment) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
- AuthenticatorAttachment - Enum Class in com.yubico.webauthn.data
-
This enumeration’s values describe authenticators' attachment modalities.
- AuthenticatorAttestationResponse - Class in com.yubico.webauthn.data
-
Represents the authenticator's response to a client's request for the creation of a new public key credential.
- AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder - Class in com.yubico.webauthn.data
- AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- authenticatorData(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
- authenticatorData(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages
-
authenticatorData
is a required parameter. - AuthenticatorData - Class in com.yubico.webauthn.data
-
The authenticator data structure is a byte array of 37 bytes or more.
- AuthenticatorData(ByteArray) - Constructor for class com.yubico.webauthn.data.AuthenticatorData
-
Decode an
AuthenticatorData
object from a raw authenticator data byte array. - AuthenticatorDataFlags - Class in com.yubico.webauthn.data
-
The flags bit field of an authenticator data structure, decoded as a high-level object.
- AuthenticatorDataFlags(byte) - Constructor for class com.yubico.webauthn.data.AuthenticatorDataFlags
-
Decode an
AuthenticatorDataFlags
object from a raw bit field byte. - AuthenticatorExtensionOutputs - Interface in com.yubico.webauthn.data
- AuthenticatorRegistrationExtensionOutputs - Class in com.yubico.webauthn.data
-
Contains authenticator extension outputs from a
navigator.credentials.create()
operation. - AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder - Class in com.yubico.webauthn.data
- AuthenticatorResponse - Interface in com.yubico.webauthn.data
-
Authenticators respond to Relying Party requests by returning an object derived from the
AuthenticatorResponse
interface. - authenticatorSelection(Optional<AuthenticatorSelectionCriteria>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.
- authenticatorSelection(Optional<AuthenticatorSelectionCriteria>) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
Constraints on what kind of authenticator the user is allowed to use to create the credential, and on features that authenticator must or should support.
- authenticatorSelection(AuthenticatorSelectionCriteria) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Intended for use by Relying Parties that wish to select the appropriate authenticators to participate in the create() operation.
- authenticatorSelection(AuthenticatorSelectionCriteria) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
Constraints on what kind of authenticator the user is allowed to use to create the credential, and on features that authenticator must or should support.
- AuthenticatorSelectionCriteria - Class in com.yubico.webauthn.data
-
This class may be used to specify requirements regarding authenticator attributes.
- AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder - Class in com.yubico.webauthn.data
- AuthenticatorTransport - Class in com.yubico.webauthn.data
-
Authenticators may communicate with Clients using a variety of transports.
B
- backupEligible(Boolean) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- backupState(Boolean) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- Base64UrlException - Exception in com.yubico.webauthn.data.exception
- Base64UrlException(String, Throwable) - Constructor for exception com.yubico.webauthn.data.exception.Base64UrlException
- BASIC - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In the case of basic attestation, the authenticator’s attestation key pair is specific to an authenticator model.
- BE - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- BLE - Static variable in class com.yubico.webauthn.data.AuthenticatorTransport
-
Indicates the respective authenticator can be contacted over Bluetooth Smart (Bluetooth Low Energy / BLE).
- BS - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- build() - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
- build() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
- build() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
- build() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs.AuthenticatorAssertionExtensionOutputsBuilder
- build() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
- build() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder
- build() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder
- build() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
- build() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder
- build() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder
- build() - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
- build() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
- build() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
- build() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder
- build() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
- build() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
- build() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder
- build() - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder
- build() - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
- build() - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
- build() - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
- build() - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
- build() - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
- build() - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
- builder() - Static method in class com.yubico.webauthn.AssertionRequest
- builder() - Static method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
- builder() - Static method in class com.yubico.webauthn.data.AssertionExtensionInputs
- builder() - Static method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- builder() - Static method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- builder() - Static method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- builder() - Static method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- builder() - Static method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
- builder() - Static method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- builder() - Static method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- builder() - Static method in class com.yubico.webauthn.data.PublicKeyCredential
- builder() - Static method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- builder() - Static method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- builder() - Static method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
- builder() - Static method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- builder() - Static method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- builder() - Static method in class com.yubico.webauthn.data.RelyingPartyIdentity
- builder() - Static method in class com.yubico.webauthn.data.UserIdentity
- builder() - Static method in class com.yubico.webauthn.FinishAssertionOptions
- builder() - Static method in class com.yubico.webauthn.FinishRegistrationOptions
- builder() - Static method in class com.yubico.webauthn.RegisteredCredential
- builder() - Static method in class com.yubico.webauthn.RelyingParty
- builder() - Static method in class com.yubico.webauthn.StartAssertionOptions
- builder() - Static method in class com.yubico.webauthn.StartRegistrationOptions
- ByteArray - Class in com.yubico.webauthn.data
-
An immutable byte array with support for encoding/decoding to/from various encodings.
- ByteArray(byte[]) - Constructor for class com.yubico.webauthn.data.ByteArray
-
Create a new instance by copying the contents of
bytes
.
C
- callerTokenBindingId(ByteArray) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
-
The token binding ID of the connection to the client, if any.
- callerTokenBindingId(ByteArray) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
-
The token binding ID of the connection to the client, if any.
- callerTokenBindingId(Optional<ByteArray>) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
-
The token binding ID of the connection to the client, if any.
- callerTokenBindingId(Optional<ByteArray>) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
-
The token binding ID of the connection to the client, if any.
- CANDIDATE_RECOMMENDATION - Enum constant in enum class com.yubico.webauthn.meta.DocumentStatus
-
A candidate recommendation is a specification release candidate.
- canEqual(Object) - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- certStore(CertStore) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
-
A
CertStore
of additional CRLs and/or intermediate certificates to use during certificate path validation, if any. - challenge(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
A challenge intended to be used for generating the newly created credential’s attestation object.
- challenge(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion.
- challenge(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step3
-
challenge
is a required parameter. - challenge(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages
-
challenge
is a required parameter. - ClientAssertionExtensionOutputs - Class in com.yubico.webauthn.data
-
Contains client extension outputs from a
navigator.credentials.get()
operation. - ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder - Class in com.yubico.webauthn.data
- clientDataJSON(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
- clientDataJSON(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder
- clientDataJSON(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step2
-
clientDataJSON
is a required parameter. - clientDataJSON(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages.Step2
-
clientDataJSON
is a required parameter. - ClientExtensionOutputs - Interface in com.yubico.webauthn.data
- clientExtensionResults(B) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
-
A map containing extension identifier → client extension output entries produced by the extension’s client extension processing.
- clientExtensionResults(B) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step3
-
clientExtensionResults
is a required parameter. - ClientRegistrationExtensionOutputs - Class in com.yubico.webauthn.data
-
Contains client extension outputs from a
navigator.credentials.create()
operation. - ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder - Class in com.yubico.webauthn.data
- clock(Clock) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
A
Clock
which will be used to tell the current time while verifying attestation certificate chains. - CollectedClientData - Class in com.yubico.webauthn.data
-
The client data represents the contextual bindings of both the Relying Party and the client.
- CollectedClientData(ByteArray) - Constructor for class com.yubico.webauthn.data.CollectedClientData
- com.yubico.webauthn - package com.yubico.webauthn
-
This package and its subpackages make up the public API of the webauthn-server-core library.
- com.yubico.webauthn.attestation - package com.yubico.webauthn.attestation
- com.yubico.webauthn.data - package com.yubico.webauthn.data
- com.yubico.webauthn.data.exception - package com.yubico.webauthn.data.exception
- com.yubico.webauthn.exception - package com.yubico.webauthn.exception
- com.yubico.webauthn.extension.appid - package com.yubico.webauthn.extension.appid
- com.yubico.webauthn.extension.uvm - package com.yubico.webauthn.extension.uvm
- com.yubico.webauthn.meta - package com.yubico.webauthn.meta
- compareTo(AuthenticatorTransport) - Method in class com.yubico.webauthn.data.AuthenticatorTransport
- compareTo(ByteArray) - Method in class com.yubico.webauthn.data.ByteArray
- compareTo(PublicKeyCredentialDescriptor) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- concat(ByteArray) - Method in class com.yubico.webauthn.data.ByteArray
- COSEAlgorithmIdentifier - Enum Class in com.yubico.webauthn.data
-
A number identifying a cryptographic algorithm.
- credentialId(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
The credential ID of the credential.
- credentialId(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages
-
credentialId
is a required parameter. - CredentialProperties() - Constructor for class com.yubico.webauthn.data.Extensions.CredentialProperties
- credentialRepository(CredentialRepository) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
An abstract database which can look up credentials, usernames and user handles from usernames, user handles and credential IDs.
- credentialRepository(CredentialRepository) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder.MandatoryStages.Step2
-
credentialRepository
is a required parameter. - CredentialRepository - Interface in com.yubico.webauthn
-
An abstraction of the database lookups needed by this library.
- credProps() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable the Credential Properties (
credProps
) Extension. - credProps(Extensions.CredentialProperties.CredentialPropertiesOutput) - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder
- credProps(Boolean) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable or disable the Credential Properties (
credProps
) Extension. - CROSS_PLATFORM - Enum constant in enum class com.yubico.webauthn.data.AuthenticatorAttachment
-
Indicates cross-platform attachment.
D
- DIRECT - Enum constant in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
Indicates that the Relying Party wants to receive the attestation statement as generated by the authenticator.
- DISCOURAGED - Enum constant in enum class com.yubico.webauthn.data.ResidentKeyRequirement
-
The client and authenticator will try to create a server-side credential if possible, and a discoverable credential (passkey) otherwise.
- DISCOURAGED - Enum constant in enum class com.yubico.webauthn.data.UserVerificationRequirement
-
This value indicates that the Relying Party does not want user verification employed during the operation (e.g., in the interest of minimizing disruption to the user interaction flow).
- displayName(String) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder
-
A human-palatable name for the user account, intended only for display.
- displayName(String) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages.Step2
-
displayName
is a required parameter. - DocumentStatus - Enum Class in com.yubico.webauthn.meta
-
A representation of Web Authentication specification document statuses.
E
- ED - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
Extension data present.
- EdDSA - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- EdDSA - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.EdDSA
and typePublicKeyCredentialType.PUBLIC_KEY
. - EDITORS_DRAFT - Enum constant in enum class com.yubico.webauthn.meta.DocumentStatus
-
An editor's draft is a changing work in progress.
- enableRevocationChecking(boolean) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
-
Whether certificate revocation should be checked during certificate path validation.
- ENTERPRISE - Enum constant in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
This value indicates that the Relying Party wants to receive an attestation statement that may include uniquely identifying information.
- equals(Object) - Method in class com.yubico.webauthn.AssertionRequest
- equals(Object) - Method in class com.yubico.webauthn.AssertionResult
- equals(Object) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
- equals(Object) - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- equals(Object) - Method in class com.yubico.webauthn.data.AttestationObject
- equals(Object) - Method in class com.yubico.webauthn.data.AttestedCredentialData
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorData
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorDataFlags
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
- equals(Object) - Method in class com.yubico.webauthn.data.AuthenticatorTransport
- equals(Object) - Method in class com.yubico.webauthn.data.ByteArray
- equals(Object) - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- equals(Object) - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- equals(Object) - Method in class com.yubico.webauthn.data.CollectedClientData
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.CredentialProperties.CredentialPropertiesOutput
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationOutput
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
- equals(Object) - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- equals(Object) - Method in class com.yubico.webauthn.data.PublicKeyCredential
- equals(Object) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- equals(Object) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- equals(Object) - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
- equals(Object) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- equals(Object) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- equals(Object) - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
- equals(Object) - Method in class com.yubico.webauthn.data.TokenBindingInfo
- equals(Object) - Method in class com.yubico.webauthn.data.UserIdentity
- equals(Object) - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- equals(Object) - Method in class com.yubico.webauthn.extension.appid.AppId
- equals(Object) - Method in class com.yubico.webauthn.FinishAssertionOptions
- equals(Object) - Method in class com.yubico.webauthn.FinishRegistrationOptions
- equals(Object) - Method in class com.yubico.webauthn.meta.Implementation
- equals(Object) - Method in class com.yubico.webauthn.meta.Specification
- equals(Object) - Method in class com.yubico.webauthn.meta.VersionInfo
- equals(Object) - Method in class com.yubico.webauthn.RegisteredCredential
- equals(Object) - Method in class com.yubico.webauthn.RegistrationResult
- equals(Object) - Method in class com.yubico.webauthn.RelyingParty
- equals(Object) - Method in class com.yubico.webauthn.StartAssertionOptions
- equals(Object) - Method in class com.yubico.webauthn.StartRegistrationOptions
- ES256 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- ES256 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.ES256
and typePublicKeyCredentialType.PUBLIC_KEY
. - ES384 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- ES384 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.ES384
and typePublicKeyCredentialType.PUBLIC_KEY
. - ES512 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- ES512 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.ES512
and typePublicKeyCredentialType.PUBLIC_KEY
. - excludeCredentials(Optional<Set<PublicKeyCredentialDescriptor>>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator.
- excludeCredentials(Set<PublicKeyCredentialDescriptor>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Intended for use by Relying Parties that wish to limit the creation of multiple credentials for the same account on a single authenticator.
- ExtensionInputs - Interface in com.yubico.webauthn.data
- ExtensionOutputs - Interface in com.yubico.webauthn.data
- extensions(AssertionExtensionInputs) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Additional parameters requesting additional processing by the client and authenticator.
- extensions(AssertionExtensionInputs) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
Extension inputs for this authentication operation.
- extensions(RegistrationExtensionInputs) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Additional parameters requesting additional processing by the client and authenticator.
- extensions(RegistrationExtensionInputs) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
Extension inputs for this registration operation.
- Extensions - Class in com.yubico.webauthn.data
-
Definitions for WebAuthn extensions.
- Extensions.Appid - Class in com.yubico.webauthn.data
-
Definitions for the FIDO AppID Extension (
appid
). - Extensions.AppidExclude - Class in com.yubico.webauthn.data
-
Definitions for the 10.2.
- Extensions.CredentialProperties - Class in com.yubico.webauthn.data
-
Definitions for the Credential Properties Extension (
credProps
). - Extensions.CredentialProperties.CredentialPropertiesOutput - Class in com.yubico.webauthn.data
-
Extension outputs for the Credential Properties Extension (
credProps
). - Extensions.LargeBlob - Class in com.yubico.webauthn.data
-
Definitions for the Large blob storage extension (
largeBlob
). - Extensions.LargeBlob.LargeBlobAuthenticationInput - Class in com.yubico.webauthn.data
-
Extension inputs for the Large blob storage extension (
largeBlob
) in authentication ceremonies. - Extensions.LargeBlob.LargeBlobAuthenticationOutput - Class in com.yubico.webauthn.data
-
Extension outputs for the Large blob storage extension (
largeBlob
) in authentication ceremonies. - Extensions.LargeBlob.LargeBlobRegistrationInput - Class in com.yubico.webauthn.data
-
Extension inputs for the Large blob storage extension (
largeBlob
) in registration ceremonies. - Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport - Class in com.yubico.webauthn.data
-
The known valid arguments for the Large blob storage extension (
largeBlob
) input in registration ceremonies. - Extensions.LargeBlob.LargeBlobRegistrationOutput - Class in com.yubico.webauthn.data
-
Extension outputs for the Large blob storage extension (
largeBlob
) in registration ceremonies. - Extensions.Uvm - Class in com.yubico.webauthn.data
-
Definitions for the User Verification Method (
uvm
) Extension. - Extensions.Uvm.UvmEntry - Class in com.yubico.webauthn.data
-
A
uvmEntry
as defined in §10.3.
F
- findTrustRoots(List<X509Certificate>, Optional<ByteArray>) - Method in interface com.yubico.webauthn.attestation.AttestationTrustSource
-
Attempt to look up attestation trust roots for an authenticator.
- finishAssertion(FinishAssertionOptions) - Method in class com.yubico.webauthn.RelyingParty
- FinishAssertionOptions - Class in com.yubico.webauthn
-
Parameters for
RelyingParty.finishAssertion(FinishAssertionOptions)
. - FinishAssertionOptions.FinishAssertionOptionsBuilder - Class in com.yubico.webauthn
- FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages - Class in com.yubico.webauthn
- FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn
- finishRegistration(FinishRegistrationOptions) - Method in class com.yubico.webauthn.RelyingParty
- FinishRegistrationOptions - Class in com.yubico.webauthn
-
Parameters for
RelyingParty.finishRegistration(FinishRegistrationOptions)
. - FinishRegistrationOptions.FinishRegistrationOptionsBuilder - Class in com.yubico.webauthn
- FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages - Class in com.yubico.webauthn
- FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn
- fromAuthenticatorData(AuthenticatorData) - Static method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
-
Parse authentication authenticator extension outputs from the given authenticator data.
- fromAuthenticatorData(AuthenticatorData) - Static method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
-
Parse registration authenticator extension outputs from the given authenticator data.
- fromBase64(String) - Static method in class com.yubico.webauthn.data.ByteArray
-
Create a new instance by decoding
base64
as classic Base64 data. - fromBase64Url(String) - Static method in class com.yubico.webauthn.data.ByteArray
-
Create a new instance by decoding
base64url
as Base64Url data. - fromHex(String) - Static method in class com.yubico.webauthn.data.ByteArray
-
Create a new instance by decoding
hex
as hexadecimal data. - fromId(long) - Static method in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
-
Attempt to parse an integer as a
COSEAlgorithmIdentifier
. - fromJson(String) - Static method in class com.yubico.webauthn.AssertionRequest
-
Decode an
AssertionRequest
from JSON. - fromJson(String) - Static method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Decode an
PublicKeyCredentialCreationOptions
from JSON. - fromName(String) - Static method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
- fromName(String) - Static method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
- fromName(String) - Static method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
- fromPublicKey(ByteArray) - Static method in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
-
Read the
COSEAlgorithmIdentifier
from a public key in COSE_Key format. - fromValue(int) - Static method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
- fromValue(int) - Static method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
- fromValue(short) - Static method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
G
- getAaguid() - Method in class com.yubico.webauthn.data.AttestedCredentialData
-
The AAGUID of the authenticator.
- getAaguid() - Method in class com.yubico.webauthn.RegistrationResult
-
The
aaguid
reported in the of the created credential. - getAlg() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Specifies the cryptographic signature algorithm with which the newly generated credential will be used, and thus also the type of asymmetric key pair to be generated, e.g., RSA or Elliptic Curve.
- getAllowCredentials() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- getAppid() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
-
The input to the FIDO AppID Extension (
appid
). - getAppid() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
-
The extension output for the FIDO AppID Extension (
appid
), if any. - getAppId() - Method in class com.yubico.webauthn.RelyingParty
-
The extension input to set for the
appid
andappidExclude
extensions. - getAppidExclude() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
-
The extension output for the FIDO AppID Exclusion (
appidExclude
) Extension, if any. - getAppidExclude() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- getAttestation() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
-
The
AuthenticatorAttestationResponse.attestationObject
parsed as a domain object. - getAttestation() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Intended for use by Relying Parties that wish to express their preference for attestation conveyance.
- getAttestationConveyancePreference() - Method in class com.yubico.webauthn.RelyingParty
-
The argument for the
attestation
parameter in registration operations. - getAttestationObject() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
-
Contains an attestation object, which is opaque to, and cryptographically protected against tampering by, the client.
- getAttestationStatement() - Method in class com.yubico.webauthn.data.AttestationObject
-
An important component of the attestation object is the attestation statement.
- getAttestationTrustPath() - Method in class com.yubico.webauthn.RegistrationResult
-
The attestation trust path for the created credential, if any.
- getAttestationTrustSource() - Method in class com.yubico.webauthn.RelyingParty
-
An
AttestationTrustSource
instance to use for looking up trust roots for authenticator attestation. - getAttestationType() - Method in class com.yubico.webauthn.RegistrationResult
-
The attestation type that was used for the created credential.
- getAttestedCredentialData() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
Attested credential data, if present.
- getAuthenticatorAttachment() - Method in class com.yubico.webauthn.AssertionResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- getAuthenticatorAttachment() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
-
If present, eligible authenticators are filtered to only authenticators attached with the specified §5.4.5 Authenticator Attachment Enumeration (enum AuthenticatorAttachment).
- getAuthenticatorAttachment() - Method in class com.yubico.webauthn.data.PublicKeyCredential
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- getAuthenticatorAttachment() - Method in class com.yubico.webauthn.RegistrationResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- getAuthenticatorData() - Method in class com.yubico.webauthn.data.AttestationObject
-
The authenticator data embedded inside this attestation object.
- getAuthenticatorData() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- getAuthenticatorData() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- getAuthenticatorData() - Method in interface com.yubico.webauthn.data.AuthenticatorResponse
-
The authenticator data returned by the authenticator.
- getAuthenticatorExtensionOutputs() - Method in class com.yubico.webauthn.AssertionResult
-
The authenticator extension outputs, if any.
- getAuthenticatorExtensionOutputs() - Method in class com.yubico.webauthn.RegistrationResult
-
The authenticator extension outputs, if any.
- getAuthenticatorSelection() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- getAuthenticatorSelection() - Method in class com.yubico.webauthn.StartRegistrationOptions
-
Constraints on what kind of authenticator the user is allowed to use to create the credential, and on features that authenticator must or should support.
- getBase64() - Method in class com.yubico.webauthn.data.ByteArray
- getBase64Url() - Method in class com.yubico.webauthn.data.ByteArray
- getBlob() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationOutput
-
The opaque byte string that was associated with the credential identified by
PublicKeyCredential.getId()
. - getBytes() - Method in class com.yubico.webauthn.data.AttestationObject
-
The original raw byte array that this object is decoded from.
- getBytes() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
The original raw byte array that this object is decoded from.
- getBytes() - Method in class com.yubico.webauthn.data.ByteArray
- getCallerTokenBindingId() - Method in class com.yubico.webauthn.FinishAssertionOptions
-
The token binding ID of the connection to the client, if any.
- getCallerTokenBindingId() - Method in class com.yubico.webauthn.FinishRegistrationOptions
-
The token binding ID of the connection to the client, if any.
- getCertStore() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
-
A
CertStore
of additional CRLs and/or intermediate certificates to use during certificate path validation, if any. - getChallenge() - Method in class com.yubico.webauthn.data.CollectedClientData
-
The base64url encoding of the challenge provided by the Relying Party.
- getChallenge() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
A challenge intended to be used for generating the newly created credential’s attestation object.
- getChallenge() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
-
A challenge that the selected authenticator signs, along with other data, when producing an authentication assertion.
- getClientData() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- getClientData() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- getClientData() - Method in interface com.yubico.webauthn.data.AuthenticatorResponse
-
AuthenticatorResponse.getClientDataJSON()
parsed as a domain object. - getClientDataJSON() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- getClientDataJSON() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- getClientDataJSON() - Method in interface com.yubico.webauthn.data.AuthenticatorResponse
-
The JSON-serialized client data (see §5.10.1 Client Data Used in WebAuthn Signatures (dictionary
CollectedClientData
)) passed to the authenticator by the client in the call to eithernavigator.credentials.create()
ornavigator.credentials.get()
. - getClientExtensionOutputs() - Method in class com.yubico.webauthn.AssertionResult
-
The client extension outputs, if any.
- getClientExtensionOutputs() - Method in class com.yubico.webauthn.RegistrationResult
-
The client extension outputs, if any.
- getClientExtensionResults() - Method in class com.yubico.webauthn.data.PublicKeyCredential
-
A map containing extension identifier → client extension output entries produced by the extension’s client extension processing.
- getClock() - Method in class com.yubico.webauthn.RelyingParty
-
A
Clock
which will be used to tell the current time while verifying attestation certificate chains. - getCredential() - Method in class com.yubico.webauthn.AssertionResult
-
The
RegisteredCredential
that was returned byCredentialRepository.lookup(ByteArray, ByteArray)
and whose public key was used to successfully verify the assertion signature. - getCredentialId() - Method in class com.yubico.webauthn.AssertionResult
-
Deprecated.Use
AssertionResult.getCredential()
.getCredentialId()
instead. - getCredentialId() - Method in class com.yubico.webauthn.data.AttestedCredentialData
-
The credential ID of the attested credential.
- getCredentialId() - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- getCredentialId() - Method in class com.yubico.webauthn.RegisteredCredential
-
The credential ID of the credential.
- getCredentialIdsForUsername(String) - Method in interface com.yubico.webauthn.CredentialRepository
-
Get the credential IDs of all credentials registered to the user with the given username.
- getCredentialPublicKey() - Method in class com.yubico.webauthn.data.AttestedCredentialData
-
The credential public key encoded in COSE_Key format, as defined in Section 7 of RFC 8152.
- getCredentialRepository() - Method in class com.yubico.webauthn.RelyingParty
-
An abstract database which can look up credentials, usernames and user handles from usernames, user handles and credential IDs.
- getCredProps() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
-
The extension output for the Credential Properties Extension (
credProps
), if any. - getCredProps() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- getDisplayName() - Method in class com.yubico.webauthn.data.UserIdentity
-
A human-palatable name for the user account, intended only for display.
- getExcludeCredentials() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- getExpectedMinimum() - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- getExtensionIds() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- getExtensionIds() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- getExtensionIds() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- getExtensionIds() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- getExtensionIds() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- getExtensionIds() - Method in interface com.yubico.webauthn.data.ExtensionInputs
-
Returns a
Set
of the extension IDs for which an extension input is present. - getExtensionIds() - Method in interface com.yubico.webauthn.data.ExtensionOutputs
-
Returns a
Set
of the extension IDs for which an extension output is present. - getExtensionIds() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- getExtensions() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
Extension-defined authenticator data, if present.
- getExtensions() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Additional parameters requesting additional processing by the client and authenticator.
- getExtensions() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
-
Additional parameters requesting additional processing by the client and authenticator.
- getExtensions() - Method in class com.yubico.webauthn.StartAssertionOptions
-
Extension inputs for this authentication operation.
- getExtensions() - Method in class com.yubico.webauthn.StartRegistrationOptions
-
Extension inputs for this registration operation.
- getFlags() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
The flags bit field.
- getFormat() - Method in class com.yubico.webauthn.data.AttestationObject
-
The attestation statement format identifier of this attestation object.
- getGitCommit() - Method in class com.yubico.webauthn.meta.Implementation
-
The commit ID of the source code the library was built from, if known.
- getHex() - Method in class com.yubico.webauthn.data.ByteArray
- getId() - Method in class com.yubico.webauthn.data.AuthenticatorTransport
- getId() - Method in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- getId() - Method in class com.yubico.webauthn.data.PublicKeyCredential
-
The raw Credential ID of this credential, corresponding to the
rawId
attribute in the WebAuthn API. - getId() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
-
The credential ID of the public key credential the caller is referring to.
- getId() - Method in enum class com.yubico.webauthn.data.PublicKeyCredentialType
- getId() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
-
A unique identifier for the Relying Party, which sets the RP ID.
- getId() - Method in class com.yubico.webauthn.data.TokenBindingInfo
- getId() - Method in class com.yubico.webauthn.data.UserIdentity
-
The user handle for the account, specified by the Relying Party.
- getId() - Method in class com.yubico.webauthn.extension.appid.AppId
-
The underlying string representation of this AppID.
- getIdentity() - Method in class com.yubico.webauthn.RelyingParty
-
The
RelyingPartyIdentity
that will be set as therp
parameter when initiating registration operations, and whichAuthenticatorData.getRpIdHash()
will be compared against. - getImplementation() - Method in class com.yubico.webauthn.meta.VersionInfo
-
Description of this version of this library
- getInstance() - Static method in class com.yubico.webauthn.meta.VersionInfo
- getKeyId() - Method in class com.yubico.webauthn.RegistrationResult
-
The credential ID and transports of the created credential.
- getKeyProtectionType() - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- getLargeBlob() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
-
The input to the Large blob storage extension (
largeBlob
). - getLargeBlob() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
-
The extension output for the Large blob storage (
largeBlob
) extension, if any. - getLargeBlob() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
-
The extension output for the Large blob storage extension (
largeBlob
), if any. - getLargeBlob() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- getLatestVersionUrl() - Method in class com.yubico.webauthn.meta.Specification
-
Address to the latest version of this specification.
- getMatcherProtectionType() - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- getName() - Method in interface com.yubico.webauthn.data.PublicKeyCredentialEntity
-
A human-palatable name for the entity.
- getName() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
-
The human-palatable name of the Relaying Party.
- getName() - Method in class com.yubico.webauthn.data.UserIdentity
-
A human-palatable identifier for a user account.
- getName() - Method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
- getName() - Method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
- getName() - Method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
- getOrigin() - Method in class com.yubico.webauthn.data.CollectedClientData
-
The fully qualified origin of the requester, as provided to the authenticator by the client, in the syntax defined by RFC 6454.
- getOrigins() - Method in class com.yubico.webauthn.RelyingParty
-
The allowed origins that returned authenticator responses will be compared against.
- getParsedAuthenticatorData() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- getParsedAuthenticatorData() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- getParsedAuthenticatorData() - Method in interface com.yubico.webauthn.data.AuthenticatorResponse
-
AuthenticatorResponse.getAuthenticatorData()
parsed as a domain object. - getPolicyTreeValidator() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
-
If non-null, the PolicyQualifiersRejected flag will be set to false during certificate path validation.
- getPreferredPubkeyParams() - Method in class com.yubico.webauthn.RelyingParty
-
The argument for the
pubKeyCredParams
parameter in registration operations. - getPubKeyCredParams() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Information about the desired properties of the credential to be created.
- getPublicKeyCose() - Method in class com.yubico.webauthn.RegisteredCredential
-
The credential public key encoded in COSE_Key format, as defined in Section 7 of RFC 8152.
- getPublicKeyCose() - Method in class com.yubico.webauthn.RegistrationResult
-
The public key of the created credential.
- getPublicKeyCredentialRequestOptions() - Method in class com.yubico.webauthn.AssertionRequest
-
An object that can be serialized to JSON and passed as the
publicKey
argument tonavigator.credentials.get()
. - getRead() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
- getReceived() - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- getReleaseDate() - Method in class com.yubico.webauthn.meta.Specification
-
The release date of the specification document.
- getRequest() - Method in class com.yubico.webauthn.FinishAssertionOptions
-
The request that the
response
is a response to. - getRequest() - Method in class com.yubico.webauthn.FinishRegistrationOptions
-
The request that the
response
is a response to. - getResidentKey() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
-
Specifies the extent to which the Relying Party desires to create a client-side discoverable credential (passkey).
- getResponse() - Method in class com.yubico.webauthn.data.PublicKeyCredential
-
The authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion.
- getResponse() - Method in class com.yubico.webauthn.FinishAssertionOptions
-
The client's response to the
request
. - getResponse() - Method in class com.yubico.webauthn.FinishRegistrationOptions
-
The client's response to the
request
. - getRk() - Method in class com.yubico.webauthn.data.Extensions.CredentialProperties.CredentialPropertiesOutput
-
This OPTIONAL property, known abstractly as the resident key credential property (i.e., client-side discoverable credential property), is a Boolean value indicating whether the
PublicKeyCredential
returned as a result of a registration ceremony is a client-side discoverable credential (passkey). - getRp() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Contains data about the Relying Party responsible for the request.
- getRpId() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
-
Specifies the relying party identifier claimed by the caller.
- getRpIdHash() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
The SHA-256 hash of the RP ID the credential is scoped to.
- getSignature() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
-
The raw signature returned from the authenticator.
- getSignatureCount() - Method in class com.yubico.webauthn.AssertionResult
-
The new signature count of the credential used for the assertion.
- getSignatureCount() - Method in class com.yubico.webauthn.RegisteredCredential
-
The stored signature count of the credential.
- getSignatureCount() - Method in class com.yubico.webauthn.RegistrationResult
-
The signature count returned with the created credential.
- getSignatureCounter() - Method in class com.yubico.webauthn.data.AuthenticatorData
-
The 32-bit unsigned signature counter.
- getSourceCodeUrl() - Method in class com.yubico.webauthn.meta.Implementation
-
Address to where the source code for this library can be found.
- getSpecification() - Method in class com.yubico.webauthn.meta.VersionInfo
-
Represents the specification this implementation is based on
- getStatus() - Method in class com.yubico.webauthn.data.TokenBindingInfo
- getStatus() - Method in class com.yubico.webauthn.meta.Specification
-
An object indicating the status of the specification document.
- getSupport() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput
-
The Relying Party's preference of whether the created credential should support the
largeBlob
extension. - getTimeout() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- getTimeout() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- getTimeout() - Method in class com.yubico.webauthn.StartAssertionOptions
-
The value for
PublicKeyCredentialRequestOptions.getTimeout()
for this authentication operation. - getTimeout() - Method in class com.yubico.webauthn.StartRegistrationOptions
-
The value for
PublicKeyCredentialCreationOptions.getTimeout()
for this registration operation. - getTokenBinding() - Method in class com.yubico.webauthn.data.CollectedClientData
-
Information about the state of the Token Binding protocol used when communicating with the Relying Party.
- getTransports() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
-
The return value from the
AuthenticatorAttestationResponse.getTransports()
method. - getTransports() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- getTrustRoots() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
-
A set of attestation root certificates trusted to certify the relevant attestation statement.
- getType() - Method in class com.yubico.webauthn.data.CollectedClientData
-
The type of the requested operation, set by the client.
- getType() - Method in class com.yubico.webauthn.data.PublicKeyCredential
-
The
PublicKeyCredential
's type value is the string "public-key". - getType() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
-
The type of the credential the caller is referring to.
- getType() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Specifies the type of credential to be created.
- getUrl() - Method in class com.yubico.webauthn.meta.Specification
-
Address to this version of the specification.
- getUser() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Contains data about the user account for which the Relying Party is requesting attestation.
- getUser() - Method in class com.yubico.webauthn.StartRegistrationOptions
-
Identifiers for the user creating a credential.
- getUserHandle() - Method in class com.yubico.webauthn.AssertionRequest
-
The user handle of the user to authenticate, if the user has already been identified.
- getUserHandle() - Method in class com.yubico.webauthn.AssertionResult
-
Deprecated.Use
AssertionResult.getCredential()
.getUserHandle()
instead. - getUserHandle() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
-
The user handle returned from the authenticator, or empty if the authenticator did not return a user handle.
- getUserHandle() - Method in class com.yubico.webauthn.RegisteredCredential
-
The user handle of the user the credential is registered to.
- getUserHandle() - Method in class com.yubico.webauthn.StartAssertionOptions
-
The user handle of the user to authenticate, if the user has already been identified.
- getUserHandleForUsername(String) - Method in interface com.yubico.webauthn.CredentialRepository
-
Get the user handle corresponding to the given username - the inverse of
CredentialRepository.getUsernameForUserHandle(ByteArray)
. - getUsername() - Method in class com.yubico.webauthn.AssertionRequest
-
The username of the user to authenticate, if the user has already been identified.
- getUsername() - Method in class com.yubico.webauthn.AssertionResult
-
The username of the authenticated user.
- getUsername() - Method in class com.yubico.webauthn.StartAssertionOptions
-
The username of the user to authenticate, if the user has already been identified.
- getUsernameForUserHandle(ByteArray) - Method in interface com.yubico.webauthn.CredentialRepository
-
Get the username corresponding to the given user handle - the inverse of
CredentialRepository.getUserHandleForUsername(String)
. - getUserVerification() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
-
Describes the Relying Party's requirements regarding user verification for the
navigator.credentials.create()
operation. - getUserVerification() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- getUserVerification() - Method in class com.yubico.webauthn.StartAssertionOptions
-
The value for
PublicKeyCredentialRequestOptions.getUserVerification()
for this authentication operation. - getUserVerificationMethod() - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- getUvm() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- getUvm() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- getUvm() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- getUvm() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- getValue() - Method in enum class com.yubico.webauthn.data.AttestationConveyancePreference
- getValue() - Method in enum class com.yubico.webauthn.data.AuthenticatorAttachment
- getValue() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
- getValue() - Method in enum class com.yubico.webauthn.data.ResidentKeyRequirement
- getValue() - Method in enum class com.yubico.webauthn.data.TokenBindingStatus
- getValue() - Method in enum class com.yubico.webauthn.data.UserVerificationRequirement
- getValue() - Method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
- getValue() - Method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
- getValue() - Method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
- getVersion() - Method in class com.yubico.webauthn.meta.Implementation
-
The version number of this release of the library.
- getWrite() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
- getWritten() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationOutput
-
A boolean that indicates that the contents of
LargeBlobAuthenticationInput#write(ByteArray)
were successfully stored on the authenticator, associated with the specified credential.
H
- hashCode() - Method in class com.yubico.webauthn.AssertionRequest
- hashCode() - Method in class com.yubico.webauthn.AssertionResult
- hashCode() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
- hashCode() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- hashCode() - Method in class com.yubico.webauthn.data.AttestationObject
- hashCode() - Method in class com.yubico.webauthn.data.AttestedCredentialData
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorData
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorDataFlags
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
- hashCode() - Method in class com.yubico.webauthn.data.AuthenticatorTransport
- hashCode() - Method in class com.yubico.webauthn.data.ByteArray
- hashCode() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- hashCode() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- hashCode() - Method in class com.yubico.webauthn.data.CollectedClientData
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.CredentialProperties.CredentialPropertiesOutput
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationOutput
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
- hashCode() - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- hashCode() - Method in class com.yubico.webauthn.data.PublicKeyCredential
- hashCode() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- hashCode() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- hashCode() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
- hashCode() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- hashCode() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- hashCode() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
- hashCode() - Method in class com.yubico.webauthn.data.TokenBindingInfo
- hashCode() - Method in class com.yubico.webauthn.data.UserIdentity
- hashCode() - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- hashCode() - Method in class com.yubico.webauthn.extension.appid.AppId
- hashCode() - Method in class com.yubico.webauthn.FinishAssertionOptions
- hashCode() - Method in class com.yubico.webauthn.FinishRegistrationOptions
- hashCode() - Method in class com.yubico.webauthn.meta.Implementation
- hashCode() - Method in class com.yubico.webauthn.meta.Specification
- hashCode() - Method in class com.yubico.webauthn.meta.VersionInfo
- hashCode() - Method in class com.yubico.webauthn.RegisteredCredential
- hashCode() - Method in class com.yubico.webauthn.RegistrationResult
- hashCode() - Method in class com.yubico.webauthn.RelyingParty
- hashCode() - Method in class com.yubico.webauthn.StartAssertionOptions
- hashCode() - Method in class com.yubico.webauthn.StartRegistrationOptions
- HexException - Exception in com.yubico.webauthn.data.exception
- HexException(String, Throwable) - Constructor for exception com.yubico.webauthn.data.exception.HexException
- HYBRID - Static variable in class com.yubico.webauthn.data.AuthenticatorTransport
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
I
- id(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
-
The raw Credential ID of this credential, corresponding to the
rawId
attribute in the WebAuthn API. - id(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
-
The credential ID of the public key credential the caller is referring to.
- id(ByteArray) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder
-
The user handle for the account, specified by the Relying Party.
- id(String) - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder
-
A unique identifier for the Relying Party, which sets the RP ID.
- id(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages
-
id
is a required parameter. - id(ByteArray) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages
-
id
is a required parameter. - id(ByteArray) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages.Step3
-
id
is a required parameter. - id(String) - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages
-
A unique identifier for the Relying Party, which sets the RP ID.
- identity(RelyingPartyIdentity) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The
RelyingPartyIdentity
that will be set as therp
parameter when initiating registration operations, and whichAuthenticatorData.getRpIdHash()
will be compared against. - identity(RelyingPartyIdentity) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder.MandatoryStages
-
identity
is a required parameter. - Implementation - Class in com.yubico.webauthn.meta
-
Description of this version of this library
- INDIRECT - Enum constant in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
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.
- INTERNAL - Static variable in class com.yubico.webauthn.data.AuthenticatorTransport
-
Indicates the respective authenticator is contacted using a client device-specific transport.
- InvalidAppIdException - Exception in com.yubico.webauthn.extension.appid
- InvalidAppIdException(String) - Constructor for exception com.yubico.webauthn.extension.appid.InvalidAppIdException
- InvalidAppIdException(String, Throwable) - Constructor for exception com.yubico.webauthn.extension.appid.InvalidAppIdException
- InvalidSignatureCountException - Exception in com.yubico.webauthn.exception
- InvalidSignatureCountException(ByteArray, long, long) - Constructor for exception com.yubico.webauthn.exception.InvalidSignatureCountException
- isAllowOriginPort() - Method in class com.yubico.webauthn.RelyingParty
-
If
true
, the origin matching rule is relaxed to allow any port number. - isAllowOriginSubdomain() - Method in class com.yubico.webauthn.RelyingParty
-
If
true
, the origin matching rule is relaxed to allow any subdomain, of any depth, of the values oforigins
. - isAllowUntrustedAttestation() - Method in class com.yubico.webauthn.RelyingParty
-
If
false
,finishRegistration
will only allow registrations where the attestation signature can be linked to a trusted attestation root. - isAttestationTrusted() - Method in class com.yubico.webauthn.RegistrationResult
-
true
if and only if the attestation signature was successfully linked to a trusted attestation root. - isBackedUp() - Method in class com.yubico.webauthn.AssertionResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isBackedUp() - Method in class com.yubico.webauthn.RegisteredCredential
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isBackedUp() - Method in class com.yubico.webauthn.RegistrationResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isBackupEligible() - Method in class com.yubico.webauthn.AssertionResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isBackupEligible() - Method in class com.yubico.webauthn.RegisteredCredential
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isBackupEligible() - Method in class com.yubico.webauthn.RegistrationResult
-
Deprecated.EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
- isDiscoverable() - Method in class com.yubico.webauthn.RegistrationResult
-
Try to determine whether the created credential is a discoverable credential, also called a passkey, using the output from the
credProps
extension. - isEmpty() - Method in class com.yubico.webauthn.data.ByteArray
- isEnableRevocationChecking() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
-
Whether certificate revocation should be checked during certificate path validation.
- isSignatureCounterValid() - Method in class com.yubico.webauthn.AssertionResult
-
true
if and only if at least one of the following is true: Thesignature counter value
in the assertion was strictly greater thanthe stored one
. - isSuccess() - Method in class com.yubico.webauthn.AssertionResult
-
true
if the assertion was verified successfully. - isSupported() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
-
true
if, and only if, the created credential supports storing large blobs. - isUserVerified() - Method in class com.yubico.webauthn.AssertionResult
-
Check whether the user verification as performed during the authentication ceremony.
- isUserVerified() - Method in class com.yubico.webauthn.RegistrationResult
-
Check whether the user verification as performed during the registration ceremony.
- isValidateSignatureCounter() - Method in class com.yubico.webauthn.RelyingParty
-
If
true
,finishAssertion
will succeed only if thesignature counter value
in the response is strictly greater than thestored signature counter value
, or if both counters are exactly zero.
K
- KEY_PROTECTION_HARDWARE - Enum constant in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
This flag SHOULD be set if the authenticator uses hardware-based key management.
- KEY_PROTECTION_REMOTE_HANDLE - Enum constant in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
This flag MUST be set if the authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle.
- KEY_PROTECTION_SECURE_ELEMENT - Enum constant in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
This flag SHOULD be set if the authenticator uses a Secure Element [SecureElement] for key management.
- KEY_PROTECTION_SOFTWARE - Enum constant in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
This flag MUST be set if the authenticator uses software-based key management.
- KEY_PROTECTION_TEE - Enum constant in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
This flag SHOULD be set if the authenticator uses the Trusted Execution Environment [TEE] for key management.
- KeyProtectionType - Enum Class in com.yubico.webauthn.extension.uvm
-
The KEY_PROTECTION constants are flags in a bit field represented as a 16 bit long integer.
L
- largeBlob(Extensions.LargeBlob.LargeBlobAuthenticationInput) - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
-
Enable the Large blob storage extension (
largeBlob
). - largeBlob(Extensions.LargeBlob.LargeBlobAuthenticationOutput) - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder
- largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable the Large blob storage extension (
largeBlob
). - largeBlob(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable the Large blob storage extension (
largeBlob
). - largeBlob(Extensions.LargeBlob.LargeBlobRegistrationOutput) - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder
- LargeBlob() - Constructor for class com.yubico.webauthn.data.Extensions.LargeBlob
- LargeBlobRegistrationInput(Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport) - Constructor for class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput
- LargeBlobSupport(String) - Constructor for class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
- lookup(ByteArray, ByteArray) - Method in interface com.yubico.webauthn.CredentialRepository
-
Look up the public key and stored signature count for the given credential registered to the given user.
- lookupAll(ByteArray) - Method in interface com.yubico.webauthn.CredentialRepository
-
Look up all credentials with the given credential ID, regardless of what user they're registered to.
M
- MandatoryStages() - Constructor for class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder.MandatoryStages
- MandatoryStages() - Constructor for class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder.MandatoryStages
- MandatoryStages(PublicKeyCredential.PublicKeyCredentialBuilder<A, B>) - Constructor for class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages
- MATCHER_PROTECTION_ON_CHIP - Enum constant in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
-
This flag SHOULD be set if the authenticator's matcher is running on the chip.
- MATCHER_PROTECTION_SOFTWARE - Enum constant in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
-
This flag MUST be set if the authenticator's matcher is running in software.
- MATCHER_PROTECTION_TEE - Enum constant in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
-
This flag SHOULD be set if the authenticator's matcher is running inside the Trusted Execution Environment [TEE].
- MatcherProtectionType - Enum Class in com.yubico.webauthn.extension.uvm
-
The MATCHER_PROTECTION constants are flags in a bit field represented as a 16 bit long integer.
- merge(AssertionExtensionInputs) - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
-
Merge
other
intothis
. - merge(RegistrationExtensionInputs) - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
-
Merge
other
intothis
.
N
- name(String) - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder
-
The human-palatable name of the Relaying Party.
- name(String) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder
-
A human-palatable identifier for a user account.
- name(String) - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages.Step2
-
The human-palatable name of the Relaying Party.
- name(String) - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages
-
name
is a required parameter. - NFC - Static variable in class com.yubico.webauthn.data.AuthenticatorTransport
-
Indicates the respective authenticator can be contacted over Near Field Communication (NFC).
- NONE - Enum constant in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
Indicates that the Relying Party is not interested in authenticator attestation.
- NONE - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In this case, no attestation information is available.
O
- of(String) - Static method in class com.yubico.webauthn.data.AuthenticatorTransport
- origins(Set<String>) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The allowed origins that returned authenticator responses will be compared against.
P
- parseAssertionResponseJson(String) - Static method in class com.yubico.webauthn.data.PublicKeyCredential
-
Parse a
PublicKeyCredential
object from JSON. - parseRegistrationResponseJson(String) - Static method in class com.yubico.webauthn.data.PublicKeyCredential
-
Parse a
PublicKeyCredential
object from JSON. - PLATFORM - Enum constant in enum class com.yubico.webauthn.data.AuthenticatorAttachment
-
Indicates platform attachment.
- policyTreeValidator(Predicate<PolicyNode>) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
-
If non-null, the PolicyQualifiersRejected flag will be set to false during certificate path validation.
- PREFERRED - Enum constant in enum class com.yubico.webauthn.data.ResidentKeyRequirement
-
The client and authenticator will try to create a discoverable credential (passkey) if possible, and a server-side credential otherwise.
- PREFERRED - Enum constant in enum class com.yubico.webauthn.data.UserVerificationRequirement
-
This value indicates that the Relying Party prefers user verification for the operation if possible, but will not fail the operation if the response does not have the
AuthenticatorDataFlags.UV
flag set. - PREFERRED - Static variable in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
-
If the authenticator used for registration supports the
largeBlob
extension, it will be enabled for the created credential. - preferredPubkeyParams(List<PublicKeyCredentialParameters>) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
The argument for the
pubKeyCredParams
parameter in registration operations. - present(ByteArray) - Static method in class com.yubico.webauthn.data.TokenBindingInfo
- PRESENT - Enum constant in enum class com.yubico.webauthn.data.TokenBindingStatus
-
Indicates token binding was used when communicating with the Relying Party.
- PROPOSED_RECOMMENDATION - Enum constant in enum class com.yubico.webauthn.meta.DocumentStatus
-
A proposed recommendation is a finished draft intended for release.
- pubKeyCredParams(List<PublicKeyCredentialParameters>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Information about the desired properties of the credential to be created.
- pubKeyCredParams(List<PublicKeyCredentialParameters>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step4
-
pubKeyCredParams
is a required parameter. - PUBLIC_KEY - Enum constant in enum class com.yubico.webauthn.data.PublicKeyCredentialType
- publicKeyCose(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
The credential public key encoded in COSE_Key format, as defined in Section 7 of RFC 8152.
- publicKeyCose(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step3
-
publicKeyCose
is a required parameter. - PublicKeyCredential<A extends AuthenticatorResponse,
B extends ClientExtensionOutputs> - Class in com.yubico.webauthn.data -
The PublicKeyCredential interface inherits from Credential [CREDENTIAL-MANAGEMENT-1], and contains the attributes that are returned to the caller when a new credential is created, or a new assertion is requested.
- PublicKeyCredential.PublicKeyCredentialBuilder<A extends AuthenticatorResponse,
B extends ClientExtensionOutputs> - Class in com.yubico.webauthn.data - PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step3 - Class in com.yubico.webauthn.data
- PublicKeyCredentialCreationOptions - Class in com.yubico.webauthn.data
-
Parameters for a call to
navigator.credentials.create()
. - PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder - Class in com.yubico.webauthn.data
- PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step3 - Class in com.yubico.webauthn.data
- PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step4 - Class in com.yubico.webauthn.data
- PublicKeyCredentialDescriptor - Class in com.yubico.webauthn.data
-
The attributes that are specified by a caller when referring to a public key credential as an input parameter to the
navigator.credentials.create()
ornavigator.credentials.get()
methods. - PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder - Class in com.yubico.webauthn.data
- PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- PublicKeyCredentialEntity - Interface in com.yubico.webauthn.data
-
Describes a user account, or a WebAuthn Relying Party, which a public key credential is associated with or scoped to, respectively.
- PublicKeyCredentialParameters - Class in com.yubico.webauthn.data
-
Used to supply additional parameters when creating a new credential.
- PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder - Class in com.yubico.webauthn.data
- PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- publicKeyCredentialRequestOptions(PublicKeyCredentialRequestOptions) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
-
An object that can be serialized to JSON and passed as the
publicKey
argument tonavigator.credentials.get()
. - publicKeyCredentialRequestOptions(PublicKeyCredentialRequestOptions) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder.MandatoryStages
-
publicKeyCredentialRequestOptions
is a required parameter. - PublicKeyCredentialRequestOptions - Class in com.yubico.webauthn.data
-
The PublicKeyCredentialRequestOptions dictionary supplies get() with the data it needs to generate an assertion.
- PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder - Class in com.yubico.webauthn.data
- PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- PublicKeyCredentialType - Enum Class in com.yubico.webauthn.data
-
Defines the valid credential types.
- publicKeyEs256Raw(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step3
-
Specify the credential public key in U2F format.
- publicKeyEs256Raw(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
Specify the credential public key in U2F format.
R
- read() - Static method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
-
Configure the Large blob storage extension (
largeBlob
) to fetch the previously-written blob associated with the asserted credential. - RECOMMENDATION - Enum constant in enum class com.yubico.webauthn.meta.DocumentStatus
-
A recommendation is a finished and released specification.
- RegisteredCredential - Class in com.yubico.webauthn
-
An abstraction of a credential registered to a particular user.
- RegisteredCredential.RegisteredCredentialBuilder - Class in com.yubico.webauthn
- RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages - Class in com.yubico.webauthn
- RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn
- RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step3 - Class in com.yubico.webauthn
- RegistrationExtensionInputs - Class in com.yubico.webauthn.data
-
Contains client extension inputs to a
navigator.credentials.create()
operation. - RegistrationExtensionInputs.RegistrationExtensionInputsBuilder - Class in com.yubico.webauthn.data
- RegistrationFailedException - Exception in com.yubico.webauthn.exception
- RegistrationFailedException(IllegalArgumentException) - Constructor for exception com.yubico.webauthn.exception.RegistrationFailedException
- RegistrationResult - Class in com.yubico.webauthn
-
The result of a call to
RelyingParty.finishRegistration(FinishRegistrationOptions)
. - RelyingParty - Class in com.yubico.webauthn
-
Encapsulates the four basic Web Authentication operations - start/finish registration, start/finish authentication - along with overall operational settings for them.
- RelyingParty.RelyingPartyBuilder - Class in com.yubico.webauthn
- RelyingParty.RelyingPartyBuilder.MandatoryStages - Class in com.yubico.webauthn
- RelyingParty.RelyingPartyBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn
- RelyingPartyIdentity - Class in com.yubico.webauthn.data
-
Used to supply additional Relying Party attributes when creating a new credential.
- RelyingPartyIdentity.RelyingPartyIdentityBuilder - Class in com.yubico.webauthn.data
- RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- request(AssertionRequest) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
-
The request that the
response
is a response to. - request(PublicKeyCredentialCreationOptions) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
-
The request that the
response
is a response to. - request(AssertionRequest) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages
-
request
is a required parameter. - request(PublicKeyCredentialCreationOptions) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages
-
request
is a required parameter. - REQUIRED - Enum constant in enum class com.yubico.webauthn.data.ResidentKeyRequirement
-
The client and authenticator will try to create a discoverable credential (passkey), and fail the registration if that is not possible.
- REQUIRED - Enum constant in enum class com.yubico.webauthn.data.UserVerificationRequirement
-
Indicates that the Relying Party requires user verification for the operation and will fail the operation if the response does not have the
AuthenticatorDataFlags.UV
flag set. - REQUIRED - Static variable in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
-
The authenticator used for registration MUST support the
largeBlob
extension. - residentKey(ResidentKeyRequirement) - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
-
Specifies the extent to which the Relying Party desires to create a client-side discoverable credential (passkey).
- ResidentKeyRequirement - Enum Class in com.yubico.webauthn.data
-
This enumeration's values describe the Relying Party's requirements for client-side discoverable credentials, also known as passkeys (formerly known as resident credentials or resident keys).
- response(PublicKeyCredential<AuthenticatorAssertionResponse, ClientAssertionExtensionOutputs>) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
-
The client's response to the
request
. - response(PublicKeyCredential<AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs>) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
-
The client's response to the
request
. - response(A) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step2
-
response
is a required parameter. - response(A) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
-
The authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion.
- response(PublicKeyCredential<AuthenticatorAssertionResponse, ClientAssertionExtensionOutputs>) - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages.Step2
-
response
is a required parameter. - response(PublicKeyCredential<AuthenticatorAttestationResponse, ClientRegistrationExtensionOutputs>) - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages.Step2
-
response
is a required parameter. - rp(RelyingPartyIdentity) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Contains data about the Relying Party responsible for the request.
- rp(RelyingPartyIdentity) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages
-
rp
is a required parameter. - rpId(Optional<String>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Specifies the relying party identifier claimed by the caller.
- rpId(String) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Specifies the relying party identifier claimed by the caller.
- RS1 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- RS1 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.RS1
and typePublicKeyCredentialType.PUBLIC_KEY
. - RS256 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- RS256 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.RS256
and typePublicKeyCredentialType.PUBLIC_KEY
. - RS384 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- RS384 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.RS384
and typePublicKeyCredentialType.PUBLIC_KEY
. - RS512 - Enum constant in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
- RS512 - Static variable in class com.yubico.webauthn.data.PublicKeyCredentialParameters
-
Algorithm
COSEAlgorithmIdentifier.RS512
and typePublicKeyCredentialType.PUBLIC_KEY
.
S
- SELF_ATTESTATION - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In the case of self attestation, also known as surrogate basic attestation, the authenticator does not have any specific attestation key.
- signature(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
- signature(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step3
-
signature
is a required parameter. - signatureCount(long) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
The stored signature count of the credential.
- size() - Method in class com.yubico.webauthn.data.ByteArray
- Specification - Class in com.yubico.webauthn.meta
-
Reference to a particular version of a specification document.
- startAssertion(StartAssertionOptions) - Method in class com.yubico.webauthn.RelyingParty
- StartAssertionOptions - Class in com.yubico.webauthn
-
Parameters for
RelyingParty.startAssertion(StartAssertionOptions)
. - StartAssertionOptions.StartAssertionOptionsBuilder - Class in com.yubico.webauthn
- startRegistration(StartRegistrationOptions) - Method in class com.yubico.webauthn.RelyingParty
- StartRegistrationOptions - Class in com.yubico.webauthn
-
Parameters for
RelyingParty.startRegistration(StartRegistrationOptions)
. - StartRegistrationOptions.StartRegistrationOptionsBuilder - Class in com.yubico.webauthn
- StartRegistrationOptions.StartRegistrationOptionsBuilder.MandatoryStages - Class in com.yubico.webauthn
- Step1() - Constructor for class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder.Step1
- Step2() - Constructor for class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step2
- Step2() - Constructor for class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder.MandatoryStages.Step2
- Step3() - Constructor for class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder.MandatoryStages.Step3
- Step3() - Constructor for class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages.Step3
- Step3() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step3
- Step3() - Constructor for class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder.MandatoryStages.Step3
- Step3() - Constructor for class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step3
- Step4() - Constructor for class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step4
- supported() - Static method in class com.yubico.webauthn.data.TokenBindingInfo
- SUPPORTED - Enum constant in enum class com.yubico.webauthn.data.TokenBindingStatus
-
Indicates the client supports token binding, but it was not negotiated when communicating with the Relying Party.
T
- timeout(long) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
A time, in milliseconds, that the caller is willing to wait for the call to complete.
- timeout(long) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
- timeout(long) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The value for
PublicKeyCredentialRequestOptions.getTimeout()
for this authentication operation. - timeout(long) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
The value for
PublicKeyCredentialCreationOptions.getTimeout()
for this registration operation. - timeout(Optional<Long>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
A time, in milliseconds, that the caller is willing to wait for the call to complete.
- timeout(Optional<Long>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Specifies a time, in milliseconds, that the caller is willing to wait for the call to complete.
- timeout(Optional<Long>) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The value for
PublicKeyCredentialRequestOptions.getTimeout()
for this authentication operation. - timeout(Optional<Long>) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
The value for
PublicKeyCredentialCreationOptions.getTimeout()
for this registration operation. - toBuilder() - Method in class com.yubico.webauthn.AssertionRequest
- toBuilder() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
- toBuilder() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- toBuilder() - Method in class com.yubico.webauthn.data.AttestedCredentialData
- toBuilder() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- toBuilder() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- toBuilder() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- toBuilder() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- toBuilder() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
- toBuilder() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- toBuilder() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- toBuilder() - Method in class com.yubico.webauthn.data.PublicKeyCredential
- toBuilder() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- toBuilder() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- toBuilder() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
- toBuilder() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- toBuilder() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- toBuilder() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
- toBuilder() - Method in class com.yubico.webauthn.data.UserIdentity
- toBuilder() - Method in class com.yubico.webauthn.FinishAssertionOptions
- toBuilder() - Method in class com.yubico.webauthn.FinishRegistrationOptions
- toBuilder() - Method in class com.yubico.webauthn.RegisteredCredential
- toBuilder() - Method in class com.yubico.webauthn.RelyingParty
- toBuilder() - Method in class com.yubico.webauthn.StartAssertionOptions
- toBuilder() - Method in class com.yubico.webauthn.StartRegistrationOptions
- toCredentialsCreateJson() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Serialize this
PublicKeyCredentialCreationOptions
value to JSON suitable for sending to the client. - toCredentialsGetJson() - Method in class com.yubico.webauthn.AssertionRequest
-
Serialize this
AssertionRequest
value to JSON suitable for sending to the client. - toCredentialsGetJson() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
-
Serialize this
PublicKeyCredentialRequestOptions
value to JSON suitable for sending to the client. - toJson() - Method in class com.yubico.webauthn.AssertionRequest
-
Encode this
AssertionRequest
to JSON. - toJson() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
-
Encode this
PublicKeyCredentialCreationOptions
to JSON. - TokenBindingInfo - Class in com.yubico.webauthn.data
-
Information about the state of the Token Binding protocol used when communicating with the Relying Party.
- TokenBindingStatus - Enum Class in com.yubico.webauthn.data
-
Indicators of whether a
TokenBindingInfo
'sid
member is present and, if not, whether the client supports token binding. - toString() - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
- toString() - Method in class com.yubico.webauthn.AssertionRequest
- toString() - Method in class com.yubico.webauthn.AssertionResult
- toString() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult
- toString() - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
- toString() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
- toString() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs
- toString() - Method in class com.yubico.webauthn.data.AttestationObject
- toString() - Method in class com.yubico.webauthn.data.AttestedCredentialData
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs.AuthenticatorAssertionExtensionOutputsBuilder
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorData
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorDataFlags
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria
- toString() - Method in class com.yubico.webauthn.data.AuthenticatorTransport
- toString() - Method in class com.yubico.webauthn.data.ByteArray
- toString() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs.ClientAssertionExtensionOutputsBuilder
- toString() - Method in class com.yubico.webauthn.data.ClientAssertionExtensionOutputs
- toString() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs.ClientRegistrationExtensionOutputsBuilder
- toString() - Method in class com.yubico.webauthn.data.ClientRegistrationExtensionOutputs
- toString() - Method in class com.yubico.webauthn.data.CollectedClientData
- toString() - Method in class com.yubico.webauthn.data.Extensions.CredentialProperties.CredentialPropertiesOutput
- toString() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
- toString() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationOutput
- toString() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
- toString() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput
- toString() - Method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationOutput
- toString() - Method in class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredential
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
- toString() - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions
- toString() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
- toString() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs
- toString() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity.RelyingPartyIdentityBuilder
- toString() - Method in class com.yubico.webauthn.data.RelyingPartyIdentity
- toString() - Method in class com.yubico.webauthn.data.TokenBindingInfo
- toString() - Method in class com.yubico.webauthn.data.UserIdentity
- toString() - Method in class com.yubico.webauthn.data.UserIdentity.UserIdentityBuilder
- toString() - Method in exception com.yubico.webauthn.exception.InvalidSignatureCountException
- toString() - Method in class com.yubico.webauthn.extension.appid.AppId
- toString() - Method in class com.yubico.webauthn.FinishAssertionOptions.FinishAssertionOptionsBuilder
- toString() - Method in class com.yubico.webauthn.FinishAssertionOptions
- toString() - Method in class com.yubico.webauthn.FinishRegistrationOptions.FinishRegistrationOptionsBuilder
- toString() - Method in class com.yubico.webauthn.FinishRegistrationOptions
- toString() - Method in class com.yubico.webauthn.meta.Implementation
- toString() - Method in class com.yubico.webauthn.meta.Specification
- toString() - Method in class com.yubico.webauthn.meta.VersionInfo
- toString() - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
- toString() - Method in class com.yubico.webauthn.RegisteredCredential
- toString() - Method in class com.yubico.webauthn.RegistrationResult
- toString() - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
- toString() - Method in class com.yubico.webauthn.RelyingParty
- toString() - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
- toString() - Method in class com.yubico.webauthn.StartAssertionOptions
- toString() - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
- toString() - Method in class com.yubico.webauthn.StartRegistrationOptions
- transports(Optional<Set<AuthenticatorTransport>>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
-
An OPTIONAL hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to.
- transports(Set<AuthenticatorTransport>) - Method in class com.yubico.webauthn.data.AuthenticatorAttestationResponse.AuthenticatorAttestationResponseBuilder
- transports(Set<AuthenticatorTransport>) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
-
An OPTIONAL hint as to how the client might communicate with the managing authenticator of the public key credential the caller is referring to.
- trustRoots(Set<X509Certificate>) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder.Step1
-
A set of attestation root certificates trusted to certify the relevant attestation statement.
- trustRoots(Set<X509Certificate>) - Method in class com.yubico.webauthn.attestation.AttestationTrustSource.TrustRootsResult.TrustRootsResultBuilder
-
A set of attestation root certificates trusted to certify the relevant attestation statement.
- type(PublicKeyCredentialType) - Method in class com.yubico.webauthn.data.PublicKeyCredential.PublicKeyCredentialBuilder
-
The
PublicKeyCredential
's type value is the string "public-key". - type(PublicKeyCredentialType) - Method in class com.yubico.webauthn.data.PublicKeyCredentialDescriptor.PublicKeyCredentialDescriptorBuilder
-
The type of the credential the caller is referring to.
- type(PublicKeyCredentialType) - Method in class com.yubico.webauthn.data.PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder
-
Specifies the type of credential to be created.
U
- UNKNOWN - Enum constant in enum class com.yubico.webauthn.data.AttestationType
-
In this case, attestation information is present but was not understood by the library.
- UP - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
User present
- USB - Static variable in class com.yubico.webauthn.data.AuthenticatorTransport
-
Indicates the respective authenticator can be contacted over removable USB.
- user(UserIdentity) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder
-
Contains data about the user account for which the Relying Party is requesting attestation.
- user(UserIdentity) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder
-
Identifiers for the user creating a credential.
- user(UserIdentity) - Method in class com.yubico.webauthn.data.PublicKeyCredentialCreationOptions.PublicKeyCredentialCreationOptionsBuilder.MandatoryStages.Step2
-
user
is a required parameter. - user(UserIdentity) - Method in class com.yubico.webauthn.StartRegistrationOptions.StartRegistrationOptionsBuilder.MandatoryStages
-
user
is a required parameter. - USER_VERIFY_ALL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
If an authenticator sets multiple flags for the "_INTERNAL" and/or "_EXTERNAL" user verification types, it MAY also set this flag to indicate that all verification methods with respective flags set will be enforced (e.g.
- USER_VERIFY_EYEPRINT_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses any form of eye biometrics for user verification.
- USER_VERIFY_FACEPRINT_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses any manner of face recognition to verify the user.
- USER_VERIFY_FINGERPRINT_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses any type of measurement of a fingerprint for user verification.
- USER_VERIFY_HANDPRINT_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses any measurement of a full hand (including palm-print, hand geometry or vein geometry) for user verification.
- USER_VERIFY_LOCATION_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses any form of location sensor or measurement for user verification.
- USER_VERIFY_NONE - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator will respond without any user interaction (e.g.
- USER_VERIFY_PASSCODE_EXTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses a local-only passcode (i.e.
- USER_VERIFY_PASSCODE_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses a local-only passcode (i.e.
- USER_VERIFY_PATTERN_EXTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses a drawn pattern for user verification that might be gathered outside the authenticator boundary.
- USER_VERIFY_PATTERN_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses a drawn pattern for user verification.
- USER_VERIFY_PRESENCE_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator is able to confirm user presence in any fashion.
- USER_VERIFY_VOICEPRINT_INTERNAL - Enum constant in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
This flag MUST be set if the authenticator uses a voiceprint (also known as speaker recognition) for user verification.
- userHandle(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder
-
The user handle of the user the credential is registered to.
- userHandle(Optional<ByteArray>) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
-
The user handle of the user to authenticate, if the user has already been identified.
- userHandle(Optional<ByteArray>) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
-
The user handle returned from the authenticator, or empty if the authenticator did not return a user handle.
- userHandle(Optional<ByteArray>) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The user handle of the user to authenticate, if the user has already been identified.
- userHandle(ByteArray) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
-
The user handle of the user to authenticate, if the user has already been identified.
- userHandle(ByteArray) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionResponse.AuthenticatorAssertionResponseBuilder
-
The user handle returned from the authenticator, or empty if the authenticator did not return a user handle.
- userHandle(ByteArray) - Method in class com.yubico.webauthn.RegisteredCredential.RegisteredCredentialBuilder.MandatoryStages.Step2
-
userHandle
is a required parameter. - userHandle(ByteArray) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The user handle of the user to authenticate, if the user has already been identified.
- UserIdentity - Class in com.yubico.webauthn.data
-
Describes a user account, with which public key credentials can be associated.
- UserIdentity.UserIdentityBuilder - Class in com.yubico.webauthn.data
- UserIdentity.UserIdentityBuilder.MandatoryStages - Class in com.yubico.webauthn.data
- UserIdentity.UserIdentityBuilder.MandatoryStages.Step2 - Class in com.yubico.webauthn.data
- UserIdentity.UserIdentityBuilder.MandatoryStages.Step3 - Class in com.yubico.webauthn.data
- username(Optional<String>) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
-
The username of the user to authenticate, if the user has already been identified.
- username(Optional<String>) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The username of the user to authenticate, if the user has already been identified.
- username(String) - Method in class com.yubico.webauthn.AssertionRequest.AssertionRequestBuilder
-
The username of the user to authenticate, if the user has already been identified.
- username(String) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The username of the user to authenticate, if the user has already been identified.
- userVerification(Optional<UserVerificationRequirement>) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The value for
PublicKeyCredentialRequestOptions.getUserVerification()
for this authentication operation. - userVerification(UserVerificationRequirement) - Method in class com.yubico.webauthn.data.AuthenticatorSelectionCriteria.AuthenticatorSelectionCriteriaBuilder
-
Describes the Relying Party's requirements regarding user verification for the
navigator.credentials.create()
operation. - userVerification(UserVerificationRequirement) - Method in class com.yubico.webauthn.data.PublicKeyCredentialRequestOptions.PublicKeyCredentialRequestOptionsBuilder
-
Describes the Relying Party's requirements regarding user verification for the
navigator.credentials.get()
operation. - userVerification(UserVerificationRequirement) - Method in class com.yubico.webauthn.StartAssertionOptions.StartAssertionOptionsBuilder
-
The value for
PublicKeyCredentialRequestOptions.getUserVerification()
for this authentication operation. - UserVerificationMethod - Enum Class in com.yubico.webauthn.extension.uvm
-
The USER_VERIFY constants are flags in a bitfield represented as a 32 bit long integer.
- UserVerificationRequirement - Enum Class in com.yubico.webauthn.data
-
A WebAuthn Relying Party may require user verification for some of its operations but not for others, and may use this type to express its needs.
- UV - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
-
User verified
- uvm() - Method in class com.yubico.webauthn.data.AssertionExtensionInputs.AssertionExtensionInputsBuilder
-
Enable the User Verification Method Extension (
uvm
). - uvm() - Method in class com.yubico.webauthn.data.RegistrationExtensionInputs.RegistrationExtensionInputsBuilder
-
Enable the User Verification Method Extension (
uvm
). - uvm(List<Extensions.Uvm.UvmEntry>) - Method in class com.yubico.webauthn.data.AuthenticatorAssertionExtensionOutputs.AuthenticatorAssertionExtensionOutputsBuilder
- uvm(List<Extensions.Uvm.UvmEntry>) - Method in class com.yubico.webauthn.data.AuthenticatorRegistrationExtensionOutputs.AuthenticatorRegistrationExtensionOutputsBuilder
- Uvm() - Constructor for class com.yubico.webauthn.data.Extensions.Uvm
- UvmEntry(UserVerificationMethod, KeyProtectionType, MatcherProtectionType) - Constructor for class com.yubico.webauthn.data.Extensions.Uvm.UvmEntry
V
- validateSignatureCounter(boolean) - Method in class com.yubico.webauthn.RelyingParty.RelyingPartyBuilder
-
If
true
,finishAssertion
will succeed only if thesignature counter value
in the response is strictly greater than thestored signature counter value
, or if both counters are exactly zero. - value - Variable in class com.yubico.webauthn.data.AuthenticatorDataFlags
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.AttestationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.AuthenticatorAttachment
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in class com.yubico.webauthn.data.AuthenticatorTransport
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.PublicKeyCredentialType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.ResidentKeyRequirement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.TokenBindingStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.data.UserVerificationRequirement
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.yubico.webauthn.meta.DocumentStatus
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.yubico.webauthn.data.AttestationConveyancePreference
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.data.AttestationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.data.AuthenticatorAttachment
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in class com.yubico.webauthn.data.AuthenticatorTransport
- values() - Static method in enum class com.yubico.webauthn.data.COSEAlgorithmIdentifier
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport
-
Returns a new
Set
containing theExtensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport.REQUIRED
andExtensions.LargeBlob.LargeBlobRegistrationInput.LargeBlobSupport.PREFERRED
values. - values() - Static method in enum class com.yubico.webauthn.data.PublicKeyCredentialType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.data.ResidentKeyRequirement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.data.TokenBindingStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.data.UserVerificationRequirement
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.extension.uvm.KeyProtectionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.extension.uvm.MatcherProtectionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.extension.uvm.UserVerificationMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.yubico.webauthn.meta.DocumentStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VersionInfo - Class in com.yubico.webauthn.meta
-
Contains version information for the com.yubico.webauthn package.
W
- WORKING_DRAFT - Enum constant in enum class com.yubico.webauthn.meta.DocumentStatus
-
A working draft is a named snapshot of a particular state of an editor's draft.
- write(ByteArray) - Static method in class com.yubico.webauthn.data.Extensions.LargeBlob.LargeBlobAuthenticationInput
-
Configure the Large blob storage extension (
largeBlob
) to store the given byte array with the existing credential.
All Classes and Interfaces|All Packages|Serialized Form