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

Package-level declarations

Types

class AlgorithmKey(val property: String = "algorithm") : KeyProperties

Represents a key that holds an algorithm property.

class CurveKey(val property: String = "curve") : KeyProperties

Represents a key property for the curve.

class CurvePointXKey(val property: String = "curvePoint.x") : KeyProperties

Class representing the CurvePointXKey.

class CurvePointYKey(val property: String = "curvePoint.y") : KeyProperties

Represents a key property for the y-coordinate of a curve point.

class CustomKey(val property: String) : KeyProperties

Represents a custom key with a specific property.

interface DerivableKey

This interface defines the functionality of a derivable key.

DerivationPathKey

class DerivationPathKey(val property: String = "derivationPath") : KeyProperties

Represents a derivation path key. Inherits from the KeyProperties class.

interface ExportableKey

This interface defines what is required for a key to be exportable

interface ImportableKey

This interface defines what is required for a key to be importable

class IndexKey(val property: String = "index") : KeyProperties

Class representing an index key.

data class JWK(val kty: String, val alg: String? = null, val kid: String? = null, val use: String? = null, val n: String? = null, val e: String? = null, val d: String? = null, val p: String? = null, val q: String? = null, val dp: String? = null, val dq: String? = null, val qi: String? = null, val crv: String? = null, val x: String? = null, val y: String? = null, val k: String? = null)

Representation of a JWK (JSON Web Key)

abstract class Key

Abstraction defining the base of what a Key is.

abstract class KeyPair

Data class representing a pair of private and public keys for a specific key curve.

abstract class KeyProperties

The KeyProperties class is an abstract class that provides a framework for defining key properties. Each subclass of KeyProperties must implement the property property.

interface KeyRestoration

This interface defines the functionality to verify and restore cryptographic keys

enum KeyTypes : Enum<KeyTypes>

Enumeration class representing different types of keys.

data class PEMKey(val keyType: PEMKeyType, val keyData: ByteArray)

Representation of a cryptographic key in PEM format.

enum PEMKeyType : Enum<PEMKeyType>

Definition of the PEM key types available

abstract class PrivateKey : Key

Abstraction of what a PrivateKey is and what functionality provides.

abstract class PublicKey : Key

Abstraction of what a PublicKey is and the functionality it provides.

class RawKey(val property: String = "raw") : KeyProperties

Represents a raw key with the property "raw".

class SeedKey(val property: String = "seed") : KeyProperties

Represents a seed key used for deriving private keys.

interface SignableKey

This interface defines the functionality of a signable key.

interface StorableKey

This interface defines what a key requires to be storable.

StorablePrivateKey

data class StorablePrivateKey(val id: String, val restorationIdentifier: String, val data: String, val keyPathIndex: Int?)

class TypeKey(val property: String = "type") : KeyProperties

Represents a specific type of key with a "type" property. Inherits from the abstract class KeyProperties.

interface VerifiableKey

This interface defines the functionality of a verifiable key.

Functions

getKeyCurveByNameAndIndex

fun getKeyCurveByNameAndIndex(name: String, index: Int?): KeyCurve

Method to get a KeyCurve instance based on a key String name.

getKeyPropertyByName

fun getKeyPropertyByName(name: String): KeyProperties

Returns a KeyProperties object based on the given name.