Interface KeyDerivation

Interface for key derivation implementations.

All key derivation methods must implement this interface to provide lock (encrypt) and unlock (decrypt) operations.

interface KeyDerivation {
    index(): number;
    lock(contentKey: SymmetricKey, secret: Uint8Array): EncryptedMessage;
    unlock(
        encryptedMessage: EncryptedMessage,
        secret: Uint8Array,
    ): SymmetricKey;
    toCbor(): Cbor;
    toCborData(): Uint8Array;
    toString(): string;
}

Implemented by

Index

Methods

index lock unlock toCbor toCborData toString

Methods

index

index(): number
Returns the method index for CBOR encoding.

Returns number
- Defined in components/src/encrypted-key/key-derivation.ts:23

lock

lock(contentKey: SymmetricKey, secret: Uint8Array): EncryptedMessage
Lock (encrypt) a content key using the derived key.
Parameters
- contentKey: SymmetricKey
  The symmetric key to encrypt
- secret: Uint8Array
  The secret (password or key material) to derive from
Returns EncryptedMessage
The encrypted message containing the locked key
- Defined in components/src/encrypted-key/key-derivation.ts:32

unlock

unlock(encryptedMessage: EncryptedMessage, secret: Uint8Array): SymmetricKey
Unlock (decrypt) a content key using the derived key.
Parameters
- encryptedMessage: EncryptedMessage
  The encrypted message containing the locked key
- secret: Uint8Array
  The secret (password or key material) to derive from
Returns SymmetricKey
The decrypted symmetric key
- Defined in components/src/encrypted-key/key-derivation.ts:41

toCbor

toCbor(): Cbor
Convert to CBOR representation.

Returns Cbor
- Defined in components/src/encrypted-key/key-derivation.ts:46

toCborData

toCborData(): Uint8Array
Convert to CBOR binary data.

Returns Uint8Array
- Defined in components/src/encrypted-key/key-derivation.ts:51

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/encrypted-key/key-derivation.ts:56