Replace SecurityCustomisations with CryptoSetupExtension (matrix-org#12342)

* Changed call sites from customisations/security to ModuleRunner.extensions * Updated depenndecy and added tests * Fixed style and formatting with prettier * Fix according to Element PR comments * Fixing issues raised in PR review * Removed commented code. Improved encapsulation. Removed noisy logging * Improved language of comment about calling the factory * Refactor to get better encapsulation * Find a better name. Provide explicit reset function. Provide more TSDoc * Simplify mock for cryptoSetup, and add assertion for exception message. * Remove unused className property. Adjust TSDoc comments * Fix linting and code style issues * Added test to ensure we canregister anduse experimental extensions * Fix linting and code-style issues * Added test to ensure only on registration of experimental extensions * Added test toensure call to getDehydratedDeviceCallback() * Test what happens when there is no implementation * Iterating cryptoSetup tests * Lint/prettier fix * Assert both branches when checking for dehydrationkey callback * Update src/modules/ModuleRunner.ts Language and formatting Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update src/modules/ModuleRunner.ts Reset by setting a fresh ExtensionsManager Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update src/modules/ModuleRunner.ts Use regular comment instead of TSDoc style comment Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update test/MatrixClientPeg-test.ts No need to extend the base class Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update src/modules/ModuleRunner.ts Fix spelling Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update src/modules/ModuleRunner.ts Fix spelling Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Update src/modules/ModuleRunner.ts Fix TSDoc formatting Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Simplify mock setup * Simplified mock and cleaned up a bit * Keeping track of extensions is an implementation detail internal to ExtensionsManager. Language and punctuation * Addressed issues and comments from PR review * Update src/modules/ModuleRunner.ts Keep the flags to track implementations as direct properties Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> * Fix flattening of implementation map * Update src/modules/ModuleRunner.ts Fix whitespace Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --------- Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>

Author: thoraj

package.json

@@ -71,7 +71,7 @@
  "@matrix-org/emojibase-bindings": "^1.1.2",
  "@matrix-org/matrix-wysiwyg": "2.17.0",
  "@matrix-org/olm": "3.2.15",
- "@matrix-org/react-sdk-module-api": "^2.3.0",
+ "@matrix-org/react-sdk-module-api": "^2.4.0",
  "@matrix-org/spec": "^1.7.0",
  "@sentry/browser": "^7.0.0",
  "@testing-library/react-hooks": "^8.0.1",

src/Lifecycle.ts

@@ -24,7 +24,7 @@ import { QueryDict } from "matrix-js-sdk/src/utils";
 import { logger } from "matrix-js-sdk/src/logger";
 
 import { IMatrixClientCreds, MatrixClientPeg } from "./MatrixClientPeg";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import EventIndexPeg from "./indexing/EventIndexPeg";
 import createMatrixClient from "./utils/createMatrixClient";
 import Notifier from "./Notifier";
@@ -863,7 +863,7 @@ async function persistCredentials(credentials: IMatrixClientCreds): Promise<void
  localStorage.setItem("mx_device_id", credentials.deviceId);
  }
 
- SecurityCustomisations.persistCredentials?.(credentials);
+ ModuleRunner.instance.extensions.cryptoSetup?.persistCredentials(credentials);
 
  logger.log(`Session persisted for ${credentials.userId}`);
 }

src/Login.ts

@@ -27,7 +27,7 @@ import {
 import { logger } from "matrix-js-sdk/src/logger";
 
 import { IMatrixClientCreds } from "./MatrixClientPeg";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import { getOidcClientId } from "./utils/oidc/registerClient";
 import { IConfigOptions } from "./IConfigOptions";
 import SdkConfig from "./SdkConfig";
@@ -291,7 +291,7 @@ export async function sendLoginRequest(
  accessToken: data.access_token,
  };
 
- SecurityCustomisations.examineLoginResponse?.(data, creds);
+ ModuleRunner.instance.extensions.cryptoSetup.examineLoginResponse(data, creds);
 
  return creds;
 }

src/MatrixClientPeg.ts

