Support encrypted state events MSC4362 #30877

kaylendog · 2025-09-25T09:21:32Z

When the labs flag ("Encrypted state events") is enabled, a new option ("Encrypt state events") appears when creating a room.

Whether or not the labs flag is enabled, in a room created with this option, state events are encrypted and decrypted as specified in MSC4362.

People invited to the room later (without MSC4268 enabled) will not be able to decrypt state (e.g. room name) that was sent before they joined.

Checklist

I have read through review guidelines and CONTRIBUTING.md.
Tests written for new code (and old code if feasible).
New or updated public/exported symbols have accurate TSDoc documentation.
Linter and other CI checks pass.
I have licensed the changes to Element by completing the Contributor License Agreement (CLA)

kaylendog · 2025-09-25T10:57:10Z

Two potential considerations:

What do clients without the flag enabled see when using a room with state event encryption enabled?
Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

Half-Shot · 2025-09-25T11:14:14Z

Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

IMO it would make sense that clients with this flag enabled can create / enable rooms to have encrypted state, but all supporting clients regardless of features should be able to interact in these rooms. So, they should probably attempt to send encrypted state if the room requires it.

kaylendog · 2025-09-25T11:20:30Z

Can clients without the flag enabled still send encrypted state events if they are sent in a room with state encryption enabled?

IMO it would make sense that clients with this flag enabled can create / enable rooms to have encrypted state, but all supporting clients regardless of features should be able to interact in these rooms. So, they should probably attempt to send encrypted state if the room requires it.

I agree! The last commit I made locks MatrixClient.enableEncryptedStateEvents to true, but the toggle switch on the create room dialogue is still locked behind the lab flag.

kaylendog · 2025-09-25T16:41:31Z

It appears that the state events sent immediately after room creation are not encrypted - investigating... Although this may be preferable behaviour - clients could fall back to this if room key sharing ever fails?

kaylendog · 2025-09-29T12:05:17Z

Latest changes enabling room name encryption might belong in the JS SDK? Thoughts appreciated!

kaylendog · 2025-09-30T13:04:52Z

It will be quite challenging to improve coverage on src/createRoom.ts, since it relies on an event listener attached to RoomState. There doesn't seem to be any existing infrastructure for mocking this behaviour.

florianduros

First quick review :)

src/settings/Settings.tsx

src/settings/controllers/EncryptedStateEventsController.ts

test/test-utils/test-utils.ts

src/components/views/dialogs/CreateRoomDialog.tsx

florianduros · 2025-10-01T14:26:09Z

src/createRoom.ts

+                    const timeout = setTimeout(() => {
+                        logger.warn("Timed out while waiting for room to enable encryption");
+                        roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                        resolve();
+                    }, 3000);


If we have to wait for this long, we need a spinner or some feedback to the user

There is an existing spinner, I could force it to be shown If state event encryption is enabled?

@florianduros this code (as linked by Skye above) has existing logic for whether or not we want to show a spinner, so I am guessing that this already covers what we need - if it's a "background" operation then we should not show a spinner, and if it's a "foreground" operation then we should. All this PR does is introduce a potential additional delay, but because there is already a possibility of a spinner I think we can assume that this is already potentially slow, so nothing has materially changed here.

What do you think?

Okay make sense. We can add later a spinner if we think the ux lacks feedback

florianduros · 2025-10-01T14:26:46Z

src/createRoom.ts

+
+                    const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;
+
+                    // Soft fail, since the room will still be functional if the initial state is not encrypted.


Also if it fails, how do we inform the user?

I was about to write that we don't care, but I've changed my mind: I think we should fail if this doesn't work: otherwise we will send potentially-confidential information in the clear.

richvdh

a few drive-by comments; sorry, haven't done a full review

test/unit-tests/createRoom-test.ts

richvdh · 2025-10-07T15:31:22Z

src/createRoom.ts

+                // Set room avatar
+                if (opts.avatar) {
+                    let url: string;
+                    if (opts.avatar instanceof File) {
+                        ({ content_uri: url } = await client.uploadContent(opts.avatar));
+                    } else {
+                        url = opts.avatar;
+                    }
+                    await client.sendStateEvent(roomId, EventType.RoomAvatar, { url }, "");
+                }
+            }


looks like you could do with a test that hits this codepath

src/createRoom.ts

