Package com.yubico.webauthn.data

Class PublicKeyCredentialParameters

java.lang.Object

com.yubico.webauthn.data.PublicKeyCredentialParameters

public final class PublicKeyCredentialParameters
extends Object

Used to supply additional parameters when creating a new credential.

Since:

0.2.0

See Also:

• §5.3. Parameters for Credential Generation (dictionary PublicKeyCredentialParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static final PublicKeyCredentialParameters	Ed448	Algorithm COSEAlgorithmIdentifier.Ed448 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	EdDSA	Algorithm COSEAlgorithmIdentifier.EdDSA and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	ES256	Algorithm COSEAlgorithmIdentifier.ES256 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	ES384	Algorithm COSEAlgorithmIdentifier.ES384 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	ES512	Algorithm COSEAlgorithmIdentifier.ES512 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	RS1	Algorithm COSEAlgorithmIdentifier.RS1 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	RS256	Algorithm COSEAlgorithmIdentifier.RS256 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	RS384	Algorithm COSEAlgorithmIdentifier.RS384 and type PublicKeyCredentialType.PUBLIC_KEY.
static final PublicKeyCredentialParameters	RS512	Algorithm COSEAlgorithmIdentifier.RS512 and type PublicKeyCredentialType.PUBLIC_KEY.

Method Summary

Modifier and Type	Method	Description
static PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder.MandatoryStages	builder()
boolean	equals(Object o)
@NonNull COSEAlgorithmIdentifier	getAlg()	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.
@NonNull PublicKeyCredentialType	getType()	Specifies the type of credential to be created.
int	hashCode()
PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EdDSA

public static final PublicKeyCredentialParameters EdDSA

Algorithm COSEAlgorithmIdentifier.EdDSA and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

1.4.0

Ed448

public static final PublicKeyCredentialParameters Ed448

Algorithm COSEAlgorithmIdentifier.Ed448 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

2.8.0

ES256

public static final PublicKeyCredentialParameters ES256

Algorithm COSEAlgorithmIdentifier.ES256 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

0.3.0

ES384

public static final PublicKeyCredentialParameters ES384

Algorithm COSEAlgorithmIdentifier.ES384 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

2.1.0

ES512

public static final PublicKeyCredentialParameters ES512

Algorithm COSEAlgorithmIdentifier.ES512 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

2.1.0

RS1

public static final PublicKeyCredentialParameters RS1

Algorithm COSEAlgorithmIdentifier.RS1 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

1.5.0

RS256

public static final PublicKeyCredentialParameters RS256

Algorithm COSEAlgorithmIdentifier.RS256 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

0.3.0

RS384

public static final PublicKeyCredentialParameters RS384

Algorithm COSEAlgorithmIdentifier.RS384 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

2.4.0

RS512

public static final PublicKeyCredentialParameters RS512

Algorithm COSEAlgorithmIdentifier.RS512 and type PublicKeyCredentialType.PUBLIC_KEY.

Since:

2.4.0

Method Details

builder

public static PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder.MandatoryStages builder()

toBuilder

public PublicKeyCredentialParameters.PublicKeyCredentialParametersBuilder toBuilder()

getAlg

@NonNull
public @NonNull COSEAlgorithmIdentifier getAlg()

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.

Since:

0.2.0

getType

@NonNull
public @NonNull PublicKeyCredentialType getType()

Specifies the type of credential to be created.

Since:

0.2.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object