integrated BuyDRM support

Author: qencode-dev

.gitignore

@@ -7,4 +7,10 @@
 
 .cache/
 .vscode/
-.idea/
+.idea/
+.eggs/
+build/
+dist/
+qencode.egg-info/
+sample-code/drm/buydrm/keys/user_private_key.pem
+sample-code/drm/buydrm/keys/user_public_cert.pem

qencode/drm/__init__.py

@@ -0,0 +1,106 @@
+from lxml import etree
+from signxml import XMLSigner
+import os
+
+NSMAP = {
+    'cpix': 'urn:dashif:org:cpix',
+    'xenc': 'http://www.w3.org/2001/04/xmlenc#',
+    'pskc': 'urn:ietf:params:xml:ns:keyprov:pskc',
+    'xsi': 'http://www.w3.org/2001/XMLSchema-instance',
+    'ds': 'http://www.w3.org/2000/09/xmldsig#'
+}
+
+SYSTEM_ID_PLAYREADY = '9a04f079-9840-4286-ab92-e65be0885f95'
+SYSTEM_ID_WIDEVINE = 'edef8ba9-79d6-4ace-a3c8-27dcd51d21ed'
+SYSTEM_ID_FAIRPLAY = '94ce86fb-07ff-4f43-adb8-93d2fa968ca2'
+
+def create_cpix_user_request(
+  key_ids, media_id, user_private_key_path, user_public_cert_path,
+  use_playready=False, use_widevine=False, use_fairplay=False,
+  nsmap=None
+):
+    document_public_cert_path = os.path.dirname(__file__) + '/keys/buydrm_qencode_public_cert.pem'
+    """Creates CPIX request XML signed end user
+
+    Arguments:
+        key_ids {list} -- List of Key IDs and corresponding track quality types. The list is of
+        the following format - { 'kid': [string in GUID/UUID format], 'track_type': [string track type]}.
+
+        media_id {string} -- Some random name for your asset which is shown in KeyOS console and reports.
+
+        nsmap {list} -- List of namespaces.
+
+    Returns:
+        string -- CPIX request XML signed end user
+    """
+    nsmap = nsmap if nsmap is not None else NSMAP
+
+    # Own private key and end user's private key used to sign the document
+    end_user_private_key = open(user_private_key_path, 'rb').read()
+
+    # Own public certificate and end user's public certificate to include into the CPIX request
+    end_user_public_cert = open(user_public_cert_path, 'rb').read()
+    document_public_cert = open(document_public_cert_path, 'rb').read()
+
+    root = etree.Element('{%s}CPIX' % nsmap['cpix'], name=media_id, nsmap=nsmap)
+    root.set('{%s}schemaLocation' % nsmap['xsi'], 'urn:dashif:org:cpix cpix.xsd')
+
+    # Delivery data list
+    delivery_data_list = etree.SubElement(root, '{%s}DeliveryDataList' % nsmap['cpix'])
+    delivery_data = etree.SubElement(delivery_data_list, '{%s}DeliveryData' % nsmap['cpix'])
+    delivery_key = etree.SubElement(delivery_data, '{%s}DeliveryKey' % nsmap['cpix'])
+
+    # The public certificate of a partner. This certificate's public key will be used
+    # to encrypt Document Key which will later be used to encrypt Contnet Keys.
+    x509_data = etree.SubElement(delivery_key, '{%s}X509Data' % nsmap['ds'])
+    x509_cert = etree.SubElement(x509_data, '{%s}X509Certificate' % nsmap['ds'])
+    x509_cert.text = document_public_cert.replace('-----BEGIN CERTIFICATE-----', '').replace('-----END CERTIFICATE-----', '').replace('\n', '')
+
+    # Content key list
+    content_key_list = etree.SubElement(root, '{%s}ContentKeyList' % nsmap['cpix'])
+
+    # Content key usage rules
+    content_key_usage_list = etree.SubElement(
+        root, '{%s}ContentKeyUsageRuleList' % nsmap['cpix']
+    )
+
+    # DRM systems list
+    drm_system_list = etree.SubElement(root, '{%s}DRMSystemList' % nsmap['cpix'])
+
+    for data in key_ids:
+        etree.SubElement(
+            content_key_list, '{%s}ContentKey' % nsmap['cpix'], kid=data['kid']
+        )
+        if use_playready:
+            etree.SubElement(
+                drm_system_list, '{%s}DRMSystem' % nsmap['cpix'], kid=data['kid'],
+                systemId=SYSTEM_ID_PLAYREADY
+            )
+        if use_widevine:
+            etree.SubElement(
+                drm_system_list, '{%s}DRMSystem' % nsmap['cpix'], kid=data['kid'],
+                systemId=SYSTEM_ID_WIDEVINE
+            )
+        if use_fairplay:
+            etree.SubElement(
+                drm_system_list, '{%s}DRMSystem' % nsmap['cpix'], kid=data['kid'],
+                systemId=SYSTEM_ID_FAIRPLAY
+            )
+
+        etree.SubElement(
+            content_key_usage_list, '{%s}ContentKeyUsageRule' % nsmap['cpix'],
+            kid=data['kid'], intendedTrackType=data['track_type']
+        )
+
+    # Signing document with end user's data
+    end_user_signed_root = XMLSigner(
+        c14n_algorithm='http://www.w3.org/TR/2001/REC-xml-c14n-20010315',
+        signature_algorithm='rsa-sha256', digest_algorithm='sha512'
+    ).sign(root, key=end_user_private_key, cert=end_user_public_cert)
+    x509_sign_cert = end_user_signed_root.xpath(
+        '//ds:X509Certificate', namespaces=nsmap
+    )[1]
+    x509_sign_cert.text = x509_sign_cert.text.replace('\n', '')
+#
+    return etree.tostring(end_user_signed_root).decode('utf-8')
+

