shaka-player 3.3.11 → 3.3.12

package/docs/tutorials/welcome.md

@@ -66,8 +66,8 @@ python build/all.py
 
 Alternatively you can use a docker container:
 ```sh
-cd build/docker
-docker-compose run --rm shaka-compiler
+docker build -t shaka-player-build build/docker
+docker run -v $(pwd):/usr/src --user $(id -u):$(id -g) shaka-player-build
 ```
 
 The output is:

package/lib/ads/client_side_ad_manager.js

@@ -15,7 +15,6 @@ goog.require('goog.asserts');
 goog.require('shaka.ads.ClientSideAd');
 goog.require('shaka.util.IReleasable');
 
-
 /**
  * A class responsible for client-side ad interactions.
  * @implements {shaka.util.IReleasable}
@@ -211,7 +210,11 @@ shaka.ads.ClientSideAdManager = class {
       // TODO (ismena): Need a better inderstanding of what this does.
       // The docs say it's called to 'start playing the ads,' but I haven't
       // seen the ads actually play until requestAds() is called.
-      this.imaAdsManager_.start();
+      // Note: We listen for a play event to avoid autoplay issues that might
+      // crash IMA.
+      this.video_.addEventListener('play', () => {
+        this.imaAdsManager_.start();
+      }, {once: true});
     } catch (adError) {
       // If there was a problem with the VAST response,
       // we we won't be getting an ad. Hide ad UI if we showed it already

package/lib/media/drm_engine.js

@@ -27,6 +27,7 @@ goog.require('shaka.util.StreamUtils');
 goog.require('shaka.util.StringUtils');
 goog.require('shaka.util.Timer');
 goog.require('shaka.util.Uint8ArrayUtils');
+goog.require('shaka.util.XmlUtils');
 
 
 /** @implements {shaka.util.IDestroyable} */
@@ -1439,7 +1440,8 @@ shaka.media.DrmEngine = class {
       return;
     }
     shaka.log.debug('Unwrapping PlayReady request.');
-    const dom = new DOMParser().parseFromString(xml, 'application/xml');
+    const dom = shaka.util.XmlUtils.parseXmlString(xml, 'PlayReadyKeyMessage');
+    goog.asserts.assert(dom, 'Failed to parse PlayReady XML!');
 
     // Set request headers.
     const headers = dom.getElementsByTagName('HttpHeader');
@@ -1523,7 +1525,7 @@ shaka.media.DrmEngine = class {
         hasExpiredKeys = true;
       }
 
-      const keyIdHex = shaka.util.Uint8ArrayUtils.toHex(keyId);
+      const keyIdHex = shaka.util.Uint8ArrayUtils.toHex(keyId).slice(0, 32);
 
       this.keyStatusByKeyId_.set(keyIdHex, status);
     });

package/lib/offline/indexeddb/storage_mechanism.js

@@ -16,6 +16,7 @@ goog.require('shaka.offline.indexeddb.V5StorageCell');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.PublicPromise');
 goog.require('shaka.util.Platform');
+goog.require('shaka.util.Timer');
 
 
 /**
@@ -55,8 +56,25 @@ shaka.offline.indexeddb.StorageMechanism = class {
     const version = shaka.offline.indexeddb.StorageMechanism.VERSION;
 
     const p = new shaka.util.PublicPromise();
+
+    // Add a timeout mechanism, for the (rare?) case where no callbacks are
+    // called at all, so that this method doesn't hang forever.
+    let timedOut = false;
+    const timeOutTimer = new shaka.util.Timer(() => {
+      timedOut = true;
+      p.reject(new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.STORAGE,
+          shaka.util.Error.Code.INDEXED_DB_INIT_TIMED_OUT));
+    });
+    timeOutTimer.tickAfter(2);
+
     const open = window.indexedDB.open(name, version);
     open.onsuccess = (event) => {
+      if (timedOut) {
+        // Too late, we have already given up on opening the storage mechanism.
+        return;
+      }
       const db = open.result;
       this.db_ = db;
       this.v1_ = shaka.offline.indexeddb.StorageMechanism.createV1_(db);
@@ -68,6 +86,7 @@ shaka.offline.indexeddb.StorageMechanism = class {
       this.v5_ = shaka.offline.indexeddb.StorageMechanism.createV5_(db);
       this.sessions_ =
           shaka.offline.indexeddb.StorageMechanism.createEmeSessionCell_(db);
+      timeOutTimer.stop();
       p.resolve();
     };
     open.onupgradeneeded = (event) => {
@@ -75,11 +94,16 @@ shaka.offline.indexeddb.StorageMechanism = class {
       this.createStores_(open.result);
     };
     open.onerror = (event) => {
+      if (timedOut) {
+        // Too late, we have already given up on opening the storage mechanism.
+        return;
+      }
       p.reject(new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
           shaka.util.Error.Category.STORAGE,
           shaka.util.Error.Code.INDEXED_DB_ERROR,
           open.error));
+      timeOutTimer.stop();
 
       // Firefox will raise an error on the main thread unless we stop it here.
       event.preventDefault();

package/lib/player.js

@@ -6635,7 +6635,7 @@ shaka.Player.TYPICAL_BUFFERING_THRESHOLD_ = 0.5;
  * @define {string} A version number taken from git at compile time.
  * @export
  */
