Added in API level 33

EdECPrivateKey

interface EdECPrivateKey : EdECKey, PrivateKey

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
Long serialVersionUID

The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Public methods
abstract Optional<ByteArray!>!

Get a copy of the byte array representing the private key.

Inherited functions
Unit destroy()

Destroy this Object.

Sensitive information associated with this Object is destroyed or cleared. Subsequent calls to certain methods on this Object will result in an IllegalStateException being thrown.

The default implementation throws DestroyFailedException.

Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.

Boolean isDestroyed()

Determine if this Object has been destroyed.

The default implementation returns false.

Android note: Up to and including API 25 this method did not have a default implementation. Implementations of this interface must provide a concrete implementation of this method in order to work on older versions of Android.

String! getAlgorithm()

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See the key related sections (KeyFactory, KeyGenerator, KeyPairGenerator, and SecretKeyFactory) in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

ByteArray! getEncoded()

Returns the key in its primary encoding format, or null if this key does not support encoding.

String! getFormat()

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

NamedParameterSpec! getParams()

Returns the algorithm parameters associated with the key.

Public methods

getBytes

Added in API level 33
abstract fun getBytes(): Optional<ByteArray!>!

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.

Return
Optional<ByteArray!>! an Optional containing the private key byte array. If the key is not available, then an empty Optional.