/*
Copyright 2022-2023 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 * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
import {
    BaseMigrationData,
    KeysQueryRequest,
    Migration,
    OlmMachine,
    type PickledInboundGroupSession,
    type PickledSession,
    StoreHandle,
} from "@matrix-org/matrix-sdk-crypto-wasm";
import { mocked, type Mocked } from "jest-mock";
import fetchMock from "fetch-mock-jest";

import { RustCrypto } from "../../../src/rust-crypto/rust-crypto";
import { initRustCrypto } from "../../../src/rust-crypto";
import {
    type AccountDataEvents,
    type Device,
    DeviceVerification,
    type EmptyObject,
    encodeBase64,
    type HttpApiEvent,
    type HttpApiEventHandlerMap,
    type IHttpOpts,
    type IToDeviceEvent,
    type MatrixClient,
    MatrixEvent,
    MatrixHttpApi,
    MemoryCryptoStore,
    TypedEventEmitter,
} from "../../../src";
import { emitPromise, mkEvent } from "../../test-utils/test-utils";
import { type CryptoBackend } from "../../../src/common-crypto/CryptoBackend";
import { type IEventDecryptionResult, type IMegolmSessionData } from "../../../src/@types/crypto";
import { type OutgoingRequestProcessor } from "../../../src/rust-crypto/OutgoingRequestProcessor";
import {
    type AccountDataClient,
    type AddSecretStorageKeyOpts,
    type SecretStorageCallbacks,
    type ServerSideSecretStorage,
    ServerSideSecretStorageImpl,
} from "../../../src/secret-storage";
import {
    type CryptoCallbacks,
    EventShieldColour,
    EventShieldReason,
    type ImportRoomKeysOpts,
    type KeyBackupCheck,
    type KeyBackupInfo,
    type VerificationRequest,
} from "../../../src/crypto-api";
import * as testData from "../../test-utils/test-data";
import { E2EKeyReceiver } from "../../test-utils/E2EKeyReceiver";
import { E2EKeyResponder } from "../../test-utils/E2EKeyResponder";
import { defer } from "../../../src/utils";
import { logger } from "../../../src/logger";
import { OutgoingRequestsManager } from "../../../src/rust-crypto/OutgoingRequestsManager";
import { ClientEvent, type ClientEventHandlerMap } from "../../../src/client";
import { type Curve25519AuthData } from "../../../src/crypto-api/keybackup";
import encryptAESSecretStorageItem from "../../../src/utils/encryptAESSecretStorageItem.ts";
import { type CryptoStore, type SecretStorePrivateKeys } from "../../../src/crypto/store/base";
import { CryptoEvent } from "../../../src/crypto-api/index.ts";
import { RustBackupManager } from "../../../src/rust-crypto/backup.ts";

const TEST_USER = "@alice:example.com";
const TEST_DEVICE_ID = "TEST_DEVICE";

beforeAll(async () => {
    // Load the WASM upfront, before any of the tests. This can take some time, and doing it here means that it gets
    // a separate timeout.
    await RustSdkCryptoJs.initAsync();
}, 15000);

afterEach(() => {
    fetchMock.reset();
    jest.restoreAllMocks();
});

describe("initRustCrypto", () => {
    function makeTestOlmMachine(): Mocked<OlmMachine> {
        return {
            registerRoomKeyUpdatedCallback: jest.fn(),
            registerUserIdentityUpdatedCallback: jest.fn(),
            getSecretsFromInbox: jest.fn().mockResolvedValue([]),
            deleteSecretsFromInbox: jest.fn(),
            registerReceiveSecretCallback: jest.fn(),
            registerDevicesUpdatedCallback: jest.fn(),
            registerRoomKeysWithheldCallback: jest.fn(),
            outgoingRequests: jest.fn(),
            isBackupEnabled: jest.fn().mockResolvedValue(false),
            verifyBackup: jest.fn().mockResolvedValue({ trusted: jest.fn().mockReturnValue(false) }),
            getBackupKeys: jest.fn(),
            getIdentity: jest.fn().mockResolvedValue(null),
            trackedUsers: jest.fn(),
        } as unknown as Mocked<OlmMachine>;
    }

    it("passes through the store params (passphrase)", async () => {
        const mockStore = { free: jest.fn() } as unknown as StoreHandle;
        jest.spyOn(StoreHandle, "open").mockResolvedValue(mockStore);

        const testOlmMachine = makeTestOlmMachine();
        jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);

        await initRustCrypto({
            logger,
            http: {} as MatrixClient["http"],
            userId: TEST_USER,
            deviceId: TEST_DEVICE_ID,
            secretStorage: {} as ServerSideSecretStorage,
            cryptoCallbacks: {} as CryptoCallbacks,
            storePrefix: "storePrefix",
            storePassphrase: "storePassphrase",
        });

        expect(StoreHandle.open).toHaveBeenCalledWith("storePrefix", "storePassphrase");
        expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore);
    });

    it("passes through the store params (key)", async () => {
        const mockStore = { free: jest.fn() } as unknown as StoreHandle;
        jest.spyOn(StoreHandle, "openWithKey").mockResolvedValue(mockStore);

        const testOlmMachine = makeTestOlmMachine();
        jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);

        const storeKey = new Uint8Array(32);
        await initRustCrypto({
            logger,
            http: {} as MatrixClient["http"],
            userId: TEST_USER,
            deviceId: TEST_DEVICE_ID,
            secretStorage: {} as ServerSideSecretStorage,
            cryptoCallbacks: {} as CryptoCallbacks,
            storePrefix: "storePrefix",
            storeKey: storeKey,
        });

        expect(StoreHandle.openWithKey).toHaveBeenCalledWith("storePrefix", storeKey);
        expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore);
    });

    it("suppresses the storePassphrase and storeKey if storePrefix is unset", async () => {
        const mockStore = { free: jest.fn() } as unknown as StoreHandle;
        jest.spyOn(StoreHandle, "open").mockResolvedValue(mockStore);

        const testOlmMachine = makeTestOlmMachine();
        jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);

        await initRustCrypto({
            logger,
            http: {} as MatrixClient["http"],
            userId: TEST_USER,
            deviceId: TEST_DEVICE_ID,
            secretStorage: {} as ServerSideSecretStorage,
            cryptoCallbacks: {} as CryptoCallbacks,
            storePrefix: null,
            storeKey: new Uint8Array(),
            storePassphrase: "storePassphrase",
        });

        expect(StoreHandle.open).toHaveBeenCalledWith();
        expect(OlmMachine.initFromStore).toHaveBeenCalledWith(expect.anything(), expect.anything(), mockStore);
    });

    it("Should get secrets from inbox on start", async () => {
        const mockStore = { free: jest.fn() } as unknown as StoreHandle;
        jest.spyOn(StoreHandle, "open").mockResolvedValue(mockStore);

        const testOlmMachine = makeTestOlmMachine();
        jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);

        await initRustCrypto({
            logger,
            http: {} as MatrixClient["http"],
            userId: TEST_USER,
            deviceId: TEST_DEVICE_ID,
            secretStorage: {} as ServerSideSecretStorage,
            cryptoCallbacks: {} as CryptoCallbacks,
            storePrefix: "storePrefix",
            storePassphrase: "storePassphrase",
        });

        expect(testOlmMachine.getSecretsFromInbox).toHaveBeenCalledWith("m.megolm_backup.v1");
    });

    describe("libolm migration", () => {
        let mockStore: RustSdkCryptoJs.StoreHandle;

        beforeEach(() => {
            // Stub out a bunch of stuff in the Rust library
            mockStore = { free: jest.fn() } as unknown as StoreHandle;
            jest.spyOn(StoreHandle, "open").mockResolvedValue(mockStore);

            jest.spyOn(Migration, "migrateBaseData").mockResolvedValue(undefined);
            jest.spyOn(Migration, "migrateOlmSessions").mockResolvedValue(undefined);
            jest.spyOn(Migration, "migrateMegolmSessions").mockResolvedValue(undefined);

            const testOlmMachine = makeTestOlmMachine();
            testOlmMachine.trackedUsers.mockResolvedValue(new Set([]));
            jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);
        });

        it("migrates data from a legacy crypto store", async () => {
            const PICKLE_KEY = "pickle1234";
            const legacyStore = new MemoryCryptoStore();

            // Populate the legacy store with some test data
            const storeSecretKey = (type: string, key: string) =>
                encryptAndStoreSecretKey(type, new TextEncoder().encode(key), PICKLE_KEY, legacyStore);

            await legacyStore.storeAccount({}, "not a real account");
            await storeSecretKey("m.megolm_backup.v1", "backup key");
            await storeSecretKey("master", "master key");
            await storeSecretKey("self_signing", "ssk");
            await storeSecretKey("user_signing", "usk");
            const nDevices = 6;
            const nSessionsPerDevice = 10;
            createSessions(legacyStore, nDevices, nSessionsPerDevice);
            createMegolmSessions(legacyStore, nDevices, nSessionsPerDevice);
            await legacyStore.markSessionsNeedingBackup([{ senderKey: pad43("device5"), sessionId: "session5" }]);

            fetchMock.get("path:/_matrix/client/v3/room_keys/version", {
                auth_data: {
                    public_key: "backup_key_public",
                },
                version: "45",
                algorithm: "m.megolm_backup.v1.curve25519-aes-sha2",
            });
            // The cached key should be valid for the backup
            const mockBackupDecryptionKey: any = {
                megolmV1PublicKey: {
                    publicKeyBase64: "backup_key_public",
                },
            };
            jest.spyOn(RustSdkCryptoJs.BackupDecryptionKey, "fromBase64").mockReturnValue(mockBackupDecryptionKey);

            function legacyMigrationProgressListener(progress: number, total: number): void {
                logger.log(`migrated ${progress} of ${total}`);
            }

            await initRustCrypto({
                logger,
                http: makeMatrixHttpApi(),
                userId: TEST_USER,
                deviceId: TEST_DEVICE_ID,
                secretStorage: {} as ServerSideSecretStorage,
                cryptoCallbacks: {} as CryptoCallbacks,
                storePrefix: "storePrefix",
                storePassphrase: "storePassphrase",
                legacyCryptoStore: legacyStore,
                legacyPickleKey: PICKLE_KEY,
                legacyMigrationProgressListener,
            });

            // Check that the migration functions were correctly called
            expect(Migration.migrateBaseData).toHaveBeenCalledWith(
                expect.any(BaseMigrationData),
                new Uint8Array(Buffer.from(PICKLE_KEY)),
                mockStore,
            );
            const data = mocked(Migration.migrateBaseData).mock.calls[0][0];
            expect(data.pickledAccount).toEqual("not a real account");
            expect(data.userId!.toString()).toEqual(TEST_USER);
            expect(data.deviceId!.toString()).toEqual(TEST_DEVICE_ID);
            expect(atob(data.backupRecoveryKey!)).toEqual("backup key");
            expect(data.backupVersion).toEqual("45");
            expect(atob(data.privateCrossSigningMasterKey!)).toEqual("master key");
            expect(atob(data.privateCrossSigningUserSigningKey!)).toEqual("usk");
            expect(atob(data.privateCrossSigningSelfSigningKey!)).toEqual("ssk");

            expect(Migration.migrateOlmSessions).toHaveBeenCalledTimes(2);
            expect(Migration.migrateOlmSessions).toHaveBeenCalledWith(
                expect.any(Array),
                new Uint8Array(Buffer.from(PICKLE_KEY)),
                mockStore,
            );
            // First call should have 50 entries; second should have 10
            const sessions1: PickledSession[] = mocked(Migration.migrateOlmSessions).mock.calls[0][0];
            expect(sessions1.length).toEqual(50);
            const sessions2: PickledSession[] = mocked(Migration.migrateOlmSessions).mock.calls[1][0];
            expect(sessions2.length).toEqual(10);
            const sessions = [...sessions1, ...sessions2];
            for (let i = 0; i < nDevices; i++) {
                for (let j = 0; j < nSessionsPerDevice; j++) {
                    const session = sessions[i * nSessionsPerDevice + j];
                    expect(session.senderKey).toEqual(`device${i}`);
                    expect(session.pickle).toEqual(`session${i}.${j}`);
                    expect(session.creationTime).toEqual(new Date(1000));
                    expect(session.lastUseTime).toEqual(new Date(1000));
                }
            }

            expect(Migration.migrateMegolmSessions).toHaveBeenCalledTimes(2);
            expect(Migration.migrateMegolmSessions).toHaveBeenCalledWith(
                expect.any(Array),
                new Uint8Array(Buffer.from(PICKLE_KEY)),
                mockStore,
            );
            // First call should have 50 entries; second should have 10
            const megolmSessions1: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock
                .calls[0][0];
            expect(megolmSessions1.length).toEqual(50);
            const megolmSessions2: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock
                .calls[1][0];
            expect(megolmSessions2.length).toEqual(10);
            const megolmSessions = [...megolmSessions1, ...megolmSessions2];
            for (let i = 0; i < nDevices; i++) {
                for (let j = 0; j < nSessionsPerDevice; j++) {
                    const session = megolmSessions[i * nSessionsPerDevice + j];
                    expect(session.senderKey).toEqual(pad43(`device${i}`));
                    expect(session.pickle).toEqual("sessionPickle");
                    expect(session.roomId!.toString()).toEqual("!room:id");
                    expect(session.senderSigningKey).toEqual("sender_signing_key");

                    // only one of the sessions needs backing up
                    expect(session.backedUp).toEqual(i !== 5 || j !== 5);
                }
            }
        }, 10000);

        it("migrates data from a legacy crypto store when secret are not encrypted", async () => {
            const PICKLE_KEY = "pickle1234";
            const legacyStore = new MemoryCryptoStore();

            // It's possible for old sessions to directly store the secrets as raw UInt8Array,
            // so we need to support that in the migration code.
            // See https://github.com/matrix-org/matrix-js-sdk/commit/c81f11df0afd4d0da3b088892745ae2f8ba1c4a7
            async function storeSecretKeyInClear(type: string, key: Uint8Array, store: CryptoStore) {
                // @ts-ignore The API to store raw UInt8Array does not exist anymore, so we need that for this test.
                store.privateKeys[type as keyof SecretStorePrivateKeys] = key;
            }

            // Populate the legacy store with some test data
            const storeSecretKey = (type: string, key: string) =>
                storeSecretKeyInClear(type, new TextEncoder().encode(key), legacyStore);

            await legacyStore.storeAccount({}, "not a real account");
            await storeSecretKey("master", "master key");
            await storeSecretKey("self_signing", "ssk");
            await storeSecretKey("user_signing", "usk");

            fetchMock.get("path:/_matrix/client/v3/room_keys/version", 404);

            function legacyMigrationProgressListener(progress: number, total: number): void {
                logger.log(`migrated ${progress} of ${total}`);
            }

            await initRustCrypto({
                logger,
                http: makeMatrixHttpApi(),
                userId: TEST_USER,
                deviceId: TEST_DEVICE_ID,
                secretStorage: {} as ServerSideSecretStorage,
                cryptoCallbacks: {} as CryptoCallbacks,
                storePrefix: "storePrefix",
                storePassphrase: "storePassphrase",
                legacyCryptoStore: legacyStore,
                legacyPickleKey: PICKLE_KEY,
                legacyMigrationProgressListener,
            });

            const data = mocked(Migration.migrateBaseData).mock.calls[0][0];
            expect(data.pickledAccount).toEqual("not a real account");
            expect(data.userId!.toString()).toEqual(TEST_USER);
            expect(data.deviceId!.toString()).toEqual(TEST_DEVICE_ID);
            expect(atob(data.privateCrossSigningMasterKey!)).toEqual("master key");
            expect(atob(data.privateCrossSigningUserSigningKey!)).toEqual("usk");
            expect(atob(data.privateCrossSigningSelfSigningKey!)).toEqual("ssk");
        });

        it("handles megolm sessions with no `keysClaimed`", async () => {
            const legacyStore = new MemoryCryptoStore();
            legacyStore.storeAccount({}, "not a real account");

            legacyStore.storeEndToEndInboundGroupSession(
                pad43(`device1`),
                `session1`,
                {
                    forwardingCurve25519KeyChain: [],
                    room_id: "!room:id",
                    session: "sessionPickle",
                },
                undefined,
            );

            const PICKLE_KEY = "pickle1234";
            await initRustCrypto({
                logger,
                http: makeMatrixHttpApi(),
                userId: TEST_USER,
                deviceId: TEST_DEVICE_ID,
                secretStorage: {} as ServerSideSecretStorage,
                cryptoCallbacks: {} as CryptoCallbacks,
                storePrefix: "storePrefix",
                storePassphrase: "storePassphrase",
                legacyCryptoStore: legacyStore,
                legacyPickleKey: PICKLE_KEY,
            });

            expect(Migration.migrateMegolmSessions).toHaveBeenCalledTimes(1);
            expect(Migration.migrateMegolmSessions).toHaveBeenCalledWith(
                expect.any(Array),
                new Uint8Array(Buffer.from(PICKLE_KEY)),
                mockStore,
            );
            const megolmSessions: PickledInboundGroupSession[] = mocked(Migration.migrateMegolmSessions).mock
                .calls[0][0];
            expect(megolmSessions.length).toEqual(1);
            const session = megolmSessions[0];
            expect(session.senderKey).toEqual(pad43(`device1`));
            expect(session.pickle).toEqual("sessionPickle");
            expect(session.roomId!.toString()).toEqual("!room:id");
            expect(session.senderSigningKey).toBe(undefined);
        }, 10000);

        async function encryptAndStoreSecretKey(
            type: string,
            key: Uint8Array,
            pickleKey: string,
            store: MemoryCryptoStore,
        ) {
            const encryptedKey = await encryptAESSecretStorageItem(encodeBase64(key), Buffer.from(pickleKey), type);
            store.storeSecretStorePrivateKey(undefined, type as keyof SecretStorePrivateKeys, encryptedKey);
        }

        /** Create a bunch of fake Olm sessions and stash them in the DB. */
        function createSessions(store: MemoryCryptoStore, nDevices: number, nSessionsPerDevice: number) {
            for (let i = 0; i < nDevices; i++) {
                for (let j = 0; j < nSessionsPerDevice; j++) {
                    const sessionData = {
                        deviceKey: `device${i}`,
                        sessionId: `session${j}`,
                        session: `session${i}.${j}`,
                        lastReceivedMessageTs: 1000,
                    };
                    store.storeEndToEndSession(`device${i}`, `session${j}`, sessionData, undefined);
                }
            }
        }

        /** Create a bunch of fake Megolm sessions and stash them in the DB. */
        function createMegolmSessions(store: MemoryCryptoStore, nDevices: number, nSessionsPerDevice: number) {
            for (let i = 0; i < nDevices; i++) {
                for (let j = 0; j < nSessionsPerDevice; j++) {
                    store.storeEndToEndInboundGroupSession(
                        pad43(`device${i}`),
                        `session${j}`,
                        {
                            forwardingCurve25519KeyChain: [],
                            keysClaimed: { ed25519: "sender_signing_key" },
                            room_id: "!room:id",
                            session: "sessionPickle",
                        },
                        undefined,
                    );
                }
            }
        }
    });
});

