Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.jwa

Enum Class OKPCurve

java.lang.Object

java.lang.Enum<OKPCurve>

io.inverno.mod.security.jose.jwa.OKPCurve

All Implemented Interfaces:

Serializable, Comparable<OKPCurve>, Constable

public enum OKPCurve
extends Enum<OKPCurve>

Octet Key Pair Elliptic curves as defined by RFC8037

Supported curves:

• Ed25519
• Ed448
• X25519
• X448

These curves are used in conjuntion with algorithms defined by EdECAlgorithm and XECAlgorithm.

Since:

1.5

Author:

Jeremy Kuhn

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	Ed25519 curve as defined by RFC8037 Section 3.1
ED448	Ed448 curve as defined by RFC8037 Section 3.1
X25519	X25519 curve as defined by RFC8037 Section 3.2
X448	X448 curve as defined by RFC8037 Section 3.2

Method Summary

Modifier and Type	Method	Description
static OKPCurve	fromCurve(String crv)	Returns the curve corresponding to the specified JWA registered curve name.
String	getCurve()	Returns the JWA registered curve name.
String	getJCAName()	Returns the JCA curve name.
int	getKeyLength()	Returns the key length in bytes.
static OKPCurve	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OKPCurve[]	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

ED25519

public static final OKPCurve ED25519

Ed25519 curve as defined by RFC8037 Section 3.1

ED448

public static final OKPCurve ED448

Ed448 curve as defined by RFC8037 Section 3.1

X25519

public static final OKPCurve X25519

X25519 curve as defined by RFC8037 Section 3.2

X448

public static final OKPCurve X448

X448 curve as defined by RFC8037 Section 3.2

Method Details

values

public static OKPCurve[] 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 OKPCurve 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

getCurve

public String getCurve()

Returns the JWA registered curve name.

Returns:

the registered name of the curve

getJCAName

public String getJCAName()

Returns the JCA curve name.

Returns:

the JCA curve name

getKeyLength

public int getKeyLength()

Returns the key length in bytes.

Returns:

the key length in bytes

fromCurve

public static OKPCurve fromCurve(String crv)

Returns the curve corresponding to the specified JWA registered curve name.

Parameters:

crv - a JWA registered curve name

Returns:

an OKP curve

Throws:

IllegalArgumentException - if the specified curve is not supported