Class BackupManager

Manages the key backup.

Hierarchy

BackupManager

Constructors

constructor

new BackupManager(baseApis: MatrixClient, getKey: GetKey): BackupManager
Parameters
- baseApis: MatrixClient
- getKey: GetKey
Returns BackupManager
- Defined in src/crypto/backup.ts:123

Properties

`Private` algorithm

algorithm: undefined | BackupAlgorithm

backupInfo

backupInfo: undefined | IKeyBackupInfo

`Private` `Readonly` baseApis

baseApis: MatrixClient

checkedForBackup

checkedForBackup: boolean

`Readonly` getKey

getKey: GetKey

`Private` sendingBackups

sendingBackups: boolean

`Private` sessionLastCheckAttemptedTime

sessionLastCheckAttemptedTime: Record<string, number> = {}

Accessors

version

get version(): undefined | string
Returns undefined | string
- Defined in src/crypto/backup.ts:128

Methods

backupGroupSession

backupGroupSession(senderKey: string, sessionId: string): Promise<void>
Parameters
- senderKey: string
- sessionId: string
Returns Promise<void>
- Defined in src/crypto/backup.ts:545

backupPendingKeys

backupPendingKeys(limit: number): Promise<number>
Take some e2e keys waiting to be backed up and send them to the backup.

Returns
Number of sessions backed up
Parameters
- limit: number
  
  Maximum number of keys to back up
Returns Promise<number>
- Defined in src/crypto/backup.ts:496

checkAndStart

checkAndStart(): Promise<null | IKeyBackupCheck>
Check the server for an active key backup and if one is present and has a valid signature from one of the user's verified devices, start backing up to it.

Returns Promise<null | IKeyBackupCheck>
- Defined in src/crypto/backup.ts:223

checkKeyBackup

checkKeyBackup(): Promise<null | IKeyBackupCheck>
Forces a re-check of the key backup and enables/disables it as appropriate.

Returns
Object with backup info (as returned by getKeyBackupVersion) in backupInfo and trust information (as returned by isKeyBackupTrusted) in trustInfo.

Returns Promise<null | IKeyBackupCheck>
- Defined in src/crypto/backup.ts:284

countSessionsNeedingBackup

countSessionsNeedingBackup(): Promise<number>
Counts the number of end to end session keys that are waiting to be backed up

Returns
Resolves to the number of sessions requiring backup

Returns Promise<number>
- Defined in src/crypto/backup.ts:604

createKeyBackupVersion

createKeyBackupVersion(info: IKeyBackupInfo): Promise<void>
Parameters
- info: IKeyBackupInfo
Returns Promise<void>
- Defined in src/crypto/backup.ts:213

disableKeyBackup

disableKeyBackup(): void
Disable backing up of keys.

Returns void
- Defined in src/crypto/backup.ts:176

enableKeyBackup

enableKeyBackup(info: IKeyBackupInfo): Promise<void>
Parameters
- info: IKeyBackupInfo
Returns Promise<void>
- Defined in src/crypto/backup.ts:158

flagAllGroupSessionsForBackup

flagAllGroupSessionsForBackup(): Promise<number>
Marks all group sessions as needing to be backed up without scheduling them to upload in the background.

Returns
Resolves to the number of sessions now requiring a backup (which will be equal to the number of sessions in the store).

Returns Promise<number>
- Defined in src/crypto/backup.ts:579

getKeyBackupEnabled

getKeyBackupEnabled(): null | boolean
Returns null | boolean
- Defined in src/crypto/backup.ts:187

isKeyBackupTrusted

isKeyBackupTrusted(backupInfo?: IKeyBackupInfo): Promise<TrustInfo>
Check if the given backup info is trusted.

