DoveRunner Token Sample - JAVA (v3.0)

Overview

This repository provides server-side sample code that can generate license token for DoveRunner multi-DRM service. DRM license tokens are used to authenticate license requests in multi-DRM integration workflows.

Here's how a license token works in the DRM license issuance process.

• When a multi-DRM client tries to play DRM content, the client requests a token to the content service platform to acquire DRM license. The service platform verifies that the user requesting the token has permission to the content, and then generates a token data according to the specification.
• The service platform can set usage rights and various security policies in the token data. The generated token is delivered to the client as response.
• When the client requests a DRM license with the token, DoveRunner cloud server validates the token and issues a license.

Documentation

• DoveRunner Docs

IDE

• JAVA JDK amazon-corretto-21 (jdK 21.0.2)
• maven / intellij

log settings

• logback.xml

Directories

dir		description
/src/main/java/com/doverunner/sample	/config
	/exception
	/token
	/util
/src/main/resource		log settings
/src/test/java/com/doverunner/sample		Guide to make Token Sample

✅ If you want to simply generate DoveRunner version of DRM LICENSE TOKEN, follow the guidance below :

1. clone this project.
2. Set up configuration (see Configuration section below).
3. To generate, see the Quick Test Example below or /src/test/java/com/doverunner/sample/DoverunnerDrmTokenSampleTest.java.

Configuration

Before running the sample, you need to set up your DoveRunner DRM credentials.

Setup Steps

1. Copy the template file:

   cp config.properties.example config.properties

2. Edit config.properties and fill in your actual values:

   doverunner.siteKey=YOUR_ACTUAL_SITE_KEY
   doverunner.accessKey=YOUR_ACTUAL_ACCESS_KEY
   doverunner.siteId=YOUR_ACTUAL_SITE_ID
   doverunner.userId=YOUR_TEST_USER_ID
   doverunner.contentId=YOUR_CONTENT_ID

3. Security Note:

• The config.properties file is ignored by Git (.gitignore)
• Never commit your actual credentials to version control
• Only the config.properties.example template is tracked in Git

Quick Test Example

public class SampleTest {

    private static Logger logger = LoggerFactory.getLogger(SampleTest.class);

    /** STEPS TO GET TOKEN
     * 
     * 1. set up policies you want
     * 2. build policy
     * 3. create token
     * */

    @Test
    public void makeToken() {
        
        String licenseToken = "";
        DoverunnerDrmTokenPolicy policy = null;
        DoverunnerDrmTokenClient token = null;

        /**
         * 1. set up policies you want
         * @param playback_policy
         * @param security_policy
         * @param external_key
         * */
        
        PlaybackPolicy playbackPolicy = new PlaybackPolicy();
        SecurityPolicy securityPolicy = new SecurityPolicy();
        ExternalKeyPolicy externalKeyPolicy = new ExternalKeyPolicy();
        
        //setup playbackPolicy
        playbackPolicy
                .allowedTrackTypes(AllowedTrackTypes.SD_HD)
                .persistent(false);

        /** setup SecurityPolicy
            - creates subpolicies named*/
        SecurityPolicyWidevine widevineForAll = new SecurityPolicyWidevine()
                .securityLevel(WidevineSecurityLevel.SW_SECURE_CRYPTO)
                .requiredHdcpVersion(RequiredHdcpVersion.HDCP_NONE)
                .requiredCgmsFlags(RequiredCgmsFlags.CGMS_NONE)
                .overrideDeviceRevocation(true);
        SecurityPolicyFairplay fairplayForAll = new SecurityPolicyFairplay()
                .hdcpEnforcement(FairplayHdcpEnforcement.HDCP_NONE)
                .allowAvAdapter(true)
                .allowAirplay(true);
        SecurityPolicyPlayready playreadyForAll = new SecurityPolicyPlayready()
                .securityLevel(PlayreadySecurityLevel.LEVEL_150)
                .analogVideoProtection(AnalogVideoProtection.LEVEL_100)
                .digitalVideoProtection(DigitalVideoProtection.LEVEL_100)
                .digitalAudioProtection(DigitalAudioProtection.LEVEL_100);
        SecurityPolicyNcg ncgForAll = new SecurityPolicyNcg()
                .allowMobileAbnormalDevice(true)
                .allowExternalDisplay(true)
                .controlHdcp(NcgControlHdcp.HDCP_NONE);
        
        //constructs subpolicies for SecurityPolicy
        securityPolicy
                .widevine(widevineForAll)
                .fairplay(fairplayForAll)
                .playready(playreadyForAll)
                .ncg(ncgForAll)
                .trackType(TrackType.ALL);
     
        // setup ExternalKeyPolicy
        ExternalKeyPolicyMpegCenc mpegCenc = new ExternalKeyPolicyMpegCenc(
                TrackType.ALL_VIDEO, "<Key ID>", "<Key>");
        externalKeyPolicy.mpegCenc(Arrays.asList(mpegCenc, mpegCenc, mpegCenc));

        /**
         * 2. build policy
         * */
        try {
            policy = new DoverunnerDrmTokenPolicy
                    .PolicyBuilder()
                    .playbackPolicy(playbackPolicy)
                    .externalKey(externalKeyPolicy)
                    .securityPolicy(securityPolicy)
                    .build();
            logger.info("---------------policyJson---------------");
            logger.debug(policy.toJsonString());

            /**
             * 3. create token
             * */
            token = new DoverunnerDrmTokenClient()
                	.widevine()
                    .siteId("<Site ID>")
                    .siteKey("<Site Key>")
                    .accessKey("<Access Key>")
                    .userId("<tester-user>")
                	.cId("<Content ID>")
                    .policy(policy)
                    .responseFormat(ResponseFormat.ORIGINAL);
            logger.info("---------------tokenJson---------------");
            logger.debug(token.toJsonString());
            licenseToken = token.execute();

        } catch (DoverunnerTokenException e) {
            licenseToken = e.getMessage();
        } catch (Exception e) {
            licenseToken = "unexpected Exception || " + e.getMessage();
        }
        logger.info("---------------result---------------");
        logger.debug(licenseToken);
    }
}

After run the method, you can get the TOKEN you intended below the '--result--' string. if there are minor mistakes when created, result will return error messages we already made on ErrorCode or you can see the messages below. Follow the comment and fix the bugs.

For example,

{
    "error_code": "1000",
    "error_message": "Token err : The userId is Required"
}

If you want to see All the error codes and error messages you would get, see the doverunner/sample/excepion/ErrorCode.java .

We hope this guide would be helpful to generate DRM License Token to request DoveRunner Multi-DRM Cloud Server where get the License issued from.

Error Messagges

Error Code	Error Messages
1000	Token err : The userId is Required
1001	Token err : The cId is Required
1002	Token err : The siteId is Required
1003	Token err : The accessKey is Required
1004	Token err : The siteKey is Required
1005	Token err : The policy is Required
1011	PlaybackPolicy : The expireDate time format should be YYYY-MM-DD'T'HH:mm:ss'Z
1018	ExternalKey : ExternalKey should be filled with MpegCenc, HlsAes or Ncg if called
1040	MpegCenc : The KeyId should be 16byte hex String
1041	MpegCenc : The Key should be 16byte hex String
1042	MpegCenc : The Iv should be 16byte hex String
1044	HlsAes : The Key should be 16byte hex String
1045	HlsAes : The Iv should be 16byte hex String
1047	Ncg : The Cek should be 32byte hex String
2001	json parser error

Support

If you have any questions or issues with the token sample, please create a ticket at DoveRunner Helpdesk website.