@wireapp/core 27.6.0 → 28.0.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [28.0.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.6.0...@wireapp/core@28.0.0) (2022-07-01)
+
+
+### Features
+
+* Use mls config object ([#4307](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4307)) ([3d510d0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/3d510d0e041a3d049282e6a312ffa880d9bafd89))
+
+
+### BREAKING CHANGES
+
+* the enableMLS flag has been removed in favor of a config object. If the config object is set, then MLS will be activated
+
+
+
+
+
 # [27.6.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@27.5.0...@wireapp/core@27.6.0) (2022-06-30)
 
 

package/package.json

@@ -73,6 +73,6 @@
     "test:project": "yarn dist && yarn test",
     "test:node": "nyc jasmine --config=jasmine.json"
   },
-  "version": "27.6.0",
-  "gitHead": "8bc302af20f400f4c0cb3e15edfcaebb4494f1d0"
+  "version": "28.0.0",
+  "gitHead": "89c2a626f3f385edea215a96640c2805972a161a"
 }

package/src/main/Account.d.ts

@@ -59,13 +59,22 @@ declare type SecretCrypto<T> = {
     encrypt: (value: Uint8Array) => Promise<T>;
     decrypt: (payload: T) => Promise<Uint8Array>;
 };
-interface AccountOptions<T> {
-    /** Used to store info in the database (will create a inMemory engine if returns undefined) */
-    createStore?: CreateStoreFn;
-    /** encrypt/decrypt function pair that will be called before storing/fetching secrets in the secrets database.
+interface MLSConfig<T = any> {
+    /**
+     * encrypt/decrypt function pair that will be called before storing/fetching secrets in the secrets database.
      * If not provided will use the built in encryption mechanism
      */
     secretsCrypto?: SecretCrypto<T>;
+    /**
+     * path on the public server to the core crypto wasm file.
+     * This file will be downloaded lazily when corecrypto is needed.
+     * It, thus, needs to know where, on the server, the file can be found
+     */
+    coreCrypoWasmFilePath: string;
+}
+interface AccountOptions<T> {
+    /** Used to store info in the database (will create a inMemory engine if returns undefined) */
+    createStore?: CreateStoreFn;
     /** Number of prekeys to generate when creating a new device (defaults to 2)
      * Prekeys are Diffie-Hellmann public keys which allow offline initiation of a secure Proteus session between two devices.
      * Having a high value will:
@@ -76,16 +85,18 @@ interface AccountOptions<T> {
      *    - make it likely that all prekeys get consumed while the device is offline and the last resort prekey will be used to create new session
      */
     nbPrekeys?: number;
-    enableMLS?: boolean;
+    /**
+     * Config for MLS devices. Will not load corecrypt or create MLS devices if undefined
+     */
+    mlsConfig?: MLSConfig<T>;
 }
 export declare class Account<T = unknown> extends EventEmitter {
     private readonly apiClient;
     private readonly logger;
     private readonly createStore;
     private storeEngine?;
-    private readonly secretsCrypto?;
     private readonly nbPrekeys;
-    private readonly enableMLS;
+    private readonly mlsConfig?;
     private coreCryptoClient?;
     static readonly TOPIC: typeof TOPIC;
     service?: {
@@ -108,7 +119,7 @@ export declare class Account<T = unknown> extends EventEmitter {
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
      * @param accountOptions
      */
-    constructor(apiClient?: APIClient, { createStore, nbPrekeys, secretsCrypto, enableMLS }?: AccountOptions<T>);
+    constructor(apiClient?: APIClient, { createStore, nbPrekeys, mlsConfig }?: AccountOptions<T>);
     private persistCookie;
     get clientId(): string;
     get userId(): string;

package/src/main/Account.js

@@ -86,14 +86,13 @@ class Account extends events_1.EventEmitter {
      * @param apiClient The apiClient instance to use in the core (will create a new new one if undefined)
      * @param accountOptions
      */
-    constructor(apiClient = new api_client_1.APIClient(), { createStore = () => undefined, nbPrekeys = 2, secretsCrypto, enableMLS = false } = {}) {
+    constructor(apiClient = new api_client_1.APIClient(), { createStore = () => undefined, nbPrekeys = 2, mlsConfig } = {}) {
         super();
         this.apiClient = apiClient;
         this.backendFeatures = this.apiClient.backendFeatures;
-        this.secretsCrypto = secretsCrypto;
+        this.mlsConfig = this.mlsConfig;
         this.nbPrekeys = nbPrekeys;
         this.createStore = createStore;
-        this.enableMLS = enableMLS;
         apiClient.on(api_client_1.APIClient.TOPIC.COOKIE_REFRESH, async (cookie) => {
             if (cookie && this.storeEngine) {
                 try {
@@ -260,17 +259,17 @@ class Account extends events_1.EventEmitter {
         const loadedClient = await this.service.client.getLocalClient();
         await this.apiClient.api.client.getClient(loadedClient.id);
         this.apiClient.context.clientId = loadedClient.id;
-        if (this.enableMLS) {
-            this.coreCryptoClient = await this.createMLSClient(loadedClient, this.apiClient.context);
+        if (this.mlsConfig) {
+            this.coreCryptoClient = await this.createMLSClient(loadedClient, this.apiClient.context, this.mlsConfig);
         }
         return loadedClient;
     }
-    async createMLSClient(client, context) {
+    async createMLSClient(client, context, mlsConfig) {
         const coreCryptoKeyId = 'corecrypto-key';
         const { CoreCrypto } = await Promise.resolve().then(() => __importStar(require('@otak/core-crypto')));
         const dbName = `secrets-${this.generateDbName(context)}`;
-        const secretStore = this.secretsCrypto
-            ? await (0, encryptedStore_1.createCustomEncryptedStore)(dbName, this.secretsCrypto)
+        const secretStore = mlsConfig.secretsCrypto
+            ? await (0, encryptedStore_1.createCustomEncryptedStore)(dbName, mlsConfig.secretsCrypto)
             : await (0, encryptedStore_1.createEncryptedStore)(dbName);
         let key = await secretStore.getsecretValue(coreCryptoKeyId);
         if (!key) {
@@ -288,10 +287,10 @@ class Account extends events_1.EventEmitter {
         if (!this.service) {
             throw new Error('Services are not set.');
         }
-        this.logger.info(`Creating new client {mls: ${!!this.enableMLS}}`);
+        this.logger.info(`Creating new client {mls: ${!!this.mlsConfig}}`);
         const registeredClient = await this.service.client.register(loginData, clientInfo, entropyData);
-        if (this.enableMLS) {
-            this.coreCryptoClient = await this.createMLSClient(registeredClient, this.apiClient.context);
+        if (this.mlsConfig) {
+            this.coreCryptoClient = await this.createMLSClient(registeredClient, this.apiClient.context, this.mlsConfig);
             await this.service.client.uploadMLSPublicKeys(this.coreCryptoClient.clientPublicKey(), registeredClient.id);
             await this.service.client.uploadMLSKeyPackages(this.coreCryptoClient.clientKeypackages(this.nbPrekeys), registeredClient.id);
         }