Do not generate keyId for keys with full segment encryption

Fail when key is unusable (emeEnabled: false)

Author: robwalch

src/controller/base-stream-controller.ts

@@ -24,7 +24,11 @@ import {
   getAesModeFromFullSegmentMethod,
   isFullSegmentEncryption,
 } from '../utils/encryption-methods-util';
-import { getRetryDelay, offlineHttpStatus } from '../utils/error-helper';
+import {
+  getRetryDelay,
+  isUnusableKeyError,
+  offlineHttpStatus,
+} from '../utils/error-helper';
 import {
   addEventListener,
   removeEventListener,
@@ -1904,7 +1908,8 @@ export default class BaseStreamController
       noAlternate &&
       isMediaFragment(frag) &&
       !frag.endList &&
-      live
+      live &&
+      !isUnusableKeyError(data)
     ) {
       this.resetFragmentErrors(filterType);
       this.treatAsGap(frag);

src/controller/error-controller.ts

@@ -6,7 +6,9 @@ import { PlaylistContextType, PlaylistLevelType } from '../types/loader';
 import { getCodecsForMimeType } from '../utils/codecs';
 import {
   getRetryConfig,
+  isKeyError,
   isTimeoutError,
+  isUnusableKeyError,
   shouldRetry,
 } from '../utils/error-helper';
 import { arrayToHex } from '../utils/hex';
@@ -302,7 +304,7 @@ export default class ErrorController
     const level = hls.levels[variantLevelIndex];
     const { fragLoadPolicy, keyLoadPolicy } = hls.config;
     const retryConfig = getRetryConfig(
-      data.details.startsWith('key') ? keyLoadPolicy : fragLoadPolicy,
+      isKeyError(data) ? keyLoadPolicy : fragLoadPolicy,
       data,
     );
     const fragmentErrors = hls.levels.reduce(
@@ -314,19 +316,21 @@ export default class ErrorController
       if (data.details !== ErrorDetails.FRAG_GAP) {
         level.fragmentError++;
       }
-      const retry = shouldRetry(
-        retryConfig,
-        fragmentErrors,
-        isTimeoutError(data),
-        data.response,
-      );
-      if (retry) {
-        return {
-          action: NetworkErrorAction.RetryRequest,
-          flags: ErrorActionFlags.None,
+      if (!isUnusableKeyError(data)) {
+        const retry = shouldRetry(
           retryConfig,
-          retryCount: fragmentErrors,
-        };
+          fragmentErrors,
+          isTimeoutError(data),
+          data.response,
+        );
+        if (retry) {
+          return {
+            action: NetworkErrorAction.RetryRequest,
+            flags: ErrorActionFlags.None,
+            retryConfig,
+            retryCount: fragmentErrors,
+          };
+        }
       }
     }
     // Reach max retry count, or Missing level reference

src/loader/key-loader.ts

@@ -177,7 +177,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
       const error = new Error(
         keySystemFormat
           ? `Expected frag.decryptdata to be defined after setting format ${keySystemFormat}`
-          : 'Missing decryption data on fragment in onKeyLoading',
+          : `Missing decryption data on fragment in onKeyLoading (emeEnabled with controller: ${this.emeController && this.config.emeEnabled})`,
       );
       return Promise.reject(
         this.createKeyLoadError(frag, ErrorDetails.KEY_LOAD_ERROR, error),
@@ -219,7 +219,7 @@ export default class KeyLoader extends Logger implements ComponentAPI {
 
     // Load the key or return the loading promise
     this.log(
-      `${this.keyIdToKeyInfo[id] ? 'Rel' : 'L'}oading keyId: ${arrayToHex(decryptdata.keyId || [])} URI: ${decryptdata.uri} from ${frag.type} ${frag.level}`,
+      `${this.keyIdToKeyInfo[id] ? 'Rel' : 'L'}oading${decryptdata.keyId ? ' keyId: ' + arrayToHex(decryptdata.keyId) : ''} URI: ${decryptdata.uri} from ${frag.type} ${frag.level}`,
     );
 
     keyInfo = this.keyIdToKeyInfo[id] = {

src/loader/level-key.ts

@@ -105,19 +105,22 @@ export class LevelKey implements DecryptData {
       return null;
     }
 
-    if (isFullSegmentEncryption(this.method) && this.uri && !this.iv) {
-      if (typeof sn !== 'number') {
-        // We are fetching decryption data for a initialization segment
-        // If the segment was encrypted with AES-128/256
-        // It must have an IV defined. We cannot substitute the Segment Number in.
-        logger.warn(
-          `missing IV for initialization segment with method="${this.method}" - compliance issue`,
-        );
-
-        // Explicitly set sn to resulting value from implicit conversions 'initSegment' values for IV generation.
-        sn = 0;
+    if (isFullSegmentEncryption(this.method)) {
+      let iv = this.iv;
+      if (!iv) {
+        if (typeof sn !== 'number') {
+          // We are fetching decryption data for a initialization segment
+          // If the segment was encrypted with AES-128/256
+          // It must have an IV defined. We cannot substitute the Segment Number in.
+          logger.warn(
+            `missing IV for initialization segment with method="${this.method}" - compliance issue`,
+          );
+
+          // Explicitly set sn to resulting value from implicit conversions 'initSegment' values for IV generation.
+          sn = 0;
+        }
+        iv = createInitializationVector(sn);
       }
-      const iv = createInitializationVector(sn);
       const decryptdata = new LevelKey(
         this.method,
         this.uri,

src/utils/error-helper.ts

@@ -17,6 +17,14 @@ export function isTimeoutError(error: ErrorData): boolean {
   return false;
 }
 
+export function isKeyError(error: ErrorData): boolean {
+  return error.details.startsWith('key');
+}
+
+export function isUnusableKeyError(error: ErrorData): boolean {
+  return isKeyError(error) && !!error.frag && !error.frag.decryptdata;
+}
+
 export function getRetryConfig(
   loadPolicy: LoadPolicy,
   error: ErrorData,