livekit-client 1.12.1 → 1.12.2

package/src/e2ee/worker/FrameCryptor.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
 // TODO code inspired by https://github.com/webrtc/samples/blob/gh-pages/src/content/insertable-streams/endtoend-encryption/js/worker.js
-import EventEmitter from 'eventemitter3';
+import { EventEmitter } from 'events';
+import type TypedEventEmitter from 'typed-emitter';
 import { workerLogger } from '../../logger';
 import type { VideoCodec } from '../../room/track/options';
 import { ENCRYPTION_ALGORITHM, IV_LENGTH, UNENCRYPTED_BYTES } from '../constants';
@@ -26,7 +27,7 @@ export interface TransformerInfo {
   abortController: AbortController;
 }
 
-export class BaseFrameCryptor extends EventEmitter<CryptorCallbacks> {
+export class BaseFrameCryptor extends (EventEmitter as new () => TypedEventEmitter<CryptorCallbacks>) {
   encodeFunction(
     encodedFrame: RTCEncodedVideoFrame | RTCEncodedAudioFrame,
     controller: TransformStreamDefaultController,
@@ -271,6 +272,7 @@ export class FrameCryptor extends BaseFrameCryptor {
     if (this.keys.getKeySet(keyIndex) && this.keys.hasValidKey) {
       try {
         const decodedFrame = await this.decryptFrame(encodedFrame, keyIndex);
+        this.keys.decryptionSuccess();
         if (decodedFrame) {
           return controller.enqueue(decodedFrame);
         }
@@ -285,7 +287,7 @@ export class FrameCryptor extends BaseFrameCryptor {
                 CryptorErrorReason.InvalidKey,
               ),
             );
-            this.keys.hasValidKey = false;
+            this.keys.decryptionFailure();
           }
         } else {
           workerLogger.warn('decoding frame failed', { error });
@@ -395,8 +397,6 @@ export class FrameCryptor extends BaseFrameCryptor {
             this.keys.setKeyFromMaterial(initialMaterial.material, keyIndex);
           }
 
-          this.keys.hasValidKey = false;
-
           workerLogger.warn('maximum ratchet attempts exceeded, resetting key');
           this.emit(
             CryptorEvent.Error,

package/src/e2ee/worker/ParticipantKeyHandler.ts

@@ -1,4 +1,5 @@
-import EventEmitter from 'eventemitter3';
+import { EventEmitter } from 'events';
+import type TypedEventEmitter from 'typed-emitter';
 import { workerLogger } from '../../logger';
 import { KEYRING_SIZE } from '../constants';
 import type { KeyProviderOptions, KeySet, ParticipantKeyHandlerCallbacks } from '../types';
@@ -15,7 +16,7 @@ import { deriveKeys, importKey, ratchet } from '../utils';
  * if decryption fails or can be triggered manually on both sender and receiver side.
  *
  */
-export class ParticipantKeyHandler extends EventEmitter<ParticipantKeyHandlerCallbacks> {
+export class ParticipantKeyHandler extends (EventEmitter as new () => TypedEventEmitter<ParticipantKeyHandlerCallbacks>) {
   private currentKeyIndex: number;
 
   private cryptoKeyRing: Array<KeySet>;
@@ -28,7 +29,13 @@ export class ParticipantKeyHandler extends EventEmitter<ParticipantKeyHandlerCal
 
   private participantId: string | undefined;
 
-  hasValidKey: boolean;
+  private decryptionFailureCount = 0;
+
+  private _hasValidKey: boolean = true;
+
+  get hasValidKey() {
+    return this._hasValidKey;
+  }
 
   constructor(
     participantId: string | undefined,
@@ -42,13 +49,37 @@ export class ParticipantKeyHandler extends EventEmitter<ParticipantKeyHandlerCal
     this.keyProviderOptions = keyProviderOptions;
     this.ratchetPromiseMap = new Map();
     this.participantId = participantId;
-    this.hasValidKey = false;
+    this.resetKeyStatus();
   }
 
   setEnabled(enabled: boolean) {
     this.enabled = enabled;
   }
 
+  decryptionFailure() {
+    if (this.keyProviderOptions.failureTolerance < 0) {
+      return;
+    }
+    this.decryptionFailureCount += 1;
+
+    if (this.decryptionFailureCount > this.keyProviderOptions.failureTolerance) {
+      this._hasValidKey = false;
+    }
+  }
+
+  decryptionSuccess() {
+    this.resetKeyStatus();
+  }
+
+  /**
+   * Call this after user initiated ratchet or a new key has been set in order to make sure to mark potentially
+   * invalid keys as valid again
+   */
+  resetKeyStatus() {
+    this.decryptionFailureCount = 0;
+    this._hasValidKey = true;
+  }
+
   /**
    * Ratchets the current key (or the one at keyIndex if provided) and
    * returns the ratcheted material
@@ -95,7 +126,7 @@ export class ParticipantKeyHandler extends EventEmitter<ParticipantKeyHandlerCal
    */
   async setKey(material: CryptoKey, keyIndex = 0) {
     await this.setKeyFromMaterial(material, keyIndex);
-    this.hasValidKey = true;
+    this.resetKeyStatus();
   }
 
   /**
@@ -122,7 +153,7 @@ export class ParticipantKeyHandler extends EventEmitter<ParticipantKeyHandlerCal
 
   async setCurrentKeyIndex(index: number) {
     this.currentKeyIndex = index % this.cryptoKeyRing.length;
-    this.hasValidKey = true;
+    this.resetKeyStatus();
   }
 
   isEnabled() {

package/src/e2ee/worker/e2ee.worker.ts

@@ -102,7 +102,7 @@ onmessage = (ev) => {
 async function handleRatchetRequest(data: RatchetRequestMessage['data']) {
   const keyHandler = getParticipantKeyHandler(data.participantId);
   await keyHandler.ratchetKey(data.keyIndex);
-  keyHandler.hasValidKey = true;
+  keyHandler.resetKeyStatus();
 }
 
 function getTrackCryptor(participantId: string, trackId: string) {

package/src/index.ts

@@ -1,5 +1,5 @@
 import { LogLevel, setLogExtension, setLogLevel } from './logger';
-import { DataPacket_Kind, DisconnectReason, VideoQuality } from './proto/livekit_models';
+import { DataPacket_Kind, DisconnectReason, VideoQuality } from './proto/livekit_models_pb';
 import DefaultReconnectPolicy from './room/DefaultReconnectPolicy';
 import Room, { ConnectionState, RoomState } from './room/Room';
 import LocalParticipant from './room/participant/LocalParticipant';