NdkMediaDrm.h revision 29f03a86a299fd9ef816ee4f6c441f7837418279
1497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 2497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Copyright (C) 2014 The Android Open Source Project 3497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 4497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Licensed under the Apache License, Version 2.0 (the "License"); 5497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * you may not use this file except in compliance with the License. 6497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * You may obtain a copy of the License at 7497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 8497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * http://www.apache.org/licenses/LICENSE-2.0 9497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 10497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Unless required by applicable law or agreed to in writing, software 11497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * distributed under the License is distributed on an "AS IS" BASIS, 12497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * See the License for the specific language governing permissions and 14497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * limitations under the License. 15497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 16497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 17497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 18497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This file defines an NDK API. 19497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not remove methods. 20497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not change method signatures. 21497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not change the value of constants. 22497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not change the size of any of the classes defined in here. 23497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not reference types that are not part of the NDK. 24497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Do not #include files that aren't part of the NDK. 25497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 26497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 27497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#ifndef _NDK_MEDIA_DRM_H 28497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#define _NDK_MEDIA_DRM_H 29497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 302975a24dc42c8953125b39a5194da3aec244cbefDan Albert#include <stdbool.h> 312975a24dc42c8953125b39a5194da3aec244cbefDan Albert#include <stdint.h> 322975a24dc42c8953125b39a5194da3aec244cbefDan Albert#include <sys/cdefs.h> 332975a24dc42c8953125b39a5194da3aec244cbefDan Albert 3443a28fb96ccb6800ceb0c6275075845f3ae5a7edMarco Nelissen#include "NdkMediaError.h" 35e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissen 36497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#ifdef __cplusplus 37497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkerextern "C" { 38497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#endif 39497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 402975a24dc42c8953125b39a5194da3aec244cbefDan Albert#if __ANDROID_API__ >= 21 41497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 42497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkerstruct AMediaDrm; 43497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef struct AMediaDrm AMediaDrm; 44497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 45497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef struct { 46497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *ptr; 47497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker size_t length; 48497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker} AMediaDrmByteArray; 49497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 50497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef AMediaDrmByteArray AMediaDrmSessionId; 51497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef AMediaDrmByteArray AMediaDrmScope; 52497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef AMediaDrmByteArray AMediaDrmKeySetId; 53497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef AMediaDrmByteArray AMediaDrmSecureStop; 54497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 55497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 56497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef enum AMediaDrmEventType { 57497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 58497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This event type indicates that the app needs to request a certificate from 59497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the provisioning server. The request message data is obtained using 60497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * AMediaDrm_getProvisionRequest. 61497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 62497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker EVENT_PROVISION_REQUIRED = 1, 63497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 64497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 65497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This event type indicates that the app needs to request keys from a license 66497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * server. The request message data is obtained using AMediaDrm_getKeyRequest. 67497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 68497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker EVENT_KEY_REQUIRED = 2, 69497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 70497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 71497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This event type indicates that the licensed usage duration for keys in a session 72497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * has expired. The keys are no longer valid. 73497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 74497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker EVENT_KEY_EXPIRED = 3, 75497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 76497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 77497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This event may indicate some specific vendor-defined condition, see your 78497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * DRM provider documentation for details 79497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 80497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker EVENT_VENDOR_DEFINED = 4 81497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker} AMediaDrmEventType; 82497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 8318a1b5904b352cedef29b95169a1226140d38576Marco Nelissentypedef void (*AMediaDrmEventListener)(AMediaDrm *, const AMediaDrmSessionId *sessionId, 84497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker AMediaDrmEventType eventType, int extra, const uint8_t *data, size_t dataSize); 85497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 86497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 87497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 88497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Query if the given scheme identified by its UUID is supported on this device, and 89497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * whether the drm plugin is able to handle the media container format specified by mimeType. 90497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 91497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * uuid identifies the universal unique ID of the crypto scheme. uuid must be 16 bytes. 92497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * mimeType is the MIME type of the media container, e.g. "video/mp4". If mimeType 93497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * is not known or required, it can be provided as NULL. 94497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 95497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkerbool AMediaDrm_isCryptoSchemeSupported(const uint8_t *uuid, const char *mimeType); 96497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 97497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 98497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Create a MediaDrm instance from a UUID 99497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * uuid identifies the universal unique ID of the crypto scheme. uuid must be 16 bytes. 100497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 101497ca097bf373ac69405131bd257915c97b31dc0Jeff TinkerAMediaDrm* AMediaDrm_createByUUID(const uint8_t *uuid); 102497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 103497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 104497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Release a MediaDrm object 105497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 106497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkervoid AMediaDrm_release(AMediaDrm *); 107497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 108497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 109497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Register a callback to be invoked when an event occurs 110497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 111497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * listener is the callback that will be invoked on event 112497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 1137c96d53a65085f42ac2b6d416cbc16fd36ed72ffMarco Nelissenmedia_status_t AMediaDrm_setOnEventListener(AMediaDrm *, AMediaDrmEventListener listener); 114497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 115497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 116497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Open a new session with the MediaDrm object. A session ID is returned. 117497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 118497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * returns MEDIADRM_NOT_PROVISIONED_ERROR if provisioning is needed 119497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * returns MEDIADRM_RESOURCE_BUSY_ERROR if required resources are in use 120497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 12118a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_openSession(AMediaDrm *, AMediaDrmSessionId *sessionId); 122497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 123497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 124497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Close a session on the MediaDrm object that was previously opened 125497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * with AMediaDrm_openSession. 126497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 12718a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_closeSession(AMediaDrm *, const AMediaDrmSessionId *sessionId); 128497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 129497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef enum AMediaDrmKeyType { 130497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 131497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This key request type species that the keys will be for online use, they will 132497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * not be saved to the device for subsequent use when the device is not connected 133497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to a network. 134497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 135497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker KEY_TYPE_STREAMING = 1, 136497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 137497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 138497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This key request type specifies that the keys will be for offline use, they 139497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * will be saved to the device for use when the device is not connected to a network. 140497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 141497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker KEY_TYPE_OFFLINE = 2, 142497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 143497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker /** 144497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * This key request type specifies that previously saved offline keys should be released. 145497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 146497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker KEY_TYPE_RELEASE = 3 147497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker} AMediaDrmKeyType; 148497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 149497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 150497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Data type containing {key, value} pair 151497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 152497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinkertypedef struct AMediaDrmKeyValuePair { 153497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *mKey; 154497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *mValue; 155497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker} AMediaDrmKeyValue; 156497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 157497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 158497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * A key request/response exchange occurs between the app and a license server 159497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to obtain or release keys used to decrypt encrypted content. 160497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * AMediaDrm_getKeyRequest is used to obtain an opaque key request byte array that 161497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * is delivered to the license server. The opaque key request byte array is 16229f03a86a299fd9ef816ee4f6c441f7837418279Jeff Tinker * returned in KeyRequest.data. 163497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 164497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * After the app has received the key request response from the server, 165497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * it should deliver to the response to the DRM engine plugin using the method 166497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * AMediaDrm_provideKeyResponse. 167497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 168497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * scope may be a sessionId or a keySetId, depending on the specified keyType. 169497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * When the keyType is KEY_TYPE_STREAMING or KEY_TYPE_OFFLINE, scope should be set 170497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to the sessionId the keys will be provided to. When the keyType is 171497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * KEY_TYPE_RELEASE, scope should be set to the keySetId of the keys being released. 172497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Releasing keys from a device invalidates them for all sessions. 173497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 174497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * init container-specific data, its meaning is interpreted based on the mime type 175497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * provided in the mimeType parameter. It could contain, for example, the content 176497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * ID, key ID or other data obtained from the content metadata that is required in 177497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * generating the key request. init may be null when keyType is KEY_TYPE_RELEASE. 178497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 179497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * initSize is the number of bytes of initData 180497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 181497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * mimeType identifies the mime type of the content. 182497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 183497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * keyType specifes the type of the request. The request may be to acquire keys for 184497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * streaming or offline content, or to release previously acquired keys, which are 185497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * identified by a keySetId. 186497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 187497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * optionalParameters are included in the key request message to allow a client 188497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * application to provide additional message parameters to the server. 189497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 190497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * numOptionalParameters indicates the number of optional parameters provided 191497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * by the caller 192497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 193497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * On exit: 194497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 1. The keyRequest pointer will reference the opaque key request data. It 195497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * will reside in memory owned by the AMediaDrm object, and will remain 196497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * accessible until the next call to AMediaDrm_getKeyRequest or until the 197497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * MediaDrm object is released. 198497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 2. keyRequestSize will be set to the size of the request 199497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 200497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * returns MEDIADRM_NOT_PROVISIONED_ERROR if reprovisioning is needed, due to a 201497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * problem with the device certificate. 202497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker*/ 20318a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_getKeyRequest(AMediaDrm *, const AMediaDrmScope *scope, 204497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *init, size_t initSize, const char *mimeType, AMediaDrmKeyType keyType, 205497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const AMediaDrmKeyValue *optionalParameters, size_t numOptionalParameters, 20618a1b5904b352cedef29b95169a1226140d38576Marco Nelissen const uint8_t **keyRequest, size_t *keyRequestSize); 207497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 208497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 209497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * A key response is received from the license server by the app, then it is 210497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * provided to the DRM engine plugin using provideKeyResponse. When the 211497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * response is for an offline key request, a keySetId is returned that can be 212497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * used to later restore the keys to a new session with AMediaDrm_restoreKeys. 213497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * When the response is for a streaming or release request, a null keySetId is 214497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * returned. 215497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 216497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * scope may be a sessionId or keySetId depending on the type of the 217497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * response. Scope should be set to the sessionId when the response is for either 218497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * streaming or offline key requests. Scope should be set to the keySetId when 219497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the response is for a release request. 220497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 221497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * response points to the opaque response from the server 222497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * responseSize should be set to the size of the response in bytes 223497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 224497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 22518a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_provideKeyResponse(AMediaDrm *, const AMediaDrmScope *scope, 22618a1b5904b352cedef29b95169a1226140d38576Marco Nelissen const uint8_t *response, size_t responseSize, AMediaDrmKeySetId *keySetId); 227497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 228497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 229497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Restore persisted offline keys into a new session. keySetId identifies the 230497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * keys to load, obtained from a prior call to AMediaDrm_provideKeyResponse. 231497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 232497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * sessionId is the session ID for the DRM session 233497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * keySetId identifies the saved key set to restore 234497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 23518a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_restoreKeys(AMediaDrm *, const AMediaDrmSessionId *sessionId, 23618a1b5904b352cedef29b95169a1226140d38576Marco Nelissen const AMediaDrmKeySetId *keySetId); 237497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 238497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 239497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Remove the current keys from a session. 240497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 241497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * keySetId identifies keys to remove 242497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 24318a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_removeKeys(AMediaDrm *, const AMediaDrmSessionId *keySetId); 244497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 245497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 246497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Request an informative description of the key status for the session. The status is 247497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * in the form of {key, value} pairs. Since DRM license policies vary by vendor, 248497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the specific status field names are determined by each DRM vendor. Refer to your 249497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * DRM provider documentation for definitions of the field names for a particular 250497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * DRM engine plugin. 251497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 252497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * On entry, numPairs should be set by the caller to the maximum number of pairs 253497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * that can be returned (the size of the array). On exit, numPairs will be set 254497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to the number of entries written to the array. If the number of {key, value} pairs 255497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to be returned is greater than *numPairs, MEDIADRM_SHORT_BUFFER will be returned 256497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * and numPairs will be set to the number of pairs available. 257497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 25818a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_queryKeyStatus(AMediaDrm *, const AMediaDrmSessionId *sessionId, 25918a1b5904b352cedef29b95169a1226140d38576Marco Nelissen AMediaDrmKeyValue *keyValuePairs, size_t *numPairs); 260497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 261497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 262497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 263497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * A provision request/response exchange occurs between the app and a provisioning 264497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * server to retrieve a device certificate. If provisionining is required, the 265497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * EVENT_PROVISION_REQUIRED event will be sent to the event handler. 266497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * getProvisionRequest is used to obtain the opaque provision request byte array that 267497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * should be delivered to the provisioning server. 268497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * On exit: 269497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 1. The provision request data will be referenced by provisionRequest, in 270497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * memory owned by the AMediaDrm object. It will remain accessible until the 271497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * next call to getProvisionRequest. 272497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 2. provisionRequestSize will be set to the size of the request data. 273497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 3. serverUrl will reference a NULL terminated string containing the URL 274497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the provisioning request should be sent to. It will remain accessible until 275497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the next call to getProvisionRequest. 276497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 27718a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_getProvisionRequest(AMediaDrm *, const uint8_t **provisionRequest, 27818a1b5904b352cedef29b95169a1226140d38576Marco Nelissen size_t *provisionRequestSize, const char **serverUrl); 279497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 280497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 281497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 282497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * After a provision response is received by the app, it is provided to the DRM 283497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * engine plugin using this method. 284497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 285497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * response is the opaque provisioning response byte array to provide to the 286497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * DRM engine plugin. 287497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * responseSize is the length of the provisioning response in bytes. 288497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 289497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * returns MEDIADRM_DEVICE_REVOKED_ERROR if the response indicates that the 290497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * server rejected the request 291497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 292e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_provideProvisionResponse(AMediaDrm *, 293497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *response, size_t responseSize); 294497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 295497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 296497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 297497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * A means of enforcing limits on the number of concurrent streams per subscriber 298497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * across devices is provided via SecureStop. This is achieved by securely 299497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * monitoring the lifetime of sessions. 300497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 301497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Information from the server related to the current playback session is written 302497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to persistent storage on the device when each MediaCrypto object is created. 303497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 304497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * In the normal case, playback will be completed, the session destroyed and the 305497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Secure Stops will be queried. The app queries secure stops and forwards the 306497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * secure stop message to the server which verifies the signature and notifies the 307497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * server side database that the session destruction has been confirmed. The persisted 308497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * record on the client is only removed after positive confirmation that the server 309497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * received the message using releaseSecureStops(). 310497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 311497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * numSecureStops is set by the caller to the maximum number of secure stops to 312497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * return. On exit, *numSecureStops will be set to the number actually returned. 313497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * If *numSecureStops is too small for the number of secure stops available, 314497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * MEDIADRM_SHORT_BUFFER will be returned and *numSecureStops will be set to the 315497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * number required. 316497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 317e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_getSecureStops(AMediaDrm *, 31818a1b5904b352cedef29b95169a1226140d38576Marco Nelissen AMediaDrmSecureStop *secureStops, size_t *numSecureStops); 319497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 320497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 321497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Process the SecureStop server response message ssRelease. After authenticating 322497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the message, remove the SecureStops identified in the response. 323497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 324497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * ssRelease is the server response indicating which secure stops to release 325497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 326e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_releaseSecureStops(AMediaDrm *, 32718a1b5904b352cedef29b95169a1226140d38576Marco Nelissen const AMediaDrmSecureStop *ssRelease); 328497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 329497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 330497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * String property name: identifies the maker of the DRM engine plugin 331497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 332c0fcdc07cc3fd44a1fd27fc9b84a5be3651cea22Martin Storsjo#define PROPERTY_VENDOR "vendor" 333497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 334497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 335497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * String property name: identifies the version of the DRM engine plugin 336497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 337c0fcdc07cc3fd44a1fd27fc9b84a5be3651cea22Martin Storsjo#define PROPERTY_VERSION "version" 338497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 339497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 340497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * String property name: describes the DRM engine plugin 341497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 342c0fcdc07cc3fd44a1fd27fc9b84a5be3651cea22Martin Storsjo#define PROPERTY_DESCRIPTION "description" 343497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 344497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 345497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * String property name: a comma-separated list of cipher and mac algorithms 346497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * supported by CryptoSession. The list may be empty if the DRM engine 347497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * plugin does not support CryptoSession operations. 348497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 349c0fcdc07cc3fd44a1fd27fc9b84a5be3651cea22Martin Storsjo#define PROPERTY_ALGORITHMS "algorithms" 350497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 351497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 352497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Read a DRM engine plugin String property value, given the property name string. 353497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 354497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * propertyName identifies the property to query 355497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * On return, propertyValue will be set to point to the property value. The 356497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * memory that the value resides in is owned by the NDK MediaDrm API and 357497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * will remain valid until the next call to AMediaDrm_getPropertyString. 358497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 359e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_getPropertyString(AMediaDrm *, const char *propertyName, 36018a1b5904b352cedef29b95169a1226140d38576Marco Nelissen const char **propertyValue); 361497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 362497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 363497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Byte array property name: the device unique identifier is established during 364497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * device provisioning and provides a means of uniquely identifying each device. 365497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 366c0fcdc07cc3fd44a1fd27fc9b84a5be3651cea22Martin Storsjo#define PROPERTY_DEVICE_UNIQUE_ID "deviceUniqueId" 367497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 368497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 369497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Read a DRM engine plugin byte array property value, given the property name string. 370497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * On return, *propertyValue will be set to point to the property value. The 371497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * memory that the value resides in is owned by the NDK MediaDrm API and 372497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * will remain valid until the next call to AMediaDrm_getPropertyByteArray. 373497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 374e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_getPropertyByteArray(AMediaDrm *, const char *propertyName, 37518a1b5904b352cedef29b95169a1226140d38576Marco Nelissen AMediaDrmByteArray *propertyValue); 376497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 377497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 378497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Set a DRM engine plugin String property value. 379497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 380e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_setPropertyString(AMediaDrm *, const char *propertyName, 381497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *value); 382497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 383497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 384497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Set a DRM engine plugin byte array property value. 385497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 386e419d7cd5c62b4b5866a45d59c5770bb470193c1Marco Nelissenmedia_status_t AMediaDrm_setPropertyByteArray(AMediaDrm *, const char *propertyName, 387497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *value, size_t valueSize); 388497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 389497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/** 390497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * In addition to supporting decryption of DASH Common Encrypted Media, the 391497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * MediaDrm APIs provide the ability to securely deliver session keys from 392497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * an operator's session key server to a client device, based on the factory-installed 393497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * root of trust, and then perform encrypt, decrypt, sign and verify operations 394497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * with the session key on arbitrary user data. 395497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 396497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Operators create session key servers that receive session key requests and provide 397497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * encrypted session keys which can be used for general purpose crypto operations. 398497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 399497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Generic encrypt/decrypt/sign/verify methods are based on the established session 400497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * keys. These keys are exchanged using the getKeyRequest/provideKeyResponse methods. 401497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * 402497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Applications of this capability include securing various types of purchased or 403497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * private content, such as applications, books and other media, photos or media 404497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * delivery protocols. 405497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 406497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 407497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 408497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Encrypt the data referenced by input of length dataSize using algorithm specified 409497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * by cipherAlgorithm, and write the encrypted result into output. The caller must 410497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * ensure that the output buffer is large enough to accept dataSize bytes. The key 411497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to use is identified by the 16 byte keyId. The key must have been loaded into 412497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the session using provideKeyResponse. 413497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 41418a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_encrypt(AMediaDrm *, const AMediaDrmSessionId *sessionId, 415497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *cipherAlgorithm, uint8_t *keyId, uint8_t *iv, 416497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *input, uint8_t *output, size_t dataSize); 417497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 418497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 419497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Decrypt the data referenced by input of length dataSize using algorithm specified 420497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * by cipherAlgorithm, and write the decrypted result into output. The caller must 421497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * ensure that the output buffer is large enough to accept dataSize bytes. The key 422497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * to use is identified by the 16 byte keyId. The key must have been loaded into 423497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * the session using provideKeyResponse. 424497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 42518a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_decrypt(AMediaDrm *, const AMediaDrmSessionId *sessionId, 426497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *cipherAlgorithm, uint8_t *keyId, uint8_t *iv, 427497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *input, uint8_t *output, size_t dataSize); 428497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 429497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 430497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Generate a signature using the specified macAlgorithm over the message data 431497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * referenced by message of size messageSize and store the signature in the 432497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * buffer referenced signature of max size *signatureSize. If the buffer is not 433497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * large enough to hold the signature, MEDIADRM_SHORT_BUFFER is returned and 434497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * *signatureSize is set to the buffer size required. The key to use is identified 435497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * by the 16 byte keyId. The key must have been loaded into the session using 436497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * provideKeyResponse. 437497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 43818a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_sign(AMediaDrm *, const AMediaDrmSessionId *sessionId, 439497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *macAlgorithm, uint8_t *keyId, uint8_t *message, size_t messageSize, 440497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker uint8_t *signature, size_t *signatureSize); 441497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 442497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker/* 443497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * Perform a signature verification using the specified macAlgorithm over the message 444497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * data referenced by the message parameter of size messageSize. Returns MEDIADRM_OK 445497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * if the signature matches, otherwise MEDAIDRM_VERIFY_FAILED is returned. The key to 446497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * use is identified by the 16 byte keyId. The key must have been loaded into the 447497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker * session using provideKeyResponse. 448497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker */ 44918a1b5904b352cedef29b95169a1226140d38576Marco Nelissenmedia_status_t AMediaDrm_verify(AMediaDrm *, const AMediaDrmSessionId *sessionId, 450497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const char *macAlgorithm, uint8_t *keyId, const uint8_t *message, size_t messageSize, 451497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker const uint8_t *signature, size_t signatureSize); 452497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 4532975a24dc42c8953125b39a5194da3aec244cbefDan Albert#endif /* __ANDROID_API__ >= 21 */ 4542975a24dc42c8953125b39a5194da3aec244cbefDan Albert 455497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#ifdef __cplusplus 456497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker} // extern "C" 457497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#endif 458497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker 459497ca097bf373ac69405131bd257915c97b31dc0Jeff Tinker#endif //_NDK_MEDIA_DRM_H 460