qencode/drm/buydrm.py

@@ -0,0 +1,31 @@
+-----BEGIN CERTIFICATE-----
+MIIFUzCCAzugAwIBAgIJALYz0aDtoodZMA0GCSqGSIb3DQEBBQUAMEAxCzAJBgNV
+BAYTAlVTMRAwDgYDVQQKDAdRZW5jb2RlMR8wHQYDVQQDDBZRZW5jb2RlIEtleU9T
+IENQSVggQVBJMB4XDTIwMTIyMTE5MDAyNFoXDTI0MTIyMDE5MDAyNFowQDELMAkG
+A1UEBhMCVVMxEDAOBgNVBAoMB1FlbmNvZGUxHzAdBgNVBAMMFlFlbmNvZGUgS2V5
+T1MgQ1BJWCBBUEkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQD2D5aP
+XSFJC3ErYVBNS54x8AnQ4997NY2Md3QtvWy1UT/8wzs87EJ+3uwoFgfj8Tpl3hZD
+amvW9BH6SlSX2uPu5uuPovxnjMVQTg6RAdfQf+dOff4dCX9ubUD1iWen17DODUoY
+BeZWky6zGTy5n6o9RGPJsE6Er/mIFWUJdKPrXMpnqJ+hfC2fWurMj8DZ2U+TiuBF
+PK8cPkYzF8+L6BH7vkYK8Tvcoy42WPBMwO/fmFT5nTFCtmMROt/x/DaIdafF4tnx
+X+liJ3q7rABZfHY66zXv4owQRrpZXupGLVS7vQtoTIHgA6wc/MWVFEyXZN66D0RI
+5/uxRD7/GLYAbGcdCVuyJ8i/eXQ3B7OWcEiOxz3TfojlbQcaO8vb9hym5/B4H8Mh
+XC99ddB1hSgNX/bWiA6kfCYtw8jR4g86vyDcU/K2e2IcliZsd6ehFWEGluSLqHJq
+2g4d49gP72aFO7x5k95id271MMxhF8CW2VjARSqgHG6G+8cWHqaLnB2JJJE1606P
+irDrEAcsSuYLsse393pfZMhOkKdq6FXRK/E5nnbh2VKeWP491lJaXakhMVqcjVQ5
+NRqHc8iXCS7qDUYDxJubwC00b2qVj+HqN+k3gx9kyU1If2S0dXOEyJEBmCScKw6k
+glN+a6N5Wv723TKiMjUq+RgcZBbkCvbuoHdN7QIDAQABo1AwTjAdBgNVHQ4EFgQU
+n6hFowsmBOhl3vm3lYj6Uu0baDIwHwYDVR0jBBgwFoAUn6hFowsmBOhl3vm3lYj6
+Uu0baDIwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAgEAvVIt4QBYfCi9
+Ae1SVHGFN6dVSlnSQwC4pBTt8ucrsDs8kE93xyVNMz4OTDZSP0x/AxwV1LFtZOdZ
+zauPGygYMf4puVwkns1DqiUkMaGR8PMPQR+SDPeM6qwIhuYLsAyzhKdRx/n+cKmJ
+/lzFi20ZJv5y6ozFwUMIskfWnE2RvfV0bbyraR+LQgOA+fy2Vd0IeTOTgXtuNIi/
+q/VMWH2TGjh1vZQmuO1tg8dGU57XFjeK3ZBtcetNwXz6iXzZ5lprGvPG3tr4QRf5
+XiUoS+mJ5mJBBOMWlgGFELA7xAB3cYj00bTE5iE1YZCeE2WHyIiDw6OrILffeU9H
+5+bo7R7z5uwn+h5Z+XYJHxS2wg3v7wpoRMFeQXFHlJhdVXlI9cpf0NgNPecnSrs5
+F2hZt1LmbrrFXVzE3BKVvxUILBW+sN9+79fcXAHewL7yPRy6G307Sy187N2RLyJT
+mQdOlEaawR2Cgv4QI7NmAuY0Jy0uYqDCP591ZKg+j1lsWi48Eirf3/hMr/TXNDIk
+A1MhY+SPW7mGbz6hVQkkJZNYyisAZcelLWyX5X0RwFo1rMQL/BWemdKU3kV4bk8p
+cWmsYLPBMN69npjGWLLzovznOWQ4sVAOBt790pgrHDC+giPeqzx2tmmm4jP14IRj
+xSPcwUZxCh50J//DsQ2PpVQxrHPnL94=
+-----END CERTIFICATE-----

