update e2ee defaults and protocol (#708)

* update e2ee defaults

* fix imports

* Create three-eagles-carry.md

* add e2e e2ee test

* prettier

Author: lukasIO

.changeset/three-eagles-carry.md

@@ -0,0 +1,6 @@
+---
+"@livekit/rtc-node": patch
+"livekit-server-sdk": patch
+---
+
+update e2ee defaults to confirm to required FFI fields and update protocol 

examples/agent-dispatch/package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "dotenv": "^16.4.5",
     "livekit-server-sdk": "workspace:*",
-    "@livekit/protocol": "^1.46.3"
+    "@livekit/protocol": "catalog:"
   },
   "devDependencies": {
     "@types/node": "^20.10.4",

examples/data-streams/index.ts

@@ -21,7 +21,7 @@ const greetParticipant = async (room: Room, recipient: RemoteParticipant) => {
   const greeting = 'Hi this is just a text sample';
   const streamWriter = await room.localParticipant?.streamText({
     destinationIdentities: [recipient.identity],
-    topic: 'chat',
+    topic: 'lk.chat',
   });
 
   for (const c of greeting) {
@@ -53,7 +53,7 @@ const main = async () => {
     room.on(RoomEvent.ParticipantDisconnected, resolve);
   });
 
-  room.registerTextStreamHandler('chat', async (reader: TextStreamReader, { identity }) => {
+  room.registerTextStreamHandler('lk.chat', async (reader: TextStreamReader, { identity }) => {
     console.log(`chat message from ${identity}: ${await reader.readAll()}`);
     // for await (const { collected } of reader) {
     //   console.log(collected);
@@ -62,14 +62,16 @@ const main = async () => {
 
   room.registerByteStreamHandler('files', async (reader: ByteStreamReader, { identity }) => {
     console.log(`welcome image received from ${identity}: ${reader.info.name}`);
-
+    console.time('receiving file');
     // create write stream and write received file to disk, make sure ./temp folder exists
     const writer = fs.createWriteStream(`./temp/${reader.info.name}`, {});
 
     for await (const chunk of reader) {
       writer.write(chunk);
     }
     writer.close();
+    console.timeEnd('receiving file');
+    console.log('received a total of', writer.bytesWritten);
   });
 
   room.on(RoomEvent.ParticipantConnected, async (participant) => {

packages/livekit-rtc/src/e2ee.ts

@@ -17,6 +17,7 @@ import {
   FrameCryptorSetKeyIndexRequest,
   GetKeyRequest,
   GetSharedKeyRequest,
+  KeyDerivationFunction,
   RatchetKeyRequest,
   RatchetSharedKeyRequest,
   SetKeyRequest,
@@ -27,18 +28,24 @@ import { FfiClient } from './ffi_client.js';
 const DEFAULT_RATCHET_SALT = new TextEncoder().encode('LKFrameEncryptionKey');
 const DEFAULT_RATCHET_WINDOW_SIZE = 16;
 const DEFAULT_FAILURE_TOLERANCE = -1;
+const DEFAULT_KEY_RING_SIZE = 16;
+const DEFAULT_KEY_DERIVATION_FUNCTION = KeyDerivationFunction.PBKDF2;
 
 export interface KeyProviderOptions {
   sharedKey?: Uint8Array;
   ratchetSalt?: Uint8Array;
   ratchetWindowSize?: number;
   failureTolerance?: number;
+  keyRingSize?: number;
+  keyDerivationFunction?: KeyDerivationFunction;
 }
 
 export const defaultKeyProviderOptions: KeyProviderOptions = {
   ratchetSalt: DEFAULT_RATCHET_SALT,
   ratchetWindowSize: DEFAULT_RATCHET_WINDOW_SIZE,
   failureTolerance: DEFAULT_FAILURE_TOLERANCE,
+  keyRingSize: DEFAULT_KEY_RING_SIZE,
+  keyDerivationFunction: DEFAULT_KEY_DERIVATION_FUNCTION,
 };
 
 export interface E2EEOptions {

packages/livekit-rtc/src/room.ts

@@ -284,14 +284,28 @@ export class Room extends (EventEmitter as new () => TypedEmitter<RoomCallbacks>
       useLegacyClientImplementation: true,
     });
     const e2eeEnabled = options.encryption || options.e2ee;
-    const e2eeOptions = options.encryption
-      ? { ...defaultE2EEOptions, ...options.encryption }
-      : { ...defaultE2EEOptions, ...options.e2ee };
+    const userE2EEOptions = options.encryption ?? options.e2ee;
+    const e2eeOptions: E2EEOptions = {
+      ...defaultE2EEOptions,
+      ...userE2EEOptions,
+      keyProviderOptions: {
+        ...defaultE2EEOptions.keyProviderOptions,
+        ...userE2EEOptions?.keyProviderOptions,
+      },
+    };
+
+    const mergedOptions = { ...options };
+
+    if (options.encryption) {
+      mergedOptions.encryption = e2eeOptions;
+    } else if (options.e2ee) {
+      mergedOptions.e2ee = e2eeOptions;
+    }
 
     const req = new ConnectRequest({
       url: url,
       token: token,
-      options,
+      options: mergedOptions,
     });
 
     FfiClient.instance.on(FfiClientEvent.FfiEvent, this.onFfiEvent);

packages/livekit-rtc/src/tests/e2e.test.ts

@@ -14,6 +14,7 @@ import {
   ParticipantKind,
   Room,
   RoomEvent,
+  type RoomOptions,
   RpcError,
   SimulateScenarioKind,
   TrackKind,
@@ -99,7 +100,10 @@ async function createJoinToken(params: {
   return await token.toJwt();
 }
 
-async function connectTestRooms(count: number): Promise<{ roomName: string; rooms: Room[] }> {
+async function connectTestRooms(
+  count: number,
+  extraOptions?: Partial<RoomOptions>,
+): Promise<{ roomName: string; rooms: Room[] }> {
   const env = getTestEnv();
   const roomName = `test_room_${randomUUID()}`;
   const rooms = await Promise.all(
@@ -111,7 +115,11 @@ async function connectTestRooms(count: number): Promise<{ roomName: string; room
         name: `Participant ${i}`,
       });
       const room = new Room();
-      await room.connect(env.url, token, { autoSubscribe: true, dynacast: false });
+      await room.connect(env.url, token, {
+        autoSubscribe: true,
+        dynacast: false,
+        ...extraOptions,
+      });
       return room;
     }),
   );
@@ -296,6 +304,46 @@ describeE2E('livekit-rtc e2e', () => {
     testTimeoutMs,
   );
 
+  it(
+    'sends and receives a data message between participants sharing a key',
+    async () => {
+      // A shared-key `keyProviderOptions` with only `sharedKey` set relies on
+      // the SDK filling in the remaining (proto-required) provider defaults;
+      // regression guard for connect failing to encode KeyProviderOptions.
+      const encryption = {
+        keyProviderOptions: { sharedKey: new TextEncoder().encode('test-shared-key') },
+      };
+      const { rooms } = await connectTestRooms(2, { encryption });
+      const [receivingRoom, sendingRoom] = rooms;
+      const senderIdentity = sendingRoom!.localParticipant!.identity;
+      const receiverIdentity = receivingRoom!.localParticipant!.identity;
+
+      const payload = new TextEncoder().encode('e2ee-hello');
+      const received = withTimeout(
+        new Promise<Uint8Array>((resolve) => {
+          receivingRoom!.on(RoomEvent.DataReceived, (data, participant) => {
+            if (participant?.identity !== senderIdentity) return;
+            resolve(data);
+          });
+        }),
+        testTimeoutMs,
+        'Timed out waiting for encrypted data message',
+      );
+
+      await sendingRoom!.localParticipant!.publishData(payload, {
+        reliable: true,
+        destination_identities: [receiverIdentity],
+      });
+
+      // The message round-trips intact only if both sides brought a working
+      // shared-key provider through connect and encrypt/decrypt lined up.
+      expect(await received).toEqual(payload);
+
+      await Promise.all(rooms.map((r) => r.disconnect()));
+    },
+    testTimeoutMs,
+  );
+
   it(
     'emits participantDisconnected when a participant leaves',
     async () => {

packages/livekit-server-sdk/package.json

@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@bufbuild/protobuf": "^1.10.1",
-    "@livekit/protocol": "^1.48.0",
+    "@livekit/protocol": "catalog:",
     "jose": "^5.1.2"
   },
   "devDependencies": {

pnpm-lock.yaml

@@ -6,9 +6,6 @@ packages:
 minimumReleaseAge: 2880
 minimumReleaseAgeExclude:
   - '@livekit/*'
-  # Renovate security update: turbo@2.9.14
-  - turbo@2.9.14
-  # Renovate security update: vite@6.4.2
-  - vite@6.4.2
-  # Renovate security update: vitest@4.1.0
-  - vitest@4.1.0
+
+catalog:
+  '@livekit/protocol': 1.48.0