Interface XECPrivateKey
- All Superinterfaces:
AsymmetricKey
,Destroyable
,Key
,PrivateKey
,Serializable
,XECKey
An interface for an elliptic curve private key as defined by RFC 7748.
These keys are distinct from the keys represented by
ECPrivateKey
,
and they are intended for use with algorithms based on RFC 7748 such as the
XDH KeyAgreement
algorithm.
An XEC private key is an encoded scalar value as described in RFC 7748.
The decoding procedure defined in this 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. Arrays returned by this interface
are unpruned, and implementations will need to prune the array before
using it in any numerical operations.- Since:
- 11
-
Field Summary
Fields declared in interface java.security.PrivateKey
serialVersionUID
-
Method Summary
Modifier and TypeMethodDescriptiondefault AlgorithmParameterSpec
Returns the parameters associated with this key.Optional
<byte[]> Get the scalar value encoded as an unpruned byte array.Methods declared in interface javax.security.auth.Destroyable
destroy, isDestroyed
Methods declared in interface java.security.Key
getAlgorithm, getEncoded, getFormat
-
Method Details
-
getScalar
Optional<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:
- the unpruned encoded scalar value, or an empty Optional if the scalar cannot be extracted (e.g. if the provider is a hardware token and the private key is not allowed to leave the crypto boundary).
-
getParams
Returns the parameters associated with this key. The parameters are optional and may be either explicitly specified or implicitly created during key pair generation.- Specified by:
getParams
in interfaceAsymmetricKey
- Specified by:
getParams
in interfaceXECKey
- Implementation Requirements:
- The default implementation returns
null
. - Returns:
- the associated parameters, may be
null
- Since:
- 22
-