2018-02-10 23:37:42 +00:00
|
|
|
|
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<!DOCTYPE html>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<html>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<head>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<meta charset="utf-8" />
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
|
|
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<title>Using PlayReady Key Server — Shaka Packager documentation</title>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/sphinxdoc_new.css" />
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/table_styling.css" />
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<script src="../_static/jquery.js"></script>
|
|
|
|
|
|
<script src="../_static/underscore.js"></script>
|
|
|
|
|
|
<script src="../_static/doctools.js"></script>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<link rel="index" title="Index" href="../genindex.html" />
|
|
|
|
|
|
<link rel="search" title="Search" href="../search.html" />
|
2018-08-20 17:47:59 +00:00
|
|
|
|
<link rel="next" title="Using Raw Key" href="raw_key.html" />
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<link rel="prev" title="Using Widevine Key Server" href="widevine.html" />
|
2020-01-22 00:59:16 +00:00
|
|
|
|
</head><body>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
|
accesskey="I">index</a></li>
|
|
|
|
|
|
<li class="right" >
|
2018-08-20 17:47:59 +00:00
|
|
|
|
<a href="raw_key.html" title="Using Raw Key"
|
2017-09-20 02:35:05 +00:00
|
|
|
|
accesskey="N">next</a> |</li>
|
|
|
|
|
|
<li class="right" >
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<a href="widevine.html" title="Using Widevine Key Server"
|
2017-09-20 02:35:05 +00:00
|
|
|
|
accesskey="P">previous</a> |</li>
|
|
|
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="tutorials.html" >Tutorials</a> »</li>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<li class="nav-item nav-item-2"><a href="drm.html" accesskey="U">DRM</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-this"><a href="">Using PlayReady Key Server</a></li>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</ul>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
</div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
|
<div class="body" role="main">
|
|
|
|
|
|
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<section id="using-playready-key-server">
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<h1>Using PlayReady Key Server<a class="headerlink" href="#using-playready-key-server" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
|
<p>Shaka Packager can talk to PlayReady Key Server that implements
|
|
|
|
|
|
<a class="reference external" href="http://bit.ly/2M9NuOt">AcquirePackagingData Web Method specification</a> to
|
|
|
|
|
|
fetch encryption keys.</p>
|
|
|
|
|
|
<p>Refer to <a class="reference internal" href="drm.html"><span class="doc">DRM</span></a> if you are interested in generating multi-DRM
|
|
|
|
|
|
contents.</p>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<section id="synopsis">
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ packager <stream_descriptor> ... \
|
2018-08-20 17:47:59 +00:00
|
|
|
|
--enable_playready_encryption \
|
|
|
|
|
|
--playready_server_url <playready_server_url> \
|
|
|
|
|
|
--program_identifier <program_identifier> \
|
|
|
|
|
|
--client_cert_file <client_cert_file> \
|
|
|
|
|
|
--client_cert_private_key_file <client_cert_private_key_file> \
|
|
|
|
|
|
--client_cert_private_key_password <client_cert_private_key_password> \
|
|
|
|
|
|
--ca_file <ca_file> \
|
|
|
|
|
|
[Other options, e.g. DASH options, HLS options]
|
|
|
|
|
|
</pre></div>
|
|
|
|
|
|
</div>
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<p>The –client_cert_xx and –ca_file parameters can be omitted if not required by
|
|
|
|
|
|
the key server.</p>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
</section>
|
|
|
|
|
|
<section id="configuration-options">
|
2018-08-20 17:47:59 +00:00
|
|
|
|
<h2>Configuration options<a class="headerlink" href="#configuration-options" title="Permalink to this headline">¶</a></h2>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
<section id="drm-related-stream-descriptor-fields">
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<h3>DRM related Stream descriptor fields<a class="headerlink" href="#drm-related-stream-descriptor-fields" title="Permalink to this headline">¶</a></h3>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<dl class="field-list simple">
|
|
|
|
|
|
<dt class="field-odd">skip_encryption=0|1</dt>
|
|
|
|
|
|
<dd class="field-odd"><p>Optional. Defaults to 0 if not specified. If it is set to 1, no encryption
|
|
|
|
|
|
of the stream will be made.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt class="field-even">drm_label</dt>
|
|
|
|
|
|
<dd class="field-even"><p>Optional value for custom DRM label, which defines the encryption key
|
2018-08-16 00:35:22 +00:00
|
|
|
|
applied to the stream. Typically values include AUDIO, SD, HD, UHD1, UHD2.
|
|
|
|
|
|
For raw key, it should be a label defined in –keys. If not provided, the
|
|
|
|
|
|
DRM label is derived from stream type (video, audio), resolutions, etc.
|
2020-01-22 00:59:16 +00:00
|
|
|
|
Note that it is case sensitive.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
</section>
|
|
|
|
|
|
<section id="general-encryption-options">
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<h3>General encryption options<a class="headerlink" href="#general-encryption-options" title="Permalink to this headline">¶</a></h3>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<dl class="option-list">
|
|
|
|
|
|
<dt><kbd><span class="option">--protection_scheme <var><scheme></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Specify a protection scheme, ‘cenc’ or ‘cbc1’ or pattern-based protection
|
|
|
|
|
|
schemes ‘cens’ or ‘cbcs’.</p>
|
|
|
|
|
|
</dd>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<dt><kbd><span class="option">--crypt_byte_block</span></kbd></dt>
|
|
|
|
|
|
<dd><p>Specify the count of the encrypted blocks in the protection pattern, where
|
|
|
|
|
|
block is of size 16-bytes.</p>
|
|
|
|
|
|
<p>There are three common patterns (crypt_byte_block:skip_byte_block):
|
|
|
|
|
|
1:9 (default), 5:5, 10:0.</p>
|
|
|
|
|
|
<p>Apply to video streams with ‘cbcs’ and ‘cens’ protection schemes only;
|
|
|
|
|
|
ignored otherwise.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--skip_byte_block</span></kbd></dt>
|
|
|
|
|
|
<dd><p>Specify the count of the unencrypted blocks in the protection pattern.</p>
|
|
|
|
|
|
<p>Apply to video streams with ‘cbcs’ and ‘cens’ protection schemes only;
|
|
|
|
|
|
ignored otherwise.</p>
|
|
|
|
|
|
</dd>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<dt><kbd><span class="option">--vp9_subsample_encryption</span>, <span class="option">--novp9_subsample_encryption</span></kbd></dt>
|
|
|
|
|
|
<dd><p>Enable / disable VP9 subsample encryption. Enabled by default.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--clear_lead <var><seconds></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Clear lead in seconds if encryption is enabled.
|
|
|
|
|
|
Shaka Packager does not support partial encrypted segments, all the
|
|
|
|
|
|
segments including the partial segment overlapping with the initial
|
|
|
|
|
|
‘clear_lead’ seconds are not encrypted, with all the following segments
|
|
|
|
|
|
encrypted. If segment_duration is greater than ‘clear_lead’, then only the
|
|
|
|
|
|
first segment is not encrypted.
|
|
|
|
|
|
Default: 5</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--protection_systems</span></kbd></dt>
|
|
|
|
|
|
<dd><p>Protection systems to be generated. Supported protection systems include
|
2018-12-20 22:38:40 +00:00
|
|
|
|
Widevine, PlayReady, FairPlay, Marlin, and
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<a class="reference external" href="https://goo.gl/s8RIhr">CommonSystem</a>.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--playready_extra_header_data <var><string></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Extra XML data to add to PlayReady PSSH data. Can be specified even if
|
|
|
|
|
|
using another key source.</p>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
</section>
|
|
|
|
|
|
<section id="playready-encryption-options">
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<h3>PlayReady encryption options<a class="headerlink" href="#playready-encryption-options" title="Permalink to this headline">¶</a></h3>
|
2020-01-22 00:59:16 +00:00
|
|
|
|
<dl class="option-list">
|
|
|
|
|
|
<dt><kbd><span class="option">--enable_playready_encryption</span></kbd></dt>
|
|
|
|
|
|
<dd><p>Enable encryption with PlayReady key. This generates PlayReady protection
|
2018-08-16 00:35:22 +00:00
|
|
|
|
system if –protection_systems is not specified. Use –protection_system to
|
2020-01-22 00:59:16 +00:00
|
|
|
|
generate multiple protection systems.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--playready_server_url <var><url></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>PlayReady packaging server url.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--program_identifier <var><program_identifier></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Program identifier for packaging request.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--ca_file <var><file path></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Absolute path to the certificate authority file for the server cert.
|
|
|
|
|
|
PEM format. Optional, depends on server configuration.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--client_cert_file <var><file path></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Absolute path to client certificate file. Optional, depends on server
|
|
|
|
|
|
configuration.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--client_cert_private_key_file <var><file path></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Absolute path to the private key file. Optional, depends on server
|
|
|
|
|
|
configuration.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
<dt><kbd><span class="option">--client_cert_private_key_password <var><string></var></span></kbd></dt>
|
|
|
|
|
|
<dd><p>Password to the private key file. Optional, depends on server configuration.</p>
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
</dl>
|
2021-06-22 00:16:40 +00:00
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
|
|
|
|
|
</section>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<div class="clearer"></div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
|
<h3><a href="../index.html">Table of Contents</a></h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li><a class="reference internal" href="#">Using PlayReady Key Server</a><ul>
|
|
|
|
|
|
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|
|
|
|
|
<li><a class="reference internal" href="#configuration-options">Configuration options</a><ul>
|
|
|
|
|
|
<li><a class="reference internal" href="#drm-related-stream-descriptor-fields">DRM related Stream descriptor fields</a></li>
|
|
|
|
|
|
<li><a class="reference internal" href="#general-encryption-options">General encryption options</a></li>
|
|
|
|
|
|
<li><a class="reference internal" href="#playready-encryption-options">PlayReady encryption options</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h4>Previous topic</h4>
|
|
|
|
|
|
<p class="topless"><a href="widevine.html"
|
|
|
|
|
|
title="previous chapter">Using Widevine Key Server</a></p>
|
|
|
|
|
|
<h4>Next topic</h4>
|
|
|
|
|
|
<p class="topless"><a href="raw_key.html"
|
|
|
|
|
|
title="next chapter">Using Raw Key</a></p>
|
|
|
|
|
|
<div role="note" aria-label="source link">
|
|
|
|
|
|
<h3>This Page</h3>
|
|
|
|
|
|
<ul class="this-page-menu">
|
|
|
|
|
|
<li><a href="../_sources/tutorials/playready.rst.txt"
|
|
|
|
|
|
rel="nofollow">Show Source</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="searchbox" style="display: none" role="search">
|
|
|
|
|
|
<h3 id="searchlabel">Quick search</h3>
|
|
|
|
|
|
<div class="searchformwrapper">
|
|
|
|
|
|
<form class="search" action="../search.html" method="get">
|
|
|
|
|
|
<input type="text" name="q" aria-labelledby="searchlabel" />
|
|
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
|
</form>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<script>$('#searchbox').show(0);</script>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="related" role="navigation" aria-label="related navigation">
|
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
|
<ul>
|
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
|
<a href="../genindex.html" title="General Index"
|
|
|
|
|
|
>index</a></li>
|
|
|
|
|
|
<li class="right" >
|
2018-08-20 17:47:59 +00:00
|
|
|
|
<a href="raw_key.html" title="Using Raw Key"
|
2017-09-20 02:35:05 +00:00
|
|
|
|
>next</a> |</li>
|
|
|
|
|
|
<li class="right" >
|
2018-08-16 00:35:22 +00:00
|
|
|
|
<a href="widevine.html" title="Using Widevine Key Server"
|
2017-09-20 02:35:05 +00:00
|
|
|
|
>previous</a> |</li>
|
|
|
|
|
|
<li class="nav-item nav-item-0"><a href="../index.html">Shaka Packager documentation</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-1"><a href="tutorials.html" >Tutorials</a> »</li>
|
2021-04-10 04:00:37 +00:00
|
|
|
|
<li class="nav-item nav-item-2"><a href="drm.html" >DRM</a> »</li>
|
|
|
|
|
|
<li class="nav-item nav-item-this"><a href="">Using PlayReady Key Server</a></li>
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="footer" role="contentinfo">
|
|
|
|
|
|
© Copyright 2017, Google.
|
2021-06-22 00:16:40 +00:00
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.2.
|
2017-09-20 02:35:05 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
