Multi-DRM Native Client Integration Guide

Overview

PallyCon Multi-DRM Cloud Server provides DRM license issuance for Google Widevine Modular, Apple FairPlay Streaming and Microsoft PlayReady.

There are two types of methods for issuing multi-DRM (FPS, Widevine, PlayReady, NCG) licenses from PallyCon cloud server.

1. Callback type

   • When PallyCon cloud server receives license request from multi-DRM client, it first checks service site’s callback page to see if the user has valid permissions.
   • In the case of a request from an authorized user, the service site returns information such as authentication, usage rights (unlimited, fixed period) and various security options to the PallyCon cloud server through the callback web page.
   • PallyCon cloud server receives the response from the callback page and issues the license to the client.

2. Token type (refer to License Token Guide

   • When a multi-DRM client tries to play DRM content, the service site can create license token with pre-defined specification and send the token to the client.
   • The service site can set usage rights (expiration date or unlimited) and various security options through the token data.
   • When a client requests a license with a token, the PallyCon cloud server validates the token and issues a license.

This document guides how to acquire DRM license from PallyCon Multi-DRM Cloud Server to playback content on various multi-drm client platforms without using PallyCon client SDKs.

Multi-DRM License Issuance

1. Prepare Playback

   • Client (Player) receives DRM integration data (PallyCon CustomData or token) from the service site to play DRM contents and attempts to play DRM contents.

2. License Request

   • Client sets PallyCon Custom Data or token into license challenge data and sends the data (created by native DRM agent) to PallyCon Multi-DRM Cloud Server.

3. Callback User Authentication

   • In case of callback type integration, PallyCon Multi-DRM Cloud Server requests user authentication to service site via callback interface page.
   • In the token-based integration, user authentication is handled at the service site before token issuance, so this process is omitted.

4. Response Usage Right Info

   • After user authentication, service site returns content usage right info to PallyCon server via callback interface page.

5. License Issuance

   • PallyCon Multi-DRM Cloud Server creates and returns license data by DRM type, using usage right info received from callback page or token request.

Widevine Modular / PlayReady DRM License Integration

Request

• Request URI : https://license-global.pallycon.com/ri/licenseManager.do

• Request Method : POST

• There are two ways to send custom data: Custom HTTP Header, URL Parameter. In the case of PlayReady, the customdata field of the PlayReady Challenge is also available (only license token string).

POST body : License Challenge Data created by platform’s native DRM client

Response

• Success

• Failure

FairPlay Streaming DRM License Integration

To apply FPS DRM, content service site should follow the below steps before starting integration.

1. Enroll in Apple developer program ( https://developer.apple.com/support/enrollment/ )
2. Request FPS Deployment Package to Apple ( https://developer.apple.com/streaming/fps/ )
3. Using the deployment package, create the below four items and register them on Integration Settings page of PallyCon Console site.

- FPS certificate file (.der or .cer)
- Private key file (.pem)
- Password for the private key (string)
- Application secret key (ASK) string

Please refer to the FairPlay Cert Registration Tutorial for details on the above registration process.

1. FPS Certification File download integration spec

To implement FPS, client app should download FPS Certificate(.cer) file from PallyCon Server using the below integration spec.

Request

• Request URI : https://license-global.pallycon.com/ri/fpsKeyManager.do?siteId=
• Request Method : GET

Response

• Success

• Failure

The FPS Cert download URL is provided for your convenience. If needed, a Cert file (.cer or .der) may be hosted on your own server and its URL may be used instead of the above specification.

2. FPS License Integration Spec

Request

• Request URI : https://license-global.pallycon.com/ri/licenseManager.do
• Request Method : POST
• Custom HTTP Header, URL Parameter are available.

• POST body : spc=‘base64 encoding(spc data)’

Response

• Success

• Failure

PallyCon Custom Data v2 Format

JSON Format

{
    "drm_type": "<multi-drm type>",
    "site_id": "<site id>",
    "data": "<base64 encoding(aes256 encryption(custom data json string))>"
}

Custom Data JSON Format

{
    "user_id": "user id",
    "cid": "content id",
    "oid": "optional id"
}

Example

PallyCon Customdata v2 string
{
     "drm_type":"Widevine", 
     "site_id":"DEMO",
     "data":"4wvWFelCQ4ynPUaCSWeb1fcNuFUFqFhEH0jivn11OStvVPP/05wUkNhdKCGchNz1"
}

custom data json string
{"user_id":"test", "cid":"test cid"}

"pallycon-customdata-v2" : "eyJkcm1fdHlwZSI6IldpZGV2aW5lIiwgInNpdGVfaWQiOiJERU1PIiwgImRhdGEiOiI0d3ZXRmVs
Q1E0eW5QVWFDU1dlYjFmY051RlVGcUZoRUgwaml2bjExT1N0dlZQUC8wNXdVa05oZEtDR2NoTnox
In0NCg=="

AES256 Encryption

AES256 Encryption
- mode : CBC
- key : 32 byte (Site key from PallyCon Console site)
- iv : 16 byte (0123456789abcdef)
- padding : pkcs7

AES256 Encryption/Decryption should be processed as below using site authentication key which is created by ‘Service Request’ on PallyCon Console site. ( The key can be found on PallyCon Console’s settings page )

Examples

PallyCon Customdata v2 string
{
     "drm_type":"Widevine",
     "site_id":"DEMO",
     "data":"4wvWFelCQ4ynPUaCSWeb1fcNuFUFqFhEH0jivn11OStvVPP/05wUkNhdKCGchNz1"
}
custom data json string 
{"user_id":"test", "cid":"test cid"}

1) Using Custom HTTP Header

setRequestHeader("pallycon-customdata-v2", "eyJkcm1fdHlwZSI6IldpZGV2aW5lIiwgInNpdGVfaWQiOiJERU1PIiwgImRhdGEiOiI0d3ZXRmVs
Q1E0eW5QVWFDU1dlYjFmY051RlVGcUZoRUgwaml2bjExT1N0dlZQUC8wNXdVa05oZEtDR2NoTnox
In0NCg==");

2) Using URL parameter

license url = "https://license-global.pallycon.com/ri/licenseManager.do?pallycon-customdata-v2=eyJkcm1fdHlwZSI6IldpZGV2aW5lIiwgInNpdGVfaWQiOiJERU1PIiwgImRhdGEiOiI0d3ZXRmVs
Q1E0eW5QVWFDU1dlYjFmY051RlVGcUZoRUgwaml2bjExT1N0dlZQUC8wNXdVa05oZEtDR2NoTnox
In0NCg=="

3) Using PlayReady customdata ( only license token string )

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>AcquireLicense
    xmlns="http://schemas.microsoft.com/DRM/2007/03/protocols">
<challenge>
...

<ClientInfo> ... </ClientInfo>
<CustomData>eyJ0b2tlbiI6IlRhXC9SdkJBZ1U4ZDdwSExqeXVyK2MxTU05N1pXUm1pSmdXYzJcL1U5MnBPbWJhOXNtXC9ybHdmc0lNM2ZValhzSTUiLCJzaXRlX2lkIjoiREVNTyIsImRybV90eXBlIjoiUGxheVJlYWR5IiwiY2lkIjoidHJheSJ9</CustomData>

PallyCon Custom Data Format (Old version)

DRMType(1) + SiteID(4) + base64 E( aes256 E ( json data ))

JSON Data Format

{
    "user_id": "user id",
    "cid": "content id",
    "oid": "optional id"
}

Example

- DRM: Widevine Modular,
- Site ID: DEMO,
- JSON: {"user_id": "test_user", "cid":"DEMOCID1", "oid":""}

"pallycon-customdata" : "WDEMOeGNlZWRzIHRoZSBzaG9ydCm5hbCBwbGVhc3VyZS4="

1) Using Custom HTTP Header

setRequestHeader("pallycon-customdata", "WDEMO4wvWFelCQ4ynPUaCSWeb1fcNuFUFqFhEH0jivn11OStvVPP/05wUkNhdKCGchNz1");

2) Using URL parameter

license url = "https://license-global.pallycon.com/ri/licenseManager.do?pallycon-customdata=WDEMO4wvWFelCQ4ynPUaCSWeb1fcNuFUFqFhEH0jivn11OStvVPP/05wUkNhdKCGchNz1"