/********************************************************************* * OEMCryptoDASH.h * * (c) Copyright 2011-2012 Google, Inc. * * Reference APIs needed to support Widevine's crypto algorithms. *********************************************************************/ #ifndef OEMCRYPTO_DASH_H_ #define OEMCRYPTO_DASH_H_ #ifdef __cplusplus extern "C" { #endif #define OEMCRYPTO_VERSION "4.0" static const char oec_version[] = OEMCRYPTO_VERSION; #include typedef uint32_t OEMCrypto_SESSION; typedef uint8_t OEMCrypto_KeyID[16]; typedef enum OEMCryptoResult { OEMCrypto_SUCCESS = 0, OEMCrypto_ERROR_INIT_FAILED = 1, OEMCrypto_ERROR_TERMINATE_FAILED = 2, OEMCrypto_ERROR_OPEN_FAILURE = 3, OEMCrypto_ERROR_CLOSE_FAILURE = 4, OEMCrypto_ERROR_ENTER_SECURE_PLAYBACK_FAILED = 5, OEMCrypto_ERROR_EXIT_SECURE_PLAYBACK_FAILED = 6, OEMCrypto_ERROR_SHORT_BUFFER = 7, OEMCrypto_ERROR_NO_DEVICE_KEY = 8, OEMCrypto_ERROR_NO_ASSET_KEY = 9, OEMCrypto_ERROR_KEYBOX_INVALID = 10, OEMCrypto_ERROR_NO_KEYDATA = 11, OEMCrypto_ERROR_NO_CW = 12, OEMCrypto_ERROR_DECRYPT_FAILED = 13, OEMCrypto_ERROR_WRITE_KEYBOX = 14, OEMCrypto_ERROR_WRAP_KEYBOX = 15, OEMCrypto_ERROR_BAD_MAGIC = 16, OEMCrypto_ERROR_BAD_CRC = 17, OEMCrypto_ERROR_NO_DEVICEID = 18, OEMCrypto_ERROR_RNG_FAILED = 19, OEMCrypto_ERROR_RNG_NOT_SUPPORTED = 20, OEMCrypto_ERROR_SETUP = 21, OEMCrypto_ERROR_OPEN_SESSION_FAILED = 22, OEMCrypto_ERROR_CLOSE_SESSION_FAILED = 23, OEMCrypto_ERROR_INVALID_SESSION = 24, OEMCrypto_ERROR_NOT_IMPLEMENTED = 25, OEMCrypto_ERROR_NO_CONTENT_KEY = 26, OEMCrypto_ERROR_CONTROL_INVALID = 27, OEMCrypto_ERROR_UNKNOWN_FAILURE = 28, OEMCrypto_ERROR_INVALID_CONTEXT = 29, OEMCrypto_ERROR_SIGNATURE_FAILURE = 30, OEMCrypto_ERROR_TOO_MANY_SESSIONS = 31, OEMCrypto_ERROR_INVALID_NONCE = 32, OEMCrypto_ERROR_TOO_MANY_KEYS = 33 } OEMCryptoResult; /* * OEMCrypto_DestBufferDesc * Describes the type and access information for the memory to receive * decrypted data. * * The OEMCrypto API supports a range of client device architectures. * Different architectures have different methods for acquiring and securing * buffers that will hold portions of the audio or video stream after * decryption. Three basic strategies are recognized for handling decrypted * stream data: * 1. Return the decrypted data in the clear into normal user memory * (ClearBuffer). The caller uses normal memory allocation methods to * acquire a buffer, and supplies the memory address of the buffer in the * descriptor. * 2. Place the decrypted data into protected memory (SecureBuffer). The * caller uses a platform-specific method to acquire the protected buffer * and a user-memory handle that references it. The handle is supplied * to the decrypt call in the descriptor. * 3. Place the decrypted data directly into the audio or video decoder fifo * (Direct). The caller will use platform-specific methods to initialize * the fifo and the decoders. The decrypted stream data is not accessible * to the caller. * * Specific fields are as follows: * * (type == OEMCrypto_BufferType_Clear) * address - Address of start of user memory buffer. * max_length - Size of user memory buffer. * (type == OEMCrypto_BufferType_Secure) * buffer - handle to a platform-specific secure buffer. * max_length - Size of platform-specific secure buffer. * (type == OEMCrypto_BufferType_Direct) * is_video - If true, decrypted bytes are routed to the video * decoder. If false, decrypted bytes are routed to the * audio decoder. */ typedef enum OEMCryptoBufferType { OEMCrypto_BufferType_Clear, OEMCrypto_BufferType_Secure, OEMCrypto_BufferType_Direct } OEMCrytoBufferType; typedef struct { OEMCryptoBufferType type; union { struct { // type == OEMCrypto_BufferType_Clear uint8_t* address; size_t max_length; } clear; struct { // type == OEMCrypto_BufferType_Secure void* handle; size_t max_length; } secure; struct { // type == OEMCrypto_BufferType_Direct bool is_video; } direct; } buffer; } OEMCrypto_DestBufferDesc; /* * OEMCrypto_KeyObject * Points to the relevant fields for a content key. The fields are extracted * from the License Response message offered to OEMCrypto_LoadKeys(). Each * field points to one of the components of the key. All fields are 128 bits * (16 bytes): * key_id - the unique id of this key. * key_data_iv - the IV for performing AES-128-CBC decryption of the * key_data field. * key_data - the key data. It is encrypted (AES-128-CBC) with the * session's derived encrypt key and the key_data_iv. * key_control_iv - the IV for performing AES-128-CBC decryption of the * key_control field. * key_control - the key control block. It is encrypted (AES-128-CBC) with * the content key from the key_data field. * * The memory for the OEMCrypto_KeyObject fields is allocated and freed * by the caller of OEMCrypto_LoadKeys(). */ typedef struct { const OEMCrypto_KeyID* key_id; const uint8_t* key_data_iv; const uint8_t* key_data; const uint8_t* key_control_iv; const uint8_t* key_control; } OEMCrypto_KeyObject; /* * OEMCrypto_KeyRefreshObject * Points to the relevant fields for renewing a content key. The fields are * extracted from the License Renewal Response message offered to * OEMCrypto_RefreshKeys(). Each field points to one of the components of * the key. All fields are 128 bits (16 bytes): * key_id - the unique id of this key. * key_control_iv - the IV for performing AES-128-CBC decryption of the * key_control field. * key_control - the key control block. It is encrypted (AES-128-CBC) with * the content key from the key_data field. * * The key_data is unchanged from the original OEMCrypto_LoadKeys() call. Some * Key Control Block fields, especially those related to key lifetime, may * change. * * The memory for the OEMCrypto_KeyRefreshObject fields is allocated and freed * by the caller of OEMCrypto_RefreshKeys(). */ typedef struct { const OEMCrypto_KeyID* key_id; const uint8_t* key_control_iv; const uint8_t* key_control; } OEMCrypto_KeyRefreshObject; #define OEMCrypto_Initialize _oec01 #define OEMCrypto_Terminate _oec02 #define OEMCrypto_SetEntitlementKey _oec03 #define OEMCrypto_DeriveControlWord _oec04 #define OEMCrypto_DecryptVideo _oec05 #define OEMCrypto_DecryptAudio _oec06 #define OEMCrypto_InstallKeybox _oec07 #define OEMCrypto_GetKeyData _oec08 #define OEMCrypto_IsKeyboxValid _oec09 #define OEMCrypto_GetRandom _oec10 #define OEMCrypto_GetDeviceID _oec11 #define OEMCrypto_EnterSecurePlayback _oec12 #define OEMCrypto_ExitSecurePlayback _oec13 #define OEMCrypto_WrapKeybox _oec14 #define OEMCrypto_OpenSession _oec15 #define OEMCrypto_CloseSession _oec16 #define OEMCrypto_SetContentKey _oec17 #define OEMCrypto_DecryptCTR _oec18 #define OEMCrypto_DecryptCTS _oec19 #define OEMCrypto_GenerateDerivedKeys _oec20 #define OEMCrypto_GenerateSignature _oec21 #define OEMCrypto_GenerateNonce _oec22 #define OEMCrypto_LoadKeys _oec23 #define OEMCrypto_RefreshKeys _oec24 #define OEMCrypto_SelectKey _oec25 /* * OEMCrypto_Initialize * * Description: * Initialize the crypto firmware/hardware. * * Parameters: * N/A * * Threading: * No other function calls will be made while this function is running. This * function will not be called again before OEMCrypto_Terminate. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_INIT_FAILED failed to initialize crypto hardware */ OEMCryptoResult OEMCrypto_Initialize(void); /* * OEMCrypto_Terminate * * Description: * The API closes the crypto operation and releases all resources used. * * Parameters: * N/A * * Threading: * No other OEMCrypto calls are made while this function is running. After * this function is called, no other OEMCrypto calls will be made until another * call to OEMCrypto_Initialize is made. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_TERMINATE_FAILED failed to de-initialize crypto hardware */ OEMCryptoResult OEMCrypto_Terminate(void); /* * OEMCrypto_OpenSession * * Description: * The API provides for session based crypto initialization for AES CTR mode. * * Parameters: * session (out) - pointer to crypto session identifier. * * Threading: * No other Open/Close session calls will be made while this function is * running. Functions on existing sessions may be called while this function * is active. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_TOO_MANY_SESSIONS failed because too many sessions are open * OEMCrypto_ERROR_OPEN_SESSION_FAILED failed to initialize the crypto session */ OEMCryptoResult OEMCrypto_OpenSession(OEMCrypto_SESSION *session); /* * OEMCrypto_CloseSession * * Description: * The API provides for session based crypto termination for AES CTR mode. * * Parameters: * session (in) - crypto session identifier. * * Threading: * No other Open/Close session calls will be made while this function is * running. Functions on existing sessions may be called while this function * is active. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_INVALID_SESSION no open session with that id. * OEMCrypto_ERROR_CLOSE_SESSION_FAILED failed to terminate the crypto session */ OEMCryptoResult OEMCrypto_CloseSession(OEMCrypto_SESSION session); /* * OEMCrypto_GenerateDerivedKeys * * Description: * Generates a pair of secondary keys, mac_key and encrypt_key, for handling * signing and content key decryption under the license server protocol * for AES CTR mode. * * Refer to document "OEMCrypto Changes for V2 License Protocol" for details. * This function computes the AES-128-CMAC of the enc_key_context and stores * it in secure memory as the encrypt_key, and the first half of the mac_key. * It then computes the AES-128-CMAC of the mac_key_context and stores it in * the second half of the mac_key. These two keys will be stored until the * next call to LoadKeys. * * Parameters: * session (in) - crypto session identifier. * mac_key_context (in) - pointer to memory containing context data for * computing the HMAC generation key. * mac_key_context_length (in) - length of the HMAC key context data. * enc_key_context (in) - pointer to memory containing context data for * computing the encryption key. * enc_key_context_length (in) - length of the encryption key context data. * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT */ OEMCryptoResult OEMCrypto_GenerateDerivedKeys( OEMCrypto_SESSION session, const uint8_t *mac_key_context, uint32_t mac_key_context_length, const uint8_t *enc_key_context, uint32_t enc_key_context_length); /* * OEMCrypto_GenerateNonce * * Description: * Generates a 32-bit nonce to detect possible replay attack on the key * control block. * * Refer to documents "OEMCrypto Changes for V2 License Protocol" and "Key * Control Block Definition" for details. * * XXX TODO: Verify design needs more than one nonce per session. If not, * I will add a comment saying only once nonce is stored. If so, I will add * a comment saying how many nonces needed. Nancy needs nine nonces, and Ned * never needs any. * * Parameters: * session (in) - crypto session identifier. * message (in) - pointer to memory containing message to be signed. * message_length (in) - length of the message. * signature (out) - pointer to memory to received the computed signature. * signature_length (in/out) - (in) length of the signature buffer. * (out) actual length of the signature * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT */ OEMCryptoResult OEMCrypto_GenerateNonce( OEMCrypto_SESSION session, uint32_t* nonce); /* * OEMCrypto_GenerateSignature * * Description: * Generates a HMAC-SHA256 signature for license request signing under the * license server protocol for AES CTR mode. * * NOTE: OEMCrypto_GenerateDerivedKeys() must be called first to establish the * mac_key * * Refer to document "OEMCrypto Changes for V2 License Protocol" for details. * * Parameters: * session (in) - crypto session identifier. * message (in) - pointer to memory containing message to be signed. * message_length (in) - length of the message. * signature (out) - pointer to memory to received the computed signature. * signature_length (in/out) - (in) length of the signature buffer. * (out) actual length of the signature * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT */ OEMCryptoResult OEMCrypto_GenerateSignature( OEMCrypto_SESSION session, const uint8_t* message, size_t message_length, uint8_t* signature, size_t* signature_length); /* * OEMCrypto_LoadKeys * * Description: * Installs a set of keys for performing decryption in the current session. * * The relevant fields have been extracted from the License Response protocol * message, but the entire message and associated signature are provided so * the message can be verified (using HMAC-SHA256 with the derived mac_key). * If the signature verification fails, ignore all other arguments and return * OEMCrypto_ERROR_SIGNATURE_FAILURE. Otherwise, add the keys to the session * context. * * The keys will be decrypted using the current encrypt_key (AES-128-CBC) and * the IV given in the KeyObject. Each key control block will be decrypted * using the corresponding content key (AES-128-CBC) and the IV given in the * KeyObject. * * If any key's control block does have valid verification fields, return * OEMCrypto_ERROR_INVALID_CONTEXT and do not install any keys. * * If any key's control block requires a nonce, and the nonce in the control * block is different from the current nonce, return * OEMCrypto_ERROR_INVALID_NONCE. In that case, do not install any keys. * * The new mac_key is decrypted with the current encrypt_key and the offered * IV. It replaces the current mac_key. * * The mac_key and encrypt_key were generated and stored by the previous call * to OEMCrypto_GenerateDerivedKeys(). The nonce was generated and stored by * the previous call to OEMCrypto_GenerateNonce(). * * NOTE: OEMCrypto_GenerateDerivedKeys() must be called first to establish the * mac_key and encrypt_key. * * Refer to document "OEMCrypto Changes for V2 License Protocol" for details. * * Parameters: * session (in) - crypto session identifier. * message (in) - pointer to memory containing message to be verified. * message_length (in) - length of the message. * signature (in) - pointer to memory containing the signature. * signature_length (in) - length of the signature. * enc_mac_key_iv (in) - IV for decrypting new mac_key. Size is 128 bits. * enc_mac_key (in) - encrypted mac_key for generating new mac_key. Size is * 128 bits. * num_keys (in) - number of keys present. * key_array (in) - set of keys to be installed. * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT * OEMCrypto_ERROR_SIGNATURE_FAILURE * OEMCrypto_ERROR_INVALID_NONCE * OEMCrypto_ERROR_TOO_MANY_KEYS */ OEMCryptoResult OEMCrypto_LoadKeys(OEMCrypto_SESSION session, const uint8_t* message, size_t message_length, const uint8_t* signature, size_t signature_length, const uint8_t* enc_mac_key_iv, const uint8_t* enc_mac_key, size_t num_keys, const OEMCrypto_KeyObject* key_array); /* * OEMCrypto_RefreshKeys * * Description: * Updates an existing set of keys for continuing decryption in the * current session. * * The relevant fields have been extracted from the Renewal Response protocol * message, but the entire message and associated signature are provided so * the message can be verified (using HMAC-SHA256 with the current mac_key). * If the signature verification fails, ignore all other arguments and return * OEMCrypto_ERROR_SIGNATURE_FAILURE. Otherwise, add the keys to the session * context. * * NOTE: OEMCrypto_GenerateDerivedKeys() or OEMCrypto_LoadKeys() must be called * first to establish the mac_key * * Refer to document OEMCrypto Changes for V2 License Protocol for details. * * Parameters: * session (in) - crypto session identifier. * message (in) - pointer to memory containing message to be verified. * message_length (in) - length of the message. * signature (in) - pointer to memory containing the signature. * signature_length (in) - length of the signature. * num_keys (in) - number of keys present. * key_array (in) - set of keys to be installed. * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT * OEMCrypto_ERROR_SIGNATURE_FAILURE */ OEMCryptoResult OEMCrypto_RefreshKeys(OEMCrypto_SESSION session, const uint8_t* message, size_t message_length, const uint8_t* signature, size_t signature_length, size_t num_keys, const OEMCrypto_KeyRefreshObject* key_array); /* * OEMCrypto_SelectKey * * Description: * Select a content key and install it in the hardware key ladder for * subsequent decryption operations (OEMCrypto_DecryptCTR()) for this session. * The specified key must have been previously "installed" via * OEMCrypto_LoadKeys() or OEMCrypto_RefreshKeys(). * * A key control block is associated with the key and the session, and is used * to configure the session context. The Key Control data is documented in * "Key Control Block Definition". * * Step 1: Lookup the content key data via the offered key_id. The key data * includes the key value, the content key IV, the key control * block, and the key control block IV. * * Step 2: Latch the content key into the hardware key ladder. Set * permission flags and timers based on the key's control block. * * Step 3: use the latched content key to decrypt (AES-128-CTR) * to decrypt buffers passed in via OEMCrypto_DecryptCTR(). Continue * to use this key until OEMCrypto_SelectKey() is called again, or * until OEMCrypto_CloseSession() is called. * * Parameters: * session (in) - crypto session identifier * key_id (in) - pointer to the Key ID * key_id_length (in) - length of the Key ID in bytes * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_INVALID_SESSION crypto session ID invalid or not open * OEMCrypto_ERROR_NO_DEVICE_KEY failed to decrypt device key * OEMCrypto_ERROR_NO_CONTENT_KEY failed to decrypt content key * OEMCrypto_ERROR_CONTROL_INVALID invalid or unsupported control input * OEMCrypto_ERROR_KEYBOX_INVALID cannot decrypt and read from Keybox */ OEMCryptoResult OEMCrypto_SelectKey(const OEMCrypto_SESSION session, const OEMCrypto_KeyID* key_id); /* * OEMCrypto_DecryptCTR * * Description: * * The API decrypts (AES-CTR) the payload in the buffer referenced by * the buffer_addr parameter into an internal buffer, using the key * identified by key_id. * * Parameters: * session (in) - crypto session identifier. * data_addr (in) - An unaligned pointer to this segment of the stream. * data_length (in) - The length of this segment of the stream. * is_encrypted (in) - True if the buffer described by data_addr, * data_length is encrypted. If is_encrypted is false, only the * data_addr and data_length parameters are used. The iv and offset * arguments are ignored. * iv (in) - The initial value block to be used for content decryption. * This is discussed further below. * offset (in) - If non-zero, the decryption block boundary is different * from the start of the data. offset should be subtracted from * data_addr to compute the starting address of the first decrypted * block. The bytes between the decryption block start address and * data_addr are discarded after decryption. * out_buffer (in) - A caller-owned descriptor that specifies the * handling of the decrypted byte stream. See OEMCrypto_DestbufferDesc * for details. * * AES CTR is a stream cipher. The stream may be composed of arbitrary- * length clear and encrypted segments. The encrypted portions of a sample * are collectively treated as a continuous sequence of decryption * block-sized blocks even though the sequence is interrupted by clear blocks. * This means a given encrypted segment may not start or end on a decryption * block boundary. * * If data_addr is not aligned with a decryption block boundary (offset != 0), * the additional offset bytes before data_addr (pre-padding) are included in * the decrypt operation, and they are dropped after decryption. If * data_length + offset is not a multiple of the decryption block size, the * extra bytes in the final decryption block (post-padding) are also dropped * after decryption. The caller is responsible for guaranteeing that all * memory addresses from (data-addr - pre-padding) to (data-addr + * data-length + post-padding) are valid memory addresses. * * After decrypting the entire buffer including any pre-padding and * post-padding, send data_length bytes starting at data_addr to the decoder. * * NOTES: * IV points to the counter value to be used for the initial * encrypted block of the input buffer. The IV length is the AES * block size. For subsequent encrypted AES blocks the IV is * calculated by incrementing the lower 64 bits (byte 8-15) of the * IV value used for the previous block. The counter rolls over to * zero when it reaches its maximum value (0xFFFFFFFFFFFFFFFF). * The upper 64 bits (byte 0-7) of the IV do not change. * * Threading: * This function may be called simultaneously with functions on other sessions, * but not with other functions on this session. * * Returns: * OEMCrypto_SUCCESS * OEMCrypto_ERROR_NO_DEVICE_KEY * OEMCrypto_ERROR_INVALID_SESSION * OEMCrypto_ERROR_UNKNOWN_FAILURE * OEMCrypto_ERROR_INVALID_CONTEXT * OEMCrypto_ERROR_DECRYPT_FAILED */ OEMCryptoResult OEMCrypto_DecryptCTR(OEMCrypto_SESSION session, const uint8_t *data_addr, size_t data_length, bool is_encrypted, const uint8_t *iv, size_t offset, const OEMCrypto_DestBufferDesc* out_buffer); /* * OEMCrypto_InstallKeybox * * Description: * Unwrap and store the keybox to persistent memory. * The device key must be stored securely. The device key will be decrypted * and latched into hardware key ladder by OEMCrypto_SetEntitlementKey. * * This function is used once to load the keybox onto the device at * provisioning time. * * Parameters: * keybox (in) - Pointer to clear keybox data. Must have been originally * wrapped with OEMCrypto_WrapKeybox. * keyboxLength (in) - Length of the keybox data in bytes. * * Threading: * This function is not called simultaneously with any other functions. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_WRITE_KEYBOX failed to handle and store Keybox */ OEMCryptoResult OEMCrypto_InstallKeybox(uint8_t *keybox, size_t keyBoxLength); /* * OEMCrypto_IsKeyboxValid * * Description: * Validate the Widevine Keybox stored on the device. * * The API performs two verification steps on the Keybox. It first verifies * the MAGIC field contains a valid signature (must be 'kbox'). The API then * computes the CRC using CRC-32 (Posix 1003.2 standard) and compares the * checksum to the CRC stored in the Keybox. The CRC is computed over the * entire Keybox excluding the 4 CRC bytes (i.e. Keybox[0..123]). * * Parameters: * none * * Threading: * This function may be called simultaneously with any session functions. * * Returns: * OEMCrypto_SUCCESS * OEMCrypto_ERROR_BAD_MAGIC * OEMCrypto_ERROR_BAD_CRC */ OEMCryptoResult OEMCrypto_IsKeyboxValid(void); /* * OEMCrypto_GetDeviceID * * Description: * Retrieve the device's unique identifier from the Keybox. * * Parameters: * deviceId (out) - pointer to the buffer that receives the Device ID * idLength (in/out) - on input, size of the caller's device ID buffer. * On output, the number of bytes written into the buffer. * * Threading: * This function may be called simultaneously with any session functions. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_SHORT_BUFFER buffer is too small to return the device ID * OEMCrypto_ERROR_NO_DEVICEID failed to return Device Id */ OEMCryptoResult OEMCrypto_GetDeviceID(uint8_t* deviceID, size_t *idLength); /* * OEMCrypto_GetKeyData * * Description: * Returns the Key Data field from the Keybox. The Key Data field does not * need to be encrypted by an OEM root key, but may be if desired. * * If the Key Data field was encrypted with an OEM root key when the Keybox * was stored on the device, then this function should decrypt it and return * the clear Key Data. If the Key Data was not encrypted, then this function * should just access and return the clear Key data. * * Parameters: * keyData (out) - pointer to a caller-managed buffer to hold the Key Data * field from the Keybox * dataLength (in/out) - on input, the allocated buffer size. On output, * the number of bytes in KeyData. * * Threading: * This function may be called simultaneously with any session functions. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_SHORT_BUFFER the buffer is too small to return the KeyData * OEMCrypto_ERROR_NO_KEYDATA failed to return KeyData */ OEMCryptoResult OEMCrypto_GetKeyData(uint8_t* keyData, size_t *keyDataLength); /* * OEMCrypto_GetRandom * * Description: * Return a buffer filled with hardware-generated random bytes. If the * hardware feature does not exist, return OEMCrypto_ERROR_RNG_NOT_SUPPORTED. * * Parameters: * randomData (out) - Pointer to caller-manager buffer that will receive the * random data. * dataLength (in) - Length of the random data buffer in bytes. * * Threading: * This function may be called simultaneously with any session functions. * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_RNG_FAILED failed to generate random number * OEMCrypto_ERROR_RNG_NOT_SUPPORTED function not supported */ OEMCryptoResult OEMCrypto_GetRandom(uint8_t* randomData, size_t dataLength); /* * OEMCrypto_WrapKeybox * * Description: * Wrap the Keybox with a key derived for the device key. If transportKey * is not NULL, the input keybox is encrypted with transportKey. If so, * decrypt the input keybox before wrapping it, using transportKey in AES-CBC * mode with an IV of all zeroes. This function is only needed if the * provisioning method involves saving the keybox to the file system. * * Parameters: * keybox (in) - Pointer to keybox data. * keyboxLength - Length of the Keybox data in bytes * wrappedKeybox (out) - Pointer to wrapped keybox * wrappedKeyboxLength (out) - Pointer to the length of the wrapped keybox in * bytes * transportKey (in) - An optional AES transport key. If provided, the input * keybox is encrypted with this transport key with AES-CBC * and a null IV. * transportKeyLength - number of bytes in the transportKey * * Returns: * OEMCrypto_SUCCESS success * OEMCrypto_ERROR_WRAP_KEYBOX failed to wrap Keybox * OEMCrypto_ERROR_NOT_IMPLEMENTED */ OEMCryptoResult OEMCrypto_WrapKeybox(uint8_t *keybox, size_t keyBoxLength, uint8_t *wrappedKeybox, size_t *wrappedKeyBoxLength, uint8_t *transportKey, size_t transportKeyLength); #ifdef __cplusplus } #endif #endif // OEMCRYPTO_DASH_H_