OpenJDK 1.23 · java.security.spec.XECPrivateKeySpec · APIdia, the JavaDoc alternative

A class representing elliptic curve private keys as defined in RFC 7748, including the curve and other algorithm parameters. The private key is represented as an encoded scalar value. The decoding procedure defined in the RFC includes an operation that forces certain bits of the key to either 1 or 0. This operation is known as "pruning" or "clamping" the private key. All arrays in this spec are unpruned, and implementations will need to prune the array before using it in any numerical operations.

Field Summary

Modifier and Type	Field and Description
private final AlgorithmParameterSpec	params
private final byte[]	scalar

Constructor Summary

Access	Constructor and Description
public	XECPrivateKeySpec(AlgorithmParameterSpec the algorithm parameters params, byte[] the unpruned encoded scalar value. This array is copied to protect against subsequent modification. scalar) Construct a private key spec using the supplied parameters and encoded scalar value.

Method Summary

Modifier and Type	Method and Description
public AlgorithmParameterSpec	Returns: the algorithm parameters getParams() Get the algorithm parameters that define the curve and other settings.
public byte[]	Returns: the unpruned encoded scalar value getScalar() Get the scalar value encoded as an unpruned byte array.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

params	back to summary
private final AlgorithmParameterSpec params

scalar	back to summary
private final byte[] scalar

Constructor Detail

XECPrivateKeySpec back to summary

XECPrivateKeySpec	back to summary
public XECPrivateKeySpec(AlgorithmParameterSpec params, byte[] scalar) Construct a private key spec using the supplied parameters and encoded scalar value. Parameters params:AlgorithmParameterSpec the algorithm parameters scalar:byte[] the unpruned encoded scalar value. This array is copied to protect against subsequent modification. Exceptions NullPointerException: if `params` or `scalar` is null.

public XECPrivateKeySpec(AlgorithmParameterSpec params, byte[] scalar)

Construct a private key spec using the supplied parameters and encoded scalar value.

Parameters

params:AlgorithmParameterSpec: the algorithm parameters
scalar:byte[]: the unpruned encoded scalar value. This array is copied to protect against subsequent modification.

Exceptions

NullPointerException:: if params or scalar is null.

Method Detail

getParams	back to summary
public AlgorithmParameterSpec getParams() Get the algorithm parameters that define the curve and other settings. Returns:AlgorithmParameterSpec the algorithm parameters

getParams

back to summary

public AlgorithmParameterSpec getParams()

Get the algorithm parameters that define the curve and other settings.

Returns:AlgorithmParameterSpec: the algorithm parameters

getScalar	back to summary
public byte[] getScalar() Get the scalar value encoded as an unpruned byte array. A new copy of the array is returned each time this method is called. Returns:byte[] the unpruned encoded scalar value

getScalar