shaka-packager/docs/source/options/raw_key_encryption_options.rst

Raw key encryption options
^^^^^^^^^^^^^^^^^^^^^^^^^^

--enable_raw_key_encryption

    Enable encryption with raw key (keys provided in command line)). This
    generates `Common protection system <https://goo.gl/s8RIhr>`_ if neither
    --pssh nor --protection_systems is specified. Use --pssh to provide custom
    protection systems or use --protection_systems to generate protection
    systems automatically.

--enable_raw_key_decryption

    Enable decryption with raw key (keys provided in command line).

--keys <key_info_string[,key_info_string][,key_info_string]...>

    **key_info_string** is of the form::

        label=<label>:key_id=<key_id>:key=<key>

    *label* can be an arbitrary string or a predefined DRM label like AUDIO,
    SD, HD, etc. Label with an empty string indicates the default key and
    key_id. The *drm_label* in :doc:`/options/stream_descriptors`,
    which can be implicit, determines which key info is applied to the stream
    by matching the *drm_label* with the *label* in key info.

    *key_id* and *key* should be 32-digit hex strings.

--iv <16-digit or 32-digit hex string>

    IV in hex string format. If not specified, a random IV will be generated.
    This flag should only be used for testing. IV must be either 8 bytes
    (16 digits HEX) or 16 bytes (32 digits in HEX).

--pssh <hex string>

    One or more concatenated PSSH boxes in hex string format. If neither this
    flag nor --protection_systems is specified, a
    `v1 common PSSH box <https://goo.gl/s8RIhr>`_ will be generated.
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00			`Raw key encryption options`
			`^^^^^^^^^^^^^^^^^^^^^^^^^^`

Rename fixed_key to raw_key Change-Id: I1ee9398387b54aa685a5bef5b8704849e62ebae3 2017-10-17 23:03:08 +00:00			`--enable_raw_key_encryption`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Multi-DRM flag refactoring - Added flag --additional_protection_systems to specify multi-DRM options. - Deprecated old multi-DRM flags: --generate_widevine_pssh --generate_playready_pssh --generate_common_pssh Issue: #245. Change-Id: If926bc9d481e941aa2269b6672bf2ba5411c3a50 2018-08-06 23:12:19 +00:00			`Enable encryption with raw key (keys provided in command line)). This`
			generates `Common protection system <https://goo.gl/s8RIhr>`_ if neither
Change --additional_protection_systems to --protection_systems Issue: #245. Change-Id: Ib7da3b874207623e3ee0b1a942ecb2509e750669 2018-08-10 20:31:17 +00:00			`--pssh nor --protection_systems is specified. Use --pssh to provide custom`
			`protection systems or use --protection_systems to generate protection`
			`systems automatically.`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Rename fixed_key to raw_key Change-Id: I1ee9398387b54aa685a5bef5b8704849e62ebae3 2017-10-17 23:03:08 +00:00			`--enable_raw_key_decryption`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Rename fixed_key to raw_key Change-Id: I1ee9398387b54aa685a5bef5b8704849e62ebae3 2017-10-17 23:03:08 +00:00			`Enable decryption with raw key (keys provided in command line).`
Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00
Add multi-key support in fixed/raw keys The keys can be specified in --keys option, with the form of label=<label>:key_id=<32-digit hex string>:key=<32-digit hex string>,label=... There can be multiple "label=..." block. The DRM label can be one of "AUDIO, SD, HD, UHD1, UHD2" or a custom label. Mark --key and --key_id as deprecated. We can achieve the same result with --keys=label=:key_id=<key_id>:key=<key>. Also add a new optional field in stream descriptor: drm_label, which is used to overwrite the internally generated DRM label for the stream. If not provided, the DRM label is generated automatically based on audio/video information, e.g. resolution. Code changes: - Merged RawKeyEncryptionParams and RawKeyDecryptionParams into RawKeyParams. - Make FixedKeySource accepts RawKeyParams as input. Change-Id: Ic8c2f071cc71188e13f14bc6396fc2b3ffa5cac6 2017-09-20 22:49:00 +00:00			`--keys <key_info_string[,key_info_string][,key_info_string]...>`

			`key_info_string is of the form::`

Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 2018-05-02 17:55:51 +00:00			`label=<label>:key_id=<key_id>:key=<key>`
Add multi-key support in fixed/raw keys The keys can be specified in --keys option, with the form of label=<label>:key_id=<32-digit hex string>:key=<32-digit hex string>,label=... There can be multiple "label=..." block. The DRM label can be one of "AUDIO, SD, HD, UHD1, UHD2" or a custom label. Mark --key and --key_id as deprecated. We can achieve the same result with --keys=label=:key_id=<key_id>:key=<key>. Also add a new optional field in stream descriptor: drm_label, which is used to overwrite the internally generated DRM label for the stream. If not provided, the DRM label is generated automatically based on audio/video information, e.g. resolution. Code changes: - Merged RawKeyEncryptionParams and RawKeyDecryptionParams into RawKeyParams. - Make FixedKeySource accepts RawKeyParams as input. Change-Id: Ic8c2f071cc71188e13f14bc6396fc2b3ffa5cac6 2017-09-20 22:49:00 +00:00
			`label can be an arbitrary string or a predefined DRM label like AUDIO,`
			`SD, HD, etc. Label with an empty string indicates the default key and`
			key_id. The drm_label in :doc:`/options/stream_descriptors`,
			`which can be implicit, determines which key info is applied to the stream`
			`by matching the drm_label with the label in key info.`

			`key_id and key should be 32-digit hex strings.`

Move command line options to Sphinxdoc Change-Id: Ia043612012ff3d101afcf3366d95f9001f0dc8f4 2017-09-06 20:57:07 +00:00			`--iv <16-digit or 32-digit hex string>`

			`IV in hex string format. If not specified, a random IV will be generated.`
			`This flag should only be used for testing. IV must be either 8 bytes`
			`(16 digits HEX) or 16 bytes (32 digits in HEX).`

			`--pssh <hex string>`

Multi-DRM flag refactoring - Added flag --additional_protection_systems to specify multi-DRM options. - Deprecated old multi-DRM flags: --generate_widevine_pssh --generate_playready_pssh --generate_common_pssh Issue: #245. Change-Id: If926bc9d481e941aa2269b6672bf2ba5411c3a50 2018-08-06 23:12:19 +00:00			`One or more concatenated PSSH boxes in hex string format. If neither this`
Change --additional_protection_systems to --protection_systems Issue: #245. Change-Id: Ib7da3b874207623e3ee0b1a942ecb2509e750669 2018-08-10 20:31:17 +00:00			`flag nor --protection_systems is specified, a`
Multi-DRM flag refactoring - Added flag --additional_protection_systems to specify multi-DRM options. - Deprecated old multi-DRM flags: --generate_widevine_pssh --generate_playready_pssh --generate_common_pssh Issue: #245. Change-Id: If926bc9d481e941aa2269b6672bf2ba5411c3a50 2018-08-06 23:12:19 +00:00			`v1 common PSSH box <https://goo.gl/s8RIhr>`_ will be generated.