Encrypted data channel #781

pblazej · 2025-09-08T14:13:59Z

Adds data channel encryption based on Add e2ee for data channel messages client-sdk-js#1595
Adds currentKey state to BaseKeyProvider
- It was missing comparing to other platforms, and we cannot explicitly default to 0
Adds some integration tests, as most of the crypto stuff is tested by webrtc
- Existing hi-level tests e.g. data streams will get a sharedKey by default 🎉

Migration/deprecations

Replace E2EEOptions with EncryptionOptions (1:1)
Add EncryptionType parameter to Room/ParticipantDelegate methods

pblazej · 2025-09-11T10:41:31Z

Sources/LiveKit/Core/Room.swift

            _state.mutate { $0.connectOptions = connectOptions }
        }

+        await cleanUp()


Moved due to E2EEManager.cleanUp called after setup

pblazej · 2025-09-11T12:07:18Z

@lukasIO would be nice to perform some x-platform test (proto compatibility)

pblazej · 2025-09-11T13:51:18Z

@lukasIO as for x-platform test:

ratcheting from JS → native works fine after fixing default window size

🆔 CHAT:  Hello new participant participant-qwfdzf1mmbr. This is just an progressively updating chat message from me, participant participant-oghni0gl54h.
🆔 CHAT:  rat1
🆔 CHAT:  rat2
🆔 CHAT:  rat3

ratcheting from the native client → JS does not work - tried to listen for KeyProviderEvent.RatchetRequest but nothing...

cc @cloudwebrtc maybe it's worth to do another x-check with flutter

lukasIO · 2025-09-11T14:07:42Z

ratcheting from the native client → JS does not work

does audio/video keep working when ratcheting on the native client ?

pblazej · 2025-09-11T14:15:28Z

ratcheting from the native client → JS does not work

does audio/video keep working when ratcheting on the native client ?

nope, keys get out of sync.

Error encrypting track data: InvalidKey: Decryption failed: The operation failed for an operation-specific reason

pblazej · 2025-09-12T06:26:02Z

