Skip to content
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

Optimise MatrixRTC sender key distribution for case of single member #4460

Draft
wants to merge 5 commits into
base: develop
Choose a base branch
from
Draft

Optimise MatrixRTC sender key distribution for case of single member #4460

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
80b6424
Organise MatrixRTCSession tests
hughns Oct 16, 2024
52a5c96
Optimise MatrixRTC sender key distribution for case of single member
hughns Oct 16, 2024
d069192
Clean up jsdoc
hughns Oct 18, 2024
0444eba
Add comments => rework logic
hughns Oct 21, 2024
86ba88f
Merge branch 'develop' into hughns/rtc-key-rotation-optimisation
hughns Oct 21, 2024
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
234 changes: 136 additions & 98 deletions spec/unit/matrixrtc/MatrixRTCSession.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,50 +769,103 @@ describe("MatrixRTCSession", () => {
expect(client.cancelPendingEvent).toHaveBeenCalledWith(eventSentinel);
});

it("rotates key if a new member joins", async () => {
async function setupParticipantChangeTest(initial: CallMembershipData[]) {
const mockRoom = makeMockRoom(initial);
sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom);
const onMyEncryptionKeyChanged = jest.fn();
sess.on(
MatrixRTCSessionEvent.EncryptionKeyChanged,
(_key: Uint8Array, _idx: number, participantId: string) => {
if (participantId === `${client.getUserId()}:${client.getDeviceId()}`) {
onMyEncryptionKeyChanged();
}
},
);

const keysSentPromise = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
});
sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
const initialKeysPayload = await keysSentPromise;

const changeMembers = (changed: CallMembershipData[]) => {
const mock = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
});

mockRoom.getLiveTimeline().getState = jest
.fn()
.mockReturnValue(makeMockRoomState(changed, mockRoom.roomId));
sess!.onMembershipUpdate();

return mock;
};

return { onMyEncryptionKeyChanged, session: sess, initialKeysPayload, changeMembers };
}

it("rotates key and emits immediately when we were alone but other members join", async () => {
jest.useFakeTimers();
try {
const mockRoom = makeMockRoom([membershipTemplate]);
sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom);
const member2 = Object.assign({}, membershipTemplate, {
device_id: "BBBBBBB",
});

const keysSentPromise1 = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
const member3 = Object.assign({}, membershipTemplate, {
device_id: "CCCCCCC",
});

sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
const firstKeysPayload = await keysSentPromise1;
expect(firstKeysPayload.keys).toHaveLength(1);
expect(firstKeysPayload.keys[0].index).toEqual(0);
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
const { session, onMyEncryptionKeyChanged, changeMembers } = await setupParticipantChangeTest([
membershipTemplate,
]);

sendEventMock.mockClear();
jest.advanceTimersByTime(10000);

const keysSentPromise2 = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
});
jest.clearAllMocks();
await changeMembers([membershipTemplate, member2, member3]);

const onMembershipsChanged = jest.fn();
sess.on(MatrixRTCSessionEvent.MembershipsChanged, onMembershipsChanged);
expect(session.statistics.counters.roomEventEncryptionKeysSent).toEqual(2);
expect(onMyEncryptionKeyChanged).toHaveBeenCalledTimes(1);
} finally {
jest.useRealTimers();
}
});

