add setting to enable invisible crypto mode in js-sdk

Author: uhoreg

src/MatrixClientPeg.ts

@@ -24,6 +24,7 @@ import {
 import { VerificationMethod } from "matrix-js-sdk/src/types";
 import * as utils from "matrix-js-sdk/src/utils";
 import { logger } from "matrix-js-sdk/src/logger";
+import { CryptoMode } from "matrix-js-sdk/src/crypto-api";
 
 import createMatrixClient from "./utils/createMatrixClient";
 import SettingsStore from "./settings/SettingsStore";
@@ -343,6 +344,10 @@ class MatrixClientPegClass implements IMatrixClientPeg {
         });
 
         StorageManager.setCryptoInitialised(true);
+
+        if (SettingsStore.getValue("feature_invisible_crypto")) {
+            this.matrixClient.getCrypto()!.setCryptoMode(CryptoMode.Invisible);
+        }
         // TODO: device dehydration and whathaveyou
         return;
     }

src/i18n/strings/en_EN.json

@@ -1444,6 +1444,8 @@
         "group_widgets": "Widgets",
         "hidebold": "Hide notification dot (only display counters badges)",
         "html_topic": "Show HTML representation of room topics",
+        "invisible_crypto": "Invisible cryptography",
+        "invisible_crypto_description": "Invisible cryptography is an experimental cryptography mode that uses cross-signing to provide a cleaner cryptography experience.  If you enable this mode, you may be unable to communicate with users who have not cross-signed their devices.",
         "join_beta": "Join the beta",
         "join_beta_reload": "Joining the beta will reload %(brand)s.",
         "jump_to_date": "Jump to date (adds /jumptodate and jump to date headers)",

src/settings/Settings.tsx

@@ -10,6 +10,7 @@ Please see LICENSE files in the repository root for full details.
 import React, { ReactNode } from "react";
 
 import { _t, _td, TranslationKey } from "../languageHandler";
+import InvisibleCryptoController from "./controllers/InvisibleCryptoController";
 import {
     NotificationBodyEnabledController,
     NotificationsEnabledController,
@@ -316,6 +317,16 @@ export const SETTINGS: { [setting: string]: ISetting } = {
         supportedLevelsAreOrdered: true,
         default: false,
     },
+    "feature_invisible_crypto": {
+        isFeature: true,
+        labsGroup: LabGroup.Encryption,
+        controller: new InvisibleCryptoController(),
+        displayName: _td("labs|invisible_crypto"),
+        description: _td("labs|invisible_crypto_description"),
+        supportedLevels: LEVELS_DEVICE_ONLY_SETTINGS_WITH_CONFIG_PRIORITISED,
+        supportedLevelsAreOrdered: true,
+        default: false,
+    },
     "useOnlyCurrentProfiles": {
         supportedLevels: LEVELS_ACCOUNT_SETTINGS,
         displayName: _td("settings|disable_historical_profile"),

src/settings/controllers/InvisibleCryptoController.ts

@@ -0,0 +1,20 @@
+/*
+Copyright 2024 New Vector Ltd.
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { CryptoMode } from "matrix-js-sdk/src/crypto-api";
+
+import SettingController from "./SettingController";
+import { MatrixClientPeg } from "../../MatrixClientPeg";
+import { SettingLevel } from "../SettingLevel";
+
+export default class InvisibleCryptoController extends SettingController {
+    public onChange(level: SettingLevel, roomId: string, newValue: any): void {
+        const crypto = MatrixClientPeg.safeGet().getCrypto();
+        if (crypto) {
+            crypto.setCryptoMode(newValue ? CryptoMode.Invisible : CryptoMode.Legacy);
+        }
+    }
+}

test/settings/controllers/InvisibleCryptoController-test.ts

@@ -0,0 +1,37 @@
+/*
+Copyright 2024 New Vector Ltd.
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { CryptoApi, CryptoMode } from "matrix-js-sdk/src/crypto-api";
+
+import { MatrixClientPeg } from "../../../src/MatrixClientPeg";
+import { stubClient } from "../../test-utils";
+import InvisibleCryptoController from "../../../src/settings/controllers/InvisibleCryptoController";
+import { SettingLevel } from "../../../src/settings/SettingLevel";
+
+describe("InvisibleCryptoController", () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    it("tracks enabling and disabling", () => {
+        const cli = stubClient();
+        const setCryptoModeMock = jest.fn();
+        cli.getCrypto = jest.fn(() => {
+            return {
+                setCryptoMode: setCryptoModeMock,
+            } as unknown as CryptoApi;
+        });
+        jest.spyOn(MatrixClientPeg, "safeGet").mockReturnValue(cli);
+
+        const controller = new InvisibleCryptoController();
+
+        controller.onChange(SettingLevel.DEVICE, "", true);
+        expect(setCryptoModeMock).toHaveBeenCalledWith(CryptoMode.Invisible);
+
+        controller.onChange(SettingLevel.DEVICE, "", false);
+        expect(setCryptoModeMock).toHaveBeenCalledWith(CryptoMode.Legacy);
+    });
+});