Module io.inverno.mod.security.jose

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

Enum Class ECCurve

java.lang.Object

java.lang.Enum<ECCurve>

io.inverno.mod.security.jose.jwa.ECCurve

All Implemented Interfaces:

Serializable, Comparable<ECCurve>, Constable

public enum ECCurve
extends Enum<ECCurve>

Elliptic Curves as defined by RFC7518.

Supported curves:

• P-256
• P-384
• P-521
• secp256k1 (deprecated)

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
P_256	P-256 curve as defined by RFC7518 Section 6.2.1.1
P_384	P-384 curve as defined by RFC7518 Section 6.2.1.1
P_521	P-521 curve as defined by RFC7518 Section 6.2.1.1
SECP256K1	Deprecated. secp256k1 has been disabled in the JDK (>=15), it can be activated by setting jdk.sunec.disableNative property to false (-Djdk.sunec.disableNative=false)

Method Summary

Modifier and Type	Method	Description
static ECCurve	fromCurve(String crv)	Returns the curve corresponding to the specified JWA registered curve name.
String	getCurve()	Returns the JWA registered curve name.
int	getFieldSize()	Returns the field size in bits.
String	getJCAName()	Returns the JCA curve name.
int	getKeyLength()	Returns the key length in bytes.
ECParameterSpec	getParameterSpec()	Returns the Elliptic curve parameters.
int	getSignatureLength()	Returns the signature length in bytes.
boolean	isOnCurve(BigInteger x, BigInteger y)	Determines whether the specified point is on the curve.
static ECCurve	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ECCurve[]	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

P_256

public static final ECCurve P_256

P-256 curve as defined by RFC7518 Section 6.2.1.1

P_384

public static final ECCurve P_384

P-384 curve as defined by RFC7518 Section 6.2.1.1

P_521

public static final ECCurve P_521

P-521 curve as defined by RFC7518 Section 6.2.1.1

SECP256K1

@Deprecated
public static final ECCurve SECP256K1

Deprecated.

secp256k1 has been disabled in the JDK (>=15), it can be activated by setting jdk.sunec.disableNative property to false (-Djdk.sunec.disableNative=false)

secp256k1 curve as defined by RFC8812 Section 4.4

Method Details

values

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

getFieldSize

public int getFieldSize()

Returns the field size in bits.

Returns:

the field size in bits

getKeyLength

public int getKeyLength()

Returns the key length in bytes.

Returns:

the key length in bytes

getSignatureLength

public int getSignatureLength()

Returns the signature length in bytes.

Returns:

the signature length in bytes

getParameterSpec

public ECParameterSpec getParameterSpec()
                                 throws JWAProcessingException,
IllegalStateException

Returns the Elliptic curve parameters.

Returns:

the Elliptic curve parameters

Throws:

JWAProcessingException - if the curve is not fully supported

IllegalStateException - if there was an error creating the parameters

isOnCurve

public boolean isOnCurve(BigInteger x,
 BigInteger y)

Determines whether the specified point is on the curve.

Parameters:

x - the x coordinate

y - the y coordinate

Returns:

true if the point is on the curve, false otherwise

fromCurve

public static ECCurve fromCurve(String crv)
                         throws IllegalArgumentException

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

Parameters:

crv - a JWA registered curve name

Returns:

an Elliptic curve

Throws:

IllegalArgumentException - if the specified curve is not supported