Skip to content

drmtday:ingest-cenc-key

drmtoday:ingest-cenc-key

Ingests a key to DRMtoday and provides the ingested key info as environment variables. The tool exports 5 environment variables:

* [env_prefix]_base64: the CEK key as base64 string
* [env_prefix]_hex: the CEK key as hex string

* [env_prefix]_id_base64: the Key ID as base64 string
* [env_prefix]_id_hex: the Key ID as hex string

* [env_prefix]_iv_base64: the FairPlay IV as base64 string
* [env_prefix]_iv_hex: the FairPlay IV as hex string

* [env_prefix]_pssh_pr_b64: the PSSH box content for PlayReady as base64 string
* [env_prefix]_pssh_widevine_b64: the PSSH box content for Widevine as base64 string

Example:

{
    "parameters": {
        "environment": "{env}",
        ["key_id" : "{uuid}",]
        ["key_seed_id" : "{uuid}" [OR] "key" : "00000000-11111-3333-4444-999999999999",]
        ["env_prefix": "key",]
        "asset_id" : "{assetid}",
        ["variant_id" : "{varintid}",]
        ["iv_seed_id" : "{uuid}" [OR] "iv": "00000000-11111-3333-4444-999999999999", -- only if FairPlay is in use ]
        "stream_type" : "AUDIO_VIDEO",
        "user" : "{api::user}",
        "password" : "{password}",
        "clearkey: false
    },
    "tool": "DRMToday:ingest_cenc_key"
},
Parameter Properties Default Type Choice Description
asset_id required
stream_type required 'VIDEO_AUDIO', 'VIDEO', 'AUDIO', 'SD', 'HD', 'UHD', 'UHD2'
user required
password required
environment optional PROD str 'prod', 'test', 'staging', 'PROD', 'TEST', 'STAGING'
key_id optional key_id is optional. A random key_id will be generated when none given. The key_id will be available in the environment as {[env_prefix]}_id_base64 and {[env_prefix]}_id_hex
key_seed_id optional key_seed_id is optional. A random key will be generated when neither key nor key_seed_id is given.
key optional key is optional. If key_seed_id is given a key will be generated otherwise a random key will be generated. The key will be available in the environment as {[env_prefix]}_base64 and {[env_prefix]}_hex
env_prefix optional key str
variant_id optional
iv optional iv is optional. When given, it'll be ingested along with the key. If not given, a random one will be generated.
iv_seed_id optional iv_seed_id is optional. When given, it's used to derive the actual IV. A random IV will be generate when neither iv or iv_seed_id are given.
overwrite optional false bool Enforce Keyingest by allowing overwriting existing assets.
clearkey optional false bool Keys ingested will be available in clear form, please read for further information https://fe.staging.drmtoday.com/frontend/documentation/integration/player/hlsclearkey.html#player-integration-clearkey