11bb92983SJerome Forissier /* SPDX-License-Identifier: BSD-2-Clause */ 2b0104773SPascal Brand /* 3b0104773SPascal Brand * Copyright (c) 2014, STMicroelectronics International N.V. 4b0104773SPascal Brand */ 5b0104773SPascal Brand 6b0104773SPascal Brand /* Based on GP TEE Internal API Specification Version 0.27 */ 7b0104773SPascal Brand #ifndef TEE_INTERNAL_API_H 8b0104773SPascal Brand #define TEE_INTERNAL_API_H 9b0104773SPascal Brand 108bbc2e9cSJens Wiklander #ifdef __TEE_API_COMPAT_H 118bbc2e9cSJens Wiklander #error "<tee_api_compat.h> must not be included before <tee_internal_api.h>" 128bbc2e9cSJens Wiklander #endif 138bbc2e9cSJens Wiklander 144b0f9953SJens Wiklander #include <compiler.h> 154b0f9953SJens Wiklander #include <stddef.h> 16b0104773SPascal Brand #include <tee_api_defines.h> 17b0104773SPascal Brand #include <tee_api_types.h> 184b0f9953SJens Wiklander #include <trace.h> 19b0104773SPascal Brand 204b0f9953SJens Wiklander /* Property access functions */ 214b0f9953SJens Wiklander 224b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsString(TEE_PropSetHandle propsetOrEnumerator, 234b0f9953SJens Wiklander const char *name, char *valueBuffer, 244b0f9953SJens Wiklander uint32_t *valueBufferLen); 254b0f9953SJens Wiklander 264b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsBool(TEE_PropSetHandle propsetOrEnumerator, 274b0f9953SJens Wiklander const char *name, bool *value); 284b0f9953SJens Wiklander 294b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsU32(TEE_PropSetHandle propsetOrEnumerator, 304b0f9953SJens Wiklander const char *name, uint32_t *value); 314b0f9953SJens Wiklander 324b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsBinaryBlock(TEE_PropSetHandle propsetOrEnumerator, 334b0f9953SJens Wiklander const char *name, void *valueBuffer, 344b0f9953SJens Wiklander uint32_t *valueBufferLen); 354b0f9953SJens Wiklander 364b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsUUID(TEE_PropSetHandle propsetOrEnumerator, 374b0f9953SJens Wiklander const char *name, TEE_UUID *value); 384b0f9953SJens Wiklander 394b0f9953SJens Wiklander TEE_Result TEE_GetPropertyAsIdentity(TEE_PropSetHandle propsetOrEnumerator, 404b0f9953SJens Wiklander const char *name, TEE_Identity *value); 414b0f9953SJens Wiklander 424b0f9953SJens Wiklander TEE_Result TEE_AllocatePropertyEnumerator(TEE_PropSetHandle *enumerator); 434b0f9953SJens Wiklander 444b0f9953SJens Wiklander void TEE_FreePropertyEnumerator(TEE_PropSetHandle enumerator); 454b0f9953SJens Wiklander 464b0f9953SJens Wiklander void TEE_StartPropertyEnumerator(TEE_PropSetHandle enumerator, 474b0f9953SJens Wiklander TEE_PropSetHandle propSet); 484b0f9953SJens Wiklander 494b0f9953SJens Wiklander void TEE_ResetPropertyEnumerator(TEE_PropSetHandle enumerator); 504b0f9953SJens Wiklander 514b0f9953SJens Wiklander TEE_Result TEE_GetPropertyName(TEE_PropSetHandle enumerator, 524b0f9953SJens Wiklander void *nameBuffer, uint32_t *nameBufferLen); 534b0f9953SJens Wiklander 544b0f9953SJens Wiklander TEE_Result TEE_GetNextProperty(TEE_PropSetHandle enumerator); 554b0f9953SJens Wiklander 564b0f9953SJens Wiklander /* System API - Misc */ 574b0f9953SJens Wiklander 584b0f9953SJens Wiklander void TEE_Panic(TEE_Result panicCode); 594b0f9953SJens Wiklander 604b0f9953SJens Wiklander /* System API - Internal Client API */ 614b0f9953SJens Wiklander 624b0f9953SJens Wiklander TEE_Result TEE_OpenTASession(const TEE_UUID *destination, 634b0f9953SJens Wiklander uint32_t cancellationRequestTimeout, 644b0f9953SJens Wiklander uint32_t paramTypes, 654b0f9953SJens Wiklander TEE_Param params[TEE_NUM_PARAMS], 664b0f9953SJens Wiklander TEE_TASessionHandle *session, 674b0f9953SJens Wiklander uint32_t *returnOrigin); 684b0f9953SJens Wiklander 694b0f9953SJens Wiklander void TEE_CloseTASession(TEE_TASessionHandle session); 704b0f9953SJens Wiklander 714b0f9953SJens Wiklander TEE_Result TEE_InvokeTACommand(TEE_TASessionHandle session, 724b0f9953SJens Wiklander uint32_t cancellationRequestTimeout, 734b0f9953SJens Wiklander uint32_t commandID, uint32_t paramTypes, 744b0f9953SJens Wiklander TEE_Param params[TEE_NUM_PARAMS], 754b0f9953SJens Wiklander uint32_t *returnOrigin); 764b0f9953SJens Wiklander 774b0f9953SJens Wiklander /* System API - Cancellations */ 784b0f9953SJens Wiklander 794b0f9953SJens Wiklander bool TEE_GetCancellationFlag(void); 804b0f9953SJens Wiklander 814b0f9953SJens Wiklander bool TEE_UnmaskCancellation(void); 824b0f9953SJens Wiklander 834b0f9953SJens Wiklander bool TEE_MaskCancellation(void); 844b0f9953SJens Wiklander 854b0f9953SJens Wiklander /* System API - Memory Management */ 864b0f9953SJens Wiklander 874b0f9953SJens Wiklander TEE_Result TEE_CheckMemoryAccessRights(uint32_t accessFlags, void *buffer, 884b0f9953SJens Wiklander uint32_t size); 894b0f9953SJens Wiklander 904b0f9953SJens Wiklander void TEE_SetInstanceData(const void *instanceData); 914b0f9953SJens Wiklander 924b0f9953SJens Wiklander const void *TEE_GetInstanceData(void); 934b0f9953SJens Wiklander 944b0f9953SJens Wiklander void *TEE_Malloc(uint32_t size, uint32_t hint); 954b0f9953SJens Wiklander 964b0f9953SJens Wiklander void *TEE_Realloc(void *buffer, uint32_t newSize); 974b0f9953SJens Wiklander 984b0f9953SJens Wiklander void TEE_Free(void *buffer); 994b0f9953SJens Wiklander 1004b0f9953SJens Wiklander void *TEE_MemMove(void *dest, const void *src, uint32_t size); 1014b0f9953SJens Wiklander 1024b0f9953SJens Wiklander /* 1034b0f9953SJens Wiklander * Note: TEE_MemCompare() has a constant-time implementation (execution time 1044b0f9953SJens Wiklander * does not depend on buffer content but only on buffer size). It is the main 1054b0f9953SJens Wiklander * difference with memcmp(). 1064b0f9953SJens Wiklander */ 1074b0f9953SJens Wiklander int32_t TEE_MemCompare(const void *buffer1, const void *buffer2, uint32_t size); 1084b0f9953SJens Wiklander 10932c75600SJens Wiklander void TEE_MemFill(void *buff, uint32_t x, uint32_t size); 1104b0f9953SJens Wiklander 1114b0f9953SJens Wiklander /* Data and Key Storage API - Generic Object Functions */ 1124b0f9953SJens Wiklander 1134b0f9953SJens Wiklander void TEE_GetObjectInfo(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 114*d372a47cSJens Wiklander void __GP11_TEE_GetObjectInfo(TEE_ObjectHandle object, 115*d372a47cSJens Wiklander __GP11_TEE_ObjectInfo *objectInfo); 116*d372a47cSJens Wiklander 1174b0f9953SJens Wiklander TEE_Result TEE_GetObjectInfo1(TEE_ObjectHandle object, 1184b0f9953SJens Wiklander TEE_ObjectInfo *objectInfo); 119*d372a47cSJens Wiklander TEE_Result __GP11_TEE_GetObjectInfo1(TEE_ObjectHandle object, 120*d372a47cSJens Wiklander __GP11_TEE_ObjectInfo *objectInfo); 1214b0f9953SJens Wiklander 1224b0f9953SJens Wiklander void TEE_RestrictObjectUsage(TEE_ObjectHandle object, uint32_t objectUsage); 1234b0f9953SJens Wiklander TEE_Result TEE_RestrictObjectUsage1(TEE_ObjectHandle object, 1244b0f9953SJens Wiklander uint32_t objectUsage); 1254b0f9953SJens Wiklander 1264b0f9953SJens Wiklander TEE_Result TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 1274b0f9953SJens Wiklander uint32_t attributeID, void *buffer, 1284b0f9953SJens Wiklander uint32_t *size); 1294b0f9953SJens Wiklander 1304b0f9953SJens Wiklander TEE_Result TEE_GetObjectValueAttribute(TEE_ObjectHandle object, 1314b0f9953SJens Wiklander uint32_t attributeID, uint32_t *a, 1324b0f9953SJens Wiklander uint32_t *b); 1334b0f9953SJens Wiklander 1344b0f9953SJens Wiklander void TEE_CloseObject(TEE_ObjectHandle object); 1354b0f9953SJens Wiklander 1364b0f9953SJens Wiklander /* Data and Key Storage API - Transient Object Functions */ 1374b0f9953SJens Wiklander 1384b0f9953SJens Wiklander TEE_Result TEE_AllocateTransientObject(TEE_ObjectType objectType, 1394b0f9953SJens Wiklander uint32_t maxKeySize, 1404b0f9953SJens Wiklander TEE_ObjectHandle *object); 1414b0f9953SJens Wiklander 1424b0f9953SJens Wiklander void TEE_FreeTransientObject(TEE_ObjectHandle object); 1434b0f9953SJens Wiklander 1444b0f9953SJens Wiklander void TEE_ResetTransientObject(TEE_ObjectHandle object); 1454b0f9953SJens Wiklander 1464b0f9953SJens Wiklander TEE_Result TEE_PopulateTransientObject(TEE_ObjectHandle object, 1474b0f9953SJens Wiklander const TEE_Attribute *attrs, 1484b0f9953SJens Wiklander uint32_t attrCount); 1494b0f9953SJens Wiklander 1504b0f9953SJens Wiklander void TEE_InitRefAttribute(TEE_Attribute *attr, uint32_t attributeID, 1514b0f9953SJens Wiklander const void *buffer, uint32_t length); 1524b0f9953SJens Wiklander 1534b0f9953SJens Wiklander void TEE_InitValueAttribute(TEE_Attribute *attr, uint32_t attributeID, 1544b0f9953SJens Wiklander uint32_t a, uint32_t b); 1554b0f9953SJens Wiklander 1564b0f9953SJens Wiklander void TEE_CopyObjectAttributes(TEE_ObjectHandle destObject, 1574b0f9953SJens Wiklander TEE_ObjectHandle srcObject); 1584b0f9953SJens Wiklander 1594b0f9953SJens Wiklander TEE_Result TEE_CopyObjectAttributes1(TEE_ObjectHandle destObject, 1604b0f9953SJens Wiklander TEE_ObjectHandle srcObject); 1614b0f9953SJens Wiklander 1624b0f9953SJens Wiklander TEE_Result TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 1634b0f9953SJens Wiklander const TEE_Attribute *params, uint32_t paramCount); 1644b0f9953SJens Wiklander 1654b0f9953SJens Wiklander /* Data and Key Storage API - Persistent Object Functions */ 1664b0f9953SJens Wiklander 1674b0f9953SJens Wiklander TEE_Result TEE_OpenPersistentObject(uint32_t storageID, const void *objectID, 1684b0f9953SJens Wiklander uint32_t objectIDLen, uint32_t flags, 1694b0f9953SJens Wiklander TEE_ObjectHandle *object); 1704b0f9953SJens Wiklander 1714b0f9953SJens Wiklander TEE_Result TEE_CreatePersistentObject(uint32_t storageID, const void *objectID, 1724b0f9953SJens Wiklander uint32_t objectIDLen, uint32_t flags, 1734b0f9953SJens Wiklander TEE_ObjectHandle attributes, 1744b0f9953SJens Wiklander const void *initialData, 1754b0f9953SJens Wiklander uint32_t initialDataLen, 1764b0f9953SJens Wiklander TEE_ObjectHandle *object); 1774b0f9953SJens Wiklander 1784b0f9953SJens Wiklander void TEE_CloseAndDeletePersistentObject(TEE_ObjectHandle object); 1794b0f9953SJens Wiklander 1804b0f9953SJens Wiklander TEE_Result TEE_CloseAndDeletePersistentObject1(TEE_ObjectHandle object); 1814b0f9953SJens Wiklander 1824b0f9953SJens Wiklander TEE_Result TEE_RenamePersistentObject(TEE_ObjectHandle object, 1834b0f9953SJens Wiklander const void *newObjectID, 1844b0f9953SJens Wiklander uint32_t newObjectIDLen); 1854b0f9953SJens Wiklander 1864b0f9953SJens Wiklander TEE_Result TEE_AllocatePersistentObjectEnumerator(TEE_ObjectEnumHandle * 1874b0f9953SJens Wiklander objectEnumerator); 1884b0f9953SJens Wiklander 1894b0f9953SJens Wiklander void TEE_FreePersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 1904b0f9953SJens Wiklander 1914b0f9953SJens Wiklander void TEE_ResetPersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 1924b0f9953SJens Wiklander 1934b0f9953SJens Wiklander TEE_Result TEE_StartPersistentObjectEnumerator(TEE_ObjectEnumHandle 1944b0f9953SJens Wiklander objectEnumerator, 1954b0f9953SJens Wiklander uint32_t storageID); 1964b0f9953SJens Wiklander 1974b0f9953SJens Wiklander TEE_Result TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 1984b0f9953SJens Wiklander TEE_ObjectInfo *objectInfo, 1994b0f9953SJens Wiklander void *objectID, uint32_t *objectIDLen); 200*d372a47cSJens Wiklander TEE_Result 201*d372a47cSJens Wiklander __GP11_TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 202*d372a47cSJens Wiklander __GP11_TEE_ObjectInfo *objectInfo, 203*d372a47cSJens Wiklander void *objectID, uint32_t *objectIDLen); 2044b0f9953SJens Wiklander 2054b0f9953SJens Wiklander /* Data and Key Storage API - Data Stream Access Functions */ 2064b0f9953SJens Wiklander 2074b0f9953SJens Wiklander TEE_Result TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 2084b0f9953SJens Wiklander uint32_t size, uint32_t *count); 2094b0f9953SJens Wiklander 2104b0f9953SJens Wiklander TEE_Result TEE_WriteObjectData(TEE_ObjectHandle object, const void *buffer, 2114b0f9953SJens Wiklander uint32_t size); 2124b0f9953SJens Wiklander 2134b0f9953SJens Wiklander TEE_Result TEE_TruncateObjectData(TEE_ObjectHandle object, uint32_t size); 2144b0f9953SJens Wiklander 2154b0f9953SJens Wiklander TEE_Result TEE_SeekObjectData(TEE_ObjectHandle object, int32_t offset, 2164b0f9953SJens Wiklander TEE_Whence whence); 2174b0f9953SJens Wiklander 2184b0f9953SJens Wiklander /* Cryptographic Operations API - Generic Operation Functions */ 2194b0f9953SJens Wiklander 2204b0f9953SJens Wiklander TEE_Result TEE_AllocateOperation(TEE_OperationHandle *operation, 2214b0f9953SJens Wiklander uint32_t algorithm, uint32_t mode, 2224b0f9953SJens Wiklander uint32_t maxKeySize); 2234b0f9953SJens Wiklander 2244b0f9953SJens Wiklander void TEE_FreeOperation(TEE_OperationHandle operation); 2254b0f9953SJens Wiklander 2264b0f9953SJens Wiklander void TEE_GetOperationInfo(TEE_OperationHandle operation, 2274b0f9953SJens Wiklander TEE_OperationInfo *operationInfo); 2284b0f9953SJens Wiklander 2294b0f9953SJens Wiklander TEE_Result 2304b0f9953SJens Wiklander TEE_GetOperationInfoMultiple(TEE_OperationHandle operation, 2314b0f9953SJens Wiklander TEE_OperationInfoMultiple *operationInfoMultiple, 2324b0f9953SJens Wiklander uint32_t *operationSize); 2334b0f9953SJens Wiklander 2344b0f9953SJens Wiklander void TEE_ResetOperation(TEE_OperationHandle operation); 2354b0f9953SJens Wiklander 2364b0f9953SJens Wiklander TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 2374b0f9953SJens Wiklander TEE_ObjectHandle key); 2384b0f9953SJens Wiklander 2394b0f9953SJens Wiklander TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 2404b0f9953SJens Wiklander TEE_ObjectHandle key1, TEE_ObjectHandle key2); 2414b0f9953SJens Wiklander 2424b0f9953SJens Wiklander void TEE_CopyOperation(TEE_OperationHandle dstOperation, 2434b0f9953SJens Wiklander TEE_OperationHandle srcOperation); 2444b0f9953SJens Wiklander 2454b0f9953SJens Wiklander TEE_Result TEE_IsAlgorithmSupported(uint32_t algId, uint32_t element); 2464b0f9953SJens Wiklander 2474b0f9953SJens Wiklander /* Cryptographic Operations API - Message Digest Functions */ 2484b0f9953SJens Wiklander 2494b0f9953SJens Wiklander void TEE_DigestUpdate(TEE_OperationHandle operation, 2504b0f9953SJens Wiklander const void *chunk, uint32_t chunkSize); 2514b0f9953SJens Wiklander 2524b0f9953SJens Wiklander TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 2534b0f9953SJens Wiklander uint32_t chunkLen, void *hash, uint32_t *hashLen); 2544b0f9953SJens Wiklander 2554b0f9953SJens Wiklander /* Cryptographic Operations API - Symmetric Cipher Functions */ 2564b0f9953SJens Wiklander 2574b0f9953SJens Wiklander void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 2584b0f9953SJens Wiklander uint32_t IVLen); 2594b0f9953SJens Wiklander 2604b0f9953SJens Wiklander TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 2614b0f9953SJens Wiklander uint32_t srcLen, void *destData, uint32_t *destLen); 2624b0f9953SJens Wiklander 2634b0f9953SJens Wiklander TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 2644b0f9953SJens Wiklander const void *srcData, uint32_t srcLen, 2654b0f9953SJens Wiklander void *destData, uint32_t *destLen); 2664b0f9953SJens Wiklander 2674b0f9953SJens Wiklander /* Cryptographic Operations API - MAC Functions */ 2684b0f9953SJens Wiklander 2694b0f9953SJens Wiklander void TEE_MACInit(TEE_OperationHandle operation, const void *IV, 2704b0f9953SJens Wiklander uint32_t IVLen); 2714b0f9953SJens Wiklander 2724b0f9953SJens Wiklander void TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 2734b0f9953SJens Wiklander uint32_t chunkSize); 2744b0f9953SJens Wiklander 2754b0f9953SJens Wiklander TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 2764b0f9953SJens Wiklander const void *message, uint32_t messageLen, 2774b0f9953SJens Wiklander void *mac, uint32_t *macLen); 2784b0f9953SJens Wiklander 2794b0f9953SJens Wiklander TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 2804b0f9953SJens Wiklander const void *message, uint32_t messageLen, 2814b0f9953SJens Wiklander const void *mac, uint32_t macLen); 2824b0f9953SJens Wiklander 2834b0f9953SJens Wiklander /* Cryptographic Operations API - Authenticated Encryption Functions */ 2844b0f9953SJens Wiklander 2854b0f9953SJens Wiklander TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 2864b0f9953SJens Wiklander uint32_t nonceLen, uint32_t tagLen, uint32_t AADLen, 2874b0f9953SJens Wiklander uint32_t payloadLen); 2884b0f9953SJens Wiklander 2894b0f9953SJens Wiklander void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 2904b0f9953SJens Wiklander uint32_t AADdataLen); 2914b0f9953SJens Wiklander 2924b0f9953SJens Wiklander TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 2934b0f9953SJens Wiklander uint32_t srcLen, void *destData, uint32_t *destLen); 2944b0f9953SJens Wiklander 2954b0f9953SJens Wiklander TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 2964b0f9953SJens Wiklander const void *srcData, uint32_t srcLen, 2974b0f9953SJens Wiklander void *destData, uint32_t *destLen, void *tag, 2984b0f9953SJens Wiklander uint32_t *tagLen); 2994b0f9953SJens Wiklander 3004b0f9953SJens Wiklander TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 3014b0f9953SJens Wiklander const void *srcData, uint32_t srcLen, 3024b0f9953SJens Wiklander void *destData, uint32_t *destLen, void *tag, 3034b0f9953SJens Wiklander uint32_t tagLen); 3044b0f9953SJens Wiklander 3054b0f9953SJens Wiklander /* Cryptographic Operations API - Asymmetric Functions */ 3064b0f9953SJens Wiklander 3074b0f9953SJens Wiklander TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 3084b0f9953SJens Wiklander const TEE_Attribute *params, 3094b0f9953SJens Wiklander uint32_t paramCount, const void *srcData, 3104b0f9953SJens Wiklander uint32_t srcLen, void *destData, 3114b0f9953SJens Wiklander uint32_t *destLen); 3124b0f9953SJens Wiklander 3134b0f9953SJens Wiklander TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 3144b0f9953SJens Wiklander const TEE_Attribute *params, 3154b0f9953SJens Wiklander uint32_t paramCount, const void *srcData, 3164b0f9953SJens Wiklander uint32_t srcLen, void *destData, 3174b0f9953SJens Wiklander uint32_t *destLen); 3184b0f9953SJens Wiklander 3194b0f9953SJens Wiklander TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 3204b0f9953SJens Wiklander const TEE_Attribute *params, 3214b0f9953SJens Wiklander uint32_t paramCount, const void *digest, 3224b0f9953SJens Wiklander uint32_t digestLen, void *signature, 3234b0f9953SJens Wiklander uint32_t *signatureLen); 3244b0f9953SJens Wiklander 3254b0f9953SJens Wiklander TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 3264b0f9953SJens Wiklander const TEE_Attribute *params, 3274b0f9953SJens Wiklander uint32_t paramCount, const void *digest, 3284b0f9953SJens Wiklander uint32_t digestLen, const void *signature, 3294b0f9953SJens Wiklander uint32_t signatureLen); 3304b0f9953SJens Wiklander 3314b0f9953SJens Wiklander /* Cryptographic Operations API - Key Derivation Functions */ 3324b0f9953SJens Wiklander 3334b0f9953SJens Wiklander void TEE_DeriveKey(TEE_OperationHandle operation, 3344b0f9953SJens Wiklander const TEE_Attribute *params, uint32_t paramCount, 3354b0f9953SJens Wiklander TEE_ObjectHandle derivedKey); 3364b0f9953SJens Wiklander 3374b0f9953SJens Wiklander /* Cryptographic Operations API - Random Number Generation Functions */ 3384b0f9953SJens Wiklander 3394b0f9953SJens Wiklander void TEE_GenerateRandom(void *randomBuffer, uint32_t randomBufferLen); 3404b0f9953SJens Wiklander 3414b0f9953SJens Wiklander /* Date & Time API */ 3424b0f9953SJens Wiklander 3434b0f9953SJens Wiklander void TEE_GetSystemTime(TEE_Time *time); 3444b0f9953SJens Wiklander 3454b0f9953SJens Wiklander TEE_Result TEE_Wait(uint32_t timeout); 3464b0f9953SJens Wiklander 3474b0f9953SJens Wiklander TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 3484b0f9953SJens Wiklander 3494b0f9953SJens Wiklander TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 3504b0f9953SJens Wiklander 3514b0f9953SJens Wiklander void TEE_GetREETime(TEE_Time *time); 3524b0f9953SJens Wiklander 3534b0f9953SJens Wiklander /* TEE Arithmetical API - Memory allocation and size of objects */ 3544b0f9953SJens Wiklander 3554b0f9953SJens Wiklander uint32_t TEE_BigIntFMMSizeInU32(uint32_t modulusSizeInBits); 3564b0f9953SJens Wiklander 3574b0f9953SJens Wiklander uint32_t TEE_BigIntFMMContextSizeInU32(uint32_t modulusSizeInBits); 3584b0f9953SJens Wiklander 3594b0f9953SJens Wiklander /* TEE Arithmetical API - Initialization functions */ 3604b0f9953SJens Wiklander 3614b0f9953SJens Wiklander void TEE_BigIntInit(TEE_BigInt *bigInt, uint32_t len); 3624b0f9953SJens Wiklander 3634b0f9953SJens Wiklander void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, uint32_t len, 3644b0f9953SJens Wiklander const TEE_BigInt *modulus); 3654b0f9953SJens Wiklander 3664b0f9953SJens Wiklander void TEE_BigIntInitFMM(TEE_BigIntFMM *bigIntFMM, uint32_t len); 3674b0f9953SJens Wiklander 3684b0f9953SJens Wiklander /* TEE Arithmetical API - Converter functions */ 3694b0f9953SJens Wiklander 3704b0f9953SJens Wiklander TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 3714b0f9953SJens Wiklander const uint8_t *buffer, 3724b0f9953SJens Wiklander uint32_t bufferLen, 3734b0f9953SJens Wiklander int32_t sign); 3744b0f9953SJens Wiklander 3754b0f9953SJens Wiklander TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, uint32_t *bufferLen, 3764b0f9953SJens Wiklander const TEE_BigInt *bigInt); 3774b0f9953SJens Wiklander 3784b0f9953SJens Wiklander void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 3794b0f9953SJens Wiklander 3804b0f9953SJens Wiklander TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 3814b0f9953SJens Wiklander 3824b0f9953SJens Wiklander /* TEE Arithmetical API - Logical operations */ 3834b0f9953SJens Wiklander 3844b0f9953SJens Wiklander int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 3854b0f9953SJens Wiklander 3864b0f9953SJens Wiklander int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 3874b0f9953SJens Wiklander 3884b0f9953SJens Wiklander void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 3894b0f9953SJens Wiklander size_t bits); 3904b0f9953SJens Wiklander 3914b0f9953SJens Wiklander bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 3924b0f9953SJens Wiklander 3934b0f9953SJens Wiklander uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 3944b0f9953SJens Wiklander 3954b0f9953SJens Wiklander void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 3964b0f9953SJens Wiklander const TEE_BigInt *op2); 3974b0f9953SJens Wiklander 3984b0f9953SJens Wiklander void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 3994b0f9953SJens Wiklander const TEE_BigInt *op2); 4004b0f9953SJens Wiklander 4014b0f9953SJens Wiklander void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 4024b0f9953SJens Wiklander 4034b0f9953SJens Wiklander void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 4044b0f9953SJens Wiklander const TEE_BigInt *op2); 4054b0f9953SJens Wiklander 4064b0f9953SJens Wiklander void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 4074b0f9953SJens Wiklander 4084b0f9953SJens Wiklander void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 4094b0f9953SJens Wiklander const TEE_BigInt *op1, const TEE_BigInt *op2); 4104b0f9953SJens Wiklander 4114b0f9953SJens Wiklander /* TEE Arithmetical API - Modular arithmetic operations */ 4124b0f9953SJens Wiklander 4134b0f9953SJens Wiklander void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 4144b0f9953SJens Wiklander const TEE_BigInt *n); 4154b0f9953SJens Wiklander 4164b0f9953SJens Wiklander void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 4174b0f9953SJens Wiklander const TEE_BigInt *op2, const TEE_BigInt *n); 4184b0f9953SJens Wiklander 4194b0f9953SJens Wiklander void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 4204b0f9953SJens Wiklander const TEE_BigInt *op2, const TEE_BigInt *n); 4214b0f9953SJens Wiklander 4224b0f9953SJens Wiklander void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 4234b0f9953SJens Wiklander const TEE_BigInt *op2, const TEE_BigInt *n); 4244b0f9953SJens Wiklander 4254b0f9953SJens Wiklander void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 4264b0f9953SJens Wiklander const TEE_BigInt *n); 4274b0f9953SJens Wiklander 4284b0f9953SJens Wiklander void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 4294b0f9953SJens Wiklander const TEE_BigInt *n); 4304b0f9953SJens Wiklander 4314b0f9953SJens Wiklander /* TEE Arithmetical API - Other arithmetic operations */ 4324b0f9953SJens Wiklander 4334b0f9953SJens Wiklander bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 4344b0f9953SJens Wiklander 4354b0f9953SJens Wiklander void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 4364b0f9953SJens Wiklander TEE_BigInt *v, const TEE_BigInt *op1, 4374b0f9953SJens Wiklander const TEE_BigInt *op2); 4384b0f9953SJens Wiklander 4394b0f9953SJens Wiklander int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 4404b0f9953SJens Wiklander uint32_t confidenceLevel); 4414b0f9953SJens Wiklander 4424b0f9953SJens Wiklander /* TEE Arithmetical API - Fast modular multiplication operations */ 4434b0f9953SJens Wiklander 4444b0f9953SJens Wiklander void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 4454b0f9953SJens Wiklander const TEE_BigInt *n, 4464b0f9953SJens Wiklander const TEE_BigIntFMMContext *context); 4474b0f9953SJens Wiklander 4484b0f9953SJens Wiklander void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 4494b0f9953SJens Wiklander const TEE_BigInt *n, 4504b0f9953SJens Wiklander const TEE_BigIntFMMContext *context); 4514b0f9953SJens Wiklander 4524b0f9953SJens Wiklander void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 4534b0f9953SJens Wiklander const TEE_BigInt *n, 4544b0f9953SJens Wiklander const TEE_BigIntFMMContext *context); 4554b0f9953SJens Wiklander 4564b0f9953SJens Wiklander void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 4574b0f9953SJens Wiklander const TEE_BigIntFMM *op2, const TEE_BigInt *n, 4584b0f9953SJens Wiklander const TEE_BigIntFMMContext *context); 4594b0f9953SJens Wiklander 4604b0f9953SJens Wiklander #define TA_EXPORT 4614b0f9953SJens Wiklander 4624b0f9953SJens Wiklander /* 4634b0f9953SJens Wiklander * TA Interface 4644b0f9953SJens Wiklander * 4654b0f9953SJens Wiklander * Each Trusted Application must provide the Implementation with a number 4664b0f9953SJens Wiklander * of functions, collectively called the “TA interface”. These functions 4674b0f9953SJens Wiklander * are the entry points called by the Trusted Core Framework to create the 4684b0f9953SJens Wiklander * instance, notify the instance that a new client is connecting, notify 4694b0f9953SJens Wiklander * the instance when the client invokes a command, etc. 4704b0f9953SJens Wiklander * 4714b0f9953SJens Wiklander * Trusted Application Entry Points: 4724b0f9953SJens Wiklander */ 4734b0f9953SJens Wiklander 4744b0f9953SJens Wiklander /* 4754b0f9953SJens Wiklander * The function TA_CreateEntryPoint is the Trusted Application's 4764b0f9953SJens Wiklander * constructor, which the Framework calls when it creates a new instance of 4774b0f9953SJens Wiklander * the Trusted Application. To register instance data, the implementation 4784b0f9953SJens Wiklander * of this constructor can use either global variables or the function 4794b0f9953SJens Wiklander * TEE_InstanceSetData. 4804b0f9953SJens Wiklander * 4814b0f9953SJens Wiklander * Return Value: 4824b0f9953SJens Wiklander * - TEE_SUCCESS: if the instance is successfully created, the function 4834b0f9953SJens Wiklander * must return TEE_SUCCESS. 4844b0f9953SJens Wiklander * - Any other value: if any other code is returned the instance is not 4854b0f9953SJens Wiklander * created, and no other entry points of this instance will be called. 4864b0f9953SJens Wiklander * The Framework MUST reclaim all resources and dereference all objects 4874b0f9953SJens Wiklander * related to the creation of the instance. 4884b0f9953SJens Wiklander * 4894b0f9953SJens Wiklander * If this entry point was called as a result of a client opening a 4904b0f9953SJens Wiklander * session, the error code is returned to the client and the session is 4914b0f9953SJens Wiklander * not opened. 4924b0f9953SJens Wiklander */ 4934b0f9953SJens Wiklander TEE_Result TA_EXPORT TA_CreateEntryPoint(void); 4944b0f9953SJens Wiklander 4954b0f9953SJens Wiklander /* 4964b0f9953SJens Wiklander * The function TA_DestroyEntryPoint is the Trusted Application‟s 4974b0f9953SJens Wiklander * destructor, which the Framework calls when the instance is being 4984b0f9953SJens Wiklander * destroyed. 4994b0f9953SJens Wiklander * 5004b0f9953SJens Wiklander * When the function TA_DestroyEntryPoint is called, the Framework 5014b0f9953SJens Wiklander * guarantees that no client session is currently open. Once the call to 5024b0f9953SJens Wiklander * TA_DestroyEntryPoint has been completed, no other entry point of this 5034b0f9953SJens Wiklander * instance will ever be called. 5044b0f9953SJens Wiklander * 5054b0f9953SJens Wiklander * Note that when this function is called, all resources opened by the 5064b0f9953SJens Wiklander * instance are still available. It is only after the function returns that 5074b0f9953SJens Wiklander * the Implementation MUST start automatically reclaiming resources left 5084b0f9953SJens Wiklander * opened. 5094b0f9953SJens Wiklander * 5104b0f9953SJens Wiklander * Return Value: 5114b0f9953SJens Wiklander * This function can return no success or error code. After this function 5124b0f9953SJens Wiklander * returns the Implementation MUST consider the instance destroyed and 5134b0f9953SJens Wiklander * reclaims all resources left open by the instance. 5144b0f9953SJens Wiklander */ 5154b0f9953SJens Wiklander void TA_EXPORT TA_DestroyEntryPoint(void); 5164b0f9953SJens Wiklander 5174b0f9953SJens Wiklander /* 5184b0f9953SJens Wiklander * The Framework calls the function TA_OpenSessionEntryPoint when a client 5194b0f9953SJens Wiklander * requests to open a session with the Trusted Application. The open 5204b0f9953SJens Wiklander * session request may result in a new Trusted Application instance being 5214b0f9953SJens Wiklander * created as defined in section 4.5. 5224b0f9953SJens Wiklander * 5234b0f9953SJens Wiklander * The client can specify parameters in an open operation which are passed 5244b0f9953SJens Wiklander * to the Trusted Application instance in the arguments paramTypes and 5254b0f9953SJens Wiklander * params. These arguments can also be used by the Trusted Application 5264b0f9953SJens Wiklander * instance to transfer response data back to the client. See section 4.3.6 5274b0f9953SJens Wiklander * for a specification of how to handle the operation parameters. 5284b0f9953SJens Wiklander * 5294b0f9953SJens Wiklander * If this function returns TEE_SUCCESS, the client is connected to a 5304b0f9953SJens Wiklander * Trusted Application instance and can invoke Trusted Application 5314b0f9953SJens Wiklander * commands. When the client disconnects, the Framework will eventually 5324b0f9953SJens Wiklander * call the TA_CloseSessionEntryPoint entry point. 5334b0f9953SJens Wiklander * 5344b0f9953SJens Wiklander * If the function returns any error, the Framework rejects the connection 5354b0f9953SJens Wiklander * and returns the error code and the current content of the parameters the 5364b0f9953SJens Wiklander * client. The return origin is then set to TEE_ORIGIN_TRUSTED_APP. 5374b0f9953SJens Wiklander * 5384b0f9953SJens Wiklander * The Trusted Application instance can register a session data pointer by 5394b0f9953SJens Wiklander * setting *psessionContext. The value of this pointer is not interpreted 5404b0f9953SJens Wiklander * by the Framework, and is simply passed back to other TA_ functions 5414b0f9953SJens Wiklander * within this session. Note that *sessionContext may be set with a pointer 5424b0f9953SJens Wiklander * to a memory allocated by the Trusted Application instance or with 5434b0f9953SJens Wiklander * anything else, like an integer, a handle etc. The Framework will not 5444b0f9953SJens Wiklander * automatically free *sessionContext when the session is closed; the 5454b0f9953SJens Wiklander * Trusted Application instance is responsible for freeing memory if 5464b0f9953SJens Wiklander * required. 5474b0f9953SJens Wiklander * 5484b0f9953SJens Wiklander * During the call to TA_OpenSessionEntryPoint the client may request to 5494b0f9953SJens Wiklander * cancel the operation. See section 4.10 for more details on 5504b0f9953SJens Wiklander * cancellations. If the call to TA_OpenSessionEntryPoint returns 5514b0f9953SJens Wiklander * TEE_SUCCESS, the client must consider the session as successfully opened 5524b0f9953SJens Wiklander * and explicitly close it if necessary. 5534b0f9953SJens Wiklander * 5544b0f9953SJens Wiklander * Parameters: 5554b0f9953SJens Wiklander * - paramTypes: the types of the four parameters. 5564b0f9953SJens Wiklander * - params: a pointer to an array of four parameters. 5574b0f9953SJens Wiklander * - sessionContext: A pointer to a variable that can be filled by the 5584b0f9953SJens Wiklander * Trusted Application instance with an opaque void* data pointer 5594b0f9953SJens Wiklander * 5604b0f9953SJens Wiklander * Return Value: 5614b0f9953SJens Wiklander * - TEE_SUCCESS if the session is successfully opened. 5624b0f9953SJens Wiklander * - Any other value if the session could not be open. 5634b0f9953SJens Wiklander * o The error code may be one of the pre-defined codes, or may be a new 5644b0f9953SJens Wiklander * error code defined by the Trusted Application implementation itself. 5654b0f9953SJens Wiklander */ 5664b0f9953SJens Wiklander TEE_Result TA_EXPORT TA_OpenSessionEntryPoint(uint32_t paramTypes, 5674b0f9953SJens Wiklander TEE_Param params[TEE_NUM_PARAMS], 5684b0f9953SJens Wiklander void **sessionContext); 5694b0f9953SJens Wiklander 5704b0f9953SJens Wiklander /* 5714b0f9953SJens Wiklander * The Framework calls this function to close a client session. During the 5724b0f9953SJens Wiklander * call to this function the implementation can use any session functions. 5734b0f9953SJens Wiklander * 5744b0f9953SJens Wiklander * The Trusted Application implementation is responsible for freeing any 5754b0f9953SJens Wiklander * resources consumed by the session being closed. Note that the Trusted 5764b0f9953SJens Wiklander * Application cannot refuse to close a session, but can hold the closing 5774b0f9953SJens Wiklander * until it returns from TA_CloseSessionEntryPoint. This is why this 5784b0f9953SJens Wiklander * function cannot return an error code. 5794b0f9953SJens Wiklander * 5804b0f9953SJens Wiklander * Parameters: 5814b0f9953SJens Wiklander * - sessionContext: The value of the void* opaque data pointer set by the 5824b0f9953SJens Wiklander * Trusted Application in the function TA_OpenSessionEntryPoint for this 5834b0f9953SJens Wiklander * session. 5844b0f9953SJens Wiklander */ 5854b0f9953SJens Wiklander void TA_EXPORT TA_CloseSessionEntryPoint(void *sessionContext); 5864b0f9953SJens Wiklander 5874b0f9953SJens Wiklander /* 5884b0f9953SJens Wiklander * The Framework calls this function when the client invokes a command 5894b0f9953SJens Wiklander * within the given session. 5904b0f9953SJens Wiklander * 5914b0f9953SJens Wiklander * The Trusted Application can access the parameters sent by the client 5924b0f9953SJens Wiklander * through the paramTypes and params arguments. It can also use these 5934b0f9953SJens Wiklander * arguments to transfer response data back to the client. 5944b0f9953SJens Wiklander * 5954b0f9953SJens Wiklander * During the call to TA_InvokeCommandEntryPoint the client may request to 5964b0f9953SJens Wiklander * cancel the operation. 5974b0f9953SJens Wiklander * 5984b0f9953SJens Wiklander * A command is always invoked within the context of a client session. 5994b0f9953SJens Wiklander * Thus, any session function can be called by the command implementation. 6004b0f9953SJens Wiklander * 6014b0f9953SJens Wiklander * Parameter: 6024b0f9953SJens Wiklander * - sessionContext: The value of the void* opaque data pointer set by the 6034b0f9953SJens Wiklander * Trusted Application in the function TA_OpenSessionEntryPoint. 6044b0f9953SJens Wiklander * - commandID: A Trusted Application-specific code that identifies the 6054b0f9953SJens Wiklander * command to be invoked. 6064b0f9953SJens Wiklander * - paramTypes: the types of the four parameters. 6074b0f9953SJens Wiklander * - params: a pointer to an array of four parameters. 6084b0f9953SJens Wiklander * 6094b0f9953SJens Wiklander * Return Value: 6104b0f9953SJens Wiklander * - TEE_SUCCESS: if the command is successfully executed, the function 6114b0f9953SJens Wiklander * must return this value. 6124b0f9953SJens Wiklander * - Any other value: if the invocation of the command fails for any 6134b0f9953SJens Wiklander * reason. 6144b0f9953SJens Wiklander * o The error code may be one of the pre-defined codes, or may be a new 6154b0f9953SJens Wiklander * error code defined by the Trusted Application implementation itself. 6164b0f9953SJens Wiklander */ 6174b0f9953SJens Wiklander 6184b0f9953SJens Wiklander TEE_Result TA_EXPORT 6194b0f9953SJens Wiklander TA_InvokeCommandEntryPoint(void *sessionContext, uint32_t commandID, 6204b0f9953SJens Wiklander uint32_t paramTypes, 6214b0f9953SJens Wiklander TEE_Param params[TEE_NUM_PARAMS]); 6224b0f9953SJens Wiklander 6234b0f9953SJens Wiklander /* 6244b0f9953SJens Wiklander * Matching Client Functions <--> TA Functions 6254b0f9953SJens Wiklander * 6264b0f9953SJens Wiklander * TEE_OpenSession or TEE_OpenTASession: 6274b0f9953SJens Wiklander * If a new Trusted Application instance is needed to handle the session, 6284b0f9953SJens Wiklander * TA_CreateEntryPoint is called. 6294b0f9953SJens Wiklander * Then, TA_OpenSessionEntryPoint is called. 6304b0f9953SJens Wiklander * 6314b0f9953SJens Wiklander * TEE_InvokeCommand or TEE_InvokeTACommand: 6324b0f9953SJens Wiklander * TA_InvokeCommandEntryPoint is called. 6334b0f9953SJens Wiklander * 6344b0f9953SJens Wiklander * TEE_CloseSession or TEE_CloseTASession: 6354b0f9953SJens Wiklander * TA_CloseSessionEntryPoint is called. 6364b0f9953SJens Wiklander * For a multi-instance TA or for a single-instance, non keep-alive TA, if 6374b0f9953SJens Wiklander * the session closed was the last session on the instance, then 6384b0f9953SJens Wiklander * TA_DestroyEntryPoint is called. Otherwise, the instance is kept until 6394b0f9953SJens Wiklander * the TEE shuts down. 6404b0f9953SJens Wiklander */ 6414b0f9953SJens Wiklander 642*d372a47cSJens Wiklander #include <tee_api_compat.h> 643*d372a47cSJens Wiklander 6444b0f9953SJens Wiklander #endif /*TEE_INTERNAL_API_H*/ 645