de.adesso.softauthn

Class PublicKeyCredentialSource

java.lang.Object

de.adesso.softauthn.PublicKeyCredentialSource

public class PublicKeyCredentialSource
extends java.lang.Object

A data class that stores information associated with a credential. This data is required to create assertions, as it contains the private key of the credential.

See Also:

Public Key Credential Source

Constructor Summary

Constructors

Constructor and Description
PublicKeyCredentialSource(com.yubico.webauthn.data.PublicKeyCredentialType type, COSE.OneKey privateKey, java.lang.String rpId, com.yubico.webauthn.data.ByteArray userHandle) Public constructor of this data class.

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<PublicKeyCredentialSource>	deserialize(com.yubico.webauthn.data.ByteArray credentialId) Deserialize the given byte array to reconstruct the credential source it represents.
com.yubico.webauthn.data.ByteArray	getId() Returns the credential id if set, otherwise null.
COSE.OneKey	getKey() See constructor for a description of this field.
java.lang.String	getRpId() See constructor for a description of this field.
com.yubico.webauthn.data.PublicKeyCredentialType	getType() See constructor for a description of this field.
com.yubico.webauthn.data.ByteArray	getUserHandle() See constructor for a description of this field.
byte[]	serialize() Encodes this credential source to a byte array so it can be encrypted and used as the credential id for server-side credential storage
void	setId(com.yubico.webauthn.data.ByteArray id) Set the credential ID, for example to the serialized version of this credential source itself for server-side credentials or a randomly generated byte array for client-side discoverable credentials.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PublicKeyCredentialSource

public PublicKeyCredentialSource(com.yubico.webauthn.data.PublicKeyCredentialType type,
                                 COSE.OneKey privateKey,
                                 java.lang.String rpId,
                                 com.yubico.webauthn.data.ByteArray userHandle)

Public constructor of this data class.

Note that the credential id must be set after creation.

Parameters:

type - Type of credential.

privateKey - The private key wrapped as a COSE OneKey.

rpId - The relying party identifier

userHandle - The user handle of the user this credential belongs to.

Method Detail

getType

public com.yubico.webauthn.data.PublicKeyCredentialType getType()

See constructor for a description of this field.

Returns:

credential type.

getKey

public COSE.OneKey getKey()

See constructor for a description of this field.

Returns:

the (private) key.

getRpId

public java.lang.String getRpId()

See constructor for a description of this field.

Returns:

relying party id.

getUserHandle

public com.yubico.webauthn.data.ByteArray getUserHandle()

See constructor for a description of this field.

Returns:

user handle.

serialize

public byte[] serialize()

Encodes this credential source to a byte array so it can be encrypted and used as the credential id for server-side credential storage

Returns:

this credential source serialized as a CBOR map. It can be deserialized again via deserialize(ByteArray).

See Also:

deserialize(ByteArray), Credential ID

deserialize

public static java.util.Optional<PublicKeyCredentialSource> deserialize(com.yubico.webauthn.data.ByteArray credentialId)

Deserialize the given byte array to reconstruct the credential source it represents.

Parameters:

credentialId - The byte array used as a credential id that encodes the credential source data.

Returns:

An optional containing the resulting credential source if the byte array is indeed a serialized credential source, or the empty optional if no credential source can be constructed from the information in the byte array.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getId

public com.yubico.webauthn.data.ByteArray getId()

Returns the credential id if set, otherwise null.

Returns:

the credential ID of this credential source.

setId

public void setId(com.yubico.webauthn.data.ByteArray id)

Set the credential ID, for example to the serialized version of this credential source itself for server-side credentials or a randomly generated byte array for client-side discoverable credentials.

Parameters:

id - The id to set.

See Also:

Credential ID