Package com.yubico.webauthn
Class RegistrationResult
- java.lang.Object
-
- com.yubico.webauthn.RegistrationResult
-
public final class RegistrationResult extends java.lang.Object
The result of a call toRelyingParty.finishRegistration(FinishRegistrationOptions)
.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
java.util.Optional<Attestation>
getAttestationMetadata()
@NonNull AttestationType
getAttestationType()
The attestation type §6.4.3.java.util.Optional<AuthenticatorRegistrationExtensionOutputs>
getAuthenticatorExtensionOutputs()
The authenticator extension outputs, if any.java.util.Optional<ClientRegistrationExtensionOutputs>
getClientExtensionOutputs()
The client extension outputs, if any.@NonNull PublicKeyCredentialDescriptor
getKeyId()
The credential ID and transportsof the created credential.@NonNull ByteArray
getPublicKeyCose()
The public key of the created credential.long
getSignatureCount()
The signature count returned with the created credential.@NonNull java.util.List<java.lang.String>
getWarnings()
Zero or more human-readable messages about non-critical issues.int
hashCode()
boolean
isAttestationTrusted()
true
if and only if the attestation signature was successfully linked to a trusted attestation root.java.util.Optional<java.lang.Boolean>
isDiscoverable()
Try to determine whether the created credential is a discoverable credential, using the output from thecredProps
extension.com.yubico.webauthn.RegistrationResult.RegistrationResultBuilder
toBuilder()
java.lang.String
toString()
-
-
-
Method Detail
-
getAttestationMetadata
public java.util.Optional<Attestation> getAttestationMetadata()
-
getClientExtensionOutputs
public java.util.Optional<ClientRegistrationExtensionOutputs> getClientExtensionOutputs()
The client extension outputs, if any.This is present if and only if at least one extension output is present in the return value.
-
getAuthenticatorExtensionOutputs
public java.util.Optional<AuthenticatorRegistrationExtensionOutputs> getAuthenticatorExtensionOutputs()
The authenticator extension outputs, if any.This is present if and only if at least one extension output is present in the return value.
-
isDiscoverable
public java.util.Optional<java.lang.Boolean> isDiscoverable()
Try to determine whether the created credential is a discoverable credential, using the output from thecredProps
extension.- Returns:
- A present
true
if the created credential is discoverable. A presentfalse
if the created credential is not discoverable. An empty value if it is not known whether the created credential is discoverable. - See Also:
- §10.4. Credential Properties Extension (credProps), "rk" output, Discoverable Credential
-
toBuilder
public com.yubico.webauthn.RegistrationResult.RegistrationResultBuilder toBuilder()
-
getKeyId
@NonNull public @NonNull PublicKeyCredentialDescriptor getKeyId()
The credential ID and transportsof the created credential.
-
isAttestationTrusted
public boolean isAttestationTrusted()
true
if and only if the attestation signature was successfully linked to a trusted attestation root.You can ignore this if authenticator attestation is not relevant to your application.
-
getAttestationType
@NonNull public @NonNull AttestationType getAttestationType()
The attestation type §6.4.3. Attestation Types that was used for the created credential.You can ignore this if authenticator attestation is not relevant to your application.
- See Also:
- §6.4.3. Attestation Types
-
getPublicKeyCose
@NonNull public @NonNull ByteArray getPublicKeyCose()
The public key of the created credential.This is used in
RelyingParty.finishAssertion(FinishAssertionOptions)
to verify the authentication signatures.- See Also:
RegisteredCredential.getPublicKeyCose()
-
getSignatureCount
public long getSignatureCount()
The signature count returned with the created credential.This is used in
RelyingParty.finishAssertion(FinishAssertionOptions)
to verify the validity of future signature counter values.- See Also:
()
-
getWarnings
@NonNull public @NonNull java.util.List<java.lang.String> getWarnings()
Zero or more human-readable messages about non-critical issues.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-