EdgeAgentSDK/org.hyperledger.identus.walletsdk.apollo.utils/Ed25519PrivateKey

Ed25519PrivateKey

class Ed25519PrivateKey(nativeValue: ByteArray) : PrivateKey, SignableKey, StorableKey, ExportableKey(source)

Represents a private key for the Ed25519 algorithm.

This class extends the abstract class PrivateKey and implements the interfaces SignableKey, StorableKey, and ExportableKey.

Parameters

nativeValue

The raw byte array representing the private key.

Constructors

Ed25519PrivateKey

constructor(nativeValue: ByteArray)

Creates an instance of Ed25519PrivateKey and initializes its properties.

Properties

keySpecification

open override val keySpecification: MutableMap<String, String>

A mutable map representing the key specification.

open override val raw: ByteArray

The raw byte array representing the private key.

restorationIdentifier

open override val restorationIdentifier: String

This variable represents the restoration identifier for a key. It is a unique identifier used for restoring the key from storage.

open override val size: Int

The size of the private key in bytes.

open override val storableData: ByteArray

Represents the storable data of a key.

open override val type: KeyTypes

The type of the key. Always set to KeyTypes.EC.

Functions

fun canVerify(): Boolean

Evaluates if this key implements VerifiableKey

open operator override fun equals(other: Any?): Boolean

Checks if the current Key object is equal to the provided object. Two Key objects are considered equal if the following conditions are met:

fun getCurve(): String

Returns the value of the key curve for this private key

getCurveInstance

fun getCurveInstance(): Curve?

Returns an instance of the key curve for this private key

fun getEncoded(): ByteArray

Returns the encoded raw value into base 64 url

fun getIndex(): String

Returns the index for this private key

open override fun getJwk(): JWK

Retrieves the JWK (JSON Web Key) representation of the private key.

open override fun getPem(): String

Returns the PEM (Privacy-Enhanced Mail) representation of the private key. The key is encoded in base64 and wrapped with "BEGIN" and "END" markers.

fun getProperty(name: String): String

Searches the value based on the input key, if it exists

fun getValue(): ByteArray

Returns the value of this private key

open override fun hashCode(): Int

Computes the hash code of the Key object. The hash code is calculated based on the properties of the keySpecification map and the raw byte array. Two Key objects with the same keySpecification map and the raw byte array are guaranteed to have the same hash code.

fun isCurve(curve: String): Boolean

Evaluates if the input curve matches the actual curve this key has

fun isDerivable(): Boolean

Evaluates if this key implements DerivableKey

fun isExportable(): Boolean

Evaluates if this key implements ExportableKey

fun isImportable(): Boolean

Evaluates if this key implements ImportableKey

fun isSignable(): Boolean

Evaluates if this key implements SignableKey

open override fun jca(): <Error class: unknown class>

open override fun jwkWithKid(kid: String): JWK

Retrieves the JWK (JSON Web Key) representation of the private key with the specified key identifier (kid).

open override fun publicKey(): PublicKey

Returns the public key corresponding to this private key.

open override fun sign(message: ByteArray): ByteArray

Signs a byte array message using the private key.