feat(E2EE): Async E2EE keys exchange by yash-rajpal · Pull Request #32197 · RocketChat/Rocket.Chat

yash-rajpal · 2024-04-12T18:36:52Z

Proposed changes (including videos or screenshots)

Async key distribution process for E2EE rooms. Earlier users needed to be online to receive and share and verify the group keys which caused a bottleneck in the process. Made this process async so that users now no longer need to be online at the same time.

Keys will be generated even when the users are offline and they can receive it when they come online.

Issue(s)

Steps to test or reproduce

Add a few users in an E2EE room
reset the E2EE for few users
Log back in with those users (just to create their public keys)
When the main users comes online in the E2EE room, it will generate the keys for all the users waiting in queue.
When users come online they receive keys and E2EE rooms messages are decrypted.

Further comments

E2EE-13

changeset-bot · 2024-04-12T18:36:55Z

🦋 Changeset detected

Latest commit: dcd8fe9

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 32 packages

Name	Type
@rocket.chat/model-typings	Minor
@rocket.chat/core-typings	Minor
@rocket.chat/rest-typings	Minor
@rocket.chat/meteor	Minor
@rocket.chat/apps	Patch
@rocket.chat/models	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/omnichannel-services	Patch
rocketchat-services	Patch
@rocket.chat/core-services	Patch
@rocket.chat/cron	Patch
@rocket.chat/fuselage-ui-kit	Major
@rocket.chat/gazzodown	Major
@rocket.chat/livechat	Patch
@rocket.chat/ui-contexts	Major
@rocket.chat/api-client	Patch
@rocket.chat/license	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/presence	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/instance-status	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/ui-avatar	Major
@rocket.chat/ui-client	Major
@rocket.chat/ui-video-conf	Major
@rocket.chat/web-ui-registration	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

dionisio-bot · 2024-04-12T18:36:56Z

Looks like this PR is ready to merge! 🎉
If you have any trouble, please check the PR guidelines

codecov · 2024-04-12T18:52:25Z

Codecov Report

Attention: Patch coverage is 59.55882% with 55 lines in your changes missing coverage. Please review.

Project coverage is 56.71%. Comparing base (1240c87) to head (dcd8fe9).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #32197      +/-   ##
===========================================
- Coverage    56.74%   56.71%   -0.03%     
===========================================
  Files         2495     2496       +1     
  Lines        55237    55360     +123     
  Branches     11434    11455      +21     
===========================================
+ Hits         31345    31400      +55     
- Misses       21196    21255      +59     
- Partials      2696     2705       +9

