diff --git a/.changeset/e2ee-key-size.md b/.changeset/e2ee-key-size.md new file mode 100644 index 000000000..1fe755f43 --- /dev/null +++ b/.changeset/e2ee-key-size.md @@ -0,0 +1,5 @@ +--- +"client-sdk-android": minor +--- + +Add a `keySize` option to `BaseKeyProvider` (`KeyProviderKeySize.BITS_128` by default, or `BITS_256`) to derive AES-256-GCM frame keys for E2EE. All participants in a room must use the same size. Matches `KeyProviderOptions.keySize` in the JS and Swift SDKs. diff --git a/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/E2EEOptions.kt b/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/E2EEOptions.kt index a09d05779..641f18a4a 100644 --- a/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/E2EEOptions.kt +++ b/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/E2EEOptions.kt @@ -26,6 +26,7 @@ internal const val defaultFailureTolerance = -1 internal const val defaultKeyRingSize = 16 internal const val defaultDiscardFrameWhenCryptorNotReady = false internal val defaultKeyDerivationAlgorithm = FrameCryptorKeyDerivationAlgorithm.PBKDF2 +internal val defaultKeySize = KeyProviderKeySize.BITS_128 data class E2EEOptions( var keyProvider: KeyProvider = BaseKeyProvider( @@ -37,6 +38,7 @@ data class E2EEOptions( defaultKeyRingSize, defaultDiscardFrameWhenCryptorNotReady, defaultKeyDerivationAlgorithm, + defaultKeySize, ), var encryptionType: Encryption.Type = Encryption.Type.GCM, ) { diff --git a/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/KeyProvider.kt b/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/KeyProvider.kt index 55dc57abd..e76b23f2f 100644 --- a/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/KeyProvider.kt +++ b/livekit-android-sdk/src/main/java/io/livekit/android/e2ee/KeyProvider.kt @@ -27,6 +27,18 @@ internal class KeyInfo(var participantId: String, var keyIndex: Int, var key: St } } +/** + * The length of the AES-GCM key derived from the shared or per-participant key material. + * + * Every participant in a room must use the same size: a 256-bit client and a 128-bit client + * cannot decrypt each other's media or data. The default is [BITS_128], which matches the + * historical behavior of all SDKs. + */ +enum class KeyProviderKeySize(val bits: Int) { + BITS_128(128), + BITS_256(256), +} + interface KeyProvider { fun setSharedKey(key: String, keyIndex: Int? = 0): Boolean fun ratchetSharedKey(keyIndex: Int? = 0): ByteArray @@ -51,6 +63,7 @@ class BaseKeyProvider( keyRingSize: Int = defaultKeyRingSize, discardFrameWhenCryptorNotReady: Boolean = defaultDiscardFrameWhenCryptorNotReady, keyDerivationAlgorithm: FrameCryptorKeyDerivationAlgorithm = defaultKeyDerivationAlgorithm, + keySize: KeyProviderKeySize = defaultKeySize, ) : KeyProvider { private val latestSetIndex = mutableMapOf() @@ -64,6 +77,7 @@ class BaseKeyProvider( keyRingSize, discardFrameWhenCryptorNotReady, keyDerivationAlgorithm, + keySize.bits, ) override fun setSharedKey(key: String, keyIndex: Int?): Boolean { diff --git a/livekit-android-sdk/src/main/java/io/livekit/android/room/Room.kt b/livekit-android-sdk/src/main/java/io/livekit/android/room/Room.kt index ebb9de898..753bea9d3 100644 --- a/livekit-android-sdk/src/main/java/io/livekit/android/room/Room.kt +++ b/livekit-android-sdk/src/main/java/io/livekit/android/room/Room.kt @@ -332,6 +332,14 @@ constructor( * Options for end-to-end encryption. Must be setup prior to [connect]. * * If null, e2ee will be disabled. + * + * To use AES-256-GCM frame keys instead of the default AES-128-GCM, pass a key size to the + * key provider. All participants in the room must use the same key size. + * ``` + * val keyProvider = BaseKeyProvider(keySize = KeyProviderKeySize.BITS_256) + * keyProvider.setSharedKey("my-shared-key") + * room.e2eeOptions = E2EEOptions(keyProvider = keyProvider) + * ``` */ var e2eeOptions: E2EEOptions? = null