it("rotates key after delay when additional members join", async () => {
jest.useFakeTimers();
try {
const member2 = Object.assign({}, membershipTemplate, {
device_id: "BBBBBBB",
});

mockRoom.getLiveTimeline().getState = jest
.fn()
.mockReturnValue(makeMockRoomState([membershipTemplate, member2], mockRoom.roomId));
sess.onMembershipUpdate();
const member3 = Object.assign({}, membershipTemplate, {
device_id: "CCCCCCC",
});

const { session, onMyEncryptionKeyChanged, changeMembers } = await setupParticipantChangeTest([
membershipTemplate,
member2,
]);

jest.advanceTimersByTime(10000);

const secondKeysPayload = await keysSentPromise2;
const keysSentPromise = changeMembers([membershipTemplate, member2, member3]);

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);
// key is only generated after a delay
jest.clearAllMocks();
jest.advanceTimersByTime(2500); // the key should not yet have been generated
expect(sendEventMock).not.toHaveBeenCalled();
expect(session.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
jest.advanceTimersByTime(500); // the key should now have been generated

await keysSentPromise;
expect(session.statistics.counters.roomEventEncryptionKeysSent).toEqual(2);
expect(onMyEncryptionKeyChanged).not.toHaveBeenCalled();

// the emit comes after the key usage delay
jest.clearAllMocks();
jest.advanceTimersByTime(5000);
expect(onMyEncryptionKeyChanged).toHaveBeenCalledTimes(1);
} finally {
jest.useRealTimers();
}
Expand Down Expand Up @@ -993,6 +1046,7 @@ describe("MatrixRTCSession", () => {
sent_ts: Date.now(),
},
);
const firstKey = sendEventMock.mock.calls[0][2].keys[0].key;
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);

sendEventMock.mockClear();
Expand Down Expand Up @@ -1025,7 +1079,7 @@ describe("MatrixRTCSession", () => {
keys: [
{
index: 0,
key: expect.stringMatching(".*"),
key: firstKey,
},
],
sent_ts: Date.now(),
Expand All @@ -1037,54 +1091,78 @@ describe("MatrixRTCSession", () => {
}
});

it("rotates key if a member leaves", async () => {
it("rotates key and emits immediately when members leave and we become only remaining member", async () => {
jest.useFakeTimers();
try {
const member2 = Object.assign({}, membershipTemplate, {
device_id: "BBBBBBB",
});
const mockRoom = makeMockRoom([membershipTemplate, member2]);
sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom);

const onMyEncryptionKeyChanged = jest.fn();
sess.on(
MatrixRTCSessionEvent.EncryptionKeyChanged,
(_key: Uint8Array, _idx: number, participantId: string) => {
if (participantId === `${client.getUserId()}:${client.getDeviceId()}`) {
onMyEncryptionKeyChanged();
}
},
);

const keysSentPromise1 = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
const member3 = Object.assign({}, membershipTemplate, {
device_id: "CCCCCCC",
});

sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
const firstKeysPayload = await keysSentPromise1;
expect(firstKeysPayload.keys).toHaveLength(1);
expect(firstKeysPayload.keys[0].index).toEqual(0);
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
const { onMyEncryptionKeyChanged, changeMembers } = await setupParticipantChangeTest([
membershipTemplate,
member2,
member3,
]);

sendEventMock.mockClear();
jest.advanceTimersByTime(10000);

const keysSentPromise2 = new Promise<EncryptionKeysEventContent>((resolve) => {
sendEventMock.mockImplementation((_roomId, _evType, payload) => resolve(payload));
jest.clearAllMocks();
await changeMembers([membershipTemplate]);

expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(2);
expect(onMyEncryptionKeyChanged).toHaveBeenCalledTimes(1);
} finally {
jest.useRealTimers();
}
});

it("rotates key after delay when additional members leave", async () => {
jest.useFakeTimers();
try {
const member2 = Object.assign({}, membershipTemplate, {
device_id: "BBBBBBB",
});

mockRoom.getLiveTimeline().getState = jest
.fn()
.mockReturnValue(makeMockRoomState([membershipTemplate], mockRoom.roomId));
sess.onMembershipUpdate();
const member3 = Object.assign({}, membershipTemplate, {
device_id: "CCCCCCC",
});

const member4 = Object.assign({}, membershipTemplate, {
device_id: "DDDDDDD",
});

const { onMyEncryptionKeyChanged, changeMembers } = await setupParticipantChangeTest([
membershipTemplate,
member2,
member3,
member4,
]);

jest.advanceTimersByTime(10000);

const secondKeysPayload = await keysSentPromise2;
jest.clearAllMocks();
const keysSentPromise = changeMembers([membershipTemplate, member2]);

// key is only generated after a delay
jest.clearAllMocks();
jest.advanceTimersByTime(2500); // the key should not yet have been generated
expect(sendEventMock).not.toHaveBeenCalled();
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
jest.advanceTimersByTime(1000); // the key should now have been generated

await keysSentPromise;

expect(secondKeysPayload.keys).toHaveLength(1);
expect(secondKeysPayload.keys[0].index).toEqual(1);
expect(onMyEncryptionKeyChanged).toHaveBeenCalledTimes(2);
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(2);
expect(onMyEncryptionKeyChanged).not.toHaveBeenCalled();

// the emit comes after the key usage delay
jest.clearAllMocks();
jest.advanceTimersByTime(5000);
expect(onMyEncryptionKeyChanged).toHaveBeenCalledTimes(1);
} finally {
jest.useRealTimers();
}
Expand Down Expand Up @@ -1131,46 +1209,6 @@ describe("MatrixRTCSession", () => {
jest.useRealTimers();
}
});

it("doesn't re-send key immediately", async () => {
const realSetTimeout = setTimeout;
jest.useFakeTimers();
try {
const mockRoom = makeMockRoom([membershipTemplate]);
sess = MatrixRTCSession.roomSessionForRoom(client, mockRoom);

const keysSentPromise1 = new Promise((resolve) => {
sendEventMock.mockImplementation(resolve);
});

sess.joinRoomSession([mockFocus], mockFocus, { manageMediaKeys: true });
await keysSentPromise1;

sendEventMock.mockClear();
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);

const onMembershipsChanged = jest.fn();
sess.on(MatrixRTCSessionEvent.MembershipsChanged, onMembershipsChanged);

const member2 = Object.assign({}, membershipTemplate, {
device_id: "BBBBBBB",
});

mockRoom.getLiveTimeline().getState = jest
.fn()
.mockReturnValue(makeMockRoomState([membershipTemplate, member2], mockRoom.roomId));
sess.onMembershipUpdate();

await new Promise((resolve) => {
realSetTimeout(resolve);
});

expect(sendEventMock).not.toHaveBeenCalled();
expect(sess!.statistics.counters.roomEventEncryptionKeysSent).toEqual(1);
} finally {
jest.useRealTimers();
}
});
});

describe("receiving", () => {
Expand Down
Loading