Package com.yubico.webauthn.data

Enum Class COSEAlgorithmIdentifier

java.lang.Object

java.lang.Enum<COSEAlgorithmIdentifier>

com.yubico.webauthn.data.COSEAlgorithmIdentifier

All Implemented Interfaces:

Serializable, Comparable<COSEAlgorithmIdentifier>, Constable

public enum COSEAlgorithmIdentifier
extends Enum<COSEAlgorithmIdentifier>

A number identifying a cryptographic algorithm. The algorithm identifiers SHOULD be values registered in the IANA COSE Algorithms registry, for instance, -7 for "ES256" and -257 for "RS256".

Since:

0.3.0

See Also:

• §5.10.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Ed25519	The signature scheme Ed25519 as defined in RFC 8032.
Ed448	The signature scheme Ed448 as defined in RFC 8032.
EdDSA	The signature scheme Ed25519 as defined in RFC 8032.
ES256	ECDSA with SHA-256 on the NIST P-256 curve.
ES384	ECDSA with SHA-384 on the NIST P-384 curve.
ES512	ECDSA with SHA-512 on the NIST P-521 curve.
RS1	RSASSA-PKCS1-v1_5 using SHA-1.
RS256	RSASSA-PKCS1-v1_5 using SHA-256.
RS384	RSASSA-PKCS1-v1_5 using SHA-384.
RS512	RSASSA-PKCS1-v1_5 using SHA-512.

Method Summary

Modifier and Type	Method	Description
static Optional<COSEAlgorithmIdentifier>	fromId(long id)	Attempt to parse an integer as a COSEAlgorithmIdentifier.
static Optional<COSEAlgorithmIdentifier>	fromPublicKey(@NonNull ByteArray publicKeyCose)	Read the COSEAlgorithmIdentifier from a public key in COSE_Key format.
long	getId()
static COSEAlgorithmIdentifier	valueOf(String name)	Returns the enum constant of this class with the specified name.
static COSEAlgorithmIdentifier[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EdDSA

public static final COSEAlgorithmIdentifier EdDSA

The signature scheme Ed25519 as defined in RFC 8032.

Note: This COSE identifier does not in general identify the full Ed25519 parameter suite, but is specialized to that meaning within the WebAuthn API.

Since:

1.4.0

See Also:

• COSE Algorithms registry
• RFC 8032
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

Ed25519

public static final COSEAlgorithmIdentifier Ed25519

The signature scheme Ed25519 as defined in RFC 8032.

This value is NOT RECOMMENDED, see the documentation of pubKeyCredParams. Use EdDSA instead or in addition.

See Also:

• COSE Algorithms registry
• Fully-Specified Algorithms for JOSE and COSE
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

Ed448

public static final COSEAlgorithmIdentifier Ed448

The signature scheme Ed448 as defined in RFC 8032.

Since:

2.8.0

See Also:

• COSE Algorithms registry
• Fully-Specified Algorithms for JOSE and COSE
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

ES256

public static final COSEAlgorithmIdentifier ES256

ECDSA with SHA-256 on the NIST P-256 curve.

Note: This COSE identifier does not in general restrict the curve to P-256, but is specialized to that meaning within the WebAuthn API.

Since:

0.3.0

See Also:

• COSE Algorithms registry
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

ES384

public static final COSEAlgorithmIdentifier ES384

ECDSA with SHA-384 on the NIST P-384 curve.

Note: This COSE identifier does not in general restrict the curve to P-384, but is specialized to that meaning within the WebAuthn API.

Since:

2.1.0

See Also:

• COSE Algorithms registry
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

ES512

public static final COSEAlgorithmIdentifier ES512

ECDSA with SHA-512 on the NIST P-521 curve.

Note: This COSE identifier does not in general restrict the curve to P-521, but is specialized to that meaning within the WebAuthn API.

Since:

2.1.0

See Also:

• COSE Algorithms registry
• WebAuthn §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier )

RS256

public static final COSEAlgorithmIdentifier RS256

RSASSA-PKCS1-v1_5 using SHA-256.

Since:

0.3.0

See Also:

• COSE Algorithms registry

RS384

public static final COSEAlgorithmIdentifier RS384

RSASSA-PKCS1-v1_5 using SHA-384.

Since:

2.4.0

See Also:

• COSE Algorithms registry

RS512

public static final COSEAlgorithmIdentifier RS512

RSASSA-PKCS1-v1_5 using SHA-512.

Since:

2.4.0

See Also:

• COSE Algorithms registry

RS1

public static final COSEAlgorithmIdentifier RS1

RSASSA-PKCS1-v1_5 using SHA-1.

Since:

1.5.0

See Also:

• COSE Algorithms registry

Method Details

values

public static COSEAlgorithmIdentifier[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static COSEAlgorithmIdentifier valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromId

public static Optional<COSEAlgorithmIdentifier> fromId(long id)

Attempt to parse an integer as a COSEAlgorithmIdentifier.

Parameters:

id - an integer equal to the id of a constant in COSEAlgorithmIdentifier

Returns:

The COSEAlgorithmIdentifier instance whose id equals id , if any.

Since:

0.3.0

See Also:

• §5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

fromPublicKey

public static Optional<COSEAlgorithmIdentifier> fromPublicKey(@NonNull
 @NonNull ByteArray publicKeyCose)

Read the COSEAlgorithmIdentifier from a public key in COSE_Key format.

Parameters:

publicKeyCose - a public key in COSE_Key format.

Returns:

The alg of the publicKeyCose parsed as a COSEAlgorithmIdentifier, if possible. Returns empty if the COSEAlgorithmIdentifier enum has no constant matching the alg value.

Throws:

IllegalArgumentException - if publicKeyCose is not a well-formed COSE_Key.

Since:

2.1.0

getId

public long getId()