Skip to content

feat(e2ee): support e2ee #631

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
okxiaoliang4 wants to merge 4 commits into
base: main
Choose a base branch
from
+57 −29
Open

feat(e2ee): support e2ee #631

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71f66c9
feat(e2ee): update KeyProvider and FrameCryptor to include trackSid a…
okxiaoliang4 Mar 31, 2026
e327a1d
chore: update @livekit/rtc-ffi-bindings
okxiaoliang4 Apr 2, 2026
14e95f6
chore: downgrade @livekit/rtc-ffi-bindings to version 0.12.49
okxiaoliang4 Apr 2, 2026
d448aa8
chore: update @livekit/rtc-ffi-bindings to version 0.12.52
okxiaoliang4 Apr 2, 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
34 changes: 31 additions & 3 deletions packages/livekit-rtc/src/e2ee.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import {
import { FfiClient } from './ffi_client.js';

const DEFAULT_RATCHET_SALT = new TextEncoder().encode('LKFrameEncryptionKey');
const DEFAULT_RATCHET_WINDOW_SIZE = 16;
const DEFAULT_RATCHET_WINDOW_SIZE = 10;
const DEFAULT_FAILURE_TOLERANCE = -1;

export interface KeyProviderOptions {
Expand Down Expand Up @@ -123,14 +123,15 @@ export class KeyProvider {
return (res.message.value as RatchetSharedKeyResponse).newKey!;
}

setKey(participantIdentity: string, keyIndex: number) {
setKey(participantIdentity: string, key: Uint8Array, keyIndex: number) {
const req = new E2eeRequest({
roomHandle: this.roomHandle,
message: {
case: 'setKey',
value: new SetKeyRequest({
keyIndex: keyIndex,
participantIdentity: participantIdentity,
key,
}),
Comment on lines +126 to 135
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

KeyProvider.setKey is a breaking change for consumers (this class is exported from src/index.ts), since it now requires a Uint8Array key parameter and changes the method signature/semantics. Consider providing an overload/backwards-compatible alternative (or a new method name) and/or documenting the migration path so downstream users don’t unexpectedly break on upgrade.

Copilot uses AI. Check for mistakes.
},
});
Expand Down Expand Up @@ -191,12 +192,20 @@ export class KeyProvider {
export class FrameCryptor {
private roomHandle = BigInt(0);
participantIdentity: string;
trackSid: string;
keyIndex: number;
enabled: boolean;

constructor(roomHandle: bigint, participantIdentity: string, keyIndex: number, enabled: boolean) {
constructor(
roomHandle: bigint,
participantIdentity: string,
trackSid: string,
keyIndex: number,
enabled: boolean,
) {
this.roomHandle = roomHandle;
this.participantIdentity = participantIdentity;
this.trackSid = trackSid;
this.keyIndex = keyIndex;
this.enabled = enabled;
}
Expand All @@ -209,6 +218,7 @@ export class FrameCryptor {
case: 'cryptorSetEnabled',
value: new FrameCryptorSetEnabledRequest({
participantIdentity: this.participantIdentity,
trackSid: this.trackSid,
enabled: this.enabled,
}),
},
Expand All @@ -230,6 +240,7 @@ export class FrameCryptor {
case: 'cryptorSetKeyIndex',
value: new FrameCryptorSetKeyIndexRequest({
participantIdentity: this.participantIdentity,
trackSid: this.trackSid,
keyIndex: this.keyIndex,
}),
},
Comment on lines +213 to 246
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

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

There’s no test coverage around the new/changed E2EE request payloads (notably trackSid being included in cryptorSetEnabled/cryptorSetKeyIndex). Since this package already uses Vitest for unit tests, consider adding a small unit test that stubs globalThis._ffiClientInstance and asserts the constructed E2eeRequest includes trackSid (and the expected values) to prevent regressions.

Copilot uses AI. Check for mistakes.
Expand Down Expand Up @@ -262,6 +273,22 @@ export class E2EEManager {
this.keyProvider = new KeyProvider(roomHandle, options.keyProviderOptions);
}

setKey(participantIdentity: string, key: Uint8Array, keyIndex: number) {
this.keyProvider.setKey(participantIdentity, key, keyIndex);
}

setSharedKey(sharedKey: Uint8Array, keyIndex: number) {
this.keyProvider.setSharedKey(sharedKey, keyIndex);
}

exportKey(participantIdentity: string, keyIndex: number): Uint8Array {
return this.keyProvider.exportKey(participantIdentity, keyIndex);
}

exportSharedKey(keyIndex: number): Uint8Array {
return this.keyProvider.exportSharedKey(keyIndex);
}

setEnabled(enabled: boolean) {
this.enabled = enabled;
const req = new E2eeRequest({
Expand Down Expand Up @@ -305,6 +332,7 @@ export class E2EEManager {
new FrameCryptor(
this.roomHandle,
cryptor.participantIdentity!,
cryptor.trackSid!,
cryptor.keyIndex!,
cryptor.enabled!,
),
Expand Down
Loading