Flag	Coverage Δ
e2e	`56.45% <59.55%> (-0.06%)`	⬇️
unit	`71.86% <ø> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

MarcosSpessatto

I still have some general comments:

Let's improve the PR description.
We need to add a changeset.
We can have some API tests to test at least half of the workflow, we can call the provideUsersGroupKeys endpoint with arbitrary values for keys, and see if the keys were set to the subscriptions. Of course, the test will not be fully complete, and test it using an UI test could potentially create a slow test, since the process is completely async.

apps/meteor/app/api/server/v1/e2e.ts

apps/meteor/app/e2e/client/rocketchat.e2e.room.js

apps/meteor/app/e2e/client/rocketchat.e2e.ts

apps/meteor/app/e2e/client/rocketchat.e2e.room.js

apps/meteor/server/lib/resetUserE2EKey.ts

apps/meteor/server/models/raw/Rooms.ts

apps/meteor/app/e2e/client/rocketchat.e2e.ts

apps/meteor/app/api/server/v1/e2e.ts

apps/meteor/app/lib/server/functions/addUserToRoom.ts

apps/meteor/app/e2e/server/functions/fetchUsersWaitingForGroupKey.ts

apps/meteor/app/e2e/server/functions/provideUsersSuggestedGroupKeys.ts

packages/rest-typings/src/v1/e2e.ts

apps/meteor/app/e2e/client/rocketchat.e2e.room.js

apps/meteor/server/lib/resetUserE2EKey.ts

packages/core-typings/src/IRoom.ts

apps/meteor/server/models/raw/Rooms.ts

apps/meteor/app/e2e/server/functions/fetchUsersWaitingForGroupKey.ts

apps/meteor/app/api/server/v1/e2e.ts

apps/meteor/app/e2e/server/functions/provideUsersSuggestedGroupKeys.ts

packages/rest-typings/src/v1/e2e.ts

apps/meteor/server/models/raw/Rooms.ts

apps/meteor/server/lib/resetUserE2EKey.ts

apps/meteor/server/models/raw/Rooms.ts

Dismissed

…ange

cardoso

This PR deprecated the e2e.updateGroupKey endpoint and removed its usage, however the usage was reintroduced in 7.0.0: #33328

cardoso · 2025-12-18T17:15:34Z

apps/meteor/app/api/server/v1/e2e.ts

 		validateParams: ise2eUpdateGroupKeyParamsPOST,
+		deprecation: {
+			version: '8.0.0',
+		},


Deprecated here

cardoso · 2025-12-18T17:15:53Z

apps/meteor/app/e2e/client/rocketchat.e2e.room.js

-			// Key has been encrypted. Publish to that user's subscription model for this room.
-			await sdk.call('e2e.updateGroupKey', this.roomId, user._id, this.keyID + Base64.encode(new Uint8Array(encryptedUserKey)));
+			const encryptedUserKeyToString = this.keyID + Base64.encode(new Uint8Array(encryptedUserKey));
+			return encryptedUserKeyToString;


Usage removed here

wip: async key exchange

1edcc53

yash-rajpal added 6 commits April 15, 2024 20:29

implement timer

105dd56

refactor little

992b2b3

add rest typings

46fd7c3

handle API error cases

31df542

joining/leaving room cases

7af8379

reuse some code

8b2ffb0

yash-rajpal marked this pull request as ready for review April 15, 2024 19:39

yash-rajpal requested review from a team as code owners April 15, 2024 19:39

lint

8b062fc

MarcosSpessatto suggested changes Apr 16, 2024

View reviewed changes

yash-rajpal added 9 commits April 18, 2024 21:34

accept async generated keys

39a59cf

start storing timestamp

1539f15

some better practices

79b50ae

wait for key distribution

ecb1a29

improve mongo queries

8fc55eb

better naving conventions

8f9faec

remove some unused functions

c206a0e

add changesets

aaf585c

fix confs

6a37fbf

KevLehman reviewed Apr 19, 2024

View reviewed changes

MarcosSpessatto changed the title ~~feat: Async E2E keys exchange~~ feat(E2EE): Async E2EE keys exchange Apr 23, 2024

MarcosSpessatto suggested changes Apr 23, 2024

View reviewed changes

rodrigok previously requested changes Apr 23, 2024

View reviewed changes

Marcos Defendi added 2 commits May 13, 2024 10:57

Merge branch 'develop' into e2e-async-key-exchange

09f494f

fix: fix lint

6c46dbd

yash-rajpal dismissed stale reviews from MarcosSpessatto and KevLehman via e3cd670 June 20, 2024 19:45

dionisio-bot bot removed the stat: ready to merge PR tested and approved waiting for merge label Jun 20, 2024

yash-rajpal requested review from KevLehman, MarcosSpessatto, hugocostadev and rodrigok June 20, 2024 19:47

MarcosSpessatto previously approved these changes Jun 20, 2024

View reviewed changes

rodrigok removed their request for review June 20, 2024 20:42

KevLehman previously approved these changes Jun 20, 2024

View reviewed changes

hugocostadev previously approved these changes Jun 21, 2024

View reviewed changes

Merge branch 'develop' into e2e-async-key-exchange

44191b4

yash-rajpal added the stat: ready to merge PR tested and approved waiting for merge label Jun 21, 2024

Merge branch 'develop' into e2e-async-key-exchange

2b0062a

ggazzo dismissed stale reviews from hugocostadev, MarcosSpessatto, and KevLehman via 2b0062a June 22, 2024 03:07

ggazzo added 2 commits June 21, 2024 23:32

Update e2e.ts

7a3bec9

..

6048635

ggazzo force-pushed the e2e-async-key-exchange branch from 8142a8d to 6048635 Compare June 22, 2024 14:07

Merge remote-tracking branch 'origin/develop' into e2e-async-key-exch…

dcd8fe9

…ange

ggazzo merged commit f75a2cb into develop Jun 22, 2024

ggazzo deleted the e2e-async-key-exchange branch June 22, 2024 18:08

This was referenced Jun 22, 2024

Release 6.10.0 #32655

Closed

Release 6.10.0 #32656

Merged

diegolmello mentioned this pull request Nov 14, 2024

feat: Async E2EE keys exchange RocketChat/Rocket.Chat.ReactNative#5995

Merged

10 tasks

cardoso mentioned this pull request Dec 18, 2025

feat!: Allow E2EE rooms to reset its room key #33328

Merged

cardoso reviewed Dec 18, 2025

View reviewed changes

cardoso mentioned this pull request Dec 19, 2025

chore: undeprecate /v1/e2e.updateGroupKey endpoint #37894

Merged

Conversation

yash-rajpal commented Apr 12, 2024 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes (including videos or screenshots)

Issue(s)

Steps to test or reproduce

Further comments

Uh oh!

changeset-bot bot commented Apr 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

dionisio-bot bot commented Apr 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Apr 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

MarcosSpessatto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cardoso left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cardoso Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

cardoso Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

yash-rajpal commented Apr 12, 2024 •

edited by atlassian bot

Loading

changeset-bot bot commented Apr 12, 2024 •

edited

Loading

dionisio-bot bot commented Apr 12, 2024 •

edited

Loading

codecov bot commented Apr 12, 2024 •

edited

Loading

cardoso left a comment •

edited

Loading