Stay organized with collections
Save and categorize content based on your preferences.
EdECPrivateKey
public
interface
EdECPrivateKey
implements
EdECKey,
PrivateKey
| java.security.interfaces.EdECPrivateKey
|
An interface for an elliptic curve private key as defined by
RFC 8032: Edwards-Curve
Digital Signature Algorithm (EdDSA). These keys are distinct from the
keys represented by ECPrivateKey, and they are intended for use
with algorithms based on RFC 8032 such as the EdDSA Signature
algorithm.
An Edwards-Curve private key is a bit string. This interface only supports bit
string lengths that are a multiple of 8, and the key is represented using
a byte array.
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[]>
|
getBytes()
Get a copy of the byte array representing the private key.
|
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
getBytes
public abstract Optional<byte[]> getBytes ()
Get a copy of the byte array representing the private key. This method
may return an empty Optional if the implementation is not
willing to produce the private key value.
| Returns |
|---|
Optional<byte[]> |
an Optional containing the private key byte array.
If the key is not available, then an empty Optional. |
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."],[],[],null,["# EdECPrivateKey\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Inherited Constants](#inhconstants) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nEdECPrivateKey\n==============\n\n\n`\npublic\n\n\ninterface\nEdECPrivateKey\n`\n\n\n`\n\n\nimplements\n\n`[EdECKey](/reference/java/security/interfaces/EdECKey)`,\n\n`[PrivateKey](/reference/java/security/PrivateKey)`\n\n\n`\n\n|-----------------------------------------|\n| java.security.interfaces.EdECPrivateKey |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nAn interface for an elliptic curve private key as defined by\n[RFC 8032: Edwards-Curve\nDigital Signature Algorithm (EdDSA)](https://tools.ietf.org/html/rfc8032). These keys are distinct from the\nkeys represented by `ECPrivateKey`, and they are intended for use\nwith algorithms based on RFC 8032 such as the EdDSA `Signature`\nalgorithm.\n\n\nAn Edwards-Curve private key is a bit string. This interface only supports bit\nstring lengths that are a multiple of 8, and the key is represented using\na byte array.\n\nSummary\n-------\n\n| ### Inherited constants |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| From interface [java.security.PrivateKey](/reference/java/security/PrivateKey) |--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `long` | [serialVersionUID](/reference/java/security/PrivateKey#serialVersionUID) *This constant was deprecated in API level 34. A `serialVersionUID` field in an interface is ineffectual. Do not use; no replacement.* | |\n| From interface [java.security.Key](/reference/java/security/Key) |--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `long` | [serialVersionUID](/reference/java/security/Key#serialVersionUID) *This constant was deprecated in API level 34. A `serialVersionUID` field in an interface is ineffectual. Do not use; no replacement.* | |\n\n| ### Public methods ||\n|-----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract `[Optional](/reference/java/util/Optional)`\u003cbyte[]\u003e` | ` `[getBytes](/reference/java/security/interfaces/EdECPrivateKey#getBytes())`() ` Get a copy of the byte array representing the private key. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From interface ` `[java.security.interfaces.EdECKey](/reference/java/security/interfaces/EdECKey)` ` |------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------| | ` abstract `[NamedParameterSpec](/reference/java/security/spec/NamedParameterSpec) | ` `[getParams](/reference/java/security/interfaces/EdECKey#getParams())`() ` Returns the algorithm parameters associated with the key. | ||\n| From interface ` `[javax.security.auth.Destroyable](/reference/javax/security/auth/Destroyable)` ` |--------------------|--------------------------------------------------------------------------------------------------------------------------------| | ` default void` | ` `[destroy](/reference/javax/security/auth/Destroyable#destroy())`() ` Destroy this `Object`. | | ` default boolean` | ` `[isDestroyed](/reference/javax/security/auth/Destroyable#isDestroyed())`() ` Determine if this `Object` has been destroyed. | ||\n| From interface ` `[java.security.Key](/reference/java/security/Key)` ` |---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract `[String](/reference/java/lang/String) | ` `[getAlgorithm](/reference/java/security/Key#getAlgorithm())`() ` Returns the standard algorithm name for this key. | | ` abstract byte[]` | ` `[getEncoded](/reference/java/security/Key#getEncoded())`() ` Returns the key in its primary encoding format, or null if this key does not support encoding. | | ` abstract `[String](/reference/java/lang/String) | ` `[getFormat](/reference/java/security/Key#getFormat())`() ` Returns the name of the primary encoding format of this key, or null if this key does not support encoding. | ||\n\nPublic methods\n--------------\n\n### getBytes\n\nAdded in [API level 33](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract Optional\u003cbyte[]\u003e getBytes ()\n```\n\nGet a copy of the byte array representing the private key. This method\nmay return an empty `Optional` if the implementation is not\nwilling to produce the private key value.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|\n| [Optional](/reference/java/util/Optional)`\u003cbyte[]\u003e` | an `Optional` containing the private key byte array. If the key is not available, then an empty `Optional`. \u003cbr /\u003e |"]]
