com.yubico.webauthn.data

Class PublicKeyCredential<A extends AuthenticatorResponse,B extends ClientExtensionOutputs>

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredential<A,B>

public final class PublicKeyCredential<A extends AuthenticatorResponse,B extends ClientExtensionOutputs>
extends java.lang.Object

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.

See Also:

§5.1. PublicKeyCredential Interface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PublicKeyCredential.PublicKeyCredentialBuilder<A extends AuthenticatorResponse,B extends ClientExtensionOutputs>

Method Summary

Modifier and Type	Method and Description
static <A extends AuthenticatorResponse,B extends ClientExtensionOutputs> PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages	builder()
boolean	equals(java.lang.Object o)
java.util.Optional<AuthenticatorAttachment>	getAuthenticatorAttachment() Deprecated. EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.
B	getClientExtensionResults() A map containing extension identifier → client extension output entries produced by the extension’s client extension processing.
@NonNull ByteArray	getId() The raw Credential ID of this credential, corresponding to the rawId attribute in the WebAuthn API.
A	getResponse() The authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion.
@NonNull PublicKeyCredentialType	getType() The PublicKeyCredential's type value is the string "public-key".
int	hashCode()
static PublicKeyCredential<AuthenticatorAssertionResponse,ClientAssertionExtensionOutputs>	parseAssertionResponseJson(java.lang.String json) Parse a PublicKeyCredential object from JSON.
static PublicKeyCredential<AuthenticatorAttestationResponse,ClientRegistrationExtensionOutputs>	parseRegistrationResponseJson(java.lang.String json) Parse a PublicKeyCredential object from JSON.
PublicKeyCredential.PublicKeyCredentialBuilder<A,B>	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getAuthenticatorAttachment

@Deprecated
public java.util.Optional<AuthenticatorAttachment> getAuthenticatorAttachment()

Deprecated. EXPERIMENTAL: This feature is from a not yet mature standard; it could change as the standard matures.

The authenticator attachment modality in effect at the time the credential was created or used.

If parsed from JSON, this will be present if and only if the input was a valid value of AuthenticatorAttachment.

The same value will also be available via RegistrationResult.getAuthenticatorAttachment() or AssertionResult.getAuthenticatorAttachment() on the result from RelyingParty.finishRegistration(FinishRegistrationOptions) or RelyingParty.finishAssertion(FinishAssertionOptions).

See Also:

RegistrationResult.getAuthenticatorAttachment(), AssertionResult.getAuthenticatorAttachment()

builder

public static <A extends AuthenticatorResponse,B extends ClientExtensionOutputs> PublicKeyCredential.PublicKeyCredentialBuilder.MandatoryStages builder()

parseRegistrationResponseJson

public static PublicKeyCredential<AuthenticatorAttestationResponse,ClientRegistrationExtensionOutputs> parseRegistrationResponseJson(java.lang.String json)
                                                                                                                              throws java.io.IOException

Parse a PublicKeyCredential object from JSON.

The json should be of the following format:

 {
   "id": "(resp.id)",
   "response": {
     "attestationObject": "(Base64Url encoded resp.attestationObject)",
     "clientDataJSON": "(Base64Url encoded resp.clientDataJSON)"
   },
   "clientExtensionResults": { (resp.getClientExtensionResults()) },
   "type": "public-key"
 }
 

resp:

The PublicKeyCredential object returned from a registration ceremony.

id:

The string value of resp.id

response.attestationObject:

The value of resp.attestationObject, Base64Url encoded as a string

response.clientDataJSON:

The value of resp.clientDataJSON, Base64Url encoded as a string

clientExtensionResults:

The return value of resp.getClientExtensionResults()

type:

The literal string value "public-key"

Parameters:

json - a JSON string of the above format

Throws:

java.io.IOException - if the json is invalid or cannot be decoded as a PublicKeyCredential

parseAssertionResponseJson

public static PublicKeyCredential<AuthenticatorAssertionResponse,ClientAssertionExtensionOutputs> parseAssertionResponseJson(java.lang.String json)
                                                                                                                      throws java.io.IOException

Parse a PublicKeyCredential object from JSON.

The json should be of the following format:

 {
   "id": "(resp.id)",
   "response": {
     "authenticatorData": "(Base64Url encoded resp.authenticatorData)",
     "signature": "(Base64Url encoded resp.signature)",
     "clientDataJSON": "(Base64Url encoded resp.clientDataJSON)",
     "userHandle": "(null, undefined or Base64Url encoded resp.userHandle)"
   },
   "clientExtensionResults": { (resp.getClientExtensionResults()) },
   "type": "public-key"
 }
 

resp:

The PublicKeyCredential object returned from an authentication ceremony.

id:

The string value of resp.id

response.authenticatorData:

The value of resp.authenticatorData, Base64Url encoded as a string

response.signature:

The value of resp.signature, Base64Url encoded as a string

response.clientDataJSON:

The value of resp.clientDataJSON, Base64Url encoded as a string

response.userHandle:

The value of resp.userHandle Base64Url encoded as a string if present, otherwise null or undefined

clientExtensionResults:

The return value of resp.getClientExtensionResults()

type:

The literal string value "public-key"

Parameters:

json - a JSON string of the above format

Throws:

java.io.IOException - if the json is invalid or cannot be decoded as a PublicKeyCredential

toBuilder

public PublicKeyCredential.PublicKeyCredentialBuilder<A,B> toBuilder()

getId

@NonNull
public @NonNull ByteArray getId()

The raw Credential ID of this credential, corresponding to the rawId attribute in the WebAuthn API.

getResponse

@NonNull
public A getResponse()

The authenticator's response to the client’s request to either create a public key credential, or generate an authentication assertion.

If the PublicKeyCredential was created in response to navigator.credentials.create(), this attribute’s value will be an AuthenticatorAttestationResponse, otherwise, the PublicKeyCredential was created in response to navigator.credentials.get(), and this attribute’s value will be an AuthenticatorAssertionResponse.

getClientExtensionResults

@NonNull
public B getClientExtensionResults()

A map containing extension identifier → client extension output entries produced by the extension’s client extension processing.

getType

@NonNull
public @NonNull PublicKeyCredentialType getType()

The PublicKeyCredential's type value is the string "public-key".

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object