Interface GeneratedSecretStorageKey

Recovery key created by CryptoApi#createRecoveryKeyFromPassphrase or CreateSecretStorageOpts#createSecretStorageKey.

interface GeneratedSecretStorageKey {
    encodedPrivateKey?: string;
    keyInfo?: {
        name?: string;
        passphrase?: PassphraseInfo;
    };
    privateKey: Uint8Array;
}

Index

Properties

encodedPrivateKey? keyInfo? privateKey

Properties

`Optional`encodedPrivateKey

encodedPrivateKey?: string

The generated key, encoded for display to the user per https://spec.matrix.org/v1.7/client-server-api/#key-representation.

`Optional`keyInfo

keyInfo?: {
name?: string;
passphrase?: PassphraseInfo;
}

Type declaration

Optionalname?: string
Optional human-readable name for the key, to be stored in account_data.
Optionalpassphrase?: PassphraseInfo
If the key was derived from a passphrase, information (algorithm, salt, etc) on that derivation.

privateKey

privateKey: Uint8Array

The raw generated private key.