richvdh · 2025-10-07T15:52:44Z

src/createRoom.ts

+                await new Promise<void>((resolve, reject) => {
+                    if (resolvedRoom.hasEncryptionStateEvent()) {
+                        return resolve();
+                    }
+
+                    const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;
+
+                    // Soft fail, since the room will still be functional if the initial state is not encrypted.
+                    const timeout = setTimeout(() => {
+                        logger.warn("Timed out while waiting for room to enable encryption");
+                        roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                        resolve();
+                    }, 3000);
+
+                    const onRoomStateUpdate = (state: RoomState): void => {
+                        if (state.getStateEvents(EventType.RoomEncryption, "")) {
+                            roomState.off(RoomStateEvent.Update, onRoomStateUpdate);
+                            clearTimeout(timeout);
+                            resolve();
+                        }
+                    };
+
+                    roomState.on(RoomStateEvent.Update, onRoomStateUpdate);
+                });


the createRoom function is way too long and complicated. Factor this bit (at least) out to a separate function?

src/createRoom.ts

Signed-off-by: Skye Elliot <[email protected]>

andybalaam

Adding a review, primarily to remind myself what needs doing when I get back to this.

src/createRoom.ts

src/settings/controllers/EncryptedStateEventsController.ts

andybalaam · 2025-10-31T15:58:15Z

src/components/views/dialogs/CreateRoomDialog.tsx