@lukasIO if you wanna dig deeper, I added one option to the example (2.8.0). Seems like the frame logic may be broken, unrelated to this PR (I haven't tested main tho).

BTW, macOS chat is still using old infra, but you should be able to get there with frame encryption. I can help you real-time if needed.

For me:

if JS ratchets, native is able to decrypt, JS is unable
if native ratchets, both are unable

so looks like the issue is on JS side (custom logic vs rtc)?

pblazej · 2025-09-12T07:20:04Z

Looks like the above behavior is by design, for the shared key it should still be: public let defaultRatchetWindowSize: Int32 = 0 so no auto-ratcheting.

This reverts commit d569de4.

pblazej · 2025-09-12T08:40:01Z

Ended up reverting that [extended ratchet window] ⬆️

lukasIO · 2025-09-12T14:08:52Z

Sources/LiveKit/Core/DataChannelPair.swift

-        delegates.notify {
-            $0.dataChannel(self, didReceiveDataPacket: dataPacket)
+        if let encryptedPacket = dataPacket.encryptedPacketOrNil,
+           let e2eeManager, e2eeManager.isDataChannelEncryptionEnabled


decrypting should also work when data channel encryption is not explicitly enabled.

thought about that, yep it makes more sense 👍

6070ec2

It does not apply to situations where e2ee is explicitly disabled (no options passed).

lukasIO

from the encryption workflow perspective this looks good to me!

pblazej · 2025-09-16T07:21:39Z

Sources/LiveKit/Protocols/RoomDelegate.swift

+
+    /// Failed to decrypt a data packet when encryption is enabled.
+    @objc optional
+    func room(_ room: Room, didFailToDecryptDataWithEror error: LiveKitError)


Maybe it would be good to pull participant id here?

pblazej · 2025-09-23T06:46:25Z

@hiroshihorie feel free to take a look at the Swift side, I don't see any obvious improvements atm.

hiroshihorie · 2025-09-30T05:17:07Z

Sources/LiveKit/Core/DataChannelPair.swift


    var isOpen: Bool { _state.isOpen }

+    var e2eeManager: E2EEManager?


Maybe this can be weak ? I think the Room holds the instance. 🤔

I'd be careful with that - I mean, there's no point in making sure that there's only 1 strong ref... if there's no cycle here... Let's double-check if the DC is deallocated properly (if needed).

pblazej · 2025-09-30T07:32:23Z

Sources/LiveKit/Protos/livekit_metrics.pb.swift

We gotta move'm to submodules finally, it's hard to track these subtle changes.

pblazej · 2025-10-01T07:09:29Z

Merging as macOS build must be fixed on main anyway.

pblazej added 4 commits September 5, 2025 14:03

Proto v1.41.0

30e8c9c

Todo

2ef85c0

Lib v137.7151.06

a1f2230

Minimal impl

a8ac611

pblazej force-pushed the blaze/dc-e2ee branch from e25ed0f to a8ac611 Compare September 8, 2025 14:47

pblazej added 17 commits September 10, 2025 09:52

Lib v137.7151.07

c29edbc

Basic test

37e1267

Participant keys

37a5f27

Failure tests

9e2acec

Fix sequencing

c9c5683

Fix pod

f0e7299

Add current key infra

a473c49

Ratcheting test

13a2f8d

Simplify extensions

414e235

Retry cosmetics

dbb1ef5

Key index test

621d9ad

Stream handling and delegates

1a16920

Deprecate old methods and fix tests

bf349fa

Cosmetics

cde547a

Deprecate e2ee options

96eccc0

Move data channel tests around

c7eed63

Assert

c21e498

pblazej commented Sep 11, 2025

View reviewed changes

pblazej added 3 commits September 11, 2025 12:53

Minor simplifications

bb1c86a

Change

592c0d4

Fix fallback

5bf4652

pblazej marked this pull request as ready for review September 11, 2025 11:35

pblazej requested review from cloudwebrtc, hiroshihorie and lukasIO September 11, 2025 11:35

Merge branch 'main' into blaze/dc-e2ee

87b49c0

pblazej added 3 commits September 11, 2025 14:15

Update proto plugin

70af9b6

Proto v1.41.0, new generator

bdbe79c

Fix default ratchet window

d569de4

pblazej mentioned this pull request Sep 12, 2025

Add e2ee for data channel messages livekit/client-sdk-js#1595

Merged

pblazej added 2 commits September 12, 2025 10:29

Revert "Fix default ratchet window"

b34a38f

This reverts commit d569de4.

Cmt

15dfb96

Param names

d48f241

lukasIO reviewed Sep 12, 2025

View reviewed changes

pblazej added 3 commits September 15, 2025 10:02

Always decrypt

6070ec2

Split inits

9b567f8

ObjC

825ae80

lukasIO approved these changes Sep 15, 2025

View reviewed changes

pblazej commented Sep 16, 2025

View reviewed changes

hiroshihorie approved these changes Sep 30, 2025

View reviewed changes

Merge branch 'main' into blaze/dc-e2ee

7529f9c

pblazej commented Sep 30, 2025

View reviewed changes

pblazej merged commit b74ed1f into main Oct 1, 2025
81 of 109 checks passed

pblazej deleted the blaze/dc-e2ee branch October 1, 2025 07:09

hiroshihorie mentioned this pull request Oct 1, 2025

v2.8.0 #796

Merged


		var isOpen: Bool { _state.isOpen }

		var e2eeManager: E2EEManager?

Encrypted data channel #781

Encrypted data channel #781

Uh oh!

Conversation

pblazej commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Migration/deprecations

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pblazej commented Sep 11, 2025

Uh oh!

pblazej commented Sep 11, 2025

Uh oh!

lukasIO commented Sep 11, 2025

Uh oh!

pblazej commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pblazej commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pblazej commented Sep 12, 2025

Uh oh!

pblazej commented Sep 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lukasIO left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pblazej commented Sep 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pblazej commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

pblazej commented Sep 8, 2025 •

edited

Loading

pblazej commented Sep 11, 2025 •

edited

Loading

pblazej commented Sep 12, 2025 •

edited

Loading