EdgeAgentSDK/org.hyperledger.identus.walletsdk.domain.models.keyManagement/PrivateKey

PrivateKey

abstract class PrivateKey : Key(source)

Abstraction of what a PrivateKey is and what functionality provides.

Inheritors

Ed25519PrivateKey

Secp256k1PrivateKey

X25519PrivateKey

Constructors

constructor()

Properties

keySpecification

abstract val keySpecification: MutableMap<String, String>

abstract val raw: ByteArray

abstract val size: Int

abstract val type: KeyTypes

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

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

abstract fun jca(): <Error class: unknown class>

abstract fun publicKey(): PublicKey

Defines a method to fetch the public key of this private key