Returns
{ usable: [bool], // is the backup trusted, true iff there is a sig that is valid & from a trusted device sigs: [ valid: [bool || null], // true: valid, false: invalid, null: cannot attempt validation deviceId: [string], device: [DeviceInfo || null], ] }
Parameters
- Optional backupInfo: IKeyBackupInfo
  
  key backup info dict from /room_keys/version
Returns Promise<TrustInfo>
- Defined in src/crypto/backup.ts:322

prepareKeyBackupVersion

prepareKeyBackupVersion(key?: null | string | Uint8Array, algorithm?: string): Promise<IPreparedKeyBackupVersion>
Parameters
- Optional key: null | string | Uint8Array
- Optional algorithm: string
Returns Promise<IPreparedKeyBackupVersion>
- Defined in src/crypto/backup.ts:194

queryKeyBackupRateLimited

queryKeyBackupRateLimited(targetRoomId: undefined | string, targetSessionId: undefined | string): Promise<void>
Attempts to retrieve a session from a key backup, if enough time has elapsed since the last check for this session id.
Parameters
- targetRoomId: undefined | string
- targetSessionId: undefined | string
Returns Promise<void>
- Defined in src/crypto/backup.ts:293

scheduleAllGroupSessionsForBackup

scheduleAllGroupSessionsForBackup(): Promise<void>
Marks all group sessions as needing to be backed up and schedules them to upload in the background as soon as possible.

Returns Promise<void>
- Defined in src/crypto/backup.ts:566

scheduleKeyBackupSend

scheduleKeyBackupSend(maxDelay?: number): Promise<void>
Schedules sending all keys waiting to be sent to the backup, if not already scheduled. Retries if necessary.
Parameters
- maxDelay: number = 10000
  
  Maximum delay to wait in ms. 0 means no delay.
Returns Promise<void>
- Defined in src/crypto/backup.ts:437

`Static` checkBackupVersion

checkBackupVersion(info: IKeyBackupInfo): void
Performs a quick check to ensure that the backup info looks sane.

Throws an error if a problem is detected.
Parameters
- info: IKeyBackupInfo
  
  the key backup info
Returns void
- Defined in src/crypto/backup.ts:139

`Static` makeAlgorithm

makeAlgorithm(info: IKeyBackupInfo, getKey: GetKey): Promise<BackupAlgorithm>
Parameters
- info: IKeyBackupInfo
- getKey: GetKey
Returns Promise<BackupAlgorithm>
- Defined in src/crypto/backup.ts:150

Class BackupManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

baseApis: MatrixClient

getKey: GetKey

Returns BackupManager

Properties

Private algorithm

backupInfo

Private Readonly baseApis

checkedForBackup

Readonly getKey

Private sendingBackups

Private sessionLastCheckAttemptedTime

Accessors

version

Returns undefined | string

Methods

backupGroupSession

Parameters

senderKey: string

sessionId: string

Returns Promise<void>

backupPendingKeys

Returns

Parameters

limit: number

Returns Promise<number>

checkAndStart

Returns Promise<null | IKeyBackupCheck>

checkKeyBackup

Returns

Returns Promise<null | IKeyBackupCheck>

countSessionsNeedingBackup

Returns

Returns Promise<number>

createKeyBackupVersion

Parameters

info: IKeyBackupInfo

Returns Promise<void>

disableKeyBackup

Returns void

enableKeyBackup

Parameters

info: IKeyBackupInfo

Returns Promise<void>

flagAllGroupSessionsForBackup

Returns

Returns Promise<number>

getKeyBackupEnabled

Returns null | boolean

isKeyBackupTrusted

Returns

Parameters

Optional backupInfo: IKeyBackupInfo

Returns Promise<TrustInfo>

prepareKeyBackupVersion

Parameters

Optional key: null | string | Uint8Array

Optional algorithm: string

Returns Promise<IPreparedKeyBackupVersion>

queryKeyBackupRateLimited

Parameters

targetRoomId: undefined | string

targetSessionId: undefined | string

Returns Promise<void>

scheduleAllGroupSessionsForBackup

Returns Promise<void>

scheduleKeyBackupSend

Parameters

maxDelay: number = 10000

Returns Promise<void>

Static checkBackupVersion

`Private` algorithm

`Private` `Readonly` baseApis

`Readonly` getKey

`Private` sendingBackups

`Private` sessionLastCheckAttemptedTime

`Optional` backupInfo: IKeyBackupInfo

`Optional` key: null | string | Uint8Array

`Optional` algorithm: string

`Static` checkBackupVersion

`Static` makeAlgorithm