W3cubDocs

/OpenJDK 25

Interface XECPrivateKey

All Superinterfaces:
AsymmetricKey, DEREncodablePREVIEW, Destroyable, Key, PrivateKey, Serializable, XECKey
public interface XECPrivateKey extends XECKey, PrivateKey
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 PrivateKey

serialVersionUID

Method Summary

Modifier and Type Method Description
default AlgorithmParameterSpec getParams()
Returns the parameters associated with this key.
Optional<byte[]> getScalar()
Get the scalar value encoded as an unpruned byte array.

Methods declared in interface Destroyable

destroy, isDestroyed

Methods declared in interface 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

default AlgorithmParameterSpec 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 interface AsymmetricKey
Specified by:
getParams in interface XECKey
Implementation Requirements:
The default implementation returns null.
Returns:
the associated parameters, may be null

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/security/interfaces/XECPrivateKey.html