@wireapp/core 30.6.1 → 30.7.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [30.7.0](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@30.6.1...@wireapp/core@30.7.0) (2022-09-14)
+
+
+### Features
+
+* **core:** sync keys with backend (FS-655) ([#4384](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/issues/4384)) ([28bd0b7](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/commit/28bd0b7358bc8291a712ac267ee65aceec3d74c4))
+
+
+
+
+
 ## [30.6.1](https://github.com/wireapp/wire-web-packages/tree/main/packages/core/compare/@wireapp/core@30.6.0...@wireapp/core@30.6.1) (2022-09-13)
 
 **Note:** Version bump only for package @wireapp/core

package/package.json

@@ -77,6 +77,6 @@
     "test:node": "nyc jasmine --config=jasmine.json",
     "watch": "tsc ---watch"
   },
-  "version": "30.6.1",
-  "gitHead": "7f7ff444af87563ce59f0782eae6806a6c43c9d3"
+  "version": "30.7.0",
+  "gitHead": "c9020130a213747f423d2c49aea546dc5038da72"
 }

package/src/main/Account.d.ts

@@ -22,6 +22,7 @@ import { UserService } from './user/';
 import { AccountService } from './account/';
 import { LinkPreviewService } from './linkPreview';
 import { WEBSOCKET_STATE } from '@wireapp/api-client/src/tcp/ReconnectingWebsocket';