@@ -41,7 +41,7 @@ import MatrixClientBackedSettingsHandler from "./settings/handlers/MatrixClientB
 import * as StorageManager from "./utils/StorageManager";
 import IdentityAuthClient from "./IdentityAuthClient";
 import { crossSigningCallbacks, tryToUnlockSecretStorageWithDehydrationKey } from "./SecurityManager";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import { SlidingSyncManager } from "./SlidingSyncManager";
 import CryptoStoreTooNewDialog from "./components/views/dialogs/CryptoStoreTooNewDialog";
 import { _t, UserFriendlyError } from "./languageHandler";
@@ -463,8 +463,9 @@ class MatrixClientPegClass implements IMatrixClientPeg {
  },
  };
 
- if (SecurityCustomisations.getDehydrationKey) {
- opts.cryptoCallbacks!.getDehydrationKey = SecurityCustomisations.getDehydrationKey;
+ const dehydrationKeyCallback = ModuleRunner.instance.extensions.cryptoSetup.getDehydrationKeyCallback();
+ if (dehydrationKeyCallback) {
+ opts.cryptoCallbacks!.getDehydrationKey = dehydrationKeyCallback;
  }
 
  this.matrixClient = createMatrixClient(opts);

src/SecurityManager.ts

@@ -33,7 +33,7 @@ import { isSecureBackupRequired } from "./utils/WellKnownUtils";
 import AccessSecretStorageDialog, { KeyParams } from "./components/views/dialogs/security/AccessSecretStorageDialog";
 import RestoreKeyBackupDialog from "./components/views/dialogs/security/RestoreKeyBackupDialog";
 import SettingsStore from "./settings/SettingsStore";
-import SecurityCustomisations from "./customisations/Security";
+import { ModuleRunner } from "./modules/ModuleRunner";
 import QuestionDialog from "./components/views/dialogs/QuestionDialog";
 import InteractiveAuthDialog from "./components/views/dialogs/InteractiveAuthDialog";
 
@@ -137,9 +137,9 @@ async function getSecretStorageKey({
  }
  }
 
- const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+ const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.getSecretStorageKey();
  if (keyFromCustomisations) {
- logger.log("Using key from security customisations (secret storage)");
+ logger.log("CryptoSetupExtension: Using key from extension (secret storage)");
  cacheSecretStorageKey(keyId, keyInfo, keyFromCustomisations);
  return [keyId, keyFromCustomisations];
  }
@@ -187,9 +187,9 @@ export async function getDehydrationKey(
  keyInfo: SecretStorage.SecretStorageKeyDescription,
  checkFunc: (data: Uint8Array) => void,
 ): Promise<Uint8Array> {
- const keyFromCustomisations = SecurityCustomisations.getSecretStorageKey?.();
+ const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.getSecretStorageKey();
  if (keyFromCustomisations) {
- logger.log("Using key from security customisations (dehydration)");
+ logger.log("CryptoSetupExtension: Using key from extension (dehydration)");
  return keyFromCustomisations;
  }
 
@@ -430,7 +430,7 @@ async function doAccessSecretStorage(func: () => Promise<void>, forceReset: bool
  // inner operation completes.
  return await func();
  } catch (e) {
- SecurityCustomisations.catchAccessSecretStorageError?.(e);
+ ModuleRunner.instance.extensions.cryptoSetup.catchAccessSecretStorageError(e as Error);
  logger.error(e);
  // Re-throw so that higher level logic can abort as needed
  throw e;

src/async-components/views/dialogs/security/CreateSecretStorageDialog.tsx

@@ -40,7 +40,7 @@ import {
  isSecureBackupRequired,
  SecureBackupSetupMethod,
 } from "../../../../utils/WellKnownUtils";
-import SecurityCustomisations from "../../../../customisations/Security";
+import { ModuleRunner } from "../../../../modules/ModuleRunner";
 import Field from "../../../../components/views/elements/Field";
 import BaseDialog from "../../../../components/views/dialogs/BaseDialog";
 import Spinner from "../../../../components/views/elements/Spinner";
@@ -180,9 +180,9 @@ export default class CreateSecretStorageDialog extends React.PureComponent<IProp
  }
 
  private getInitialPhase(): void {
- const keyFromCustomisations = SecurityCustomisations.createSecretStorageKey?.();
+ const keyFromCustomisations = ModuleRunner.instance.extensions.cryptoSetup.createSecretStorageKey();
  if (keyFromCustomisations) {
- logger.log("Created key via customisations, jumping to bootstrap step");
+ logger.log("CryptoSetupExtension: Created key via extension, jumping to bootstrap step");
  this.recoveryKey = {
  privateKey: keyFromCustomisations,
  };

src/components/structures/MatrixChat.tsx

@@ -88,7 +88,7 @@ import { showToast as showMobileGuideToast } from "../../toasts/MobileGuideToast
 import { shouldUseLoginForWelcome } from "../../utils/pages";
 import RoomListStore from "../../stores/room-list/RoomListStore";
 import { RoomUpdateCause } from "../../stores/room-list/models";
-import SecurityCustomisations from "../../customisations/Security";
+import { ModuleRunner } from "../../modules/ModuleRunner";
 import Spinner from "../views/elements/Spinner";
 import QuestionDialog from "../views/dialogs/QuestionDialog";
 import UserSettingsDialog from "../views/dialogs/UserSettingsDialog";
@@ -442,7 +442,9 @@ export default class MatrixChat extends React.PureComponent<IProps, IState> {
  if (crossSigningIsSetUp) {
  // if the user has previously set up cross-signing, verify this device so we can fetch the
  // private keys.
- if (SecurityCustomisations.SHOW_ENCRYPTION_SETUP_UI === false) {
+
+ const cryptoExtension = ModuleRunner.instance.extensions.cryptoSetup;
+ if (cryptoExtension.SHOW_ENCRYPTION_SETUP_UI == false) {
  this.onLoggedIn();
  } else {
  this.setStateForNewView({ view: Views.COMPLETE_SECURITY });

src/modules/ModuleRunner.ts

@@ -17,31 +17,131 @@ limitations under the License.
 import { safeSet } from "matrix-js-sdk/src/utils";
 import { TranslationStringsObject } from "@matrix-org/react-sdk-module-api/lib/types/translations";
 import { AnyLifecycle } from "@matrix-org/react-sdk-module-api/lib/lifecycles/types";
+import {
+ DefaultCryptoSetupExtensions,
+ ProvideCryptoSetupExtensions,
+} from "@matrix-org/react-sdk-module-api/lib/lifecycles/CryptoSetupExtensions";
+import {
+ DefaultExperimentalExtensions,
+ ProvideExperimentalExtensions,
+} from "@matrix-org/react-sdk-module-api/lib/lifecycles/ExperimentalExtensions";
 
 import { AppModule } from "./AppModule";
 import { ModuleFactory } from "./ModuleFactory";
 
 import "./ModuleComponents";
 
+/**
+ * Handles and manages extensions provided by modules.
+ */
+class ExtensionsManager {
+ // Private backing fields for extensions
+ private cryptoSetupExtension: ProvideCryptoSetupExtensions;
+ private experimentalExtension: ProvideExperimentalExtensions;
+
+ /** `true` if `cryptoSetupExtension` is the default implementation; `false` if it is implemented by a module. */
+ private hasDefaultCryptoSetupExtension = true;
+
+ /** `true` if `experimentalExtension` is the default implementation; `false` if it is implemented by a module. */
+ private hasDefaultExperimentalExtension = true;
+
+ /**
+ * Create a new instance.
+ */
+ public constructor() {
+ // Set up defaults
+ this.cryptoSetupExtension = new DefaultCryptoSetupExtensions();
+ this.experimentalExtension = new DefaultExperimentalExtensions();
+ }
+
+ /**
+ * Provides a crypto setup extension.
+ *
+ * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+ */
+ public get cryptoSetup(): ProvideCryptoSetupExtensions {
+ return this.cryptoSetupExtension;
+ }
+
+ /**
+ * Provides an experimental extension.
+ *
+ * @remarks
+ * This method extension is provided to simplify experimentation and development, and is not intended for production code.
+ *
+ * @returns The registered extension. If no module provides this extension, a default implementation is returned.
+ */
+ public get experimental(): ProvideExperimentalExtensions {
+ return this.experimentalExtension;
+ }
+
+ /**
+ * Add any extensions provided by the module.
+ *
+ * @param module - The appModule to check for extensions.
+ *
+ * @throws if an extension is provided by more than one module.
+ */
+ public addExtensions(module: AppModule): void {
+ const runtimeModule = module.module;
+
+ /* Add the cryptoSetup extension if any */
+ if (runtimeModule.extensions?.cryptoSetup) {
+ if (this.hasDefaultCryptoSetupExtension) {
+ this.cryptoSetupExtension = runtimeModule.extensions?.cryptoSetup;
+ this.hasDefaultCryptoSetupExtension = false;
+ } else {
+ throw new Error(
+ `adding cryptoSetup extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided.`,
+ );
+ }
+ }
+
+ /* Add the experimental extension if any */
+ if (runtimeModule.extensions?.experimental) {
+ if (this.hasDefaultExperimentalExtension) {
+ this.experimentalExtension = runtimeModule.extensions?.experimental;
+ this.hasDefaultExperimentalExtension = false;
+ } else {
+ throw new Error(
+ `adding experimental extension implementation from module ${runtimeModule.moduleName} but an implementation was already provided.`,
+ );
+ }
+ }
+ }
+}
+
 /**
  * Handles and coordinates the operation of modules.
  */
 export class ModuleRunner {
  public static readonly instance = new ModuleRunner();
 
+ private extensionsManager = new ExtensionsManager();
+
  private modules: AppModule[] = [];
 
  private constructor() {
  // we only want one instance
  }
 
  /**
- * Resets the runner, clearing all known modules.
+ * Exposes all extensions which may be overridden/provided by modules.
+ *
+ * @returns An `ExtensionsManager` which exposes the extensions.
+ */
+ public get extensions(): ExtensionsManager {
+ return this.extensionsManager;
+ }
+
+ /**
+ * Resets the runner, clearing all known modules, and all extensions
  *
  * Intended for test usage only.
  */
  public reset(): void {
  this.modules = [];
+ this.extensionsManager = new ExtensionsManager();
  }
 
  /**
@@ -72,7 +172,12 @@ export class ModuleRunner {
  * @param factory The module factory.
  */
  public registerModule(factory: ModuleFactory): void {
- this.modules.push(new AppModule(factory));
+ const appModule = new AppModule(factory);
+
+ this.modules.push(appModule);
+
+ // Check if the new module provides any extensions, and also ensure a given extension is only provided by a single runtime module.
+ this.extensionsManager.addExtensions(appModule);
  }
 
  /**

src/toasts/SetupEncryptionToast.ts

@@ -21,7 +21,8 @@ import SetupEncryptionDialog from "../components/views/dialogs/security/SetupEnc
 import { accessSecretStorage } from "../SecurityManager";
 import ToastStore from "../stores/ToastStore";
 import GenericToast from "../components/views/toasts/GenericToast";
-import SecurityCustomisations from "../customisations/Security";
+import { ModuleRunner } from "../modules/ModuleRunner";
+import { SetupEncryptionStore } from "../stores/SetupEncryptionStore";
 import Spinner from "../components/views/elements/Spinner";
 
 const TOAST_KEY = "setupencryption";
@@ -79,7 +80,12 @@ const onReject = (): void => {
 };
 
 export const showToast = (kind: Kind): void => {
- if (SecurityCustomisations.setupEncryptionNeeded?.(kind)) {
+ if (
+ ModuleRunner.instance.extensions.cryptoSetup.setupEncryptionNeeded({
+ kind: kind as any,
+ storeProvider: { getInstance: () => SetupEncryptionStore.sharedInstance() },
+ })
+ ) {
  return;
  }