@unwanted/matrix-sdk-mini 34.12.0 → 36.0.0

package/src/crypto/store/indexeddb-crypto-store-backend.ts

@@ -1,1250 +0,0 @@
-/*
-Copyright 2017 - 2021 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import { Logger, logger } from "../../logger.ts";
-import { deepCompare } from "../../utils.ts";
-import {
-    CryptoStore,
-    IDeviceData,
-    IProblem,
-    ISession,
-    SessionExtended,
-    ISessionInfo,
-    IWithheld,
-    MigrationState,
-    Mode,
-    OutgoingRoomKeyRequest,
-    ParkedSharedHistory,
-    SecretStorePrivateKeys,
-    SESSION_BATCH_SIZE,
-    ACCOUNT_OBJECT_KEY_MIGRATION_STATE,
-} from "./base.ts";
-import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "../index.ts";
-import { IOlmDevice } from "../algorithms/megolm.ts";
-import { IRoomEncryption } from "../RoomList.ts";
-import { InboundGroupSessionData } from "../OlmDevice.ts";
-import { IndexedDBCryptoStore } from "./indexeddb-crypto-store.ts";
-import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
-
-const PROFILE_TRANSACTIONS = false;
-
-/**
- * Implementation of a CryptoStore which is backed by an existing
- * IndexedDB connection. Generally you want IndexedDBCryptoStore
- * which connects to the database and defers to one of these.
- *
- * @internal
- */
-export class Backend implements CryptoStore {
-    private nextTxnId = 0;
-
-    /**
-     */
-    public constructor(private db: IDBDatabase) {
-        // make sure we close the db on `onversionchange` - otherwise
-        // attempts to delete the database will block (and subsequent
-        // attempts to re-create it will also block).
-        db.onversionchange = (): void => {
-            logger.log(`versionchange for indexeddb ${this.db.name}: closing`);
-            db.close();
-        };
-    }
-
-    public async containsData(): Promise<boolean> {
-        throw Error("Not implemented for Backend");
-    }
-
-    public async startup(): Promise<CryptoStore> {
-        // No work to do, as the startup is done by the caller (e.g IndexedDBCryptoStore)
-        // by passing us a ready IDBDatabase instance
-        return this;
-    }
-
-    public async deleteAllData(): Promise<void> {
-        throw Error("This is not implemented, call IDBFactory::deleteDatabase(dbName) instead.");
-    }
-
-    /**
-     * Get data on how much of the libolm to Rust Crypto migration has been done.
-     *
-     * Implementation of {@link CryptoStore.getMigrationState}.
-     */
-    public async getMigrationState(): Promise<MigrationState> {
-        let migrationState = MigrationState.NOT_STARTED;
-        await this.doTxn("readonly", [IndexedDBCryptoStore.STORE_ACCOUNT], (txn) => {
-            const objectStore = txn.objectStore(IndexedDBCryptoStore.STORE_ACCOUNT);
-            const getReq = objectStore.get(ACCOUNT_OBJECT_KEY_MIGRATION_STATE);
-            getReq.onsuccess = (): void => {
-                migrationState = getReq.result ?? MigrationState.NOT_STARTED;
-            };
-        });
-        return migrationState;
-    }
-
-    /**
-     * Set data on how much of the libolm to Rust Crypto migration has been done.
-     *
-     * Implementation of {@link CryptoStore.setMigrationState}.
-     */
-    public async setMigrationState(migrationState: MigrationState): Promise<void> {
-        await this.doTxn("readwrite", [IndexedDBCryptoStore.STORE_ACCOUNT], (txn) => {
-            const objectStore = txn.objectStore(IndexedDBCryptoStore.STORE_ACCOUNT);
-            objectStore.put(migrationState, ACCOUNT_OBJECT_KEY_MIGRATION_STATE);
-        });
-    }
-
-    /**
-     * Look for an existing outgoing room key request, and if none is found,
-     * add a new one
-     *
-     *
-     * @returns resolves to
-     *    {@link OutgoingRoomKeyRequest}: either the
-     *    same instance as passed in, or the existing one.
-     */
-    public getOrAddOutgoingRoomKeyRequest(request: OutgoingRoomKeyRequest): Promise<OutgoingRoomKeyRequest> {
-        const requestBody = request.requestBody;
-
-        return new Promise((resolve, reject) => {
-            const txn = this.db.transaction("outgoingRoomKeyRequests", "readwrite");
-            txn.onerror = reject;
-
-            // first see if we already have an entry for this request.
-            this._getOutgoingRoomKeyRequest(txn, requestBody, (existing) => {
-                if (existing) {
-                    // this entry matches the request - return it.
-                    logger.log(
-                        `already have key request outstanding for ` +
-                            `${requestBody.room_id} / ${requestBody.session_id}: ` +
-                            `not sending another`,
-                    );
-                    resolve(existing);
-                    return;
-                }
-
-                // we got to the end of the list without finding a match
-                // - add the new request.
-                logger.log(`enqueueing key request for ${requestBody.room_id} / ` + requestBody.session_id);
-                txn.oncomplete = (): void => {
-                    resolve(request);
-                };
-                const store = txn.objectStore("outgoingRoomKeyRequests");
-                store.add(request);
-            });
-        });
-    }
-
-    /**
-     * Look for an existing room key request
-     *
-     * @param requestBody - existing request to look for
-     *
-     * @returns resolves to the matching
-     *    {@link OutgoingRoomKeyRequest}, or null if
-     *    not found
-     */
-    public getOutgoingRoomKeyRequest(requestBody: IRoomKeyRequestBody): Promise<OutgoingRoomKeyRequest | null> {
-        return new Promise((resolve, reject) => {
-            const txn = this.db.transaction("outgoingRoomKeyRequests", "readonly");
-            txn.onerror = reject;
-
-            this._getOutgoingRoomKeyRequest(txn, requestBody, (existing) => {
-                resolve(existing);
-            });
-        });
-    }
-
-    /**
-     * look for an existing room key request in the db
-     *
-     * @internal
-     * @param txn -  database transaction
-     * @param requestBody - existing request to look for
-     * @param callback -  function to call with the results of the
-     *    search. Either passed a matching
-     *    {@link OutgoingRoomKeyRequest}, or null if
-     *    not found.
-     */
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    private _getOutgoingRoomKeyRequest(
-        txn: IDBTransaction,
-        requestBody: IRoomKeyRequestBody,
-        callback: (req: OutgoingRoomKeyRequest | null) => void,
-    ): void {
-        const store = txn.objectStore("outgoingRoomKeyRequests");
-
-        const idx = store.index("session");
-        const cursorReq = idx.openCursor([requestBody.room_id, requestBody.session_id]);
-
-        cursorReq.onsuccess = (): void => {
-            const cursor = cursorReq.result;
-            if (!cursor) {
-                // no match found
-                callback(null);
-                return;
-            }
-
-            const existing = cursor.value;
-
-            if (deepCompare(existing.requestBody, requestBody)) {
-                // got a match
-                callback(existing);
-                return;
-            }
-
-            // look at the next entry in the index
-            cursor.continue();
-        };
-    }
-
-    /**
-     * Look for room key requests by state
-     *
-     * @param wantedStates - list of acceptable states
-     *
-     * @returns resolves to the a
-     *    {@link OutgoingRoomKeyRequest}, or null if
-     *    there are no pending requests in those states. If there are multiple
-     *    requests in those states, an arbitrary one is chosen.
-     */
-    public getOutgoingRoomKeyRequestByState(wantedStates: number[]): Promise<OutgoingRoomKeyRequest | null> {
-        if (wantedStates.length === 0) {
-            return Promise.resolve(null);
-        }
-
-        // this is a bit tortuous because we need to make sure we do the lookup
-        // in a single transaction, to avoid having a race with the insertion
-        // code.
-
-        // index into the wantedStates array
-        let stateIndex = 0;
-        let result: OutgoingRoomKeyRequest;
-
-        function onsuccess(this: IDBRequest<IDBCursorWithValue | null>): void {
-            const cursor = this.result;
-            if (cursor) {
-                // got a match
-                result = cursor.value;
-                return;
-            }
-
-            // try the next state in the list
-            stateIndex++;
-            if (stateIndex >= wantedStates.length) {
-                // no matches
-                return;
-            }
-
-            const wantedState = wantedStates[stateIndex];
-            const cursorReq = (this.source as IDBIndex).openCursor(wantedState);
-            cursorReq.onsuccess = onsuccess;
-        }
-
-        const txn = this.db.transaction("outgoingRoomKeyRequests", "readonly");
-        const store = txn.objectStore("outgoingRoomKeyRequests");
-
-        const wantedState = wantedStates[stateIndex];
-        const cursorReq = store.index("state").openCursor(wantedState);
-        cursorReq.onsuccess = onsuccess;
-
-        return promiseifyTxn(txn).then(() => result);
-    }
-
-    /**
-     *
-     * @returns All elements in a given state
-     */
-    public getAllOutgoingRoomKeyRequestsByState(wantedState: number): Promise<OutgoingRoomKeyRequest[]> {
-        return new Promise((resolve, reject) => {
-            const txn = this.db.transaction("outgoingRoomKeyRequests", "readonly");
-            const store = txn.objectStore("outgoingRoomKeyRequests");
-            const index = store.index("state");
-            const request = index.getAll(wantedState);
-
-            request.onsuccess = (): void => resolve(request.result);
-            request.onerror = (): void => reject(request.error);
-        });
-    }
-
-    public getOutgoingRoomKeyRequestsByTarget(
-        userId: string,
-        deviceId: string,
-        wantedStates: number[],
-    ): Promise<OutgoingRoomKeyRequest[]> {
-        let stateIndex = 0;
-        const results: OutgoingRoomKeyRequest[] = [];
-
-        function onsuccess(this: IDBRequest<IDBCursorWithValue | null>): void {
-            const cursor = this.result;
-            if (cursor) {
-                const keyReq = cursor.value;
-                if (
-                    keyReq.recipients.some(
-                        (recipient: IRoomKeyRequestRecipient) =>
-                            recipient.userId === userId && recipient.deviceId === deviceId,
-                    )
-                ) {
-                    results.push(keyReq);
-                }
-                cursor.continue();
-            } else {
-                // try the next state in the list
-                stateIndex++;
-                if (stateIndex >= wantedStates.length) {
-                    // no matches
-                    return;
-                }
-
-                const wantedState = wantedStates[stateIndex];
-                const cursorReq = (this.source as IDBIndex).openCursor(wantedState);
-                cursorReq.onsuccess = onsuccess;
-            }
-        }
-
-        const txn = this.db.transaction("outgoingRoomKeyRequests", "readonly");
-        const store = txn.objectStore("outgoingRoomKeyRequests");
-
-        const wantedState = wantedStates[stateIndex];
-        const cursorReq = store.index("state").openCursor(wantedState);
-        cursorReq.onsuccess = onsuccess;
-
-        return promiseifyTxn(txn).then(() => results);
-    }
-
-    /**
-     * Look for an existing room key request by id and state, and update it if
-     * found
-     *
-     * @param requestId -      ID of request to update
-     * @param expectedState -  state we expect to find the request in
-     * @param updates -        name/value map of updates to apply
-     *
-     * @returns resolves to
-     *    {@link OutgoingRoomKeyRequest}
-     *    updated request, or null if no matching row was found
-     */
-    public updateOutgoingRoomKeyRequest(
-        requestId: string,
-        expectedState: number,
-        updates: Partial<OutgoingRoomKeyRequest>,
-    ): Promise<OutgoingRoomKeyRequest | null> {
-        let result: OutgoingRoomKeyRequest | null = null;
-
-        function onsuccess(this: IDBRequest<IDBCursorWithValue | null>): void {
-            const cursor = this.result;
-            if (!cursor) {
-                return;
-            }
-            const data = cursor.value;
-            if (data.state != expectedState) {
-                logger.warn(
-                    `Cannot update room key request from ${expectedState} ` +
-                        `as it was already updated to ${data.state}`,
-                );
-                return;
-            }
-            Object.assign(data, updates);
-            cursor.update(data);
-            result = data;
-        }
-
-        const txn = this.db.transaction("outgoingRoomKeyRequests", "readwrite");
-        const cursorReq = txn.objectStore("outgoingRoomKeyRequests").openCursor(requestId);
-        cursorReq.onsuccess = onsuccess;
-        return promiseifyTxn(txn).then(() => result);
-    }
-
-    /**
-     * Look for an existing room key request by id and state, and delete it if
-     * found
-     *
-     * @param requestId -      ID of request to update
-     * @param expectedState -  state we expect to find the request in
-     *
-     * @returns resolves once the operation is completed
-     */
-    public deleteOutgoingRoomKeyRequest(
-        requestId: string,
-        expectedState: number,
-    ): Promise<OutgoingRoomKeyRequest | null> {
-        const txn = this.db.transaction("outgoingRoomKeyRequests", "readwrite");
-        const cursorReq = txn.objectStore("outgoingRoomKeyRequests").openCursor(requestId);
-        cursorReq.onsuccess = (): void => {
-            const cursor = cursorReq.result;
-            if (!cursor) {
-                return;
-            }
-            const data = cursor.value;
-            if (data.state != expectedState) {
-                logger.warn(`Cannot delete room key request in state ${data.state} ` + `(expected ${expectedState})`);
-                return;
-            }
-            cursor.delete();
-        };
-        return promiseifyTxn<OutgoingRoomKeyRequest | null>(txn);
-    }
-
-    // Olm Account
-
-    public getAccount(txn: IDBTransaction, func: (accountPickle: string | null) => void): void {
-        const objectStore = txn.objectStore("account");
-        const getReq = objectStore.get("-");
-        getReq.onsuccess = function (): void {
-            try {
-                func(getReq.result || null);
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public storeAccount(txn: IDBTransaction, accountPickle: string): void {
-        const objectStore = txn.objectStore("account");
-        objectStore.put(accountPickle, "-");
-    }
-
-    public getCrossSigningKeys(
-        txn: IDBTransaction,
-        func: (keys: Record<string, CrossSigningKeyInfo> | null) => void,
-    ): void {
-        const objectStore = txn.objectStore("account");
-        const getReq = objectStore.get("crossSigningKeys");
-        getReq.onsuccess = function (): void {
-            try {
-                func(getReq.result || null);
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public getSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(
-        txn: IDBTransaction,
-        func: (key: SecretStorePrivateKeys[K] | null) => void,
-        type: K,
-    ): void {
-        const objectStore = txn.objectStore("account");
-        const getReq = objectStore.get(`ssss_cache:${type}`);
-        getReq.onsuccess = function (): void {
-            try {
-                func(getReq.result || null);
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public storeCrossSigningKeys(txn: IDBTransaction, keys: Record<string, CrossSigningKeyInfo>): void {
-        const objectStore = txn.objectStore("account");
-        objectStore.put(keys, "crossSigningKeys");
-    }
-
-    public storeSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(
-        txn: IDBTransaction,
-        type: K,
-        key: SecretStorePrivateKeys[K],
-    ): void {
-        const objectStore = txn.objectStore("account");
-        objectStore.put(key, `ssss_cache:${type}`);
-    }
-
-    // Olm Sessions
-
-    public countEndToEndSessions(txn: IDBTransaction, func: (count: number) => void): void {
-        const objectStore = txn.objectStore("sessions");
-        const countReq = objectStore.count();
-        countReq.onsuccess = function (): void {
-            try {
-                func(countReq.result);
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public getEndToEndSessions(
-        deviceKey: string,
-        txn: IDBTransaction,
-        func: (sessions: { [sessionId: string]: ISessionInfo }) => void,
-    ): void {
-        const objectStore = txn.objectStore("sessions");
-        const idx = objectStore.index("deviceKey");
-        const getReq = idx.openCursor(deviceKey);
-        const results: Parameters<Parameters<Backend["getEndToEndSessions"]>[2]>[0] = {};
-        getReq.onsuccess = function (): void {
-            const cursor = getReq.result;
-            if (cursor) {
-                results[cursor.value.sessionId] = {
-                    session: cursor.value.session,
-                    lastReceivedMessageTs: cursor.value.lastReceivedMessageTs,
-                };
-                cursor.continue();
-            } else {
-                try {
-                    func(results);
-                } catch (e) {
-                    abortWithException(txn, <Error>e);
-                }
-            }
-        };
-    }
-
-    public getEndToEndSession(
-        deviceKey: string,
-        sessionId: string,
-        txn: IDBTransaction,
-        func: (session: ISessionInfo | null) => void,
-    ): void {
-        const objectStore = txn.objectStore("sessions");
-        const getReq = objectStore.get([deviceKey, sessionId]);
-        getReq.onsuccess = function (): void {
-            try {
-                if (getReq.result) {
-                    func({
-                        session: getReq.result.session,
-                        lastReceivedMessageTs: getReq.result.lastReceivedMessageTs,
-                    });
-                } else {
-                    func(null);
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public getAllEndToEndSessions(txn: IDBTransaction, func: (session: ISessionInfo | null) => void): void {
-        const objectStore = txn.objectStore("sessions");
-        const getReq = objectStore.openCursor();
-        getReq.onsuccess = function (): void {
-            try {
-                const cursor = getReq.result;
-                if (cursor) {
-                    func(cursor.value);
-                    cursor.continue();
-                } else {
-                    func(null);
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public storeEndToEndSession(
-        deviceKey: string,
-        sessionId: string,
-        sessionInfo: ISessionInfo,
-        txn: IDBTransaction,
-    ): void {
-        const objectStore = txn.objectStore("sessions");
-        objectStore.put({
-            deviceKey,
-            sessionId,
-            session: sessionInfo.session,
-            lastReceivedMessageTs: sessionInfo.lastReceivedMessageTs,
-        });
-    }
-
-    public async storeEndToEndSessionProblem(deviceKey: string, type: string, fixed: boolean): Promise<void> {
-        const txn = this.db.transaction("session_problems", "readwrite");
-        const objectStore = txn.objectStore("session_problems");
-        objectStore.put({
-            deviceKey,
-            type,
-            fixed,
-            time: Date.now(),
-        });
-        await promiseifyTxn(txn);
-    }
-
-    public async getEndToEndSessionProblem(deviceKey: string, timestamp: number): Promise<IProblem | null> {
-        let result: IProblem | null = null;
-        const txn = this.db.transaction("session_problems", "readwrite");
-        const objectStore = txn.objectStore("session_problems");
-        const index = objectStore.index("deviceKey");
-        const req = index.getAll(deviceKey);
-        req.onsuccess = (): void => {
-            const problems = req.result;
-            if (!problems.length) {
-                result = null;
-                return;
-            }
-            problems.sort((a, b) => {
-                return a.time - b.time;
-            });
-            const lastProblem = problems[problems.length - 1];
-            for (const problem of problems) {
-                if (problem.time > timestamp) {
-                    result = Object.assign({}, problem, { fixed: lastProblem.fixed });
-                    return;
-                }
-            }
-            if (lastProblem.fixed) {
-                result = null;
-            } else {
-                result = lastProblem;
-            }
-        };
-        await promiseifyTxn(txn);
-        return result;
-    }
-
-    // FIXME: we should probably prune this when devices get deleted
-    public async filterOutNotifiedErrorDevices(devices: IOlmDevice[]): Promise<IOlmDevice[]> {
-        const txn = this.db.transaction("notified_error_devices", "readwrite");
-        const objectStore = txn.objectStore("notified_error_devices");
-
-        const ret: IOlmDevice[] = [];
-
-        await Promise.all(
-            devices.map((device) => {
-                return new Promise<void>((resolve) => {
-                    const { userId, deviceInfo } = device;
-                    const getReq = objectStore.get([userId, deviceInfo.deviceId]);
-                    getReq.onsuccess = function (): void {
-                        if (!getReq.result) {
-                            objectStore.put({ userId, deviceId: deviceInfo.deviceId });
-                            ret.push(device);
-                        }
-                        resolve();
-                    };
-                });
-            }),
-        );
-
-        return ret;
-    }
-
-    /**
-     * Fetch a batch of Olm sessions from the database.
-     *
-     * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
-     */
-    public async getEndToEndSessionsBatch(): Promise<null | ISessionInfo[]> {
-        const result: ISessionInfo[] = [];
-        await this.doTxn("readonly", [IndexedDBCryptoStore.STORE_SESSIONS], (txn) => {
-            const objectStore = txn.objectStore(IndexedDBCryptoStore.STORE_SESSIONS);
-            const getReq = objectStore.openCursor();
-            getReq.onsuccess = function (): void {
-                try {
-                    const cursor = getReq.result;
-                    if (cursor) {
-                        result.push(cursor.value);
-                        if (result.length < SESSION_BATCH_SIZE) {
-                            cursor.continue();
-                        }
-                    }
-                } catch (e) {
-                    abortWithException(txn, <Error>e);
-                }
-            };
-        });
-
-        if (result.length === 0) {
-            // No sessions left.
-            return null;
-        }
-
-        return result;
-    }
-
-    /**
-     * Delete a batch of Olm sessions from the database.
-     *
-     * Implementation of {@link CryptoStore.deleteEndToEndSessionsBatch}.
-     *
-     * @internal
-     */
-    public async deleteEndToEndSessionsBatch(sessions: { deviceKey: string; sessionId: string }[]): Promise<void> {
-        await this.doTxn("readwrite", [IndexedDBCryptoStore.STORE_SESSIONS], async (txn) => {
-            try {
-                const objectStore = txn.objectStore(IndexedDBCryptoStore.STORE_SESSIONS);
-                for (const { deviceKey, sessionId } of sessions) {
-                    const req = objectStore.delete([deviceKey, sessionId]);
-                    await new Promise((resolve) => {
-                        req.onsuccess = resolve;
-                    });
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        });
-    }
-
-    // Inbound group sessions
-
-    public getEndToEndInboundGroupSession(
-        senderCurve25519Key: string,
-        sessionId: string,
-        txn: IDBTransaction,
-        func: (groupSession: InboundGroupSessionData | null, groupSessionWithheld: IWithheld | null) => void,
-    ): void {
-        let session: InboundGroupSessionData | null | boolean = false;
-        let withheld: IWithheld | null | boolean = false;
-        const objectStore = txn.objectStore("inbound_group_sessions");
-        const getReq = objectStore.get([senderCurve25519Key, sessionId]);
-        getReq.onsuccess = function (): void {
-            try {
-                if (getReq.result) {
-                    session = getReq.result.session;
-                } else {
-                    session = null;
-                }
-                if (withheld !== false) {
-                    func(session as InboundGroupSessionData, withheld as IWithheld);
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-
-        const withheldObjectStore = txn.objectStore("inbound_group_sessions_withheld");
-        const withheldGetReq = withheldObjectStore.get([senderCurve25519Key, sessionId]);
-        withheldGetReq.onsuccess = function (): void {
-            try {
-                if (withheldGetReq.result) {
-                    withheld = withheldGetReq.result.session;
-                } else {
-                    withheld = null;
-                }
-                if (session !== false) {
-                    func(session as InboundGroupSessionData, withheld as IWithheld);
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public getAllEndToEndInboundGroupSessions(txn: IDBTransaction, func: (session: ISession | null) => void): void {
-        const objectStore = txn.objectStore("inbound_group_sessions");
-        const getReq = objectStore.openCursor();
-        getReq.onsuccess = function (): void {
-            const cursor = getReq.result;
-            if (cursor) {
-                try {
-                    func({
-                        senderKey: cursor.value.senderCurve25519Key,
-                        sessionId: cursor.value.sessionId,
-                        sessionData: cursor.value.session,
-                    });
-                } catch (e) {
-                    abortWithException(txn, <Error>e);
-                }
-                cursor.continue();
-            } else {
-                try {
-                    func(null);
-                } catch (e) {
-                    abortWithException(txn, <Error>e);
-                }
-            }
-        };
-    }
-
-    public addEndToEndInboundGroupSession(
-        senderCurve25519Key: string,
-        sessionId: string,
-        sessionData: InboundGroupSessionData,
-        txn: IDBTransaction,
-    ): void {
-        const objectStore = txn.objectStore("inbound_group_sessions");
-        const addReq = objectStore.add({
-            senderCurve25519Key,
-            sessionId,
-            session: sessionData,
-        });
-        addReq.onerror = (ev): void => {
-            if (addReq.error?.name === "ConstraintError") {
-                // This stops the error from triggering the txn's onerror
-                ev.stopPropagation();
-                // ...and this stops it from aborting the transaction
-                ev.preventDefault();
-                logger.log("Ignoring duplicate inbound group session: " + senderCurve25519Key + " / " + sessionId);
-            } else {
-                abortWithException(txn, new Error("Failed to add inbound group session: " + addReq.error));
-            }
-        };
-    }
-
-    public storeEndToEndInboundGroupSession(
-        senderCurve25519Key: string,
-        sessionId: string,
-        sessionData: InboundGroupSessionData,
-        txn: IDBTransaction,
-    ): void {
-        const objectStore = txn.objectStore("inbound_group_sessions");
-        objectStore.put({
-            senderCurve25519Key,
-            sessionId,
-            session: sessionData,
-        });
-    }
-
-    public storeEndToEndInboundGroupSessionWithheld(
-        senderCurve25519Key: string,
-        sessionId: string,
-        sessionData: IWithheld,
-        txn: IDBTransaction,
-    ): void {
-        const objectStore = txn.objectStore("inbound_group_sessions_withheld");
-        objectStore.put({
-            senderCurve25519Key,
-            sessionId,
-            session: sessionData,
-        });
-    }
-
-    /**
-     * Count the number of Megolm sessions in the database.
-     *
-     * Implementation of {@link CryptoStore.countEndToEndInboundGroupSessions}.
-     *
-     * @internal
-     */
-    public async countEndToEndInboundGroupSessions(): Promise<number> {
-        let result = 0;
-        await this.doTxn("readonly", [IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS], (txn) => {
-            const sessionStore = txn.objectStore(IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS);
-            const countReq = sessionStore.count();
-            countReq.onsuccess = (): void => {
-                result = countReq.result;
-            };
-        });
-        return result;
-    }
-
-    /**
-     * Fetch a batch of Megolm sessions from the database.
-     *
-     * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
-     */
-    public async getEndToEndInboundGroupSessionsBatch(): Promise<null | SessionExtended[]> {
-        const result: SessionExtended[] = [];
-        await this.doTxn(
-            "readonly",
-            [IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS, IndexedDBCryptoStore.STORE_BACKUP],
-            (txn) => {
-                const sessionStore = txn.objectStore(IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS);
-                const backupStore = txn.objectStore(IndexedDBCryptoStore.STORE_BACKUP);
-
-                const getReq = sessionStore.openCursor();
-                getReq.onsuccess = function (): void {
-                    try {
-                        const cursor = getReq.result;
-                        if (cursor) {
-                            const backupGetReq = backupStore.get(cursor.key);
-                            backupGetReq.onsuccess = (): void => {
-                                result.push({
-                                    senderKey: cursor.value.senderCurve25519Key,
-                                    sessionId: cursor.value.sessionId,
-                                    sessionData: cursor.value.session,
-                                    needsBackup: backupGetReq.result !== undefined,
-                                });
-                                if (result.length < SESSION_BATCH_SIZE) {
-                                    cursor.continue();
-                                }
-                            };
-                        }
-                    } catch (e) {
-                        abortWithException(txn, <Error>e);
-                    }
-                };
-            },
-        );
-
-        if (result.length === 0) {
-            // No sessions left.
-            return null;
-        }
-
-        return result;
-    }
-
-    /**
-     * Delete a batch of Megolm sessions from the database.
-     *
-     * Implementation of {@link CryptoStore.deleteEndToEndInboundGroupSessionsBatch}.
-     *
-     * @internal
-     */
-    public async deleteEndToEndInboundGroupSessionsBatch(
-        sessions: { senderKey: string; sessionId: string }[],
-    ): Promise<void> {
-        await this.doTxn("readwrite", [IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS], async (txn) => {
-            try {
-                const objectStore = txn.objectStore(IndexedDBCryptoStore.STORE_INBOUND_GROUP_SESSIONS);
-                for (const { senderKey, sessionId } of sessions) {
-                    const req = objectStore.delete([senderKey, sessionId]);
-                    await new Promise((resolve) => {
-                        req.onsuccess = resolve;
-                    });
-                }
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        });
-    }
-
-    public getEndToEndDeviceData(txn: IDBTransaction, func: (deviceData: IDeviceData | null) => void): void {
-        const objectStore = txn.objectStore("device_data");
-        const getReq = objectStore.get("-");
-        getReq.onsuccess = function (): void {
-            try {
-                func(getReq.result || null);
-            } catch (e) {
-                abortWithException(txn, <Error>e);
-            }
-        };
-    }
-
-    public storeEndToEndDeviceData(deviceData: IDeviceData, txn: IDBTransaction): void {
-        const objectStore = txn.objectStore("device_data");
-        objectStore.put(deviceData, "-");
-    }
-
-    public storeEndToEndRoom(roomId: string, roomInfo: IRoomEncryption, txn: IDBTransaction): void {
-        const objectStore = txn.objectStore("rooms");
-        objectStore.put(roomInfo, roomId);
-    }
-
-    public getEndToEndRooms(txn: IDBTransaction, func: (rooms: Record<string, IRoomEncryption>) => void): void {
-        const rooms: Parameters<Parameters<Backend["getEndToEndRooms"]>[1]>[0] = {};
-        const objectStore = txn.objectStore("rooms");
-        const getReq = objectStore.openCursor();
-        getReq.onsuccess = function (): void {
-            const cursor = getReq.result;
-            if (cursor) {
-                rooms[cursor.key as string] = cursor.value;
-                cursor.continue();
-            } else {
-                try {
-                    func(rooms);
-                } catch (e) {
-                    abortWithException(txn, <Error>e);
-                }
-            }
-        };
-    }
-
-    // session backups
-
-    public getSessionsNeedingBackup(limit: number): Promise<ISession[]> {
-        return new Promise((resolve, reject) => {
-            const sessions: ISession[] = [];
-
-            const txn = this.db.transaction(["sessions_needing_backup", "inbound_group_sessions"], "readonly");
-            txn.onerror = reject;
-            txn.oncomplete = function (): void {
-                resolve(sessions);
-            };
-            const objectStore = txn.objectStore("sessions_needing_backup");
-            const sessionStore = txn.objectStore("inbound_group_sessions");
-            const getReq = objectStore.openCursor();
-            getReq.onsuccess = function (): void {
-                const cursor = getReq.result;
-                if (cursor) {
-                    const sessionGetReq = sessionStore.get(cursor.key);
-                    sessionGetReq.onsuccess = function (): void {
-                        sessions.push({
-                            senderKey: sessionGetReq.result.senderCurve25519Key,
-                            sessionId: sessionGetReq.result.sessionId,
-                            sessionData: sessionGetReq.result.session,
-                        });
-                    };
-                    if (!limit || sessions.length < limit) {
-                        cursor.continue();
-                    }
-                }
-            };
-        });
-    }
-
-    public countSessionsNeedingBackup(txn?: IDBTransaction): Promise<number> {
-        if (!txn) {
-            txn = this.db.transaction("sessions_needing_backup", "readonly");
-        }
-        const objectStore = txn.objectStore("sessions_needing_backup");
-        return new Promise((resolve, reject) => {
-            const req = objectStore.count();
-            req.onerror = reject;
-            req.onsuccess = (): void => resolve(req.result);
-        });
-    }
-
-    public async unmarkSessionsNeedingBackup(sessions: ISession[], txn?: IDBTransaction): Promise<void> {
-        if (!txn) {
-            txn = this.db.transaction("sessions_needing_backup", "readwrite");
-        }
-        const objectStore = txn.objectStore("sessions_needing_backup");
-        await Promise.all(
-            sessions.map((session) => {
-                return new Promise((resolve, reject) => {
-                    const req = objectStore.delete([session.senderKey, session.sessionId]);
-                    req.onsuccess = resolve;
-                    req.onerror = reject;
-                });
-            }),
-        );
-    }
-
-    public async markSessionsNeedingBackup(sessions: ISession[], txn?: IDBTransaction): Promise<void> {
-        if (!txn) {
-            txn = this.db.transaction("sessions_needing_backup", "readwrite");
-        }
-        const objectStore = txn.objectStore("sessions_needing_backup");
-        await Promise.all(
-            sessions.map((session) => {
-                return new Promise((resolve, reject) => {
-                    const req = objectStore.put({
-                        senderCurve25519Key: session.senderKey,
-                        sessionId: session.sessionId,
-                    });
-                    req.onsuccess = resolve;
-                    req.onerror = reject;
-                });
-            }),
-        );
-    }
-
-    public addSharedHistoryInboundGroupSession(
-        roomId: string,
-        senderKey: string,
-        sessionId: string,
-        txn?: IDBTransaction,
-    ): void {
-        if (!txn) {
-            txn = this.db.transaction("shared_history_inbound_group_sessions", "readwrite");
-        }
-        const objectStore = txn.objectStore("shared_history_inbound_group_sessions");
-        const req = objectStore.get([roomId]);
-        req.onsuccess = (): void => {
-            const { sessions } = req.result || { sessions: [] };
-            sessions.push([senderKey, sessionId]);
-            objectStore.put({ roomId, sessions });
-        };
-    }
-
-    public getSharedHistoryInboundGroupSessions(
-        roomId: string,
-        txn?: IDBTransaction,
-    ): Promise<[senderKey: string, sessionId: string][]> {
-        if (!txn) {
-            txn = this.db.transaction("shared_history_inbound_group_sessions", "readonly");
-        }
-        const objectStore = txn.objectStore("shared_history_inbound_group_sessions");
-        const req = objectStore.get([roomId]);
-        return new Promise((resolve, reject) => {
-            req.onsuccess = (): void => {
-                const { sessions } = req.result || { sessions: [] };
-                resolve(sessions);
-            };
-            req.onerror = reject;
-        });
-    }
-
-    public addParkedSharedHistory(roomId: string, parkedData: ParkedSharedHistory, txn?: IDBTransaction): void {
-        if (!txn) {
-            txn = this.db.transaction("parked_shared_history", "readwrite");
-        }
-        const objectStore = txn.objectStore("parked_shared_history");
-        const req = objectStore.get([roomId]);
-        req.onsuccess = (): void => {
-            const { parked } = req.result || { parked: [] };
-            parked.push(parkedData);
-            objectStore.put({ roomId, parked });
-        };
-    }
-
-    public takeParkedSharedHistory(roomId: string, txn?: IDBTransaction): Promise<ParkedSharedHistory[]> {
-        if (!txn) {
-            txn = this.db.transaction("parked_shared_history", "readwrite");
-        }
-        const cursorReq = txn.objectStore("parked_shared_history").openCursor(roomId);
-        return new Promise((resolve, reject) => {
-            cursorReq.onsuccess = (): void => {
-                const cursor = cursorReq.result;
-                if (!cursor) {
-                    resolve([]);
-                    return;
-                }
-                const data = cursor.value;
-                cursor.delete();
-                resolve(data);
-            };
-            cursorReq.onerror = reject;
-        });
-    }
-
-    public doTxn<T>(
-        mode: Mode,
-        stores: string | string[],
-        func: (txn: IDBTransaction) => T,
-        log: Logger = logger,
-    ): Promise<T> {
-        let startTime: number;
-        let description: string;
-        if (PROFILE_TRANSACTIONS) {
-            const txnId = this.nextTxnId++;
-            startTime = Date.now();
-            description = `${mode} crypto store transaction ${txnId} in ${stores}`;
-            log.debug(`Starting ${description}`);
-        }
-        const txn = this.db.transaction(stores, mode);
-        const promise = promiseifyTxn(txn);
-        const result = func(txn);
-        if (PROFILE_TRANSACTIONS) {
-            promise.then(
-                () => {
-                    const elapsedTime = Date.now() - startTime;
-                    log.debug(`Finished ${description}, took ${elapsedTime} ms`);
-                },
-                () => {
-                    const elapsedTime = Date.now() - startTime;
-                    log.error(`Failed ${description}, took ${elapsedTime} ms`);
-                },
-            );
-        }
-        return promise.then(() => {
-            return result;
-        });
-    }
-}
-
-type DbMigration = (db: IDBDatabase) => void;
-const DB_MIGRATIONS: DbMigration[] = [
-    (db): void => {
-        createDatabase(db);
-    },
-    (db): void => {
-        db.createObjectStore("account");
-    },
-    (db): void => {
-        const sessionsStore = db.createObjectStore("sessions", {
-            keyPath: ["deviceKey", "sessionId"],
-        });
-        sessionsStore.createIndex("deviceKey", "deviceKey");
-    },
-    (db): void => {
-        db.createObjectStore("inbound_group_sessions", {
-            keyPath: ["senderCurve25519Key", "sessionId"],
-        });
-    },
-    (db): void => {
-        db.createObjectStore("device_data");
-    },
-    (db): void => {
-        db.createObjectStore("rooms");
-    },
-    (db): void => {
-        db.createObjectStore("sessions_needing_backup", {
-            keyPath: ["senderCurve25519Key", "sessionId"],
-        });
-    },
-    (db): void => {
-        db.createObjectStore("inbound_group_sessions_withheld", {
-            keyPath: ["senderCurve25519Key", "sessionId"],
-        });
-    },
-    (db): void => {
-        const problemsStore = db.createObjectStore("session_problems", {
-            keyPath: ["deviceKey", "time"],
-        });
-        problemsStore.createIndex("deviceKey", "deviceKey");
-
-        db.createObjectStore("notified_error_devices", {
-            keyPath: ["userId", "deviceId"],
-        });
-    },
-    (db): void => {
-        db.createObjectStore("shared_history_inbound_group_sessions", {
-            keyPath: ["roomId"],
-        });
-    },
-    (db): void => {
-        db.createObjectStore("parked_shared_history", {
-            keyPath: ["roomId"],
-        });
-    },
-    // Expand as needed.
-];
-export const VERSION = DB_MIGRATIONS.length;
-
-export function upgradeDatabase(db: IDBDatabase, oldVersion: number): void {
-    logger.log(`Upgrading IndexedDBCryptoStore from version ${oldVersion}` + ` to ${VERSION}`);
-    DB_MIGRATIONS.forEach((migration, index) => {
-        if (oldVersion <= index) migration(db);
-    });
-}
-
-function createDatabase(db: IDBDatabase): void {
-    const outgoingRoomKeyRequestsStore = db.createObjectStore("outgoingRoomKeyRequests", { keyPath: "requestId" });
-
-    // we assume that the RoomKeyRequestBody will have room_id and session_id
-    // properties, to make the index efficient.
-    outgoingRoomKeyRequestsStore.createIndex("session", ["requestBody.room_id", "requestBody.session_id"]);
-
-    outgoingRoomKeyRequestsStore.createIndex("state", "state");
-}
-
-interface IWrappedIDBTransaction extends IDBTransaction {
-    _mx_abortexception: Error; // eslint-disable-line camelcase
-}
-
-/*
- * Aborts a transaction with a given exception
- * The transaction promise will be rejected with this exception.
- */
-function abortWithException(txn: IDBTransaction, e: Error): void {
-    // We cheekily stick our exception onto the transaction object here
-    // We could alternatively make the thing we pass back to the app
-    // an object containing the transaction and exception.
-    (txn as IWrappedIDBTransaction)._mx_abortexception = e;
-    try {
-        txn.abort();
-    } catch {
-        // sometimes we won't be able to abort the transaction
-        // (ie. if it's aborted or completed)
-    }
-}
-
-function promiseifyTxn<T>(txn: IDBTransaction): Promise<T | null> {
-    return new Promise((resolve, reject) => {
-        txn.oncomplete = (): void => {
-            if ((txn as IWrappedIDBTransaction)._mx_abortexception !== undefined) {
-                reject((txn as IWrappedIDBTransaction)._mx_abortexception);
-            }
-            resolve(null);
-        };
-        txn.onerror = (event): void => {
-            if ((txn as IWrappedIDBTransaction)._mx_abortexception !== undefined) {
-                reject((txn as IWrappedIDBTransaction)._mx_abortexception);
-            } else {
-                logger.log("Error performing indexeddb txn", event);
-                reject(txn.error);
-            }
-        };
-        txn.onabort = (event): void => {
-            if ((txn as IWrappedIDBTransaction)._mx_abortexception !== undefined) {
-                reject((txn as IWrappedIDBTransaction)._mx_abortexception);
-            } else {
-                logger.log("Error performing indexeddb txn", event);
-                reject(txn.error);
-            }
-        };
-    });
-}