+import { MLSService } from './mls';
 import type { MLSConfig } from './mls/types';
 export declare type ProcessedEventPayload = HandledEventPayload;
 declare enum TOPIC {
@@ -84,6 +85,7 @@ export declare class Account<T = any> extends EventEmitter {
     private coreCryptoClient?;
     static readonly TOPIC: typeof TOPIC;
     service?: {
+        mls: MLSService;
         account: AccountService;
         asset: AssetService;
         broadcast: BroadcastService;

package/src/main/Account.js

@@ -138,7 +138,7 @@ class Account extends events_1.EventEmitter {
      * @param cookie The cookie to identify the user against backend (will use the browser's one if not given)
      */
     async init(clientType, cookie, initClient = true) {
-        var _a, _b;
+        var _a, _b, _c;
         const context = await this.apiClient.init(clientType, cookie);
         await this.initServices(context);
         // Assumption: client gets only initialized once
@@ -148,6 +148,8 @@ class Account extends events_1.EventEmitter {
             await ((_a = this.service) === null || _a === void 0 ? void 0 : _a.notification.checkExistingPendingProposals());
             // initialize schedulers for renewing key materials
             await ((_b = this.service) === null || _b === void 0 ? void 0 : _b.notification.checkForKeyMaterialsUpdate());
+            // initialize scheduler for syncing key packages with backend
+            await ((_c = this.service) === null || _c === void 0 ? void 0 : _c.notification.checkForKeyPackagesBackendSync());
         }
         return context;
     }
@@ -247,6 +249,7 @@ class Account extends events_1.EventEmitter {
         const broadcastService = new broadcast_1.BroadcastService(this.apiClient, cryptographyService);
         const userService = new user_1.UserService(this.apiClient, broadcastService, conversationService, connectionService);
         this.service = {
+            mls: mlsService,
             account: accountService,
             asset: assetService,
             broadcast: broadcastService,
@@ -300,8 +303,8 @@ class Account extends events_1.EventEmitter {
         });
         if (isNewMLSDevice) {
             // If the device is new, we need to upload keypackages and public key to the backend
-            await this.service.client.uploadMLSPublicKeys(await mlsClient.clientPublicKey(), client.id);
-            await this.service.client.uploadMLSKeyPackages(await mlsClient.clientKeypackages(this.nbPrekeys), client.id);
+            await this.service.mls.uploadMLSPublicKeys(await mlsClient.clientPublicKey(), client.id);
+            await this.service.mls.uploadMLSKeyPackages(await mlsClient.clientKeypackages(this.nbPrekeys), client.id);
         }
         return mlsClient;
     }

package/src/main/client/ClientService.d.ts

@@ -37,12 +37,4 @@ export declare class ClientService {
     createLocalClient(client: RegisteredClient, domain?: string): Promise<MetaClient>;
     synchronizeClients(): Promise<MetaClient[]>;
     register(loginData: LoginData, clientInfo: ClientInfo, entropyData?: Uint8Array): Promise<RegisteredClient>;
-    /**
-     * Will make the given client mls capable (generate and upload key packages)
-     *
-     * @param mlsClient Intance of the coreCrypto that represents the mls client
-     * @param clientId The id of the client
-     */
-    uploadMLSPublicKeys(publicKey: Uint8Array, clientId: string): Promise<void>;
-    uploadMLSKeyPackages(keypackages: Uint8Array[], clientId: string): Promise<void>;
 }

package/src/main/client/ClientService.js

@@ -21,7 +21,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientService = void 0;
 const client_1 = require("@wireapp/api-client/src/client/");
 const _1 = require("./");
-const bazinga64_1 = require("bazinga64");
 class ClientService {
     constructor(apiClient, storeEngine, cryptographyService) {
         this.apiClient = apiClient;
@@ -99,20 +98,6 @@ class ClientService {
         await this.createLocalClient(client, this.apiClient.context.domain);
         return client;
     }
-    /**
-     * Will make the given client mls capable (generate and upload key packages)
-     *
-     * @param mlsClient Intance of the coreCrypto that represents the mls client
-     * @param clientId The id of the client
-     */
-    async uploadMLSPublicKeys(publicKey, clientId) {
-        return this.backend.putClient(clientId, {
-            mls_public_keys: { ed25519: btoa(bazinga64_1.Converter.arrayBufferViewToBaselineString(publicKey)) },
-        });
-    }
-    async uploadMLSKeyPackages(keypackages, clientId) {
-        return this.backend.uploadMLSKeyPackages(clientId, keypackages.map(keypackage => btoa(bazinga64_1.Converter.arrayBufferViewToBaselineString(keypackage))));
-    }
 }
 exports.ClientService = ClientService;
 //# sourceMappingURL=ClientService.js.map

package/src/main/mls/MLSService/MLSService.d.ts

@@ -23,4 +23,14 @@ export declare class MLSService {
     removeClientsFromConversation(conversationId: ConversationId, clientIds: Uint8Array[]): Promise<PostMlsMessageResponse | null>;
     commitPendingProposals(conversationId: ConversationId): Promise<CommitBundle>;
     conversationExists(conversationId: ConversationId): Promise<boolean>;
+    clientValidKeypackagesCount(): Promise<number>;
+    clientKeypackages(amountRequested: number): Promise<Uint8Array[]>;
+    /**
+     * Will make the given client mls capable (generate and upload key packages)
+     *
+     * @param mlsClient Intance of the coreCrypto that represents the mls client
+     * @param clientId The id of the client
+     */
+    uploadMLSPublicKeys(publicKey: Uint8Array, clientId: string): Promise<void>;
+    uploadMLSKeyPackages(keypackages: Uint8Array[], clientId: string): Promise<void>;
 }

package/src/main/mls/MLSService/MLSService.js

@@ -126,6 +126,26 @@ class MLSService {
     async conversationExists(conversationId) {
         return this.getCoreCryptoClient().conversationExists(conversationId);
     }
+    async clientValidKeypackagesCount() {
+        return this.getCoreCryptoClient().clientValidKeypackagesCount();
+    }
+    async clientKeypackages(amountRequested) {
+        return this.getCoreCryptoClient().clientKeypackages(amountRequested);
+    }
+    /**
+     * Will make the given client mls capable (generate and upload key packages)
+     *
+     * @param mlsClient Intance of the coreCrypto that represents the mls client
+     * @param clientId The id of the client
+     */
+    async uploadMLSPublicKeys(publicKey, clientId) {
+        return this.apiClient.api.client.putClient(clientId, {
+            mls_public_keys: { ed25519: btoa(bazinga64_1.Converter.arrayBufferViewToBaselineString(publicKey)) },
+        });
+    }
+    async uploadMLSKeyPackages(keypackages, clientId) {
+        return this.apiClient.api.client.uploadMLSKeyPackages(clientId, keypackages.map(keypackage => btoa(bazinga64_1.Converter.arrayBufferViewToBaselineString(keypackage))));
+    }
 }
 exports.MLSService = MLSService;
 //# sourceMappingURL=MLSService.js.map

package/src/main/mls/keyPackagesStatusStore/keyPackagesStatusStore.d.ts

@@ -0,0 +1,7 @@
+export interface KeyPackagesStatusStore {
+    lastQueryDate: number;
+}
+export declare const keyPackagesStatusStore: {
+    getState: () => KeyPackagesStatusStore;
+    saveState: ({ lastQueryDate }: KeyPackagesStatusStore) => void;
+};

package/src/main/mls/keyPackagesStatusStore/keyPackagesStatusStore.js

@@ -0,0 +1,42 @@
+"use strict";
+/*
+ * Wire
+ * Copyright (C) 2022 Wire Swiss GmbH
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://www.gnu.org/licenses/.
+ *
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keyPackagesStatusStore = void 0;
+const storageKey = 'keyPackagesStatus';
+const getState = () => {
+    const storedState = localStorage.getItem(storageKey);
+    if (!storedState) {
+        return {
+            lastQueryDate: 0,
+        };
+    }
+    const parsedState = JSON.parse(storedState);
+    return {
+        lastQueryDate: Number(parsedState.lastQueryDate),
+    };
+};
+const saveState = ({ lastQueryDate }) => {
+    localStorage.setItem(storageKey, JSON.stringify({ lastQueryDate }));
+};
+exports.keyPackagesStatusStore = {
+    getState,
+    saveState,
+};
+//# sourceMappingURL=keyPackagesStatusStore.js.map

package/src/main/notification/NotificationService.d.ts

@@ -122,10 +122,19 @@ export declare class NotificationService extends EventEmitter {
     private scheduleTaskToRenewKeyMaterial;
     /**
      * ## MLS only ##
-     * Get all pending proposals from the database and schedule them
+     * Get all keying material last update dates and schedule tasks for renewal
      * Function must only be called once, after application start
      *
      */
     checkForKeyMaterialsUpdate(): Promise<void>;
+    private scheduleKeyPackagesSync;
+    private syncKeyPackages;
+    /**
+     * ## MLS only ##
+     * Get date of last key packages count query and schedule a task to sync it with backend
+     * Function must only be called once, after application start
+     *
+     */
+    checkForKeyPackagesBackendSync(): Promise<void>;
 }
 export {};

package/src/main/notification/NotificationService.js

@@ -68,11 +68,13 @@ const protocol_messaging_1 = require("@wireapp/protocol-messaging");
 const bazinga64_1 = require("bazinga64");
 const TaskScheduler_1 = require("../util/TaskScheduler/TaskScheduler");
 const LowPrecisionTaskScheduler_1 = require("../util/LowPrecisionTaskScheduler/LowPrecisionTaskScheduler");
+const keyPackagesStatusStore_1 = require("../mls/keyPackagesStatusStore/keyPackagesStatusStore");
 var TOPIC;
 (function (TOPIC) {
     TOPIC["NOTIFICATION_ERROR"] = "NotificationService.TOPIC.NOTIFICATION_ERROR";
 })(TOPIC || (TOPIC = {}));
 const DEFAULT_KEYING_MATERIAL_UPDATE_THRESHOLD = 1000 * 60 * 60 * 24 * 30; //30 days
+const INITIAL_NUMBER_OF_KEY_PACKAGES = 100;
 class NotificationService extends events_1.EventEmitter {
     constructor(apiClient, cryptographyService, mlsService, storeEngine) {
         super();
@@ -449,7 +451,7 @@ class NotificationService extends events_1.EventEmitter {
     }
     /**
      * ## MLS only ##
-     * Get all pending proposals from the database and schedule them
+     * Get all keying material last update dates and schedule tasks for renewal
      * Function must only be called once, after application start
      *
      */
@@ -462,6 +464,44 @@ class NotificationService extends events_1.EventEmitter {
             this.logger.error('Could not get last key material update dates', error);
         }
     }
+    scheduleKeyPackagesSync(firingDate) {
+        TaskScheduler_1.TaskScheduler.addTask({
+            firingDate,
+            key: 'try-key-packages-backend-sync',
+            task: () => this.syncKeyPackages(),
+        });
+    }
+    async syncKeyPackages() {
+        const validKeyPackagesCount = await this.mlsService.clientValidKeypackagesCount();
+        const lastQueryDate = new Date().getTime();
+        await keyPackagesStatusStore_1.keyPackagesStatusStore.saveState({ lastQueryDate });
+        const minAllowedNumberOfKeyPackages = INITIAL_NUMBER_OF_KEY_PACKAGES / 2;
+        if (validKeyPackagesCount <= minAllowedNumberOfKeyPackages) {
+            const clientId = this.apiClient.validatedClientId;
+            //check numbers of keys on backend
+            const backendKeyPackagesCount = await this.apiClient.api.client.getMLSKeyPackageCount(clientId);
+            if (backendKeyPackagesCount <= minAllowedNumberOfKeyPackages) {
+                //upload new keys
+                const newKeyPackages = await this.mlsService.clientKeypackages(INITIAL_NUMBER_OF_KEY_PACKAGES);
+                await this.mlsService.uploadMLSKeyPackages(newKeyPackages, clientId);
+            }
+        }
+        //schedule new task after next 24h
+        const nextKeyPackagesQueryDate = lastQueryDate + commons_1.TimeUtil.TimeInMillis.DAY;
+        this.scheduleKeyPackagesSync(nextKeyPackagesQueryDate);
+    }
+    /**
+     * ## MLS only ##
+     * Get date of last key packages count query and schedule a task to sync it with backend
+     * Function must only be called once, after application start
+     *
+     */
+    async checkForKeyPackagesBackendSync() {
+        const { lastQueryDate } = keyPackagesStatusStore_1.keyPackagesStatusStore.getState();
+        //schedule a task lastKeyPackagesQueryDate + 24H
+        const nextKeyPackagesQueryDate = lastQueryDate + commons_1.TimeUtil.TimeInMillis.DAY;
+        this.scheduleKeyPackagesSync(nextKeyPackagesQueryDate);
+    }
 }
 exports.NotificationService = NotificationService;
 NotificationService.TOPIC = TOPIC;