qencode/drm/keys/buydrm_qencode_public_cert.pem

@@ -0,0 +1,95 @@
+import uuid
+import time
+import json
+import base64
+import qencode
+from qencode.drm.buydrm import create_cpix_user_request
+from qencode import QencodeClientException, QencodeTaskException
+
+# replace with your API KEY (can be found in your Project settings on Qencode portal)
+API_KEY = 'your-api-qencode-key'
+
+# specify path to your BuyDRM certificate files
+USER_PVT_KEY_PATH = './keys/user_private_key.pem'
+USER_PUB_CERT_PATH = './keys/user_public_cert.pem'
+
+key_ids = [
+  { 'kid': str(uuid.uuid4()), 'track_type': 'SD' },
+  { 'kid': str(uuid.uuid4()), 'track_type': 'HD' }
+]
+media_id = 'my first stream'
+
+
+
+QUERY = """
+{
+  "query": {
+    "format": [
+      {
+        "output": "advanced_dash",
+        "stream": [
+          {
+            "video_codec": "libx264",
+            "height": 360,
+            "audio_bitrate": 128,
+            "keyframe": 25,
+            "bitrate": 950
+          }
+        ],
+        "buydrm_drm": {
+          "request": "{cpix_request}"
+        }
+      }
+    ],
+    "source": "https://nyc3.s3.qencode.com/qencode/bbb_30s.mp4"
+  }
+}
+"""
+
+
+def start_encode():
+  """
+    Create client object
+    :param api_key: string. required
+    :param api_url: string. not required
+    :param api_version: int. not required. default 'v1'
+    :return: task object
+  """
+
+  # this creates signed request to BuyDRM
+  cpix_request = create_cpix_user_request(
+    key_ids, media_id, USER_PVT_KEY_PATH, USER_PUB_CERT_PATH,
+    use_playready=True, use_widevine=True
+  )
+
+  client = qencode.client(API_KEY)
+  if client.error:
+    raise QencodeClientException(client.message)
+
+  print 'The client created. Expire date: %s' % client.expire
+
+  task = client.create_task()
+
+  if task.error:
+    raise QencodeTaskException(task.message)
+
+  query = QUERY.replace('{cpix_request}', base64.b64encode(cpix_request))
+
+  task.custom_start(query)
+
+  if task.error:
+    raise QencodeTaskException(task.message)
+
+  print 'Start encode. Task: %s' % task.task_token
+
+  while True:
+    status = task.status()
+    # print status
+    print json.dumps(status, indent=2, sort_keys=True)
+    if status['error'] or status['status'] == 'completed':
+      break
+    time.sleep(5)
+
+
+if __name__ == '__main__':
+  start_encode()