matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-09 10:22:46 +03:00
Code Activity

Do not rotate MatrixRTC media encryption key when a new member joins a session (#4472)

Browse Source 
* Do not rotate MatrixRTC media encryption key when a new member joins a call

This change reverts https://github.com/matrix-org/matrix-js-sdk/pull/4422.

Instead, the rotation when a new member joins will be reintroduced as part of supporting to-device based MatrixRTC encryption key distribution.

* Improve function name
This commit is contained in:
Hugh Nimmo-Smith
2024-10-25 14:32:44 +01:00
committed by GitHub
parent 3cc3bd0728
commit 0a29063bc9
2 changed files with 15 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
spec/unit/matrixrtc/MatrixRTCSession.spec.ts
View File

@@ -773,7 +773,7 @@ describe("MatrixRTCSession", () => {
expect(client.cancelPendingEvent).toHaveBeenCalledWith(eventSentinel); expect(client.cancelPendingEvent).toHaveBeenCalledWith(eventSentinel);
}); });
it("rotates key if a new member joins", async () => { it("Re-sends key if a new member joins", async () => {
jest.useFakeTimers(); jest.useFakeTimers();
try { try {
const mockRoom = makeMockRoom([membershipTemplate]); const mockRoom = makeMockRoom([membershipTemplate]);
@@ -784,9 +784,7 @@ describe("MatrixRTCSession", () => {
}); });
sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true }); sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
const firstKeysPayload = await keysSentPromise1; await keysSentPromise1;
expect(firstKeysPayload.keys).toHaveLength(1);
expect(firstKeysPayload.keys[0].index).toEqual(0);
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1); expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
sendEventMock.mockClear(); sendEventMock.mockClear();
@@ -808,14 +806,9 @@ describe("MatrixRTCSession", () => {
.mockReturnValue(makeMockRoomState([membershipTemplate, member2], mockRoom.roomId)); .mockReturnValue(makeMockRoomState([membershipTemplate, member2], mockRoom.roomId));
sess.onMembershipUpdate(); sess.onMembershipUpdate();
jest.advanceTimersByTime(10000); await keysSentPromise2;
const secondKeysPayload = await keysSentPromise2;
expect(sendEventMock).toHaveBeenCalled(); expect(sendEventMock).toHaveBeenCalled();
expect(secondKeysPayload.keys).toHaveLength(1);
expect(secondKeysPayload.keys[0].index).toEqual(1);
expect(secondKeysPayload.keys[0].key).not.toEqual(firstKeysPayload.keys[0].key);
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(2); expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(2);
} finally { } finally {
jest.useRealTimers(); jest.useRealTimers();
@@ -1103,8 +1096,8 @@ describe("MatrixRTCSession", () => {
} }
jest.useFakeTimers(); jest.useFakeTimers();
try { try {
// start with a single member // start with all members
const mockRoom = makeMockRoom(members.slice(0, 1)); const mockRoom = makeMockRoom(members);
for (let i = 0; i < membersToTest; i++) { for (let i = 0; i < membersToTest; i++) {
const keysSentPromise = new Promise<EncryptionKeysEventContent>((resolve) => { const keysSentPromise = new Promise<EncryptionKeysEventContent>((resolve) => {
@@ -1116,10 +1109,12 @@ describe("MatrixRTCSession", () => {
sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom); sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom);
sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true }); sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
} else { } else {
// otherwise update the state // otherwise update the state reducing the membership each time in order to trigger key rotation
mockRoom.getLiveTimeline().getState = jest mockRoom.getLiveTimeline().getState = jest
.fn() .fn()
.mockReturnValue(makeMockRoomState(members.slice(0, i + 1), mockRoom.roomId)); .mockReturnValue(
makeMockRoomState(members.slice(0, membersToTest - i), mockRoom.roomId),
);
} }
sess!.onMembershipUpdate(); sess!.onMembershipUpdate();

12
src/matrixrtc/MatrixRTCSession.ts
View File

@@ -328,7 +328,7 @@ export class MatrixRTCSession extends TypedEventEmitter<MatrixRTCSessionEvent, M
logger.info(`Joining call session in room ${this.room.roomId} with manageMediaKeys=${this.manageMediaKeys}`); logger.info(`Joining call session in room ${this.room.roomId} with manageMediaKeys=${this.manageMediaKeys}`);
if (joinConfig?.manageMediaKeys) { if (joinConfig?.manageMediaKeys) {
this.makeNewSenderKey(); this.makeNewSenderKey();
this.requestKeyEventSend(); this.requestSendCurrentKey();
} }
// We don't wait for this, mostly because it may fail and schedule a retry, so this // We don't wait for this, mostly because it may fail and schedule a retry, so this
// function returning doesn't really mean anything at all. // function returning doesn't really mean anything at all.
@@ -546,10 +546,10 @@ export class MatrixRTCSession extends TypedEventEmitter<MatrixRTCSessionEvent, M
} }
/** /**
* Requests that we resend our keys to the room. May send a keys event immediately * Requests that we resend our current keys to the room. May send a keys event immediately
* or queue for alter if one has already been sent recently. * or queue for alter if one has already been sent recently.
*/ */
private requestKeyEventSend(): void { private requestSendCurrentKey(): void {
if (!this.manageMediaKeys) return; if (!this.manageMediaKeys) return;
if ( if (
@@ -795,8 +795,8 @@ export class MatrixRTCSession extends TypedEventEmitter<MatrixRTCSessionEvent, M
logger.debug(`Member(s) have left: queueing sender key rotation`); logger.debug(`Member(s) have left: queueing sender key rotation`);
this.makeNewKeyTimeout = setTimeout(this.onRotateKeyTimeout, MAKE_KEY_DELAY); this.makeNewKeyTimeout = setTimeout(this.onRotateKeyTimeout, MAKE_KEY_DELAY);
} else if (anyJoined) { } else if (anyJoined) {
logger.debug(`New member(s) have joined: queueing sender key rotation`); logger.debug(`New member(s) have joined: re-sending keys`);
this.makeNewKeyTimeout = setTimeout(this.onRotateKeyTimeout, MAKE_KEY_DELAY); this.requestSendCurrentKey();
} else if (oldFingerprints) { } else if (oldFingerprints) {
// does it look like any of the members have updated their memberships? // does it look like any of the members have updated their memberships?
const newFingerprints = this.lastMembershipFingerprints!; const newFingerprints = this.lastMembershipFingerprints!;
@@ -808,7 +808,7 @@ export class MatrixRTCSession extends TypedEventEmitter<MatrixRTCSessionEvent, M
Array.from(newFingerprints).some((x) => !oldFingerprints.has(x)); Array.from(newFingerprints).some((x) => !oldFingerprints.has(x));
if (candidateUpdates) { if (candidateUpdates) {
logger.debug(`Member(s) have updated/reconnected: re-sending keys to everyone`); logger.debug(`Member(s) have updated/reconnected: re-sending keys to everyone`);
this.requestKeyEventSend(); this.requestSendCurrentKey();
} }
} }
} }