Stay organized with collections Save and categorize content based on your preferences.
XECPrivateKey
public interface XECPrivateKey
implements PrivateKey, XECKey
| java.security.interfaces.XECPrivateKey |
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.
Summary
Inherited constants |
|---|
| |
From interface java.security.Key long | serialVersionUID This constant was deprecated in API level 34. A serialVersionUID field in an interface is ineffectual. Do not use; no replacement. | |
Public methods |
|---|
abstract Optional<byte[]> | getScalar() Get the scalar value encoded as an unpruned byte array. |
Inherited methods |
|---|
| |
| |
From interface java.security.Key abstract String | getAlgorithm() Returns the standard algorithm name for this key. | abstract byte[] | getEncoded() Returns the key in its primary encoding format, or null if this key does not support encoding. | abstract String | getFormat() Returns the name of the primary encoding format of this key, or null if this key does not support encoding. | |
Public methods
getScalar
public abstract 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 |
|---|
Optional<byte[]> | 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). |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]
