Package com.yubico.webauthn.data

Enum COSEAlgorithmIdentifier

java.lang.Object

java.lang.Enum<COSEAlgorithmIdentifier>

com.yubico.webauthn.data.COSEAlgorithmIdentifier

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<COSEAlgorithmIdentifier>

public enum COSEAlgorithmIdentifier
extends java.lang.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".

See Also:

§5.10.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

Enum Constant Summary

Enum Constants

Enum Constant	Description
EdDSA
ES256
RS1
RS256

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EdDSA

public static final COSEAlgorithmIdentifier EdDSA

ES256

public static final COSEAlgorithmIdentifier ES256

RS256

public static final COSEAlgorithmIdentifier RS256

RS1

public static final COSEAlgorithmIdentifier RS1

Method Detail

values

public static COSEAlgorithmIdentifier[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (COSEAlgorithmIdentifier c : COSEAlgorithmIdentifier.values())
    System.out.println(c);

Returns:

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

valueOf

public static COSEAlgorithmIdentifier valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromId

public static java.util.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.

See Also:

§5.8.5. Cryptographic Algorithm Identifier (typedef COSEAlgorithmIdentifier)

fromPublicKey

public static java.util.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:

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

getId

public long getId()