SupportedEllipticCurve (OpenAM Server Only 6.5.5 Documentation)

java.lang.Object
- java.lang.Enum<SupportedEllipticCurve>
- - org.forgerock.json.jose.jws.SupportedEllipticCurve

All Implemented Interfaces:

Serializable, Comparable<SupportedEllipticCurve>
```
public enum SupportedEllipticCurve
extends Enum<SupportedEllipticCurve>
```
Enumerates all supported elliptic curve parameters for ESXXX signature formats.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ED25519` The Ed25519 curve used for EdDSA signatures.
`P256` NIST P-256.
`P384` NIST P-384.
`P521` NIST P-521.
`X25519` Curve25519 when used for ECDH-ES key agreement (X25519).
`X448` Curve448 when used for ECDH-ES key agreement (X448).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SupportedEllipticCurve`	`forKey(Key key)` Determines the standard curve that matches the given (private or public) key.
`static SupportedEllipticCurve`	`forKey(Key key, KeyUse use)` Determines the standard curve that matches the given (private or public) key.
`static SupportedEllipticCurve`	`forName(String curveName)` Returns the curve parameters for the given standard curve name (crv claim in a JWK).
`static SupportedEllipticCurve`	`forSignature(byte[] signature)` Determines the supported curve parameters for the given ECDSA signature.
`static SupportedEllipticCurve`	`forSignature(byte[] signature, JwsAlgorithmType type)` Determines the supported curve parameters for the given signature.
`KeyType`	`getJwkType()` Returns the type of JWK that is used for this elliptic curve.
`JwsAlgorithm`	`getJwsAlgorithm()` Returns the JwsAlgorithm that corresponds to this elliptic curve.
`String`	`getKeyAgreementAlgorithm()` Determines the Java KeyAgreement algorithm to use for this curve.
`String`	`getKeyGenerationAlgorithm()` Determines the Java KeyPairGenerator algorithm to use for this curve.
`AlgorithmParameterSpec`	`getParameters()` Returns the parameters for the given elliptic curve.
`int`	`getSignatureSize()` Returns the size of the signature produced by this curve in octets.
`String`	`getStandardName()` Return the name of the curve as used for the "crv" claim in a JWK.
`boolean`	`isXDHCurve()` Determines whether this curve is intended for use with X-Diffie-Hellman (XDH) key agreement (X25519 or X448).
`String`	`toString()`
`boolean`	`validate(PublicKey publicKey)` Validates that the given public key is on this curve.
`static SupportedEllipticCurve`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SupportedEllipticCurve[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - P256
```
public static final SupportedEllipticCurve P256
```
    NIST P-256.
  - P384
```
public static final SupportedEllipticCurve P384
```
    NIST P-384.
  - P521
```
public static final SupportedEllipticCurve P521
```
    NIST P-521. Please note that this is not a typo: ES512 uses curve P-521, which produces a 132-octet signature value.
  - X25519
```
public static final SupportedEllipticCurve X25519
```
    Curve25519 when used for ECDH-ES key agreement (X25519).
  - X448
```
public static final SupportedEllipticCurve X448
```
    Curve448 when used for ECDH-ES key agreement (X448).
  - ED25519
```
public static final SupportedEllipticCurve ED25519
```
    The Ed25519 curve used for EdDSA signatures. As Java represents curve parameters in "short Weierstrass" form, this curve is identical to X25519 in that form. It is therefore important to check which curve is intended.
- Method Detail
  - values
```
public static SupportedEllipticCurve[] 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 (SupportedEllipticCurve c : SupportedEllipticCurve.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SupportedEllipticCurve valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getParameters
```
public AlgorithmParameterSpec getParameters()
```
    Returns the parameters for the given elliptic curve.
    
    Returns:
    
    the elliptic curve algorithm parameters.
  - getStandardName
```
public String getStandardName()
```
    Return the name of the curve as used for the "crv" claim in a JWK.
    
    Returns:
    
    the standard JWA name for the curve.
  - getSignatureSize
```
public int getSignatureSize()
```
    Returns the size of the signature produced by this curve in octets.
    
    Returns:
    
    the number of octets (bytes) required to hold a signature of this curve.
  - getJwsAlgorithm
```
public JwsAlgorithm getJwsAlgorithm()
```
    Returns the JwsAlgorithm that corresponds to this elliptic curve.
    
    Returns:
    
    the corresponding JwsAlgorithm.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<SupportedEllipticCurve>
  - forName
```
public static SupportedEllipticCurve forName(String curveName)
```
    Returns the curve parameters for the given standard curve name (crv claim in a JWK).
    
    Parameters:
    
    curveName - the curve name.
    
    Returns:
    
    the curve parameters for the name.
    
    Throws:
    
    IllegalArgumentException - if the curve name is not supported.
  - forKey
```
public static SupportedEllipticCurve forKey(Key key,
                                            KeyUse use)
```
    Determines the standard curve that matches the given (private or public) key. This is done by comparing the key parameters for an exact match against one of the standard curves. All parameters much match for a match to succeed.
    
    Parameters:
    
    key - the private or public key to determine the curve for.
    
    use - the intended use of the curve.
    
    Returns:
    
    the matching supported curve parameters.
    
    Throws:
    
    IllegalArgumentException - if the key does not match any supported curve parameters.
  - forKey
```
public static SupportedEllipticCurve forKey(Key key)
```
    Determines the standard curve that matches the given (private or public) key. This is done by comparing the key parameters for an exact match against one of the standard curves. All parameters much match for a match to succeed. Any curve suitable for encryption (key agreement) will be returned.
    
    Parameters:
    
    key - the private or public key to determine the curve for.
    
    Returns:
    
    the matching supported curve parameters.
    
    Throws:
    
    IllegalArgumentException - if the key does not match any supported curve parameters.
  - forSignature
```
public static SupportedEllipticCurve forSignature(byte[] signature,
                                                  JwsAlgorithmType type)
```
    Determines the supported curve parameters for the given signature. This is done purely based on the length of the signature and the behaviour is not specified if multiple curves could have produced this signature.
    
    Parameters:
    
    signature - the signature to match.
    
    type - the type of signature.
    
    Returns:
    
    the curve that produced this signature.
    
    Throws:
    
    IllegalArgumentException - if the signature does not match any supported curve parameters.
  - forSignature
```
public static SupportedEllipticCurve forSignature(byte[] signature)
```
    Determines the supported curve parameters for the given ECDSA signature. This is done purely based on the length of the signature and the behaviour is not specified if multiple curves could have produced this signature.
    
    Parameters:
    
    signature - the signature to match.
    
    Returns:
    
    the curve that produced this signature.
    
    Throws:
    
    IllegalArgumentException - if the signature does not match any supported curve parameters.
  - getJwkType
```
public KeyType getJwkType()
```
    Returns the type of JWK that is used for this elliptic curve. The NIST prime-order standard curves use EcJWKs, while the newer X25519/X448 and related curves use OkpJWKs.
    
    Returns:
    
    either OKP or EC depending on the type of elliptic curve.
  - validate
```
public boolean validate(PublicKey publicKey)
```
    Validates that the given public key is on this curve.
    
    Parameters:
    
    publicKey - the public key to validate.
    
    Returns:
    
    true if the public key represents a valid point on this curve, otherwise false.
  - getKeyAgreementAlgorithm
```
public String getKeyAgreementAlgorithm()
```
    Determines the Java KeyAgreement algorithm to use for this curve.
    
    Returns:
    
    the key agreement algorithm to use with this curve.
  - getKeyGenerationAlgorithm
```
public String getKeyGenerationAlgorithm()
```
    Determines the Java KeyPairGenerator algorithm to use for this curve.
    
    Returns:
    
    the key generation algorithm to use for this curve.
  - isXDHCurve
```
public boolean isXDHCurve()
```
    Determines whether this curve is intended for use with X-Diffie-Hellman (XDH) key agreement (X25519 or X448). This is an efficient variant on ECDH implemented by modern curves.
    
    Returns:
    
    whether this curve is intended for XDH key agreement.

Enum SupportedEllipticCurve

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

P256

P384

P521

X25519

X448

ED25519

Method Detail

values

valueOf

getParameters

getStandardName

getSignatureSize

getJwsAlgorithm

toString

forName

forKey

forKey

forSignature

forSignature

getJwkType

validate

getKeyAgreementAlgorithm

getKeyGenerationAlgorithm

isXDHCurve