-shaka.Player.version = 'v3.3.11-uncompiled';
+shaka.Player.version = 'v3.3.12-uncompiled';
 
 // Initialize the deprecation system using the version string we just set
 // on the player.

package/lib/polyfill/media_capabilities.js

@@ -43,6 +43,7 @@ shaka.polyfill.MediaCapabilities = class {
         !shaka.util.Platform.isPS5() &&
         !shaka.util.Platform.isWebOS() &&
         !shaka.util.Platform.isTizen() &&
+        !shaka.util.Platform.isEOS() &&
         navigator.mediaCapabilities) {
       shaka.log.info(
           'MediaCapabilities: Native mediaCapabilities support found.');

package/lib/text/ttml_text_parser.js

@@ -41,8 +41,6 @@ shaka.text.TtmlTextParser = class {
     const ttsNs = TtmlTextParser.styleNs_;
     const str = shaka.util.StringUtils.fromUTF8(data);
     const cues = [];
-    const parser = new DOMParser();
-    let xml = null;
 
     // dont try to parse empty string as
     // DOMParser will not throw error but return an errored xml
@@ -50,9 +48,8 @@ shaka.text.TtmlTextParser = class {
       return cues;
     }
 
-    try {
-      xml = parser.parseFromString(str, 'text/xml');
-    } catch (exception) {
+    const tt = XmlUtils.parseXmlString(str, 'tt');
+    if (!tt) {
       throw new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,
           shaka.util.Error.Category.TEXT,
@@ -60,110 +57,89 @@ shaka.text.TtmlTextParser = class {
           'Failed to parse TTML.');
     }
 
-    if (xml) {
-      const parserError = xml.getElementsByTagName('parsererror')[0];
-      if (parserError) {
-        throw new shaka.util.Error(
-            shaka.util.Error.Severity.CRITICAL,
-            shaka.util.Error.Category.TEXT,
-            shaka.util.Error.Code.INVALID_XML,
-            parserError.textContent);
-      }
-
-      const tt = xml.getElementsByTagName('tt')[0];
-      // TTML should always have tt element.
-      if (!tt) {
-        throw new shaka.util.Error(
-            shaka.util.Error.Severity.CRITICAL,
-            shaka.util.Error.Category.TEXT,
-            shaka.util.Error.Code.INVALID_XML,
-            'TTML does not contain <tt> tag.');
-      }
-
-      const body = tt.getElementsByTagName('body')[0];
-      if (!body) {
-        return [];
-      }
+    const body = tt.getElementsByTagName('body')[0];
+    if (!body) {
+      return [];
+    }
 
-      // Get the framerate, subFrameRate and frameRateMultiplier if applicable.
-      const frameRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRate');
-      const subFrameRate = XmlUtils.getAttributeNSList(
-          tt, ttpNs, 'subFrameRate');
-      const frameRateMultiplier =
-          XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRateMultiplier');
-      const tickRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'tickRate');
+    // Get the framerate, subFrameRate and frameRateMultiplier if applicable.
+    const frameRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRate');
+    const subFrameRate = XmlUtils.getAttributeNSList(
+        tt, ttpNs, 'subFrameRate');
+    const frameRateMultiplier =
+        XmlUtils.getAttributeNSList(tt, ttpNs, 'frameRateMultiplier');
+    const tickRate = XmlUtils.getAttributeNSList(tt, ttpNs, 'tickRate');
 
-      const cellResolution = XmlUtils.getAttributeNSList(
-          tt, ttpNs, 'cellResolution');
-      const spaceStyle = tt.getAttribute('xml:space') || 'default';
-      const extent = XmlUtils.getAttributeNSList(tt, ttsNs, 'extent');
+    const cellResolution = XmlUtils.getAttributeNSList(
+        tt, ttpNs, 'cellResolution');
+    const spaceStyle = tt.getAttribute('xml:space') || 'default';
+    const extent = XmlUtils.getAttributeNSList(tt, ttsNs, 'extent');
 
-      if (spaceStyle != 'default' && spaceStyle != 'preserve') {
-        throw new shaka.util.Error(
-            shaka.util.Error.Severity.CRITICAL,
-            shaka.util.Error.Category.TEXT,
-            shaka.util.Error.Code.INVALID_XML,
-            'Invalid xml:space value: ' + spaceStyle);
-      }
-      const whitespaceTrim = spaceStyle == 'default';
+    if (spaceStyle != 'default' && spaceStyle != 'preserve') {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.TEXT,
+          shaka.util.Error.Code.INVALID_XML,
+          'Invalid xml:space value: ' + spaceStyle);
+    }
+    const whitespaceTrim = spaceStyle == 'default';
 
-      const rateInfo = new TtmlTextParser.RateInfo_(
-          frameRate, subFrameRate, frameRateMultiplier, tickRate);
+    const rateInfo = new TtmlTextParser.RateInfo_(
+        frameRate, subFrameRate, frameRateMultiplier, tickRate);
 
-      const cellResolutionInfo =
-        TtmlTextParser.getCellResolution_(cellResolution);
+    const cellResolutionInfo =
+      TtmlTextParser.getCellResolution_(cellResolution);
 
-      const metadata = tt.getElementsByTagName('metadata')[0];
-      const metadataElements = metadata ? XmlUtils.getChildren(metadata) : [];
-      const styles = Array.from(tt.getElementsByTagName('style'));
-      const regionElements = Array.from(tt.getElementsByTagName('region'));
+    const metadata = tt.getElementsByTagName('metadata')[0];
+    const metadataElements = metadata ? XmlUtils.getChildren(metadata) : [];
+    const styles = Array.from(tt.getElementsByTagName('style'));
+    const regionElements = Array.from(tt.getElementsByTagName('region'));
 
-      const cueRegions = [];
-      for (const region of regionElements) {
-        const cueRegion =
-            TtmlTextParser.parseCueRegion_(region, styles, extent);
-        if (cueRegion) {
-          cueRegions.push(cueRegion);
-        }
+    const cueRegions = [];
+    for (const region of regionElements) {
+      const cueRegion =
+          TtmlTextParser.parseCueRegion_(region, styles, extent);
+      if (cueRegion) {
+        cueRegions.push(cueRegion);
       }
+    }
 
-      // A <body> element should only contain <div> elements, not <p> or <span>
-      // elements.  We used to allow this, but it is non-compliant, and the
-      // loose nature of our previous parser made it difficult to implement TTML
-      // nesting more fully.
-      if (XmlUtils.findChildren(body, 'p').length) {
+    // A <body> element should only contain <div> elements, not <p> or <span>
+    // elements.  We used to allow this, but it is non-compliant, and the
+    // loose nature of our previous parser made it difficult to implement TTML
+    // nesting more fully.
+    if (XmlUtils.findChildren(body, 'p').length) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.TEXT,
+          shaka.util.Error.Code.INVALID_TEXT_CUE,
+          '<p> can only be inside <div> in TTML');
+    }
+
+    for (const div of XmlUtils.findChildren(body, 'div')) {
+      // A <div> element should only contain <p>, not <span>.
+      if (XmlUtils.findChildren(div, 'span').length) {
         throw new shaka.util.Error(
             shaka.util.Error.Severity.CRITICAL,
             shaka.util.Error.Category.TEXT,
             shaka.util.Error.Code.INVALID_TEXT_CUE,
-            '<p> can only be inside <div> in TTML');
-      }
-
-      for (const div of XmlUtils.findChildren(body, 'div')) {
-        // A <div> element should only contain <p>, not <span>.
-        if (XmlUtils.findChildren(div, 'span').length) {
-          throw new shaka.util.Error(
-              shaka.util.Error.Severity.CRITICAL,
-              shaka.util.Error.Category.TEXT,
-              shaka.util.Error.Code.INVALID_TEXT_CUE,
-              '<span> can only be inside <p> in TTML');
-        }
+            '<span> can only be inside <p> in TTML');
       }
+    }
 
-      const cue = TtmlTextParser.parseCue_(
-          body, time.periodStart, rateInfo, metadataElements, styles,
-          regionElements, cueRegions, whitespaceTrim,
-          cellResolutionInfo, /* parentCueElement= */ null,
-          /* isContent= */ false);
-      if (cue) {
-        // According to the TTML spec, backgrounds default to transparent.
-        // So default the background of the top-level element to transparent.
-        // Nested elements may override that background color already.
-        if (!cue.backgroundColor) {
-          cue.backgroundColor = 'transparent';
-        }
-        cues.push(cue);
+    const cue = TtmlTextParser.parseCue_(
+        body, time.periodStart, rateInfo, metadataElements, styles,
+        regionElements, cueRegions, whitespaceTrim,
+        cellResolutionInfo, /* parentCueElement= */ null,
+        /* isContent= */ false);
+    if (cue) {
+      // According to the TTML spec, backgrounds default to transparent.
+      // So default the background of the top-level element to transparent.
+      // Nested elements may override that background color already.
+      if (!cue.backgroundColor) {
+        cue.backgroundColor = 'transparent';
       }
+      cues.push(cue);
     }
 
     return cues;

package/lib/util/error.js

@@ -999,6 +999,13 @@ shaka.util.Error.Code = {
    */
   'MODIFY_OPERATION_NOT_SUPPORTED': 9016,
 
+  /**
+   * When attempting to open an indexedDB instance, nothing happened for long
+   * enough for us to time out.  This keeps the storage mechanism from hanging
+   * indefinitely, if neither the success nor error callbacks are called.
+   */
+  'INDEXED_DB_INIT_TIMED_OUT': 9017,
+
   /**
    * CS IMA SDK, required for ad insertion, has not been included on the page.
    */

package/lib/util/periods.js

@@ -1180,15 +1180,6 @@ shaka.util.PeriodCombiner = class {
       return false;
     }
 
-    // If the language doesn't match, but the candidate is the "primary"
-    // language, then that should be preferred as a fallback.
-    if (!best.primary && candidate.primary) {
-      return true;
-    }
-    if (best.primary && !candidate.primary) {
-      return false;
-    }
-
     // If language-based differences haven't decided this, look at roles.  If
     // the candidate has more roles in common with the output, upgrade to the
     // candidate.
@@ -1222,6 +1213,15 @@ shaka.util.PeriodCombiner = class {
       return false;
     }
 
+    // If the language doesn't match, but the candidate is the "primary"
+    // language, then that should be preferred as a fallback.
+    if (!best.primary && candidate.primary) {
+      return true;
+    }
+    if (best.primary && !candidate.primary) {
+      return false;
+    }
+
     // If language-based and role-based features are equivalent, take the audio
     // with the closes channel count to the output.
     const channelsBetterOrWorse =

package/lib/util/xml_utils.js

@@ -8,6 +8,7 @@ goog.provide('shaka.util.XmlUtils');
 
 goog.require('goog.asserts');
 goog.require('shaka.log');
+goog.require('shaka.util.Lazy');
 goog.require('shaka.util.StringUtils');
 
 
@@ -348,19 +349,21 @@ shaka.util.XmlUtils = class {
    */
   static parseXmlString(xmlString, expectedRootElemName) {
     const parser = new DOMParser();
-    let xml = null;
+    const unsafeXmlString =
+        shaka.util.XmlUtils.trustedHTMLFromString_.value()(xmlString);
+    let unsafeXml = null;
     try {
-      xml = parser.parseFromString(xmlString, 'text/xml');
+      unsafeXml = parser.parseFromString(unsafeXmlString, 'text/xml');
     } catch (exception) {
       shaka.log.error('XML parsing exception:', exception);
       return null;
     }
 
     // According to MDN, parseFromString never returns null.
-    goog.asserts.assert(xml, 'Parsed XML document cannot be null!');
+    goog.asserts.assert(unsafeXml, 'Parsed XML document cannot be null!');
 
     // Check for empty documents.
-    const rootElem = xml.documentElement;
+    const rootElem = unsafeXml.documentElement;
     if (!rootElem) {
       shaka.log.error('XML document was empty!');
       return null;
@@ -374,13 +377,28 @@ shaka.util.XmlUtils = class {
     }
 
     // The top-level element in the loaded XML should have the name we expect.
-    if (xml.documentElement.tagName != expectedRootElemName) {
+    if (rootElem.tagName != expectedRootElemName) {
       shaka.log.error(
           `XML tag name does not match expected "${expectedRootElemName}":`,
-          xml.documentElement.tagName);
+          rootElem.tagName);
       return null;
     }
 
+    // SECURITY: Verify that the document does not contain elements from the
+    // HTML or SVG namespaces, which could trigger script execution and XSS.
+    const iterator = document.createNodeIterator(
+        unsafeXml,
+        NodeFilter.SHOW_ALL,
+    );
+    let currentNode;
+    while (currentNode = iterator.nextNode()) {
+      if (currentNode instanceof HTMLElement ||
+          currentNode instanceof SVGElement) {
+        shaka.log.error('XML document embeds unsafe content!');
+        return null;
+      }
+    }
+
     return rootElem;
   }
 
@@ -402,3 +420,24 @@ shaka.util.XmlUtils = class {
     }
   }
 };
+
+/**
+ * Promote a string to TrustedHTML. This function is security-sensitive and
+ * should only be used with security approval where the string is guaranteed not
+ * to cause an XSS vulnerability.
+ *
+ * @private {!shaka.util.Lazy.<function(!string): (!TrustedHTML|!string)>}
+ */
+shaka.util.XmlUtils.trustedHTMLFromString_ = new shaka.util.Lazy(() => {
+  if (typeof trustedTypes !== 'undefined') {
+    // Create a Trusted Types policy for promoting the string to TrustedHTML.
+    // The Lazy wrapper ensures this policy is only created once.
+    const policy = trustedTypes.createPolicy('shaka-player#xml', {
+      createHTML: (s) => s,
+    });
+    return (s) => policy.createHTML(s);
+  }
+  // Fall back to strings in environments that don't support Trusted Types.
+  return (s) => s;
+});
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "shaka-player",
   "description": "DASH/EME video player library",
-  "version": "3.3.11",
+  "version": "3.3.12",
   "homepage": "https://github.com/shaka-project/shaka-player",
   "author": "Google",
   "maintainers": [

package/test/offline/storage_integration.js

@@ -1034,6 +1034,36 @@ filterDescribe('Storage', storageSupport, () => {
       }
     });
 
+    /**
+     * In some situations, indexedDB.open() can just hang, and call neither the
+     * 'success' nor the 'error' callbacks.
+     * I'm not sure what causes it, but it seems to happen consistently between
+     * reloads when it does so it might be a browser-based issue.
+     * In that case, we should time out with an error, instead of also hanging.
+     */
+    it('throws an error if indexedDB open times out', async () => {
+      const oldOpen = window.indexedDB.open;
+      window.indexedDB.open = () => {
+        // Just return a dummy object.
+        return /** @type {!IDBOpenDBRequest} */ ({
+          onsuccess: (event) => {},
+          onerror: (error) => {},
+        });
+      };
+
+      /** @type {!shaka.offline.StorageMuxer} */
+      const muxer = new shaka.offline.StorageMuxer();
+      const expectedError = shaka.test.Util.jasmineError(new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.STORAGE,
+          shaka.util.Error.Code.INDEXED_DB_INIT_TIMED_OUT));
+
+      await expectAsync(muxer.init())
+          .toBeRejectedWith(expectedError);
+
+      window.indexedDB.open = oldOpen;
+    });
+
     it('throws an error if the content is a live stream', async () => {
       const expected = Util.jasmineError(new shaka.util.Error(
           shaka.util.Error.Severity.CRITICAL,