Skip to content

Finally drop clear RTC to-device #5455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BillCarsonFr wants to merge 2 commits into
base: develop
Choose a base branch
from
+99 −46
Open

Finally drop clear RTC to-device #5455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f95e7d
Finally drop clear RTC to-device
BillCarsonFr Jul 30, 2026
9752a6c
Update spec/unit/matrixrtc/ToDeviceKeyTransport.spec.ts
BillCarsonFr Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 72 additions & 38 deletions spec/unit/matrixrtc/ToDeviceKeyTransport.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ limitations under the License.

import { type Mocked } from "vitest";

import { makeMockEvent } from "./mocks.ts";
import { makeMatrixEvent } from "./mocks.ts";
import { ClientEvent, EventType, type MatrixClient } from "../../../src";
import { ToDeviceKeyTransport } from "../../../src/matrixrtc/ToDeviceKeyTransport.ts";
import { getMockClientWithEventEmitter } from "../../test-utils/client.ts";
Expand Down Expand Up @@ -122,24 +122,23 @@ describe("ToDeviceKeyTransport", () => {
const testEncoded = "ABCDEDF";
const testKeyIndex = 2;

mockClient.emit(
ClientEvent.ToDeviceEvent,
makeMockEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, {
keys: {
index: testKeyIndex,
key: testEncoded,
},
member: {
claimed_device_id: "BOBDEVICE",
},
room_id: roomId,
session: {
application: "m.call",
call_id: "",
scope: "m.room",
},
}),
);
const mockEvent = makeMatrixEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, {
keys: {
index: testKeyIndex,
key: testEncoded,
},
member: {
claimed_device_id: "BOBDEVICE",
},
room_id: roomId,
session: {
application: "m.call",
call_id: "",
scope: "m.room",
},
});
mockEvent.makeEncrypted(EventType.RoomMessageEncrypted, {}, "", "");
mockClient.emit(ClientEvent.ToDeviceEvent, mockEvent);

const { userId, deviceId, keyBase64Encoded, index } = await receivedKeyResolvers.promise;
expect(userId).toBe("@bob:example.org");
Expand All @@ -150,6 +149,41 @@ describe("ToDeviceKeyTransport", () => {
expect(statistics.counters.roomEventEncryptionKeysReceived).toBe(1);
});

it("should drop non-encrypted/clear to-device events", () => {
const receivedKeyResolvers = vi.fn();
transport.on(KeyTransportEvents.ReceivedKeys, (membership, keyBase64Encoded, index, _timestamp) => {
receivedKeyResolvers();
});
transport.start();

const testEncoded = "ABCDEDF";
const testKeyIndex = 2;

const clearEvent = makeMatrixEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, {
keys: {
index: testKeyIndex,
key: testEncoded,
},
member: {
claimed_device_id: "BOBDEVICE",
},
room_id: roomId,
session: {
application: "m.call",
call_id: "",
scope: "m.room",
},
});
mockClient.emit(ClientEvent.ToDeviceEvent, clearEvent);

expect(receivedKeyResolvers).toHaveBeenCalledTimes(0);

clearEvent.makeEncrypted(EventType.RoomMessageEncrypted, {}, "", "");
mockClient.emit(ClientEvent.ToDeviceEvent, clearEvent);

expect(receivedKeyResolvers).toHaveBeenCalledTimes(1);
});

it("should not sent to ourself", async () => {
const keyBase64Encoded = "ABCDEDF";
const keyIndex = 2;
Expand All @@ -168,24 +202,24 @@ describe("ToDeviceKeyTransport", () => {
const testEncoded = "ABCDEDF";
const testKeyIndex = 2;

mockClient.emit(
ClientEvent.ToDeviceEvent,
makeMockEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, {
keys: {
index: testKeyIndex,
key: testEncoded,
},
member: {
claimed_device_id: "BOBDEVICE",
},
room_id: "!anotherroom:id",
session: {
application: "m.call",
call_id: "",
scope: "m.room",
},
}),
);
const keyEvent = makeMatrixEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, {
keys: {
index: testKeyIndex,
key: testEncoded,
},
member: {
claimed_device_id: "BOBDEVICE",
},
room_id: "!anotherroom:id",
session: {
application: "m.call",
call_id: "",
scope: "m.room",
},
});

keyEvent.makeEncrypted(EventType.RoomMessageEncrypted, {}, "", "");
mockClient.emit(ClientEvent.ToDeviceEvent, keyEvent);

expect(mockLogger.warn).toHaveBeenCalledWith("Malformed Event: Mismatch roomId");
expect(statistics.counters.roomEventEncryptionKeysReceived).toBe(0);
Expand Down Expand Up @@ -240,7 +274,7 @@ describe("ToDeviceKeyTransport", () => {

mockClient.emit(
ClientEvent.ToDeviceEvent,
makeMockEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, event),
makeMatrixEvent(EventType.CallEncryptionKeysPrefix, "@bob:example.org", undefined, event),
);

expect(mockLogger.warn).toHaveBeenCalled();
Expand Down
21 changes: 20 additions & 1 deletion spec/unit/matrixrtc/mocks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ limitations under the License.
import { EventEmitter } from "node:stream";
import { type Mocked, type MockedObject } from "vitest";

import { EventType, type Room, RoomEvent, type MatrixClient, type MatrixEvent } from "../../../src";
import { EventType, type Room, RoomEvent, type MatrixClient, MatrixEvent } from "../../../src";
import { CallMembership } from "../../../src/matrixrtc";
import { secureRandomString } from "../../../src/randomstring";
import { type RtcMembershipData, type SessionMembershipData } from "../../../src/matrixrtc/membershipData";
Expand Down Expand Up @@ -108,6 +108,7 @@ export type MockClient = MockedObject<
| "cancelPendingEvent"
>
>;

/**
* Mocks a object that has all required methods for a MatrixRTC session client.
*/
Expand Down Expand Up @@ -232,6 +233,24 @@ export function makeMockEvent(
} as unknown as MatrixEvent;
}

export function makeMatrixEvent(

@robintown robintown Aug 3, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any chance this can replace all usages of the above makeMockEvent?

@BillCarsonFr BillCarsonFr Aug 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is breaking existing tests, didn't want this PR to touch other things.

type: string,
sender: string,
roomId: string | undefined,
content: any,
timestamp?: number,
stateKey?: string,
): MatrixEvent {
return new MatrixEvent({
type,
sender,
room_id: roomId,
content,
state_key: stateKey,
origin_server_ts: timestamp,
});
}

export function mockRTCEvent(
{ user_id: sender, ...membershipData }: MembershipData,
roomId: string,
Expand Down
14 changes: 7 additions & 7 deletions src/matrixrtc/ToDeviceKeyTransport.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,13 +152,13 @@ export class ToDeviceKeyTransport
return;
}

// TODO: Not possible to check if the event is encrypted or not
// see https://github.com/matrix-org/matrix-rust-sdk/issues/4883
// if (evnt.getWireType() != EventType.RoomMessageEncrypted) {
// // WARN: The call keys were sent in clear. Ignore them
// logger.warn(`Call encryption keys sent in clear from: ${event.getSender()}`);
// return;
// }
// NB: When received via the widget driver, the to-device events
// are properly reconstructed as if they are encrypted (see MatrixEvent#makeEncrypted).
if (event.getWireType() != EventType.RoomMessageEncrypted) {
// WARN: The call keys were sent in clear. Ignore them
this.logger.warn(`Call encryption keys sent in clear from: ${event.getSender()}`);
return;
}

const content = this.getValidEventContent(event);
if (!content) return;
Expand Down