E2EEManager.kt
8.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
/*
* Copyright 2023-2025 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.e2ee
import dagger.assisted.Assisted
import dagger.assisted.AssistedFactory
import dagger.assisted.AssistedInject
import io.livekit.android.events.RoomEvent
import io.livekit.android.room.Room
import io.livekit.android.room.participant.LocalParticipant
import io.livekit.android.room.participant.Participant
import io.livekit.android.room.participant.RemoteParticipant
import io.livekit.android.room.track.LocalAudioTrack
import io.livekit.android.room.track.LocalVideoTrack
import io.livekit.android.room.track.RemoteAudioTrack
import io.livekit.android.room.track.RemoteVideoTrack
import io.livekit.android.room.track.Track
import io.livekit.android.room.track.TrackPublication
import io.livekit.android.util.LKLog
import livekit.org.webrtc.FrameCryptor
import livekit.org.webrtc.FrameCryptor.FrameCryptionState
import livekit.org.webrtc.FrameCryptorAlgorithm
import livekit.org.webrtc.FrameCryptorFactory
import livekit.org.webrtc.PeerConnectionFactory
import livekit.org.webrtc.RtpReceiver
import livekit.org.webrtc.RtpSender
class E2EEManager
@AssistedInject
constructor(
@Assisted keyProvider: KeyProvider,
peerConnectionFactory: PeerConnectionFactory,
) {
private var room: Room? = null
private var keyProvider: KeyProvider
private var peerConnectionFactory: PeerConnectionFactory
private var frameCryptors = mutableMapOf<Pair<String, Participant.Identity>, FrameCryptor>()
private var algorithm: FrameCryptorAlgorithm = FrameCryptorAlgorithm.AES_GCM
private lateinit var emitEvent: (roomEvent: RoomEvent) -> Unit?
var enabled: Boolean = false
init {
this.keyProvider = keyProvider
this.peerConnectionFactory = peerConnectionFactory
}
fun keyProvider(): KeyProvider {
return this.keyProvider
}
suspend fun setup(room: Room, emitEvent: (roomEvent: RoomEvent) -> Unit) {
if (this.room != room) {
// E2EEManager already setup, clean up first
cleanUp()
}
this.enabled = true
this.room = room
this.emitEvent = emitEvent
this.room?.localParticipant?.trackPublications?.forEach { item ->
var participant = this.room!!.localParticipant
var publication = item.value
if (publication.track != null) {
addPublishedTrack(publication.track!!, publication, participant, room)
}
}
this.room?.remoteParticipants?.forEach { item ->
var participant = item.value
participant.trackPublications.forEach { item ->
var publication = item.value
if (publication.track != null) {
addSubscribedTrack(publication.track!!, publication, participant, room)
}
}
}
}
fun addSubscribedTrack(track: Track, publication: TrackPublication, participant: RemoteParticipant, room: Room) {
var rtpReceiver: RtpReceiver? = when (publication.track!!) {
is RemoteAudioTrack -> (publication.track!! as RemoteAudioTrack).receiver
is RemoteVideoTrack -> (publication.track!! as RemoteVideoTrack).receiver
else -> {
throw IllegalArgumentException("unsupported track type")
}
}
var frameCryptor = addRtpReceiver(rtpReceiver!!, participant.identity!!, publication.sid, publication.track!!.kind.name.lowercase())
frameCryptor.setObserver { trackId, state ->
LKLog.i { "Receiver::onFrameCryptionStateChanged: $trackId, state: $state" }
emitEvent(
RoomEvent.TrackE2EEStateEvent(
room!!,
publication.track!!,
publication,
participant,
state = e2eeStateFromFrameCryptoState(state),
),
)
}
}
fun removeSubscribedTrack(track: Track, publication: TrackPublication, participant: RemoteParticipant, room: Room) {
var trackId = publication.sid
var participantId = participant.identity
var frameCryptor = frameCryptors.get(trackId to participantId)
if (frameCryptor != null) {
frameCryptor.isEnabled = false
frameCryptor.dispose()
frameCryptors.remove(trackId to participantId)
}
}
fun addPublishedTrack(track: Track, publication: TrackPublication, participant: LocalParticipant, room: Room) {
var rtpSender: RtpSender? = when (publication.track!!) {
is LocalAudioTrack -> (publication.track!! as LocalAudioTrack)?.sender
is LocalVideoTrack -> (publication.track!! as LocalVideoTrack)?.sender
else -> {
throw IllegalArgumentException("unsupported track type")
}
} ?: throw IllegalArgumentException("rtpSender is null")
var frameCryptor = addRtpSender(rtpSender!!, participant.identity!!, publication.sid, publication.track!!.kind.name.lowercase())
frameCryptor.setObserver { trackId, state ->
LKLog.i { "Sender::onFrameCryptionStateChanged: $trackId, state: $state" }
emitEvent(
RoomEvent.TrackE2EEStateEvent(
room!!,
publication.track!!,
publication,
participant,
state = e2eeStateFromFrameCryptoState(state),
),
)
}
}
fun removePublishedTrack(track: Track, publication: TrackPublication, participant: LocalParticipant, room: Room) {
var trackId = publication.sid
var participantId = participant.identity
var frameCryptor = frameCryptors.get(trackId to participantId)
if (frameCryptor != null) {
frameCryptor.isEnabled = false
frameCryptor.dispose()
frameCryptors.remove(trackId to participantId)
}
}
private fun e2eeStateFromFrameCryptoState(state: FrameCryptionState?): E2EEState {
return when (state) {
FrameCryptionState.NEW -> E2EEState.NEW
FrameCryptionState.OK -> E2EEState.OK
FrameCryptionState.KEYRATCHETED -> E2EEState.KEY_RATCHETED
FrameCryptionState.MISSINGKEY -> E2EEState.MISSING_KEY
FrameCryptionState.ENCRYPTIONFAILED -> E2EEState.ENCRYPTION_FAILED
FrameCryptionState.DECRYPTIONFAILED -> E2EEState.DECRYPTION_FAILED
FrameCryptionState.INTERNALERROR -> E2EEState.INTERNAL_ERROR
else -> E2EEState.INTERNAL_ERROR
}
}
private fun addRtpSender(sender: RtpSender, participantId: Participant.Identity, trackId: String, kind: String): FrameCryptor {
var frameCryptor = FrameCryptorFactory.createFrameCryptorForRtpSender(
peerConnectionFactory,
sender,
participantId.value,
algorithm,
keyProvider.rtcKeyProvider,
)
frameCryptors[trackId to participantId] = frameCryptor
frameCryptor.setEnabled(enabled)
return frameCryptor
}
private fun addRtpReceiver(receiver: RtpReceiver, participantId: Participant.Identity, trackId: String, kind: String): FrameCryptor {
var frameCryptor = FrameCryptorFactory.createFrameCryptorForRtpReceiver(
peerConnectionFactory,
receiver,
participantId.value,
algorithm,
keyProvider.rtcKeyProvider,
)
frameCryptors[trackId to participantId] = frameCryptor
frameCryptor.setEnabled(enabled)
return frameCryptor
}
/**
* Enable or disable E2EE
* @param enabled
*/
fun enableE2EE(enabled: Boolean) {
this.enabled = enabled
for (item in frameCryptors.entries) {
var frameCryptor = item.value
frameCryptor.setEnabled(enabled)
}
}
/**
* Ratchet key for local participant
*/
fun ratchetKey() {
var newKey = keyProvider.ratchetSharedKey()
LKLog.d { "ratchetSharedKey: newKey: $newKey" }
}
fun cleanUp() {
for (frameCryptor in frameCryptors.values) {
frameCryptor.dispose()
}
frameCryptors.clear()
}
@AssistedFactory
interface Factory {
fun create(
@Assisted keyProvider: KeyProvider,
): E2EEManager
}
}