feat: Support for CoreCrypto 9 [WPB-20699] (#19608)

* feat: Support for CoreCrypto 9 [WPB-20699]

* improve logs

* fix errors

* fix lock file

* recover semi reseted mls conversations

* bump core

* fix: align EnrollmentTimer test with implementation (notAfter field) and clarify test description

Author: thisisamir98

package.json

@@ -16,7 +16,7 @@
     "@wireapp/avs": "10.0.46",
     "@wireapp/avs-debugger": "0.0.7",
     "@wireapp/commons": "5.4.5",
-    "@wireapp/core": "46.35.3",
+    "@wireapp/core": "46.38.1",
     "@wireapp/kalium-backup": "0.0.4",
     "@wireapp/promise-queue": "2.4.5",
     "@wireapp/react-ui-kit": "9.66.0",

src/script/E2EIdentity/E2EIdentityEnrollment.test.ts

@@ -67,12 +67,13 @@ const generateWireIdentity = (
   x509Identity: {
     free: jest.fn(),
     certificate: '',
-    display_name: 'John Doe',
+    displayName: 'John Doe',
     domain: 'domain',
     handle: 'johndoe',
-    not_after: BigInt(0),
-    not_before: BigInt(0),
-    serial_number: '',
+    notAfter: BigInt(0),
+    notBefore: BigInt(0),
+    serialNumber: '',
+    [Symbol.dispose]: () => {},
   },
   thumbprint: '',
   credentialType,

src/script/E2EIdentity/EnrollmentTimer/EnrollmentTimer.test.ts

@@ -48,7 +48,7 @@ describe('e2ei delays', () => {
       {
         x509Identity: {
           certificate: ' ',
-          not_after: (Date.now() + validityPeriod) / 1000,
+          notAfter: (Date.now() + validityPeriod) / 1000,
         },
       } as any,
       Date.now(),
@@ -67,7 +67,7 @@ describe('e2ei delays', () => {
       {
         x509Identity: {
           certificate: ' ',
-          not_after: deadline / 1000,
+          notAfter: deadline / 1000,
         },
       } as any,
       Date.now(),
@@ -78,14 +78,14 @@ describe('e2ei delays', () => {
     expect(firingDate).toBe(gracePeriodStartingPoint);
   });
 
-  it('should return a non snoozable timer if device is out of the grace period', () => {
+  it('should return a snoozable timer scheduled at the start of the grace period if we are not in it yet', () => {
     const deadline = Date.now() + gracePeriod + 1000;
     const gracePeriodStartingPoint = deadline - gracePeriod;
     const {firingDate, isSnoozable} = getEnrollmentTimer(
       {
         x509Identity: {
           certificate: ' ',
-          not_after: deadline / 1000,
+          notAfter: deadline / 1000,
         },
       } as any,
       Date.now(),

src/script/E2EIdentity/EnrollmentTimer/EnrollmentTimer.ts

@@ -80,7 +80,7 @@ function getGracePeriod(
   // To be sure the device does not expire, we want to keep a safe delay
   const safeDelay = randomInt(TimeInMillis.DAY) + messageRetentionTime;
 
-  const end = Number(identity?.x509Identity?.not_after) * TimeInMillis.SECOND;
+  const end = Number(identity?.x509Identity?.notAfter) * TimeInMillis.SECOND;
   const start = Math.max(end - safeDelay, end - teamGracePeriodDuration);
 
   return {end, start};

src/script/components/Badge/components/VerificationBadges/VerificationBadges.tsx

@@ -88,7 +88,7 @@ const getMLSStatuses = ({identities, user}: {identities?: WireIdentity[]; user?:
   }
 
   return identities.map(identity => {
-    const matchingName = identity.x509Identity?.display_name === user.name();
+    const matchingName = identity.x509Identity?.displayName === user.name();
     const matchingHandle = checkUserHandle(identity, user);
 
     if (!matchingName || !matchingHandle) {

src/script/main/app.ts

@@ -581,20 +581,26 @@ export class App {
       await conversationRepository.init1To1Conversations(connections, conversations);
       if (this.core.hasMLSDevice) {
         // add the potential `self` and `team` conversations
-        await initialiseSelfAndTeamConversations(conversations, selfUser, clientEntity.id, this.core);
+        await initialiseSelfAndTeamConversations(
+          conversations,
+          conversationRepository,
+          selfUser,
+          clientEntity.id,
+          this.core,
+        );
 
         // join all the mls groups that are known by the user but were migrated to mls
         await joinConversationsAfterMigrationFinalisation({
           conversations,
-          selfUser,
+          conversationRepository,
           core: this.core,
           onSuccess: conversationRepository.injectJoinedAfterMigrationFinalisationMessage,
           onError: ({id}, error) =>
             this.logger.error(`Failed when joining a migrated mls conversation with id ${id}, error: `, error),
         });
 
         // join all the mls groups we're member of and have not yet joined (eg. we were not send welcome message)
-        await initMLSGroupConversations(conversations, selfUser, {
+        await initMLSGroupConversations(conversations, conversationRepository, {
           core: this.core,
           onError: ({id}, error) =>
             this.logger.error(`Failed when initialising mls conversation with id ${id}, error: `, error),

src/script/mls/MLSConversations.test.ts

@@ -26,6 +26,8 @@ import {Account} from '@wireapp/core';
 import {MLSConversation} from 'Repositories/conversation/ConversationSelectors';
 import {Conversation} from 'Repositories/entity/Conversation';
 import {User} from 'Repositories/entity/User';
+import {Core} from 'src/script/service/CoreSingleton';
+import {TestFactory} from 'test/helper/TestFactory';
 
 import {initMLSGroupConversations, initialiseSelfAndTeamConversations} from './MLSConversations';
 
@@ -44,20 +46,28 @@ function createMLSConversations(nbConversations: number, type?: CONVERSATION_TYP
 }
 
 describe('MLSConversations', () => {
+  const testFactory = new TestFactory();
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   describe('initMLSGroupConversations', () => {
-    it('joins all the unestablished MLS groups', async () => {
-      const core = new Account();
+    it('joins all the unestablished MLS groups (epoch > 0)', async () => {
       const nbMLSConversations = 5 + Math.ceil(Math.random() * 10);
-
       const mlsConversations = createMLSConversations(nbMLSConversations, CONVERSATION_TYPE.REGULAR);
+      // Force epoch > 0 to trigger join path instead of establish
+      mlsConversations.forEach(c => (c.epoch = 1));
 
-      jest.spyOn(core.service!.conversation, 'mlsGroupExistsLocally').mockResolvedValue(false);
-      jest.spyOn(core.service!.conversation, 'joinByExternalCommit');
+      const conversationRepository = await testFactory.exposeConversationActors();
+      const repositoryCore = (conversationRepository as any).core as Core;
+      jest.spyOn(repositoryCore.service!.conversation, 'mlsGroupExistsLocally').mockResolvedValue(false);
+      const joinSpy = jest.spyOn(repositoryCore.service!.conversation, 'joinByExternalCommit');
 
-      await initMLSGroupConversations(mlsConversations, new User(), {core});
+      await initMLSGroupConversations(mlsConversations, conversationRepository, {core: repositoryCore});
 
       for (const conversation of mlsConversations) {
-        expect(core.service?.conversation.joinByExternalCommit).toHaveBeenCalledWith(conversation.qualifiedId);
+        expect(joinSpy).toHaveBeenCalledWith(conversation.qualifiedId);
       }
     });
   });
@@ -71,7 +81,8 @@ describe('MLSConversations', () => {
     jest.spyOn(core.service!.conversation!, 'mlsGroupExistsLocally').mockResolvedValue(true);
     jest.spyOn(core.service!.mls!, 'scheduleKeyMaterialRenewal');
 
-    await initMLSGroupConversations(mlsConversations, new User(), {core});
+    const conversationRepository = await testFactory.exposeConversationActors();
+    await initMLSGroupConversations(mlsConversations, conversationRepository, {core});
 
     for (const conversation of mlsConversations) {
       expect(core.service!.mls!.scheduleKeyMaterialRenewal).toHaveBeenCalledWith(conversation.groupId);
@@ -92,7 +103,9 @@ describe('MLSConversations', () => {
       const mlsConversations = createMLSConversations(nbMLSConversations);
       const conversations = [teamConversation, ...mlsConversations, selfConversation];
 
-      await initialiseSelfAndTeamConversations(conversations, new User(), 'client-1', core);
+      const conversationRepository = await testFactory.exposeConversationActors();
+
+      await initialiseSelfAndTeamConversations(conversations, conversationRepository, new User(), 'client-1', core);
 
       expect(core.service!.mls!.registerConversation).toHaveBeenCalledTimes(2);
     });
@@ -112,13 +125,14 @@ describe('MLSConversations', () => {
       const mlsConversations = createMLSConversations(nbMLSConversations);
       const conversations = [teamConversation, ...mlsConversations, selfConversation];
 
-      await initialiseSelfAndTeamConversations(conversations, new User(), 'clientId', core);
+      const conversationRepository = await testFactory.exposeConversationActors();
+
+      await initialiseSelfAndTeamConversations(conversations, conversationRepository, new User(), 'clientId', core);
 
       expect(core.service!.mls!.registerConversation).toHaveBeenCalledTimes(0);
     });
 
     it('joins self and team conversation with external commit that have epoch > 0', async () => {
-      const core = new Account();
       const nbMLSConversations = 5 + Math.ceil(Math.random() * 10);
 
       const selfConversation = createMLSConversation();
@@ -132,13 +146,22 @@ describe('MLSConversations', () => {
       const mlsConversations = createMLSConversations(nbMLSConversations);
       const conversations = [teamConversation, ...mlsConversations, selfConversation];
 
+      const conversationRepository = await testFactory.exposeConversationActors();
+      const repositoryCore = (conversationRepository as any).core as Core;
       // MLS group is not yet established locally
-      jest.spyOn(core.service!.mls!, 'isConversationEstablished').mockResolvedValue(false);
-
-      await initialiseSelfAndTeamConversations(conversations, new User(), 'clientId', core);
-
-      expect(core.service!.mls!.registerConversation).toHaveBeenCalledTimes(0);
-      expect(core.service!.conversation!.joinByExternalCommit).toHaveBeenCalledTimes(2);
+      jest.spyOn(repositoryCore.service!.mls!, 'isConversationEstablished').mockResolvedValue(false);
+      const joinSpy = jest.spyOn(repositoryCore.service!.conversation!, 'joinByExternalCommit');
+
+      await initialiseSelfAndTeamConversations(
+        conversations,
+        conversationRepository,
+        new User(),
+        'clientId',
+        repositoryCore,
+      );
+
+      expect(repositoryCore.service!.mls!.registerConversation).toHaveBeenCalledTimes(0);
+      expect(joinSpy).toHaveBeenCalledTimes(2);
     });
 
     it('DOES NOT join self and team conversation with external commit that have epoch > 0, but is already established locally', async () => {
@@ -158,7 +181,8 @@ describe('MLSConversations', () => {
 
       jest.spyOn(core.service!.mls!, 'isConversationEstablished').mockResolvedValue(true);
 
-      await initialiseSelfAndTeamConversations(conversations, new User(), 'clientId', core);
+      const conversationRepository = await testFactory.exposeConversationActors();
+      await initialiseSelfAndTeamConversations(conversations, conversationRepository, new User(), 'clientId', core);
 
       expect(core.service!.mls!.registerConversation).not.toHaveBeenCalled();
       expect(core.service!.conversation!.joinByExternalCommit).not.toHaveBeenCalled();

src/script/mls/MLSConversations.ts

@@ -17,11 +17,9 @@
  *
  */
 
-import {QualifiedId} from '@wireapp/api-client/lib/user';
-import {KeyPackageClaimUser} from '@wireapp/core/lib/conversation';
-
 import {Account} from '@wireapp/core';
 
+import {ConversationRepository} from 'Repositories/conversation/ConversationRepository';
 import {
   isMLSCapableConversation,
   isMLSConversation,
@@ -32,6 +30,9 @@ import {
 } from 'Repositories/conversation/ConversationSelectors';
 import {Conversation} from 'Repositories/entity/Conversation';
 import {User} from 'Repositories/entity/User';
+import {getLogger} from 'Util/Logger';
+
+const logger = getLogger('Webapp/MLSConversations');
 
 /**
  * Will initialize all the MLS conversations that the user is member of but that are not yet locally established.
@@ -41,7 +42,7 @@ import {User} from 'Repositories/entity/User';
  */
 export async function initMLSGroupConversations(
   conversations: Conversation[],
-  selfUser: User,
+  conversationRepository: ConversationRepository,
   {
     core,
     onSuccessfulJoin,
@@ -63,7 +64,7 @@ export async function initMLSGroupConversations(
   );
 
   for (const mlsConversation of mlsGroupConversations) {
-    await initMLSGroupConversation(mlsConversation, selfUser.qualifiedId, {
+    await initMLSGroupConversation(mlsConversation, conversationRepository, {
       core,
       onSuccessfulJoin,
       onError,
@@ -79,7 +80,7 @@ export async function initMLSGroupConversations(
  */
 export async function initMLSGroupConversation(
   mlsConversation: MLSCapableConversation,
-  selfUserQualifiedId: QualifiedId,
+  conversationRepository: ConversationRepository,
   {
     core,
     onSuccessfulJoin,
@@ -100,15 +101,20 @@ export async function initMLSGroupConversation(
 
     const doesMLSGroupExist = await conversationService.mlsGroupExistsLocally(groupId);
 
-    //if group is already established, we just schedule periodic key material updates
+    // if group is already established, we just schedule periodic key material updates
     if (doesMLSGroupExist) {
       await mlsService.scheduleKeyMaterialRenewal(groupId);
       return;
     }
 
-    //otherwise we should try joining via external commit
-    await conversationService.joinByExternalCommit(qualifiedId);
-    await addOtherSelfClientsToMLSConversation(mlsConversation, selfUserQualifiedId, core.clientId, core);
+    // otherwise we should try to ensure the conversation exists (this will establish it if epoch is 0, or join by external commit if epoch > 0)
+    console.info('Conversation does not exist, ensuring establishment');
+    await conversationRepository.ensureConversationExists({
+      groupId,
+      conversationId: qualifiedId,
+      epoch: mlsConversation.epoch,
+      core,
+    });
 
     onSuccessfulJoin?.(mlsConversation);
   } catch (error) {
@@ -127,6 +133,7 @@ export async function initMLSGroupConversation(
  */
 export async function initialiseSelfAndTeamConversations(
   conversations: Conversation[],
+  conversationRepository: ConversationRepository,
   selfUser: User,
   selfClientId: string,
   core: Account,
@@ -154,52 +161,27 @@ export async function initialiseSelfAndTeamConversations(
 
       // If the conversation is already established, we don't need to do anything.
       const isGroupAlreadyEstablished = await mlsService.isConversationEstablished(conversation.groupId);
+      logger.info('Checking if group is already established', {
+        isGroupAlreadyEstablished,
+        qualifiedId: conversation.qualifiedId,
+      });
       if (isGroupAlreadyEstablished) {
         return Promise.resolve();
       }
 
-      // Otherwise, we need to join the conversation via external commit.
-      await conversationService.joinByExternalCommit(conversation.qualifiedId);
-      await addOtherSelfClientsToMLSConversation(conversation, selfUser.qualifiedId, selfClientId, core);
+      logger.info('Conversation does not exist, ensuring establishment', {
+        conversationId: conversation.qualifiedId,
+        groupId: conversation.groupId,
+        epoch: conversation.epoch,
+      });
+
+      // Otherwise, we need to ensure the conversation exists by establishing it or joining it by external commit.
+      await conversationRepository.ensureConversationExists({
+        conversationId: conversation.qualifiedId,
+        groupId: conversation.groupId,
+        epoch: conversation.epoch,
+        core,
+      });
     }),
   );
 }
-
-/**
- * Will add all other user's self clients to the mls group.
- *
- * @param conversation id of the conversation
- * @param selfUserId id of the self user who's clients should be added
- * @param selfClientId id of the current client (that should be skipped)
- * @param core instance of the core
- */
-export async function addOtherSelfClientsToMLSConversation(
-  conversation: Conversation,
-  selfUserId: QualifiedId,
-  selfClientId: string,
-  core: Account,
-) {
-  try {
-    const {groupId, qualifiedId} = conversation;
-
-    if (!groupId) {
-      throw new Error(`No group id found for MLS conversation ${conversation.id}`);
-    }
-
-    const selfQualifiedUser: KeyPackageClaimUser = {
-      ...selfUserId,
-      skipOwnClientId: selfClientId,
-    };
-
-    await core.service?.conversation.addUsersToMLSConversation({
-      conversationId: qualifiedId,
-      groupId,
-      qualifiedUsers: [selfQualifiedUser],
-    });
-  } catch (error) {
-    console.warn(
-      `Error when tried to add other self clients to MLS conversation ${conversation.qualifiedId.id} ${conversation.qualifiedId.domain}`,
-      error,
-    );
-  }
-}