Class CryptographyKey

A wrapper around CryptoKey that uses non-extractable keys for security. Keys are stored as HKDF base keys to enable ratcheting via deriveBits.

Index

Methods

deriveBits deriveKey getBytes getCryptoKey fromBytes fromCryptoKey

Methods

deriveBits

deriveBits(
    salt: Uint8Array<ArrayBuffer>,
    info: Uint8Array<ArrayBuffer>,
    length: number,
): Promise<Uint8Array<ArrayBuffer>>
Derive bytes from this key using HKDF. Used for encryption key derivation and ratcheting.
Parameters
- salt: Uint8Array<ArrayBuffer>
- info: Uint8Array<ArrayBuffer>
- length: number
Returns Promise<Uint8Array<ArrayBuffer>>
- Defined in symmetric.ts:59

deriveKey

deriveKey(
salt: Uint8Array<ArrayBuffer>,
info: Uint8Array<ArrayBuffer>,
): Promise<CryptographyKey>
Derive a new CryptographyKey from this key using HKDF. Used for key ratcheting.
Parameters
- salt: Uint8Array<ArrayBuffer>
- info: Uint8Array<ArrayBuffer>
Returns Promise<CryptographyKey>
- Defined in symmetric.ts:81

getBytes

getBytes(length?: number): Promise<Uint8Array<ArrayBuffer>>
Get raw bytes from this key for intermediate operations like concatenation. Uses deriveBits with empty salt/info to extract the key material. This is needed for X3DH handshake where multiple DH secrets are concatenated.
Parameters
- length: number = 32
Returns Promise<Uint8Array<ArrayBuffer>>
- Defined in symmetric.ts:95

getCryptoKey

getCryptoKey(): CryptoKey
Get the underlying CryptoKey object.

Returns CryptoKey
- Defined in symmetric.ts:51

`Static`fromBytes

fromBytes(keyMaterial: Uint8Array<ArrayBuffer>): Promise<CryptographyKey>
Create a CryptographyKey from raw bytes. The key will be imported as a non-extractable HKDF key.
Parameters
- keyMaterial: Uint8Array<ArrayBuffer>
Returns Promise<CryptographyKey>
- Defined in symmetric.ts:28

`Static`fromCryptoKey

fromCryptoKey(key: CryptoKey): CryptographyKey
Create a CryptographyKey from an existing CryptoKey.
Parameters
- key: CryptoKey
Returns CryptographyKey
- Defined in symmetric.ts:44