describe("RustCrypto", () => {
    it("getVersion() should return the current version of the rust sdk and vodozemac", async () => {
        const rustCrypto = await makeTestRustCrypto();
        const versions = RustSdkCryptoJs.getVersions();
        expect(rustCrypto.getVersion()).toBe(
            `Rust SDK ${versions.matrix_sdk_crypto} (${versions.git_sha}), Vodozemac ${versions.vodozemac}`,
        );
    });

    describe("importing and exporting room keys", () => {
        let rustCrypto: RustCrypto;

        beforeEach(
            async () => {
                rustCrypto = await makeTestRustCrypto();
            },
            /* it can take a while to initialise the crypto library on the first pass, so bump up the timeout. */
            10000,
        );

        it("should import and export keys", async () => {
            const someRoomKeys = testData.MEGOLM_SESSION_DATA_ARRAY;
            let importTotal = 0;
            const opt: ImportRoomKeysOpts = {
                progressCallback: (progress) => {
                    if (progress.stage === "load_keys") {
                        importTotal = progress.total;
                    }
                },
            };
            await rustCrypto.importRoomKeys(someRoomKeys, opt);

            expect(importTotal).toBe(someRoomKeys.length);

            const keys = await rustCrypto.exportRoomKeys();
            expect(Array.isArray(keys)).toBeTruthy();
            expect(keys.length).toBe(someRoomKeys.length);

            const exportedKey = keys.find((k) => k.session_id == someRoomKeys[0].session_id);
            expect(exportedKey).toMatchSnapshot();
        });

        it("should import and export keys as JSON", async () => {
            const someRoomKeys = testData.MEGOLM_SESSION_DATA_ARRAY;
            let importTotal = 0;
            const opt: ImportRoomKeysOpts = {
                progressCallback: (progress) => {
                    if (progress.stage === "load_keys") {
                        importTotal = progress.total;
                    }
                },
            };
            await rustCrypto.importRoomKeysAsJson(JSON.stringify(someRoomKeys), opt);

            expect(importTotal).toBe(someRoomKeys.length);

            const keys: Array<IMegolmSessionData> = JSON.parse(await rustCrypto.exportRoomKeysAsJson());
            expect(Array.isArray(keys)).toBeTruthy();
            expect(keys.length).toBe(someRoomKeys.length);

            const exportedKey = keys.find((k) => k.session_id == someRoomKeys[0].session_id);
            expect(exportedKey).toMatchSnapshot();
        });
    });

    describe("call preprocess methods", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto();
        });

        it("should pass through unencrypted to-device messages", async () => {
            const inputs: IToDeviceEvent[] = [
                { content: { key: "value" }, type: "org.matrix.test", sender: "@alice:example.com" },
            ];
            const res = await rustCrypto.preprocessToDeviceMessages(inputs);
            expect(res).toEqual(inputs);
        });

        it("should pass through bad encrypted messages", async () => {
            const olmMachine: OlmMachine = rustCrypto["olmMachine"];
            const keys = olmMachine.identityKeys;
            const inputs: IToDeviceEvent[] = [
                {
                    type: "m.room.encrypted",
                    content: {
                        algorithm: "m.olm.v1.curve25519-aes-sha2",
                        sender_key: "IlRMeOPX2e0MurIyfWEucYBRVOEEUMrOHqn/8mLqMjA",
                        ciphertext: {
                            [keys.curve25519.toBase64()]: {
                                type: 0,
                                body: "ajyjlghi",
                            },
                        },
                    },
                    sender: "@alice:example.com",
                },
            ];

            const res = await rustCrypto.preprocessToDeviceMessages(inputs);
            expect(res).toEqual(inputs);
        });

        it("emits VerificationRequestReceived on incoming m.key.verification.request", async () => {
            rustCrypto = await makeTestRustCrypto(
                new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                    baseUrl: "http://server/",
                    prefix: "",
                    onlyData: true,
                }),
                testData.TEST_USER_ID,
            );

            fetchMock.post("path:/_matrix/client/v3/keys/upload", { one_time_key_counts: {} });
            fetchMock.post("path:/_matrix/client/v3/keys/query", {
                device_keys: {
                    [testData.TEST_USER_ID]: {
                        [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA,
                    },
                },
            });

            // wait until we know about the other device
            rustCrypto.onSyncCompleted({});
            await rustCrypto.getUserDeviceInfo([testData.TEST_USER_ID]);

            const toDeviceEvent = {
                type: "m.key.verification.request",
                content: {
                    from_device: testData.TEST_DEVICE_ID,
                    methods: ["m.sas.v1"],
                    transaction_id: "testTxn",
                    timestamp: Date.now() - 1000,
                },
                sender: testData.TEST_USER_ID,
            };

            const onEvent = jest.fn();
            rustCrypto.on(CryptoEvent.VerificationRequestReceived, onEvent);
            await rustCrypto.preprocessToDeviceMessages([toDeviceEvent]);
            expect(onEvent).toHaveBeenCalledTimes(1);

            const [req]: [VerificationRequest] = onEvent.mock.lastCall;
            expect(req.transactionId).toEqual("testTxn");
        });
    });

    it("getCrossSigningKeyId when there is no cross signing keys", async () => {
        const rustCrypto = await makeTestRustCrypto();
        await expect(rustCrypto.getCrossSigningKeyId()).resolves.toBe(null);
    });

    describe("getCrossSigningStatus", () => {
        it("returns sensible values on a default client", async () => {
            const secretStorage = {
                isStored: jest.fn().mockResolvedValue(null),
                getDefaultKeyId: jest.fn().mockResolvedValue("key"),
            } as unknown as Mocked<ServerSideSecretStorage>;
            const rustCrypto = await makeTestRustCrypto(undefined, undefined, undefined, secretStorage);

            const result = await rustCrypto.getCrossSigningStatus();

            expect(secretStorage.isStored).toHaveBeenCalledWith("m.cross_signing.master");
            expect(result).toEqual({
                privateKeysCachedLocally: {
                    masterKey: false,
                    selfSigningKey: false,
                    userSigningKey: false,
                },
                privateKeysInSecretStorage: false,
                publicKeysOnDevice: false,
            });
        });

        it("throws if `stop` is called mid-call", async () => {
            const secretStorage = {
                isStored: jest.fn().mockResolvedValue(null),
                getDefaultKeyId: jest.fn().mockResolvedValue(null),
            } as unknown as Mocked<ServerSideSecretStorage>;
            const rustCrypto = await makeTestRustCrypto(undefined, undefined, undefined, secretStorage);

            // start the call off
            const result = rustCrypto.getCrossSigningStatus();

            // call `.stop`
            rustCrypto.stop();

            // getCrossSigningStatus should abort
            await expect(result).rejects.toEqual(new Error("MatrixClient has been stopped"));
        });
    });

    it("bootstrapCrossSigning delegates to CrossSigningIdentity", async () => {
        const rustCrypto = await makeTestRustCrypto();
        const mockCrossSigningIdentity = {
            bootstrapCrossSigning: jest.fn().mockResolvedValue(undefined),
        };
        // @ts-ignore private property
        rustCrypto.crossSigningIdentity = mockCrossSigningIdentity;
        await rustCrypto.bootstrapCrossSigning({});
        expect(mockCrossSigningIdentity.bootstrapCrossSigning).toHaveBeenCalledWith({});
    });

    it("bootstrapSecretStorage creates new backup when requested", async () => {
        const secretStorageCallbacks = {
            getSecretStorageKey: async (keys: any, name: string) => {
                return [[...Object.keys(keys.keys)][0], new Uint8Array(32)];
            },
        } as SecretStorageCallbacks;
        const secretStorage = new ServerSideSecretStorageImpl(new DummyAccountDataClient(), secretStorageCallbacks);

        const outgoingRequestProcessor = {
            makeOutgoingRequest: jest.fn(),
        } as unknown as Mocked<OutgoingRequestProcessor>;

        const rustCrypto = await makeTestRustCrypto(
            new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                baseUrl: "http://server/",
                prefix: "",
                onlyData: true,
            }),
            testData.TEST_USER_ID,
            undefined,
            secretStorage,
        );

        rustCrypto["checkKeyBackupAndEnable"] = async () => {
            return null;
        };
        (rustCrypto["crossSigningIdentity"] as any)["outgoingRequestProcessor"] = outgoingRequestProcessor;
        const resetKeyBackup = (rustCrypto["resetKeyBackup"] = jest.fn());

        async function createSecretStorageKey() {
            return {
                keyInfo: {} as AddSecretStorageKeyOpts,
                privateKey: new Uint8Array(32),
            };
        }

        // create initial secret storage
        await rustCrypto.bootstrapCrossSigning({ setupNewCrossSigning: true });
        await rustCrypto.bootstrapSecretStorage({
            createSecretStorageKey,
            setupNewSecretStorage: true,
            setupNewKeyBackup: true,
        });
        // check that rustCrypto.resetKeyBackup was called
        expect(resetKeyBackup.mock.calls).toHaveLength(1);

        // reset secret storage
        await rustCrypto.bootstrapSecretStorage({
            createSecretStorageKey,
            setupNewSecretStorage: true,
            setupNewKeyBackup: true,
        });
        // check that rustCrypto.resetKeyBackup was called again
        expect(resetKeyBackup.mock.calls).toHaveLength(2);
    });

    describe("upload existing key backup key to new 4S store", () => {
        const secretStorageCallbacks = {
            getSecretStorageKey: async (keys: any, name: string) => {
                return [[...Object.keys(keys.keys)][0], new Uint8Array(32)];
            },
        } as SecretStorageCallbacks;
        let secretStorage: ServerSideSecretStorageImpl;

        let backupAuthData: any;
        let backupAlg: string;

        const fetchMock = {
            authedRequest: jest.fn().mockImplementation((method, path, query, body) => {
                if (path === "/room_keys/version") {
                    if (method === "POST") {
                        backupAuthData = body["auth_data"];
                        backupAlg = body["algorithm"];
                        return Promise.resolve({ version: "1", algorithm: backupAlg, auth_data: backupAuthData });
                    } else if (method === "GET" && backupAuthData) {
                        return Promise.resolve({ version: "1", algorithm: backupAlg, auth_data: backupAuthData });
                    }
                }
                return Promise.resolve({});
            }),
        };

        beforeEach(() => {
            backupAuthData = undefined;
            backupAlg = "";

            secretStorage = new ServerSideSecretStorageImpl(new DummyAccountDataClient(), secretStorageCallbacks);
        });

        it("bootstrapSecretStorage saves megolm backup key if already cached", async () => {
            const rustCrypto = await makeTestRustCrypto(
                fetchMock as unknown as MatrixHttpApi<any>,
                testData.TEST_USER_ID,
                undefined,
                secretStorage,
            );

            async function createSecretStorageKey() {
                return {
                    keyInfo: {} as AddSecretStorageKeyOpts,
                    privateKey: new Uint8Array(32),
                };
            }

            await rustCrypto.resetKeyBackup();

            const storeSpy = jest.spyOn(secretStorage, "store");

            await rustCrypto.bootstrapSecretStorage({
                createSecretStorageKey,
                setupNewSecretStorage: true,
                setupNewKeyBackup: false,
            });

            expect(storeSpy).toHaveBeenCalledWith("m.megolm_backup.v1", expect.anything());
        });

        it("bootstrapSecretStorage doesn't try to save megolm backup key not in cache", async () => {
            const mockOlmMachine = {
                isBackupEnabled: jest.fn().mockResolvedValue(false),
                sign: jest.fn().mockResolvedValue({
                    asJSON: jest.fn().mockReturnValue("{}"),
                }),
                saveBackupDecryptionKey: jest.fn(),
                exportCrossSigningKeys: jest.fn().mockResolvedValue({
                    masterKey: "sosecret",
                    userSigningKey: "secrets",
                    self_signing_key: "ssshhh",
                }),
                getBackupKeys: jest.fn().mockResolvedValue({}),
                verifyBackup: jest.fn().mockResolvedValue({ trusted: jest.fn().mockReturnValue(false) }),
            } as unknown as OlmMachine;

            const rustCrypto = new RustCrypto(
                logger,
                mockOlmMachine,
                fetchMock as unknown as MatrixHttpApi<any>,
                TEST_USER,
                TEST_DEVICE_ID,
                secretStorage,
                {} as CryptoCallbacks,
            );

            async function createSecretStorageKey() {
                return {
                    keyInfo: {} as AddSecretStorageKeyOpts,
                    privateKey: new Uint8Array(32),
                };
            }

            await rustCrypto.resetKeyBackup();

            const storeSpy = jest.spyOn(secretStorage, "store");

            await rustCrypto.bootstrapSecretStorage({
                createSecretStorageKey,
                setupNewSecretStorage: true,
                setupNewKeyBackup: false,
            });

            expect(storeSpy).not.toHaveBeenCalledWith("m.megolm_backup.v1", expect.anything());
        });
    });

    it("isSecretStorageReady", async () => {
        const mockSecretStorage = {
            getDefaultKeyId: jest.fn().mockResolvedValue(null),
        } as unknown as Mocked<ServerSideSecretStorage>;
        const rustCrypto = await makeTestRustCrypto(undefined, undefined, undefined, mockSecretStorage);
        await expect(rustCrypto.isSecretStorageReady()).resolves.toBe(false);
    });

    describe("outgoing requests", () => {
        /** the RustCrypto implementation under test */
        let rustCrypto: RustCrypto;

        /** A mock OutgoingRequestProcessor which rustCrypto is connected to */
        let outgoingRequestProcessor: Mocked<OutgoingRequestProcessor>;

        /** a mocked-up OlmMachine which rustCrypto is connected to */
        let olmMachine: Mocked<RustSdkCryptoJs.OlmMachine>;

        /** A list of results to be returned from olmMachine.outgoingRequest. Each call will shift a result off
         *  the front of the queue, until it is empty. */
        let outgoingRequestQueue: Array<Array<any>>;

        /** wait for a call to outgoingRequestProcessor.makeOutgoingRequest.
         *
         * The promise resolves to a callback: the makeOutgoingRequest call will not complete until the returned
         * callback is called.
         */
        function awaitCallToMakeOutgoingRequest(): Promise<() => void> {
            return new Promise<() => void>((resolveCalledPromise, _reject) => {
                outgoingRequestProcessor.makeOutgoingRequest.mockImplementationOnce(async () => {
                    const completePromise = new Promise<void>((resolveCompletePromise, _reject) => {
                        resolveCalledPromise(resolveCompletePromise);
                    });
                    return completePromise;
                });
            });
        }

        beforeEach(async () => {
            await RustSdkCryptoJs.initAsync();

            // for these tests we use a mock OlmMachine, with an implementation of outgoingRequests that
            // returns objects from outgoingRequestQueue
            outgoingRequestQueue = [];
            olmMachine = {
                outgoingRequests: jest.fn().mockImplementation(() => {
                    return Promise.resolve(outgoingRequestQueue.shift() ?? []);
                }),
                close: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;

            outgoingRequestProcessor = {
                makeOutgoingRequest: jest.fn(),
            } as unknown as Mocked<OutgoingRequestProcessor>;

            const outgoingRequestsManager = new OutgoingRequestsManager(logger, olmMachine, outgoingRequestProcessor);

            rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                {} as MatrixHttpApi<any>,
                TEST_USER,
                TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );
            rustCrypto["outgoingRequestProcessor"] = outgoingRequestProcessor;
            rustCrypto["outgoingRequestsManager"] = outgoingRequestsManager;
        });

        it("should poll for outgoing messages and send them", async () => {
            const testReq = new KeysQueryRequest("1234", "{}");
            outgoingRequestQueue.push([testReq]);

            const makeRequestPromise = awaitCallToMakeOutgoingRequest();
            rustCrypto.onSyncCompleted({});

            await makeRequestPromise;
            expect(olmMachine.outgoingRequests).toHaveBeenCalled();
            expect(outgoingRequestProcessor.makeOutgoingRequest).toHaveBeenCalledWith(testReq);
        });

        it("should go round the loop again if another sync completes while the first `outgoingRequests` is running", async () => {
            // the first call to `outgoingMessages` will return a promise which blocks for a while
            const firstOutgoingRequestsDefer = defer<Array<any>>();
            mocked(olmMachine.outgoingRequests).mockReturnValueOnce(firstOutgoingRequestsDefer.promise);

            // the second will return a KeysQueryRequest.
            const testReq = new KeysQueryRequest("1234", "{}");
            outgoingRequestQueue.push([testReq]);

            // the first sync completes, triggering the first call to `outgoingMessages`
            rustCrypto.onSyncCompleted({});
            expect(olmMachine.outgoingRequests).toHaveBeenCalledTimes(1);

            // a second /sync completes before the first call to `outgoingRequests` completes. It shouldn't trigger
            // a second call immediately, but should queue one up.
            rustCrypto.onSyncCompleted({});
            expect(olmMachine.outgoingRequests).toHaveBeenCalledTimes(1);

            // the first call now completes, *with an empty result*, which would normally cause us to exit the loop, but
            // we should have a second call queued. It should trigger a call to `makeOutgoingRequest`.
            firstOutgoingRequestsDefer.resolve([]);
            await awaitCallToMakeOutgoingRequest();
            expect(olmMachine.outgoingRequests).toHaveBeenCalledTimes(2);
        });

        it("should encode outgoing requests properly", async () => {
            // we need a real OlmMachine, so replace the one created by beforeEach
            rustCrypto = await makeTestRustCrypto();
            const olmMachine: OlmMachine = rustCrypto["olmMachine"];

            const outgoingRequestProcessor = {} as unknown as OutgoingRequestProcessor;
            rustCrypto["outgoingRequestProcessor"] = outgoingRequestProcessor;
            const outgoingRequestsManager = new OutgoingRequestsManager(logger, olmMachine, outgoingRequestProcessor);
            rustCrypto["outgoingRequestsManager"] = outgoingRequestsManager;

            // The second time we do a /keys/upload, the `device_keys` property
            // should be absent from the request body
            // cf. https://github.com/matrix-org/matrix-rust-sdk-crypto-wasm/issues/57
            //
            // On the first upload, we pretend that there are no OTKs, so it will
            // try to upload more keys
            let keysUploadCount = 0;
            let deviceKeys: object;
            let deviceKeysAbsent = false;
            outgoingRequestProcessor.makeOutgoingRequest = jest.fn(async (request, uiaCallback?) => {
                let resp: any = {};
                if (request instanceof RustSdkCryptoJs.KeysUploadRequest) {
                    if (keysUploadCount == 0) {
                        deviceKeys = JSON.parse(request.body).device_keys;
                        resp = { one_time_key_counts: { signed_curve25519: 0 } };
                    } else {
                        deviceKeysAbsent = !("device_keys" in JSON.parse(request.body));
                        resp = { one_time_key_counts: { signed_curve25519: 50 } };
                    }
                    keysUploadCount++;
                } else if (request instanceof RustSdkCryptoJs.KeysQueryRequest) {
                    resp = {
                        device_keys: {
                            [TEST_USER]: {
                                [TEST_DEVICE_ID]: deviceKeys,
                            },
                        },
                    };
                } else if (
                    request instanceof RustSdkCryptoJs.UploadSigningKeysRequest ||
                    request instanceof RustSdkCryptoJs.PutDehydratedDeviceRequest
                ) {
                    // These request types do not implement OutgoingRequest and do not need to be marked as sent.
                    return;
                }
                if (request.id) {
                    olmMachine.markRequestAsSent(request.id, request.type, JSON.stringify(resp));
                }
            });
            await outgoingRequestsManager.doProcessOutgoingRequests();
            await outgoingRequestsManager.doProcessOutgoingRequests();

            expect(deviceKeysAbsent).toBe(true);
        });
    });

    describe(".getEncryptionInfoForEvent", () => {
        let rustCrypto: RustCrypto;
        let olmMachine: Mocked<RustSdkCryptoJs.OlmMachine>;

        beforeEach(() => {
            olmMachine = {
                getRoomEventEncryptionInfo: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;
            rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                {} as MatrixClient["http"],
                TEST_USER,
                TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );
        });

        async function makeEncryptedEvent(): Promise<MatrixEvent> {
            const encryptedEvent = mkEvent({
                event: true,
                type: "m.room.encrypted",
                content: { algorithm: "fake_alg" },
                room: "!room:id",
            });
            encryptedEvent.event.event_id = "$event:id";
            const mockCryptoBackend = {
                decryptEvent: () =>
                    ({
                        clearEvent: { content: { body: "1234" } },
                    }) as unknown as IEventDecryptionResult,
            } as unknown as CryptoBackend;
            await encryptedEvent.attemptDecryption(mockCryptoBackend);
            return encryptedEvent;
        }

        it("should handle unencrypted events", async () => {
            const event = mkEvent({ event: true, type: "m.room.message", content: { body: "xyz" } });
            const res = await rustCrypto.getEncryptionInfoForEvent(event);
            expect(res).toBe(null);
            expect(olmMachine.getRoomEventEncryptionInfo).not.toHaveBeenCalled();
        });

        it("should handle decryption failures", async () => {
            const event = mkEvent({
                event: true,
                type: "m.room.encrypted",
                content: { algorithm: "fake_alg" },
                room: "!room:id",
            });
            event.event.event_id = "$event:id";
            const mockCryptoBackend = {
                decryptEvent: () => {
                    throw new Error("UISI");
                },
            };
            await event.attemptDecryption(mockCryptoBackend as unknown as CryptoBackend);

            const res = await rustCrypto.getEncryptionInfoForEvent(event);
            expect(res).toBe(null);
            expect(olmMachine.getRoomEventEncryptionInfo).not.toHaveBeenCalled();
        });

        it("passes the event into the OlmMachine", async () => {
            const encryptedEvent = await makeEncryptedEvent();
            const res = await rustCrypto.getEncryptionInfoForEvent(encryptedEvent);
            expect(res).toBe(null);
            expect(olmMachine.getRoomEventEncryptionInfo).toHaveBeenCalledTimes(1);
            const [passedEvent, passedRoom] = olmMachine.getRoomEventEncryptionInfo.mock.calls[0];
            expect(passedRoom.toString()).toEqual("!room:id");
            expect(JSON.parse(passedEvent)).toStrictEqual(
                expect.objectContaining({
                    event_id: "$event:id",
                }),
            );
        });

        it.each([
            [RustSdkCryptoJs.ShieldColor.None, EventShieldColour.NONE],
            [RustSdkCryptoJs.ShieldColor.Grey, EventShieldColour.GREY],
            [RustSdkCryptoJs.ShieldColor.Red, EventShieldColour.RED],
        ])("gets the right shield color (%i)", async (rustShield, expectedShield) => {
            const mockEncryptionInfo = {
                shieldState: jest.fn().mockReturnValue({ color: rustShield, message: undefined }),
            } as unknown as RustSdkCryptoJs.EncryptionInfo;
            olmMachine.getRoomEventEncryptionInfo.mockResolvedValue(mockEncryptionInfo);

            const res = await rustCrypto.getEncryptionInfoForEvent(await makeEncryptedEvent());
            expect(mockEncryptionInfo.shieldState).toHaveBeenCalledWith(false);
            expect(res).not.toBe(null);
            expect(res!.shieldColour).toEqual(expectedShield);
        });

        it.each([
            [undefined, undefined, null],
            [
                "Encrypted by an unverified user.",
                RustSdkCryptoJs.ShieldStateCode.UnverifiedIdentity,
                EventShieldReason.UNVERIFIED_IDENTITY,
            ],
            [
                "Encrypted by a device not verified by its owner.",
                RustSdkCryptoJs.ShieldStateCode.UnsignedDevice,
                EventShieldReason.UNSIGNED_DEVICE,
            ],
            [
                "The authenticity of this encrypted message can't be guaranteed on this device.",
                RustSdkCryptoJs.ShieldStateCode.AuthenticityNotGuaranteed,
                EventShieldReason.AUTHENTICITY_NOT_GUARANTEED,
            ],
            [
                "Encrypted by an unknown or deleted device.",
                RustSdkCryptoJs.ShieldStateCode.UnknownDevice,
                EventShieldReason.UNKNOWN_DEVICE,
            ],
            ["Not encrypted.", RustSdkCryptoJs.ShieldStateCode.SentInClear, EventShieldReason.SENT_IN_CLEAR],
            [
                "Encrypted by a previously-verified user who is no longer verified.",
                RustSdkCryptoJs.ShieldStateCode.VerificationViolation,
                EventShieldReason.VERIFICATION_VIOLATION,
            ],
        ])("gets the right shield reason (%s)", async (rustReason, rustCode, expectedReason) => {
            // suppress the warning from the unknown shield reason
            jest.spyOn(console, "warn").mockImplementation(() => {});

            const mockEncryptionInfo = {
                shieldState: jest
                    .fn()
                    .mockReturnValue({ color: RustSdkCryptoJs.ShieldColor.None, code: rustCode, message: rustReason }),
            } as unknown as RustSdkCryptoJs.EncryptionInfo;
            olmMachine.getRoomEventEncryptionInfo.mockResolvedValue(mockEncryptionInfo);

            const res = await rustCrypto.getEncryptionInfoForEvent(await makeEncryptedEvent());
            expect(mockEncryptionInfo.shieldState).toHaveBeenCalledWith(false);
            expect(res).not.toBe(null);
            expect(res!.shieldReason).toEqual(expectedReason);
        });
    });

    describe("get|setTrustCrossSignedDevices", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto();
        });

        it("should be true by default", () => {
            expect(rustCrypto.getTrustCrossSignedDevices()).toBe(true);
        });

        it("should be easily turn-off-and-on-able", () => {
            rustCrypto.setTrustCrossSignedDevices(false);
            expect(rustCrypto.getTrustCrossSignedDevices()).toBe(false);
            rustCrypto.setTrustCrossSignedDevices(true);
            expect(rustCrypto.getTrustCrossSignedDevices()).toBe(true);
        });
    });

    describe("setDeviceVerified", () => {
        let rustCrypto: RustCrypto;

        async function getTestDevice(): Promise<Device> {
            const devices = await rustCrypto.getUserDeviceInfo([testData.TEST_USER_ID]);
            return devices.get(testData.TEST_USER_ID)!.get(testData.TEST_DEVICE_ID)!;
        }

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto(
                new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                    baseUrl: "http://server/",
                    prefix: "",
                    onlyData: true,
                }),
                testData.TEST_USER_ID,
            );

            fetchMock.post("path:/_matrix/client/v3/keys/upload", { one_time_key_counts: {} });
            fetchMock.post("path:/_matrix/client/v3/keys/query", {
                device_keys: {
                    [testData.TEST_USER_ID]: {
                        [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA,
                    },
                },
            });
            // call onSyncCompleted to kick off the outgoingRequestLoop and download the device list.
            rustCrypto.onSyncCompleted({});

            // before the call, the device should be unverified.
            const device = await getTestDevice();
            expect(device.verified).toEqual(DeviceVerification.Unverified);
        });

        it("should throw an error for an unknown device", async () => {
            await expect(rustCrypto.setDeviceVerified(testData.TEST_USER_ID, "xxy")).rejects.toThrow("Unknown device");
        });

        it("should mark an unverified device as verified", async () => {
            await rustCrypto.setDeviceVerified(testData.TEST_USER_ID, testData.TEST_DEVICE_ID);

            // and confirm that the device is now verified
            expect((await getTestDevice()).verified).toEqual(DeviceVerification.Verified);
        });

        it("should mark a verified device as unverified", async () => {
            await rustCrypto.setDeviceVerified(testData.TEST_USER_ID, testData.TEST_DEVICE_ID);
            expect((await getTestDevice()).verified).toEqual(DeviceVerification.Verified);

            await rustCrypto.setDeviceVerified(testData.TEST_USER_ID, testData.TEST_DEVICE_ID, false);
            expect((await getTestDevice()).verified).toEqual(DeviceVerification.Unverified);
        });
    });

    describe("getDeviceVerificationStatus", () => {
        let rustCrypto: RustCrypto;
        let olmMachine: Mocked<RustSdkCryptoJs.OlmMachine>;

        beforeEach(() => {
            olmMachine = {
                getDevice: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;
            rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                {} as MatrixClient["http"],
                TEST_USER,
                TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );
        });

        it("should call getDevice", async () => {
            olmMachine.getDevice.mockResolvedValue({
                free: jest.fn(),
                isCrossSigningTrusted: jest.fn().mockReturnValue(false),
                isLocallyTrusted: jest.fn().mockReturnValue(false),
                isCrossSignedByOwner: jest.fn().mockReturnValue(false),
            } as unknown as RustSdkCryptoJs.Device);
            const res = await rustCrypto.getDeviceVerificationStatus("@user:domain", "device");
            expect(olmMachine.getDevice.mock.calls[0][0].toString()).toEqual("@user:domain");
            expect(olmMachine.getDevice.mock.calls[0][1].toString()).toEqual("device");
            expect(res?.crossSigningVerified).toBe(false);
            expect(res?.localVerified).toBe(false);
            expect(res?.signedByOwner).toBe(false);
        });

        it("should return null for unknown device", async () => {
            olmMachine.getDevice.mockResolvedValue(undefined);
            const res = await rustCrypto.getDeviceVerificationStatus("@user:domain", "device");
            expect(res).toBe(null);
        });
    });

    describe("userHasCrossSigningKeys", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto(
                new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                    baseUrl: "http://server/",
                    prefix: "",
                    onlyData: true,
                }),
                testData.TEST_USER_ID,
            );
        });

        it("throws an error if the fetch fails", async () => {
            fetchMock.post("path:/_matrix/client/v3/keys/query", 400);
            await expect(rustCrypto.userHasCrossSigningKeys()).rejects.toThrow("400 error");
        });

        it("returns false if the user has no cross-signing keys", async () => {
            fetchMock.post("path:/_matrix/client/v3/keys/query", {
                device_keys: {
                    [testData.TEST_USER_ID]: { [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA },
                },
            });

            await expect(rustCrypto.userHasCrossSigningKeys()).resolves.toBe(false);
        });

        it("returns true if the user has cross-signing keys", async () => {
            fetchMock.post("path:/_matrix/client/v3/keys/query", {
                device_keys: {
                    [testData.TEST_USER_ID]: { [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA },
                },
                ...testData.SIGNED_CROSS_SIGNING_KEYS_DATA,
            });

            await expect(rustCrypto.userHasCrossSigningKeys()).resolves.toBe(true);
        });

        it("returns true if the user is untracked, downloadUncached is set at true and the cross-signing keys are available", async () => {
            fetchMock.post("path:/_matrix/client/v3/keys/query", {
                device_keys: {
                    [testData.BOB_TEST_USER_ID]: {
                        [testData.BOB_TEST_DEVICE_ID]: testData.BOB_SIGNED_TEST_DEVICE_DATA,
                    },
                },
                ...testData.BOB_SIGNED_CROSS_SIGNING_KEYS_DATA,
            });

            await expect(rustCrypto.userHasCrossSigningKeys(testData.BOB_TEST_USER_ID, true)).resolves.toBe(true);
        });

        it("returns false if the user is unknown", async () => {
            await expect(rustCrypto.userHasCrossSigningKeys(testData.BOB_TEST_USER_ID)).resolves.toBe(false);
        });
    });

    describe("createRecoveryKeyFromPassphrase", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto();
        });

        it("should create a recovery key without password", async () => {
            const recoveryKey = await rustCrypto.createRecoveryKeyFromPassphrase();

            // Expected the encoded private key to have 59 chars
            expect(recoveryKey.encodedPrivateKey?.length).toBe(59);
            // Expect the private key to be an Uint8Array with a length of 32
            expect(recoveryKey.privateKey).toBeInstanceOf(Uint8Array);
            expect(recoveryKey.privateKey.length).toBe(32);
            // Expect passphrase info to be absent
            expect(recoveryKey.keyInfo?.passphrase).toBeUndefined();
        });

        it("should create a recovery key with password", async () => {
            const recoveryKey = await rustCrypto.createRecoveryKeyFromPassphrase("my password");

            // Expected the encoded private key to have 59 chars
            expect(recoveryKey.encodedPrivateKey?.length).toBe(59);
            // Expect the private key to be an Uint8Array with a length of 32
            expect(recoveryKey.privateKey).toBeInstanceOf(Uint8Array);
            expect(recoveryKey.privateKey.length).toBe(32);
            // Expect keyInfo.passphrase to be filled
            expect(recoveryKey.keyInfo?.passphrase?.algorithm).toBe("m.pbkdf2");
            expect(recoveryKey.keyInfo?.passphrase?.iterations).toBe(500000);
        });
    });

    it("should wait for a keys/query before returning devices", async () => {
        // We want to use fake timers, but the wasm bindings of matrix-sdk-crypto rely on a working `queueMicrotask`.
        jest.useFakeTimers({ doNotFake: ["queueMicrotask"] });

        fetchMock.post("path:/_matrix/client/v3/keys/upload", { one_time_key_counts: {} });
        fetchMock.post("path:/_matrix/client/v3/keys/query", {
            device_keys: {
                [testData.TEST_USER_ID]: {
                    [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA,
                },
            },
        });

        const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi(), testData.TEST_USER_ID);

        // an attempt to fetch the device list should block
        const devicesPromise = rustCrypto.getUserDeviceInfo([testData.TEST_USER_ID]);

        // ... until a /sync completes, and we trigger the outgoingRequests.
        rustCrypto.onSyncCompleted({});

        const deviceMap = (await devicesPromise).get(testData.TEST_USER_ID)!;
        expect(deviceMap.has(TEST_DEVICE_ID)).toBe(true);
        expect(deviceMap.has(testData.TEST_DEVICE_ID)).toBe(true);
        rustCrypto.stop();
    });

    it("should emit events on device changes", async () => {
        jest.useFakeTimers({ doNotFake: ["queueMicrotask"] });

        fetchMock.post("path:/_matrix/client/v3/keys/upload", { one_time_key_counts: {} });
        fetchMock.post("path:/_matrix/client/v3/keys/query", {
            device_keys: {
                [testData.TEST_USER_ID]: {
                    [testData.TEST_DEVICE_ID]: testData.SIGNED_TEST_DEVICE_DATA,
                },
            },
        });

        const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi(), testData.TEST_USER_ID);
        const willUpdateCallback = jest.fn();
        rustCrypto.on(CryptoEvent.WillUpdateDevices, willUpdateCallback);
        const devicesUpdatedCallback = jest.fn();
        rustCrypto.on(CryptoEvent.DevicesUpdated, devicesUpdatedCallback);

        rustCrypto.onSyncCompleted({});

        // wait for the devices to be updated
        await rustCrypto.getUserDeviceInfo([testData.TEST_USER_ID]);
        expect(willUpdateCallback).toHaveBeenCalledWith([testData.TEST_USER_ID], false);
        expect(devicesUpdatedCallback).toHaveBeenCalledWith([testData.TEST_USER_ID], false);
        rustCrypto.stop();
    });

    describe("requestDeviceVerification", () => {
        it("throws an error if the device is unknown", async () => {
            const rustCrypto = await makeTestRustCrypto();
            await expect(() => rustCrypto.requestDeviceVerification(TEST_USER, "unknown")).rejects.toThrow(
                "Not a known device",
            );
        });
    });

    describe("get|storeSessionBackupPrivateKey", () => {
        it("can save and restore a key", async () => {
            const key = "testtesttesttesttesttesttesttest";
            const rustCrypto = await makeTestRustCrypto();
            await rustCrypto.storeSessionBackupPrivateKey(
                new TextEncoder().encode(key),
                testData.SIGNED_BACKUP_DATA.version!,
            );
            const fetched = await rustCrypto.getSessionBackupPrivateKey();
            expect(new TextDecoder().decode(fetched!)).toEqual(key);
        });

        it("fails to save a key if version not provided", async () => {
            const key = "testtesttesttesttesttesttesttest";
            const rustCrypto = await makeTestRustCrypto();
            await expect(() => rustCrypto.storeSessionBackupPrivateKey(new TextEncoder().encode(key))).rejects.toThrow(
                "storeSessionBackupPrivateKey: version is required",
            );
            const fetched = await rustCrypto.getSessionBackupPrivateKey();
            expect(fetched).toBeNull();
        });
    });

    describe("getActiveSessionBackupVersion", () => {
        it("returns null", async () => {
            const rustCrypto = await makeTestRustCrypto();
            expect(await rustCrypto.getActiveSessionBackupVersion()).toBeNull();
        });
    });

    describe("findVerificationRequestDMInProgress", () => {
        it("throws an error if the userId is not provided", async () => {
            const rustCrypto = await makeTestRustCrypto();
            expect(() => rustCrypto.findVerificationRequestDMInProgress(testData.TEST_ROOM_ID)).toThrow(
                "missing userId",
            );
        });
    });

    describe("requestVerificationDM", () => {
        it("send verification request to an unknown user", async () => {
            const rustCrypto = await makeTestRustCrypto();
            await expect(() =>
                rustCrypto.requestVerificationDM("@bob:example.com", testData.TEST_ROOM_ID),
            ).rejects.toThrow("unknown userId @bob:example.com");
        });
    });

    describe("getUserVerificationStatus", () => {
        let rustCrypto: RustCrypto;
        let olmMachine: Mocked<RustSdkCryptoJs.OlmMachine>;

        beforeEach(() => {
            olmMachine = {
                getIdentity: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;
            rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                {} as MatrixClient["http"],
                TEST_USER,
                TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );
        });

        it("returns an unverified UserVerificationStatus when there is no UserIdentity", async () => {
            const userVerificationStatus = await rustCrypto.getUserVerificationStatus(testData.TEST_USER_ID);
            expect(userVerificationStatus.isVerified()).toBeFalsy();
            expect(userVerificationStatus.isTofu()).toBeFalsy();
            expect(userVerificationStatus.isCrossSigningVerified()).toBeFalsy();
            expect(userVerificationStatus.wasCrossSigningVerified()).toBeFalsy();
        });

        it("returns a verified UserVerificationStatus when the UserIdentity is verified", async () => {
            olmMachine.getIdentity.mockResolvedValue({
                free: jest.fn(),
                isVerified: jest.fn().mockReturnValue(true),
                wasPreviouslyVerified: jest.fn().mockReturnValue(true),
            });

            const userVerificationStatus = await rustCrypto.getUserVerificationStatus(testData.TEST_USER_ID);
            expect(userVerificationStatus.isVerified()).toBeTruthy();
            expect(userVerificationStatus.isTofu()).toBeFalsy();
            expect(userVerificationStatus.isCrossSigningVerified()).toBeTruthy();
            expect(userVerificationStatus.wasCrossSigningVerified()).toBeTruthy();
        });
    });

    describe("pinCurrentIdentity", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            const secretStorageCallbacks = {
                getSecretStorageKey: async (keys: any, name: string) => {
                    return [[...Object.keys(keys.keys)][0], new Uint8Array(32)];
                },
            } as SecretStorageCallbacks;
            const secretStorage = new ServerSideSecretStorageImpl(new DummyAccountDataClient(), secretStorageCallbacks);
            rustCrypto = await makeTestRustCrypto(
                new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                    baseUrl: "http://server/",
                    prefix: "",
                    onlyData: true,
                }),
                TEST_USER,
                TEST_DEVICE_ID,
                secretStorage,
            );
        });

        it("throws an error for an unknown user", async () => {
            await expect(rustCrypto.pinCurrentUserIdentity("@other_user:example.com")).rejects.toThrow(
                "Cannot pin identity of unknown user",
            );
        });

        it("throws an error for our own user", async () => {
            jest.useRealTimers();
            const e2eKeyReceiver = new E2EKeyReceiver("http://server");
            const e2eKeyResponder = new E2EKeyResponder("http://server");
            e2eKeyResponder.addKeyReceiver(TEST_USER, e2eKeyReceiver);
            fetchMock.post("path:/_matrix/client/v3/keys/device_signing/upload", {
                status: 200,
                body: {},
            });
            fetchMock.post("path:/_matrix/client/v3/keys/signatures/upload", {
                status: 200,
                body: {},
            });
            await rustCrypto.bootstrapCrossSigning({ setupNewCrossSigning: true });
            await expect(rustCrypto.pinCurrentUserIdentity(TEST_USER)).rejects.toThrow(
                "Cannot pin identity of own user",
            );
        });
    });

    describe("withdraw verification", () => {
        function createTestSetup(): { olmMachine: Mocked<RustSdkCryptoJs.OlmMachine>; rustCrypto: RustCrypto } {
            const olmMachine = {
                getIdentity: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;
            const rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                {} as MatrixClient["http"],
                TEST_USER,
                TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );
            return { olmMachine, rustCrypto };
        }

        it("throws an error for an unknown user", async () => {
            const { rustCrypto } = createTestSetup();
            await expect(rustCrypto.withdrawVerificationRequirement("@alice:example.com")).rejects.toThrow(
                "Cannot withdraw verification of unknown user",
            );
        });

        it("Calls withdraw for other identity", async () => {
            const { olmMachine, rustCrypto } = createTestSetup();
            const identity = {
                withdrawVerification: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OtherUserIdentity>;

            olmMachine.getIdentity.mockResolvedValue(identity);

            await rustCrypto.withdrawVerificationRequirement("@bob:example.com");

            expect(identity.withdrawVerification).toHaveBeenCalled();
        });

        it("Calls withdraw for own identity", async () => {
            const { olmMachine, rustCrypto } = createTestSetup();
            const ownIdentity = {
                withdrawVerification: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OwnUserIdentity>;

            olmMachine.getIdentity.mockResolvedValue(ownIdentity);

            await rustCrypto.withdrawVerificationRequirement("@alice:example.com");

            expect(ownIdentity.withdrawVerification).toHaveBeenCalled();
        });
    });

    describe("key backup", () => {
        it("is started when rust crypto is created", async () => {
            // `RustCrypto.checkKeyBackupAndEnable` async call is made in background in the RustCrypto constructor.
            // We don't have an instance of the rust crypto yet, we spy directly in the prototype.
            const spyCheckKeyBackupAndEnable = jest
                .spyOn(RustCrypto.prototype, "checkKeyBackupAndEnable")
                .mockResolvedValue({} as KeyBackupCheck);

            await makeTestRustCrypto();

            expect(spyCheckKeyBackupAndEnable).toHaveBeenCalled();
        });

        it("raises KeyBackupStatus event when identify change", async () => {
            // Return the key backup
            fetchMock.get("path:/_matrix/client/v3/room_keys/version", testData.SIGNED_BACKUP_DATA);

            const olmMachine = {
                getIdentity: jest.fn(),
                // Force the backup to be trusted by the olmMachine
                verifyBackup: jest.fn().mockResolvedValue({ trusted: jest.fn().mockReturnValue(true) }),
                isBackupEnabled: jest.fn().mockReturnValue(true),
                getBackupKeys: jest.fn(),
                enableBackupV1: jest.fn(),
            } as unknown as Mocked<RustSdkCryptoJs.OlmMachine>;

            const rustCrypto = new RustCrypto(
                logger,
                olmMachine,
                makeMatrixHttpApi(),
                testData.TEST_USER_ID,
                testData.TEST_DEVICE_ID,
                {} as ServerSideSecretStorage,
                {} as CryptoCallbacks,
            );

            // Wait for the key backup to be available
            const keyBackupStatusPromise = new Promise<boolean>((resolve) =>
                rustCrypto.once(CryptoEvent.KeyBackupStatus, resolve),
            );
            await rustCrypto.onUserIdentityUpdated(new RustSdkCryptoJs.UserId(testData.TEST_USER_ID));
            expect(await keyBackupStatusPromise).toBe(true);
        });

        it("does not back up keys that came from backup", async () => {
            const rustCrypto = await makeTestRustCrypto();
            const olmMachine: OlmMachine = rustCrypto["olmMachine"];

            const backupVersion = testData.SIGNED_BACKUP_DATA.version!;
            await olmMachine.enableBackupV1(
                (testData.SIGNED_BACKUP_DATA.auth_data as Curve25519AuthData).public_key,
                backupVersion,
            );

            // we import two keys: one "from backup", and one "from export"
            const [backedUpRoomKey, exportedRoomKey] = testData.MEGOLM_SESSION_DATA_ARRAY;
            await rustCrypto.importBackedUpRoomKeys([backedUpRoomKey], backupVersion);
            await rustCrypto.importRoomKeys([exportedRoomKey]);

            // we ask for the keys that should be backed up
            const roomKeysRequest = await olmMachine.backupRoomKeys();
            expect(roomKeysRequest).toBeTruthy();
            const roomKeys = JSON.parse(roomKeysRequest!.body);

            // we expect that the key "from export" is present
            expect(roomKeys).toMatchObject({
                rooms: {
                    [exportedRoomKey.room_id]: {
                        sessions: {
                            [exportedRoomKey.session_id]: {},
                        },
                    },
                },
            });

            // we expect that the key "from backup" is not present
            expect(roomKeys).not.toMatchObject({
                rooms: {
                    [backedUpRoomKey.room_id]: {
                        sessions: {
                            [backedUpRoomKey.session_id]: {},
                        },
                    },
                },
            });
        });

        it("ignores invalid keys when restoring from backup", async () => {
            const rustCrypto = await makeTestRustCrypto();
            const olmMachine: OlmMachine = rustCrypto["olmMachine"];

            const backupVersion = testData.SIGNED_BACKUP_DATA.version!;
            await olmMachine.enableBackupV1(
                (testData.SIGNED_BACKUP_DATA.auth_data as Curve25519AuthData).public_key,
                backupVersion,
            );

            const backup = Array.from(testData.MEGOLM_SESSION_DATA_ARRAY);
            // in addition to correct keys, we restore an invalid key
            backup.push({ room_id: "!roomid", session_id: "sessionid" } as IMegolmSessionData);
            const progressCallback = jest.fn();
            await rustCrypto.importBackedUpRoomKeys(backup, backupVersion, { progressCallback });
            expect(progressCallback).toHaveBeenCalledWith({
                total: 3,
                successes: 0,
                stage: "load_keys",
                failures: 1,
            });
            expect(progressCallback).toHaveBeenCalledWith({
                total: 3,
                successes: 1,
                stage: "load_keys",
                failures: 1,
            });
        });

        describe("getKeyBackupInfo", () => {
            it("should return the current key backup info", async () => {
                fetchMock.get("path:/_matrix/client/v3/room_keys/version", testData.SIGNED_BACKUP_DATA);

                const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi());
                await expect(rustCrypto.getKeyBackupInfo()).resolves.toStrictEqual(testData.SIGNED_BACKUP_DATA);
            });

            it("should return null if not available", async () => {
                const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi());
                await expect(rustCrypto.getKeyBackupInfo()).resolves.toBeNull();
            });
        });
    });

    describe("device dehydration", () => {
        it("should detect if dehydration is supported", async () => {
            const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi());
            fetchMock.config.overwriteRoutes = true;
            fetchMock.get("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 404,
                body: {
                    errcode: "M_UNRECOGNIZED",
                    error: "Unknown endpoint",
                },
            });
            expect(await rustCrypto.isDehydrationSupported()).toBe(false);
            fetchMock.get("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 404,
                body: {
                    errcode: "M_NOT_FOUND",
                    error: "Not found",
                },
            });
            expect(await rustCrypto.isDehydrationSupported()).toBe(true);
            fetchMock.get("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                device_id: "DEVICE_ID",
                device_data: "data",
            });
            expect(await rustCrypto.isDehydrationSupported()).toBe(true);
        });

        it("should load the dehydration key from SSSS if available", async () => {
            fetchMock.config.overwriteRoutes = true;

            const secretStorageCallbacks = {
                getSecretStorageKey: async (keys: any, name: string) => {
                    return [[...Object.keys(keys.keys)][0], new Uint8Array(32)];
                },
            } as SecretStorageCallbacks;
            const secretStorage = new ServerSideSecretStorageImpl(new DummyAccountDataClient(), secretStorageCallbacks);

            // Create a RustCrypto to set up device dehydration.
            const e2eKeyReceiver1 = new E2EKeyReceiver("http://server");
            const e2eKeyResponder1 = new E2EKeyResponder("http://server");
            e2eKeyResponder1.addKeyReceiver(TEST_USER, e2eKeyReceiver1);
            fetchMock.get("path:/_matrix/client/v3/room_keys/version", {
                status: 404,
                body: {
                    errcode: "M_NOT_FOUND",
                    error: "Not found",
                },
            });
            fetchMock.post("path:/_matrix/client/v3/keys/device_signing/upload", {
                status: 200,
                body: {},
            });
            fetchMock.post("path:/_matrix/client/v3/keys/signatures/upload", {
                status: 200,
                body: {},
            });
            const rustCrypto1 = await makeTestRustCrypto(makeMatrixHttpApi(), TEST_USER, TEST_DEVICE_ID, secretStorage);

            // dehydration requires secret storage and cross signing
            async function createSecretStorageKey() {
                return {
                    keyInfo: {} as AddSecretStorageKeyOpts,
                    privateKey: new Uint8Array(32),
                };
            }
            await rustCrypto1.bootstrapCrossSigning({ setupNewCrossSigning: true });
            await rustCrypto1.bootstrapSecretStorage({
                createSecretStorageKey,
                setupNewSecretStorage: true,
                setupNewKeyBackup: false,
            });

            // we need to process a sync so that the OlmMachine will upload keys
            await rustCrypto1.preprocessToDeviceMessages([]);
            await rustCrypto1.onSyncCompleted({});

            fetchMock.get("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 404,
                body: {
                    errcode: "M_NOT_FOUND",
                    error: "Not found",
                },
            });
            let dehydratedDeviceBody: any;
            fetchMock.put("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", (_, opts) => {
                dehydratedDeviceBody = JSON.parse(opts.body as string);
                return {};
            });
            await rustCrypto1.startDehydration();
            await rustCrypto1.stop();

            // Create another RustCrypto, using the same SecretStorage, to
            // rehydrate the device.
            const e2eKeyReceiver2 = new E2EKeyReceiver("http://server");
            const e2eKeyResponder2 = new E2EKeyResponder("http://server");
            e2eKeyResponder2.addKeyReceiver(TEST_USER, e2eKeyReceiver2);

            const rustCrypto2 = await makeTestRustCrypto(
                makeMatrixHttpApi(),
                TEST_USER,
                "ANOTHERDEVICE",
                secretStorage,
            );

            // dehydration requires secret storage and cross signing
            await rustCrypto2.bootstrapCrossSigning({ setupNewCrossSigning: true });

            // we need to process a sync so that the OlmMachine will upload keys
            await rustCrypto2.preprocessToDeviceMessages([]);
            await rustCrypto2.onSyncCompleted({});

            fetchMock.get("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                device_id: dehydratedDeviceBody.device_id,
                device_data: dehydratedDeviceBody.device_data,
            });
            fetchMock.post(
                `path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device/${encodeURIComponent(dehydratedDeviceBody.device_id)}/events`,
                {
                    events: [],
                    next_batch: "token",
                },
            );

            // We check that a RehydrationCompleted event gets emitted, which
            // means that the device was successfully rehydrated.
            const rehydrationCompletedPromise = emitPromise(rustCrypto2, CryptoEvent.RehydrationCompleted);
            await rustCrypto2.startDehydration();
            await rehydrationCompletedPromise;
            await rustCrypto2.stop();
        });

        describe("start dehydration options", () => {
            let rustCrypto: RustCrypto;
            let secretStorage: ServerSideSecretStorageImpl;
            let dehydratedDeviceInfo: Record<string, any> | undefined;

            // Function that is called when `GET /dehydrated_device` is called
            // (i.e. when we try to rehydrate a device)
            const getDehydratedDeviceMock = jest.fn(() => {
                if (dehydratedDeviceInfo) {
                    return {
                        status: 200,
                        body: dehydratedDeviceInfo,
                    };
                } else {
                    return {
                        status: 404,
                        body: {
                            errcode: "M_NOT_FOUND",
                            error: "Not found",
                        },
                    };
                }
            });
            // Function that is called when `PUT /dehydrated_device` is called
            // (i.e. when we create a new dehydrated device)
            const putDehydratedDeviceMock = jest.fn((path, opts) => {
                const content = JSON.parse(opts.body as string);
                dehydratedDeviceInfo = {
                    device_id: content.device_id,
                    device_data: content.device_data,
                };
                return {
                    status: 200,
                    body: {
                        device_id: content.device_id,
                    },
                };
            });

            beforeEach(async () => {
                // Set up a RustCrypto object with secret storage and cross-signing.
                const secretStorageCallbacks = {
                    getSecretStorageKey: async (keys: any, name: string) => {
                        return [[...Object.keys(keys.keys)][0], new Uint8Array(32)];
                    },
                } as SecretStorageCallbacks;
                secretStorage = new ServerSideSecretStorageImpl(new DummyAccountDataClient(), secretStorageCallbacks);

                const e2eKeyReceiver = new E2EKeyReceiver("http://server");
                const e2eKeyResponder = new E2EKeyResponder("http://server");
                e2eKeyResponder.addKeyReceiver(TEST_USER, e2eKeyReceiver);
                fetchMock.get("path:/_matrix/client/v3/room_keys/version", {
                    status: 404,
                    body: {
                        errcode: "M_NOT_FOUND",
                        error: "Not found",
                    },
                });
                fetchMock.post("path:/_matrix/client/v3/keys/device_signing/upload", {
                    status: 200,
                    body: {},
                });
                fetchMock.post("path:/_matrix/client/v3/keys/signatures/upload", {
                    status: 200,
                    body: {},
                });
                rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi(), TEST_USER, TEST_DEVICE_ID, secretStorage);

                // dehydration requires secret storage and cross signing
                async function createSecretStorageKey() {
                    return {
                        keyInfo: {} as AddSecretStorageKeyOpts,
                        privateKey: new Uint8Array(32),
                    };
                }
                await rustCrypto.bootstrapCrossSigning({ setupNewCrossSigning: true });
                await rustCrypto.bootstrapSecretStorage({
                    createSecretStorageKey,
                    setupNewSecretStorage: true,
                    setupNewKeyBackup: false,
                });
                // we need to process a sync so that the OlmMachine will upload keys
                await rustCrypto.preprocessToDeviceMessages([]);
                await rustCrypto.onSyncCompleted({});

                // set up mocks needed for device dehydration
                dehydratedDeviceInfo = undefined;
                fetchMock.get(
                    "path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device",
                    getDehydratedDeviceMock,
                );
                fetchMock.put(
                    "path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device",
                    putDehydratedDeviceMock,
                );
                fetchMock.post(/_matrix\/client\/unstable\/org.matrix.msc3814.v1\/dehydrated_device\/.*\/events/, {
                    status: 200,
                    body: {
                        events: [],
                        next_batch: "foo",
                    },
                });
                getDehydratedDeviceMock.mockClear();
                putDehydratedDeviceMock.mockClear();
            });

            afterEach(() => {
                rustCrypto.stop();
            });

            // Several tests require a dehydrated device and dehydration key
            // already set up.
            async function setUpInitialDehydratedDevice() {
                await rustCrypto.startDehydration();
                getDehydratedDeviceMock.mockClear();
                putDehydratedDeviceMock.mockClear();
                return await secretStorage.get("org.matrix.msc3814");
            }

            it("should create a new key and dehydrate a device when no options given", async () => {
                // With the default options, when we don't have an existing key ...
                await rustCrypto.startDehydration();
                // ... we create a new dehydration key ...
                expect(await secretStorage.get("org.matrix.msc3814")).toBeTruthy();
                // ... and create a new dehydrated device.
                expect(putDehydratedDeviceMock).toHaveBeenCalled();
            });

            it("should rehydrate a device if available and keep existing key when no options given", async () => {
                const origDehydrationKey = await setUpInitialDehydratedDevice();

                // If we already have a dehydration key and dehydrated device...
                await rustCrypto.startDehydration();
                // ... we should fetch the device to rehydrate it ...
                expect(getDehydratedDeviceMock).toHaveBeenCalled();
                // ... create a new dehydrated device ...
                expect(putDehydratedDeviceMock).toHaveBeenCalled();
                // ... and keep the same dehydration key.
                expect(await secretStorage.get("org.matrix.msc3814")).toEqual(origDehydrationKey);
            });

            it("should do nothing if onlyIfKeyCached is true and we have no key cached", async () => {
                // Since there is no key cached, so should do nothing.  i.e. it
                // should not make any HTTP requests and should not create a new key.
                await rustCrypto.startDehydration({ onlyIfKeyCached: true });
                expect(getDehydratedDeviceMock).not.toHaveBeenCalled();
                expect(putDehydratedDeviceMock).not.toHaveBeenCalled();
                expect(await secretStorage.get("org.matrix.msc3814")).toBeFalsy();
            });

            it("should start dehydration when onlyIfKeyCached is true, and we have a cached key", async () => {
                const origDehydrationKey = await setUpInitialDehydratedDevice();

                // If `onlyIfKeyCached` is `true`, and we already have have a
                // key, we should behave the same as if no options were given.
                await rustCrypto.startDehydration({ onlyIfKeyCached: true });
                expect(getDehydratedDeviceMock).toHaveBeenCalled();
                expect(putDehydratedDeviceMock).toHaveBeenCalled();
                expect(await secretStorage.get("org.matrix.msc3814")).toEqual(origDehydrationKey);
            });

            it("should not rehydrate if rehydrate is set to false", async () => {
                const origDehydrationKey = await setUpInitialDehydratedDevice();

                // If `rehydrate` is set to `false` ...
                await rustCrypto.startDehydration({ rehydrate: false });
                // ... we should not try to rehydrate ...
                expect(getDehydratedDeviceMock).not.toHaveBeenCalled();
                // ... but we should still create a new dehydrated device ...
                expect(putDehydratedDeviceMock).toHaveBeenCalled();
                // ... and we should keep the same dehydration key.
                expect(await secretStorage.get("org.matrix.msc3814")).toEqual(origDehydrationKey);
            });

            it("should create a new key if createNewKey is set to true", async () => {
                const origDehydrationKey = await setUpInitialDehydratedDevice();

                // If `createNewKey` is set to `true` ...
                await rustCrypto.startDehydration({ createNewKey: true });
                // ... we should rehydrate and dehydrate as normal ...
                expect(getDehydratedDeviceMock).toHaveBeenCalled();
                expect(putDehydratedDeviceMock).toHaveBeenCalled();
                // ... and we should create a new dehydration key.
                expect(await secretStorage.get("org.matrix.msc3814")).not.toEqual(origDehydrationKey);
            });
        });

        it("should handle errors when deleting a dehydrated device", async () => {
            const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi());
            const dehydratedDeviceManager = rustCrypto["dehydratedDeviceManager"];
            fetchMock.config.overwriteRoutes = true;
            // if the server doesn't support dehydrated devices, delete should succeed without throwing an error
            fetchMock.delete("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 404,
                body: {
                    errcode: "M_UNRECOGNIZED",
                    error: "Unknown endpoint",
                },
            });
            await dehydratedDeviceManager.delete();

            // if there is no dehydrated device, delete should succeed without throwing an error
            fetchMock.delete("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 404,
                body: {
                    errcode: "M_NOT_FOUND",
                    error: "Not found",
                },
            });
            await dehydratedDeviceManager.delete();

            // for any other error response, delete should throw an error
            fetchMock.delete("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", {
                status: 400,
                body: {
                    errcode: "M_UNKNOWN",
                    error: "Unknown error",
                },
            });
            await expect(dehydratedDeviceManager.delete()).rejects.toThrow();
        });
    });

    describe("import & export secrets bundle", () => {
        let rustCrypto: RustCrypto;

        beforeEach(async () => {
            rustCrypto = await makeTestRustCrypto(
                new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
                    baseUrl: "http://server/",
                    prefix: "",
                    onlyData: true,
                }),
                testData.TEST_USER_ID,
            );
        });

        it("should throw an error if there is nothing to export", async () => {
            await expect(rustCrypto.exportSecretsBundle()).rejects.toThrow(
                "The store doesn't contain any cross-signing keys",
            );
        });

        it("should correctly import & export a secrets bundle", async () => {
            const bundle = {
                cross_signing: {
                    master_key: "bMnVpkHI4S2wXRxy+IpaKM5PIAUUkl6DE+n0YLIW/qs",
                    user_signing_key: "8tlgLjUrrb/zGJo4YKGhDTIDCEjtJTAS/Sh2AGNLuIo",
                    self_signing_key: "pfDknmP5a0fVVRE54zhkUgJfzbNmvKcNfIWEW796bQs",
                },
                backup: {
                    algorithm: "m.megolm_backup.v1.curve25519-aes-sha2",
                    key: "bYYv3aFLQ49jMNcOjuTtBY9EKDby2x1m3gfX81nIKRQ",
                    backup_version: "9",
                },
            };
            await rustCrypto.importSecretsBundle(bundle);
            await expect(rustCrypto.exportSecretsBundle()).resolves.toEqual(expect.objectContaining(bundle));
        });
    });

    describe("encryptToDeviceMessages", () => {
        let rustCrypto: RustCrypto;
        let testOlmMachine: RustSdkCryptoJs.OlmMachine;

        beforeEach(async () => {
            testOlmMachine = await OlmMachine.initialize(
                new RustSdkCryptoJs.UserId(testData.TEST_USER_ID),
                new RustSdkCryptoJs.DeviceId(testData.TEST_DEVICE_ID),
            );
            jest.spyOn(OlmMachine, "initFromStore").mockResolvedValue(testOlmMachine);
            rustCrypto = await makeTestRustCrypto();
            expect(OlmMachine.initFromStore).toHaveBeenCalled();
        });

        afterEach(() => {
            testOlmMachine?.free();
        });

        const payload = { hello: "world" };

        it("returns empty batch if devices not known", async () => {
            const getMissingSessions = jest.spyOn(testOlmMachine, "getMissingSessions");
            const getDevice = jest.spyOn(testOlmMachine, "getDevice");
            const batch = await rustCrypto.encryptToDeviceMessages(
                "m.test.type",
                [
                    { deviceId: "AAA", userId: "@user1:domain" },
                    { deviceId: "BBB", userId: "@user1:domain" },
                    { deviceId: "CCC", userId: "@user2:domain" },
                ],
                payload,
            );
            expect(getMissingSessions.mock.calls[0][0].length).toBe(2);
            expect(getDevice).toHaveBeenCalledTimes(3);
            expect(batch?.eventType).toEqual("m.room.encrypted");
            expect(batch?.batch).toEqual([]);
        });

        it("returns encrypted batch for known devices", async () => {
            // Make m aware of another device, and get some OTK to be able to establish a session.
            await testOlmMachine.markRequestAsSent(
                "foo",
                RustSdkCryptoJs.RequestType.KeysQuery,
                JSON.stringify({
                    device_keys: {
                        "@example:localhost": {
                            AFGUOBTZWM: {
                                algorithms: ["m.olm.v1.curve25519-aes-sha2", "m.megolm.v1.aes-sha2"],
                                device_id: "AFGUOBTZWM",
                                keys: {
                                    "curve25519:AFGUOBTZWM": "boYjDpaC+7NkECQEeMh5dC+I1+AfriX0VXG2UV7EUQo",
                                    "ed25519:AFGUOBTZWM": "NayrMQ33ObqMRqz6R9GosmHdT6HQ6b/RX/3QlZ2yiec",
                                },
                                signatures: {
                                    "@example:localhost": {
                                        "ed25519:AFGUOBTZWM":
                                            "RoSWvru1jj6fs2arnTedWsyIyBmKHMdOu7r9gDi0BZ61h9SbCK2zLXzuJ9ZFLao2VvA0yEd7CASCmDHDLYpXCA",
                                    },
                                },
                                user_id: "@example:localhost",
                                unsigned: {
                                    device_display_name: "rust-sdk",
                                },
                            },
                        },
                    },
                    failures: {},
                }),
            );

            await testOlmMachine.markRequestAsSent(
                "bar",
                RustSdkCryptoJs.RequestType.KeysClaim,
                JSON.stringify({
                    one_time_keys: {
                        "@example:localhost": {
                            AFGUOBTZWM: {
                                "signed_curve25519:AAAABQ": {
                                    key: "9IGouMnkB6c6HOd4xUsNv4i3Dulb4IS96TzDordzOws",
                                    signatures: {
                                        "@example:localhost": {
                                            "ed25519:AFGUOBTZWM":
                                                "2bvUbbmJegrV0eVP/vcJKuIWC3kud+V8+C0dZtg4dVovOSJdTP/iF36tQn2bh5+rb9xLlSeztXBdhy4c+LiOAg",
                                        },
                                    },
                                },
                            },
                        },
                    },
                    failures: {},
                }),
            );

            const batch = await rustCrypto.encryptToDeviceMessages(
                "m.test.type",
                [
                    { deviceId: "AAA", userId: "@user1:domain" },
                    { deviceId: "BBB", userId: "@user1:domain" },
                    { deviceId: "CCC", userId: "@user2:domain" },
                    { deviceId: "AFGUOBTZWM", userId: "@example:localhost" },
                ],
                payload,
            );
            expect(batch?.eventType).toEqual("m.room.encrypted");
            expect(batch?.batch.length).toEqual(1);
            expect(batch?.batch[0].deviceId).toEqual("AFGUOBTZWM");
            expect(batch?.batch[0].userId).toEqual("@example:localhost");
            expect(batch?.batch[0].payload).toEqual(
                expect.objectContaining({
                    "algorithm": "m.olm.v1.curve25519-aes-sha2",
                    "ciphertext": expect.any(Object),
                    "org.matrix.msgid": expect.any(String),
                    "sender_key": expect.any(String),
                }),
            );
        });
    });

    describe("resetEncryption", () => {
        let secretStorage: ServerSideSecretStorage;
        beforeEach(() => {
            secretStorage = {
                setDefaultKeyId: jest.fn().mockResolvedValue(undefined),
                hasKey: jest.fn().mockResolvedValue(false),
                getKey: jest.fn().mockResolvedValue(null),
                store: jest.fn().mockResolvedValue(undefined),
                getDefaultKeyId: jest.fn().mockResolvedValue("defaultKeyId"),
            } as unknown as ServerSideSecretStorage;

            fetchMock.post("path:/_matrix/client/v3/keys/upload", { one_time_key_counts: {} });
            fetchMock.post("path:/_matrix/client/v3/keys/signatures/upload", {});
        });

        it("reset should reset 4S, backup, cross-signing, and dehydrated device", async () => {
            // When we will delete the key backup
            let backupIsDeleted = false;
            fetchMock.delete("path:/_matrix/client/v3/room_keys/version/1", () => {
                backupIsDeleted = true;
                return {};
            });
            // If the backup is deleted, we will return an empty object
            fetchMock.get("path:/_matrix/client/v3/room_keys/version", () => {
                return backupIsDeleted ? {} : testData.SIGNED_BACKUP_DATA;
            });

            let dehydratedDeviceIsDeleted = false;
            fetchMock.delete("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", () => {
                dehydratedDeviceIsDeleted = true;
                return { device_id: "ADEVICEID" };
            });

            // A new key backup should be created after the reset
            let newKeyBackupInfo!: KeyBackupInfo;
            fetchMock.post("path:/_matrix/client/v3/room_keys/version", (res, options) => {
                newKeyBackupInfo = JSON.parse(options.body as string);
                return { version: "2" };
            });

            // We consider the key backup as trusted
            jest.spyOn(RustBackupManager.prototype, "isKeyBackupTrusted").mockResolvedValue({
                trusted: true,
                matchesDecryptionKey: true,
            });

            const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi(), undefined, undefined, secretStorage);
            // We have a key backup
            expect(await rustCrypto.getActiveSessionBackupVersion()).not.toBeNull();

            const authUploadDeviceSigningKeys = jest.fn();
            await rustCrypto.resetEncryption(authUploadDeviceSigningKeys);

            // The secrets in 4S should be deleted
            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.master", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.self_signing", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.user_signing", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.megolm_backup.v1", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.secret_storage.key.defaultKeyId", null);
            // A new key backup should be created
            expect(newKeyBackupInfo.auth_data).toBeTruthy();
            // The new cross signing keys should be uploaded
            expect(authUploadDeviceSigningKeys).toHaveBeenCalledWith(expect.any(Function));
            // The dehydrated device was deleted
            expect(dehydratedDeviceIsDeleted).toBeTruthy();
        });
    });

    describe("disableKeyStorage", () => {
        it("should disable key storage", async () => {
            const secretStorage = {
                getDefaultKeyId: jest.fn().mockResolvedValue("bloop"),
                setDefaultKeyId: jest.fn(),
                store: jest.fn(),
            } as unknown as ServerSideSecretStorage;

            fetchMock.get("path:/_matrix/client/v3/room_keys/version", testData.SIGNED_BACKUP_DATA);

            let backupIsDeleted = false;
            fetchMock.delete("path:/_matrix/client/v3/room_keys/version/1", () => {
                backupIsDeleted = true;
                return {};
            });

            let dehydratedDeviceIsDeleted = false;
            fetchMock.delete("path:/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device", () => {
                dehydratedDeviceIsDeleted = true;
                return { device_id: "ADEVICEID" };
            });

            const rustCrypto = await makeTestRustCrypto(makeMatrixHttpApi(), undefined, undefined, secretStorage);
            await rustCrypto.disableKeyStorage();

            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.master", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.self_signing", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.cross_signing.user_signing", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.megolm_backup.v1", null);
            expect(secretStorage.store).toHaveBeenCalledWith("m.secret_storage.key.bloop", null);
            expect(secretStorage.setDefaultKeyId).toHaveBeenCalledWith(null);

            expect(backupIsDeleted).toBeTruthy();
            expect(dehydratedDeviceIsDeleted).toBeTruthy();
        });
    });
});

