Interface BackupDecryptor

Responsible for decrypting megolm session data retrieved from a remote backup. The result of CryptoBackend#getBackupDecryptor.

interface BackupDecryptor {
    sourceTrusted: boolean;
    decryptSessions(ciphertexts: Record<string, KeyBackupSession<AESEncryptedSecretStoragePayload | Curve25519SessionData>>): Promise<IMegolmSessionData[]>;
    free(): void;
}

Index

Properties

sourceTrusted

Methods

decryptSessions free

Properties

`Readonly`sourceTrusted

sourceTrusted: boolean

Whether keys retrieved from this backup can be trusted.

Depending on the backup algorithm, keys retrieved from the backup can be trusted or not. If false, keys retrieved from the backup must be considered unsafe (authenticity cannot be guaranteed). It could be by design (deniability) or for some technical reason (eg asymmetric encryption).

Methods

decryptSessions

decryptSessions(ciphertexts): Promise<IMegolmSessionData[]>
Decrypt megolm session data retrieved from backup.
Parameters
- ciphertexts: Record<string, KeyBackupSession<AESEncryptedSecretStoragePayload | Curve25519SessionData>>
  a Record of sessionId to session data.
Returns Promise<IMegolmSessionData[]>
An array of decrypted IMegolmSessionData
- Defined in src/common-crypto/CryptoBackend.ts:254

free

free(): void
Free any resources held by this decryptor.

Should be called once the decryptor is no longer needed.

Returns void
- Defined in src/common-crypto/CryptoBackend.ts:261

Interface BackupDecryptor

Index

Properties

Methods

Properties

`Readonly`sourceTrusted

Methods

decryptSessions

Parameters

Returns Promise<IMegolmSessionData[]>

free

Returns void

Settings

On This Page

Interface BackupDecryptor

Index

Properties

Methods

Properties

ReadonlysourceTrusted

Methods

decryptSessions

Parameters

Returns Promise<IMegolmSessionData[]>

free

Returns void

Settings

On This Page

`Readonly`sourceTrusted