summaryrefslogtreecommitdiff
path: root/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts')
-rw-r--r--includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts184
1 files changed, 0 insertions, 184 deletions
diff --git a/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts b/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts
deleted file mode 100644
index 143b2bb..0000000
--- a/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/backup.d.ts
+++ /dev/null
@@ -1,184 +0,0 @@
-/**
- * Classes for dealing with key backup.
- */
-import type { IMegolmSessionData } from "../@types/crypto";
-import { MatrixClient } from "../client";
-import { DeviceInfo } from "./deviceinfo";
-import { DeviceTrustLevel } from "./CrossSigning";
-import { IEncryptedPayload } from "./aes";
-import { Curve25519SessionData, IAes256AuthData, ICurve25519AuthData, IKeyBackupInfo, IKeyBackupSession } from "./keybackup";
-type AuthData = IKeyBackupInfo["auth_data"];
-type SigInfo = {
- deviceId: string;
- valid?: boolean | null;
- device?: DeviceInfo | null;
- crossSigningId?: boolean;
- deviceTrust?: DeviceTrustLevel;
-};
-export type TrustInfo = {
- usable: boolean;
- sigs: SigInfo[];
- trusted_locally?: boolean;
-};
-export interface IKeyBackupCheck {
- backupInfo?: IKeyBackupInfo;
- trustInfo: TrustInfo;
-}
-export interface IPreparedKeyBackupVersion {
- algorithm: string;
- auth_data: AuthData;
- recovery_key: string;
- privateKey: Uint8Array;
-}
-/** A function used to get the secret key for a backup.
- */
-type GetKey = () => Promise<ArrayLike<number>>;
-interface BackupAlgorithmClass {
- algorithmName: string;
- init(authData: AuthData, getKey: GetKey): Promise<BackupAlgorithm>;
- prepare(key?: string | Uint8Array | null): Promise<[Uint8Array, AuthData]>;
- checkBackupVersion(info: IKeyBackupInfo): void;
-}
-interface BackupAlgorithm {
- untrusted: boolean;
- encryptSession(data: Record<string, any>): Promise<Curve25519SessionData | IEncryptedPayload>;
- decryptSessions(ciphertexts: Record<string, IKeyBackupSession>): Promise<IMegolmSessionData[]>;
- authData: AuthData;
- keyMatches(key: ArrayLike<number>): Promise<boolean>;
- free(): void;
-}
-export interface IKeyBackup {
- rooms: {
- [roomId: string]: {
- sessions: {
- [sessionId: string]: IKeyBackupSession;
- };
- };
- };
-}
-/**
- * Manages the key backup.
- */
-export declare class BackupManager {
- private readonly baseApis;
- readonly getKey: GetKey;
- private algorithm;
- backupInfo: IKeyBackupInfo | undefined;
- checkedForBackup: boolean;
- private sendingBackups;
- private sessionLastCheckAttemptedTime;
- constructor(baseApis: MatrixClient, getKey: GetKey);
- get version(): string | undefined;
- /**
- * Performs a quick check to ensure that the backup info looks sane.
- *
- * Throws an error if a problem is detected.
- *
- * @param info - the key backup info
- */
- static checkBackupVersion(info: IKeyBackupInfo): void;
- static makeAlgorithm(info: IKeyBackupInfo, getKey: GetKey): Promise<BackupAlgorithm>;
- enableKeyBackup(info: IKeyBackupInfo): Promise<void>;
- /**
- * Disable backing up of keys.
- */
- disableKeyBackup(): void;
- getKeyBackupEnabled(): boolean | null;
- prepareKeyBackupVersion(key?: string | Uint8Array | null, algorithm?: string | undefined): Promise<IPreparedKeyBackupVersion>;
- createKeyBackupVersion(info: IKeyBackupInfo): Promise<void>;
- /**
- * 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.
- */
- checkAndStart(): Promise<IKeyBackupCheck | null>;
- /**
- * 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.
- */
- checkKeyBackup(): Promise<IKeyBackupCheck | null>;
- /**
- * Attempts to retrieve a session from a key backup, if enough time
- * has elapsed since the last check for this session id.
- */
- queryKeyBackupRateLimited(targetRoomId: string | undefined, targetSessionId: string | undefined): Promise<void>;
- /**
- * Check if the given backup info is trusted.
- *
- * @param backupInfo - key backup info dict from /room_keys/version
- */
- isKeyBackupTrusted(backupInfo?: IKeyBackupInfo): Promise<TrustInfo>;
- /**
- * Schedules sending all keys waiting to be sent to the backup, if not already
- * scheduled. Retries if necessary.
- *
- * @param maxDelay - Maximum delay to wait in ms. 0 means no delay.
- */
- scheduleKeyBackupSend(maxDelay?: number): Promise<void>;
- /**
- * Take some e2e keys waiting to be backed up and send them
- * to the backup.
- *
- * @param limit - Maximum number of keys to back up
- * @returns Number of sessions backed up
- */
- backupPendingKeys(limit: number): Promise<number>;
- backupGroupSession(senderKey: string, sessionId: string): Promise<void>;
- /**
- * Marks all group sessions as needing to be backed up and schedules them to
- * upload in the background as soon as possible.
- */
- scheduleAllGroupSessionsForBackup(): Promise<void>;
- /**
- * Marks all group sessions as needing to be backed up without scheduling
- * them to upload in the background.
- * @returns Promise which resolves to the number of sessions now requiring a backup
- * (which will be equal to the number of sessions in the store).
- */
- flagAllGroupSessionsForBackup(): Promise<number>;
- /**
- * Counts the number of end to end session keys that are waiting to be backed up
- * @returns Promise which resolves to the number of sessions requiring backup
- */
- countSessionsNeedingBackup(): Promise<number>;
-}
-export declare class Curve25519 implements BackupAlgorithm {
- authData: ICurve25519AuthData;
- private publicKey;
- private getKey;
- static algorithmName: string;
- constructor(authData: ICurve25519AuthData, publicKey: any, // FIXME: PkEncryption
- getKey: () => Promise<Uint8Array>);
- static init(authData: AuthData, getKey: () => Promise<Uint8Array>): Promise<Curve25519>;
- static prepare(key?: string | Uint8Array | null): Promise<[Uint8Array, AuthData]>;
- static checkBackupVersion(info: IKeyBackupInfo): void;
- get untrusted(): boolean;
- encryptSession(data: Record<string, any>): Promise<Curve25519SessionData>;
- decryptSessions(sessions: Record<string, IKeyBackupSession<Curve25519SessionData>>): Promise<IMegolmSessionData[]>;
- keyMatches(key: Uint8Array): Promise<boolean>;
- free(): void;
-}
-export declare class Aes256 implements BackupAlgorithm {
- readonly authData: IAes256AuthData;
- private readonly key;
- static algorithmName: "org.matrix.msc3270.v1.aes-hmac-sha2";
- constructor(authData: IAes256AuthData, key: Uint8Array);
- static init(authData: IAes256AuthData, getKey: () => Promise<Uint8Array>): Promise<Aes256>;
- static prepare(key?: string | Uint8Array | null): Promise<[Uint8Array, AuthData]>;
- static checkBackupVersion(info: IKeyBackupInfo): void;
- get untrusted(): boolean;
- encryptSession(data: Record<string, any>): Promise<IEncryptedPayload>;
- decryptSessions(sessions: Record<string, IKeyBackupSession<IEncryptedPayload>>): Promise<IMegolmSessionData[]>;
- keyMatches(key: Uint8Array): Promise<boolean>;
- free(): void;
-}
-export declare const algorithmsByName: Record<string, BackupAlgorithmClass>;
-export declare const DefaultAlgorithm: BackupAlgorithmClass;
-export {};
-//# sourceMappingURL=backup.d.ts.map \ No newline at end of file
© Floofi Systems, Some rights reserved. Powered by cgit.