/** Build a MatrixHttpApi instance */
function makeMatrixHttpApi(): MatrixHttpApi<IHttpOpts & { onlyData: true }> {
    return new MatrixHttpApi(new TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap>(), {
        baseUrl: "http://server/",
        prefix: "",
        onlyData: true,
    });
}

/** build a basic RustCrypto instance for testing
 *
 * just provides default arguments for initRustCrypto()
 */
async function makeTestRustCrypto(
    http: MatrixHttpApi<IHttpOpts & { onlyData: true }> = {} as MatrixClient["http"],
    userId: string = TEST_USER,
    deviceId: string = TEST_DEVICE_ID,
    secretStorage: ServerSideSecretStorage = {} as ServerSideSecretStorage,
    cryptoCallbacks: CryptoCallbacks = {} as CryptoCallbacks,
): Promise<RustCrypto> {
    return await initRustCrypto({
        logger,
        http,
        userId,
        deviceId,
        secretStorage,
        cryptoCallbacks,
        storePrefix: null,
        storePassphrase: undefined,
    });
}

/** emulate account data, storing in memory
 */
class DummyAccountDataClient
    extends TypedEventEmitter<ClientEvent.AccountData, ClientEventHandlerMap>
    implements AccountDataClient
{
    private storage: Map<string, any> = new Map();

    public constructor() {
        super();
    }

    public async getAccountDataFromServer<K extends keyof AccountDataEvents>(
        eventType: K,
    ): Promise<AccountDataEvents[K] | null> {
        const ret = this.storage.get(eventType);

        if (eventType) {
            return ret;
        } else {
            return null;
        }
    }

    public async setAccountData(eventType: string, content: any): Promise<EmptyObject> {
        this.storage.set(eventType, content);
        this.emit(
            ClientEvent.AccountData,
            new MatrixEvent({
                content,
                type: eventType,
            }),
        );
        return {};
    }
}

/** Pad a string to 43 characters long */
function pad43(x: string): string {
    return x + ".".repeat(43 - x.length);
}