+        let e2eeStateSection: JSX.Element | undefined;
+        if (
+            SettingsStore.getValue("feature_msc3414_encrypted_state_events", null, false) &&


Should we replace 3414 with 4362 everywhere?

Hmm, no because MSC4362 says to use prefix io.element.msc3414.encrypt_state_events

But we could rename the feature flag, though that might get confusing.

I do kinda think that we should rename the feature flag, and change the comments in the rust-sdk. We're implementing the proposals of MSC4362, not MSC3414.

Hmm, no because MSC4362 says to use prefix io.element.msc3414.encrypt_state_events

Perhaps MSC4362 should be adjusted to use just encrypt_state_events, as in MSC3414, which we can move to if it ever gets merged into the spec? I agree with Rich that this should probably be io.element.msc4362.encrypt_state_events. I wrote up MSC4362 primarily to document what I had implemented. Still, now that the proposal exists, I think we should start working more in the other direction, where the proposal informs the implementation?

I have updated MSC4362 to use io.element.msc4362.encrypt_state_events and I will update this PR to reflect that.

Work on this is in:

events: Rename unstable-msc3413 feature to unstable-msc4362 ruma/ruma#2287

crypto: Refer to MSC4362 when we are talking about encrypted state matrix-org/matrix-rust-sdk#5868

base: Bump ruma to 91424b1fc matrix-org/matrix-rust-sdk#5873

Bump matrix-rust-sdk to 1c22d0b25bd matrix-org/matrix-sdk-crypto-wasm#280

Update encrypted state to say MSC4362 everywhere matrix-org/matrix-js-sdk#5079

element-web

Since what we have implemented is described by that MSC.

…tically Update tests for wording changes

github-actions bot deployed to Netlify September 25, 2025 09:25 View deployment

kaylendog self-assigned this Sep 25, 2025

kaylendog added Z-Labs Z-Parity T-Enhancement and removed Z-Parity labels Sep 25, 2025

github-actions bot deployed to EndToEndTests September 25, 2025 09:35 View deployment

kaylendog marked this pull request as ready for review September 25, 2025 09:42

kaylendog requested review from a team as code owners September 25, 2025 09:42

kaylendog requested review from MidhunSureshR and florianduros September 25, 2025 09:42

github-actions bot deployed to Netlify September 25, 2025 09:45 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 09:56 View deployment

kaylendog force-pushed the kaylendog/msc3414 branch from 47ec3fd to f568949 Compare September 25, 2025 11:06

github-actions bot deployed to Netlify September 25, 2025 11:09 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 11:22 View deployment

github-actions bot deployed to Netlify September 25, 2025 11:53 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 12:03 View deployment

github-actions bot deployed to Netlify September 25, 2025 12:14 View deployment

github-actions bot deployed to EndToEndTests September 25, 2025 12:25 View deployment

This was referenced Sep 25, 2025

MSC4362: Simplified Encrypted State Events matrix-org/matrix-spec-proposals#4362

Draft

Encrypt state events (room metadata) on E2E rooms element-hq/element-meta#1214

Open

kaylendog changed the title ~~Implement lab for encrypted state events (MSC3414)~~ Implement lab for encrypted state events (MSC3414/MSC4362) Sep 26, 2025

github-actions bot deployed to Netlify September 29, 2025 12:12 View deployment

github-actions bot deployed to EndToEndTests September 29, 2025 17:23 View deployment

github-actions bot deployed to Netlify September 30, 2025 10:18 View deployment

github-actions bot deployed to EndToEndTests September 30, 2025 10:31 View deployment

github-actions bot deployed to Netlify September 30, 2025 13:15 View deployment

github-actions bot deployed to EndToEndTests September 30, 2025 14:18 View deployment

florianduros requested changes Oct 1, 2025

View reviewed changes

richvdh reviewed Oct 7, 2025

View reviewed changes

kaylendog mentioned this pull request Oct 9, 2025

Move room name, avatar, and topic to IOpts. #30981

Merged

5 tasks

github-actions bot requested a deployment to Netlify October 9, 2025 15:45 In progress

github-actions bot deployed to EndToEndTests October 9, 2025 16:01 View deployment

richvdh marked this pull request as draft October 27, 2025 13:16

andybalaam mentioned this pull request Oct 28, 2025

Meta: Encrypted state matrix-org/matrix-rust-sdk#5397

Open

17 tasks

Provide a labs flag for encrypted state events (MSC3414)

9d06c66

Signed-off-by: Skye Elliot <[email protected]>

andybalaam force-pushed the kaylendog/msc3414 branch from 330ec69 to 9d06c66 Compare October 31, 2025 15:44

github-actions bot deployed to Netlify October 31, 2025 15:47 View deployment

andybalaam requested changes Oct 31, 2025

View reviewed changes

src/createRoom.ts Outdated Show resolved Hide resolved

src/settings/controllers/EncryptedStateEventsController.ts Show resolved Hide resolved

andybalaam reviewed Oct 31, 2025

View reviewed changes

github-actions bot deployed to EndToEndTests October 31, 2025 16:01 View deployment

andybalaam changed the title ~~Implement lab for encrypted state events (MSC3414/MSC4362)~~ Implement lab for encrypted state events MSC4362 Nov 14, 2025

andybalaam changed the title ~~Implement lab for encrypted state events MSC4362~~ Add labs flag for encrypted state events MSC4362 Nov 14, 2025

Rename the encrypted state feature to msc4362

f6f1f3a

Since what we have implemented is described by that MSC.

andybalaam changed the title ~~Add labs flag for encrypted state events MSC4362~~ Support encrypted state events MSC4362 Nov 14, 2025

andybalaam added 7 commits November 14, 2025 12:25

Remove the link between encrypted state and shared history

780f08f

Update wording since the 'WARNING' string will be added automatically

a17f024

Doc comment for stateEncryption field

8e4591b

Extract waiting for m.room.encryption into a function

7e90132

fixup! Update wording since the 'WARNING' string will be added automa…

a864b12

…tically Update tests for wording changes

Set the room topic in a room with encrypted state

e211694

Add a missing word in a test name

027a014


		const roomState = resolvedRoom.getLiveTimeline().getState(Direction.Forward)!;

		// Soft fail, since the room will still be functional if the initial state is not encrypted.

Uh oh!

Support encrypted state events MSC4362 #30877

Are you sure you want to change the base?

Support encrypted state events MSC4362 #30877

Conversation

kaylendog commented Sep 25, 2025 • edited by andybalaam Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

kaylendog commented Sep 25, 2025

Uh oh!

Half-Shot commented Sep 25, 2025

Uh oh!

kaylendog commented Sep 25, 2025

Uh oh!

kaylendog commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kaylendog commented Sep 29, 2025

Uh oh!

kaylendog commented Sep 30, 2025

Uh oh!

florianduros left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaylendog Oct 8, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richvdh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andybalaam left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andybalaam Nov 17, 2025 • 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

kaylendog commented Sep 25, 2025 •

edited by andybalaam

Loading

kaylendog commented Sep 25, 2025 •

edited

Loading

kaylendog Oct 8, 2025 •

edited

Loading

andybalaam Nov 17, 2025 •

edited

Loading