1 /* 2 * Copyright (c) 2014, STMicroelectronics International N.V. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /* Based on GP TEE Internal API Specification Version 1.1 */ 29 #ifndef TEE_API_H 30 #define TEE_API_H 31 32 #include <stddef.h> 33 #include <compiler.h> 34 #include <tee_api_defines.h> 35 #include <tee_api_types.h> 36 #include <trace.h> 37 38 /* Property access functions */ 39 40 TEE_Result TEE_GetPropertyAsString(TEE_PropSetHandle propsetOrEnumerator, 41 const char *name, char *valueBuffer, 42 uint32_t *valueBufferLen); 43 44 TEE_Result TEE_GetPropertyAsBool(TEE_PropSetHandle propsetOrEnumerator, 45 const char *name, bool *value); 46 47 TEE_Result TEE_GetPropertyAsU32(TEE_PropSetHandle propsetOrEnumerator, 48 const char *name, uint32_t *value); 49 50 TEE_Result TEE_GetPropertyAsBinaryBlock(TEE_PropSetHandle propsetOrEnumerator, 51 const char *name, void *valueBuffer, 52 uint32_t *valueBufferLen); 53 54 TEE_Result TEE_GetPropertyAsUUID(TEE_PropSetHandle propsetOrEnumerator, 55 const char *name, TEE_UUID *value); 56 57 TEE_Result TEE_GetPropertyAsIdentity(TEE_PropSetHandle propsetOrEnumerator, 58 const char *name, TEE_Identity *value); 59 60 TEE_Result TEE_AllocatePropertyEnumerator(TEE_PropSetHandle *enumerator); 61 62 void TEE_FreePropertyEnumerator(TEE_PropSetHandle enumerator); 63 64 void TEE_StartPropertyEnumerator(TEE_PropSetHandle enumerator, 65 TEE_PropSetHandle propSet); 66 67 void TEE_ResetPropertyEnumerator(TEE_PropSetHandle enumerator); 68 69 TEE_Result TEE_GetPropertyName(TEE_PropSetHandle enumerator, 70 void *nameBuffer, uint32_t *nameBufferLen); 71 72 TEE_Result TEE_GetNextProperty(TEE_PropSetHandle enumerator); 73 74 /* System API - Misc */ 75 76 void TEE_Panic(TEE_Result panicCode); 77 78 /* System API - Internal Client API */ 79 80 TEE_Result TEE_OpenTASession(const TEE_UUID *destination, 81 uint32_t cancellationRequestTimeout, 82 uint32_t paramTypes, 83 TEE_Param params[TEE_NUM_PARAMS], 84 TEE_TASessionHandle *session, 85 uint32_t *returnOrigin); 86 87 void TEE_CloseTASession(TEE_TASessionHandle session); 88 89 TEE_Result TEE_InvokeTACommand(TEE_TASessionHandle session, 90 uint32_t cancellationRequestTimeout, 91 uint32_t commandID, uint32_t paramTypes, 92 TEE_Param params[TEE_NUM_PARAMS], 93 uint32_t *returnOrigin); 94 95 /* System API - Cancellations */ 96 97 bool TEE_GetCancellationFlag(void); 98 99 bool TEE_UnmaskCancellation(void); 100 101 bool TEE_MaskCancellation(void); 102 103 /* System API - Memory Management */ 104 105 TEE_Result TEE_CheckMemoryAccessRights(uint32_t accessFlags, void *buffer, 106 uint32_t size); 107 108 void TEE_SetInstanceData(const void *instanceData); 109 110 const void *TEE_GetInstanceData(void); 111 112 void *TEE_Malloc(uint32_t size, uint32_t hint); 113 114 void *TEE_Realloc(const void *buffer, uint32_t newSize); 115 116 void TEE_Free(void *buffer); 117 118 void *TEE_MemMove(void *dest, const void *src, uint32_t size); 119 120 int32_t TEE_MemCompare(const void *buffer1, const void *buffer2, uint32_t size); 121 122 void *TEE_MemFill(void *buff, uint32_t x, uint32_t size); 123 124 /* Data and Key Storage API - Generic Object Functions */ 125 126 void TEE_GetObjectInfo(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 127 TEE_Result TEE_GetObjectInfo1(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 128 129 void TEE_RestrictObjectUsage(TEE_ObjectHandle object, uint32_t objectUsage); 130 TEE_Result TEE_RestrictObjectUsage1(TEE_ObjectHandle object, uint32_t objectUsage); 131 132 TEE_Result TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 133 uint32_t attributeID, void *buffer, 134 uint32_t *size); 135 136 TEE_Result TEE_GetObjectValueAttribute(TEE_ObjectHandle object, 137 uint32_t attributeID, uint32_t *a, 138 uint32_t *b); 139 140 void TEE_CloseObject(TEE_ObjectHandle object); 141 142 /* Data and Key Storage API - Transient Object Functions */ 143 144 TEE_Result TEE_AllocateTransientObject(TEE_ObjectType objectType, 145 uint32_t maxKeySize, 146 TEE_ObjectHandle *object); 147 148 void TEE_FreeTransientObject(TEE_ObjectHandle object); 149 150 void TEE_ResetTransientObject(TEE_ObjectHandle object); 151 152 TEE_Result TEE_PopulateTransientObject(TEE_ObjectHandle object, 153 const TEE_Attribute *attrs, 154 uint32_t attrCount); 155 156 void TEE_InitRefAttribute(TEE_Attribute *attr, uint32_t attributeID, 157 const void *buffer, uint32_t length); 158 159 void TEE_InitValueAttribute(TEE_Attribute *attr, uint32_t attributeID, 160 uint32_t a, uint32_t b); 161 162 void TEE_CopyObjectAttributes(TEE_ObjectHandle destObject, 163 TEE_ObjectHandle srcObject); 164 165 TEE_Result TEE_CopyObjectAttributes1(TEE_ObjectHandle destObject, 166 TEE_ObjectHandle srcObject); 167 168 TEE_Result TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 169 const TEE_Attribute *params, uint32_t paramCount); 170 171 /* Data and Key Storage API - Persistent Object Functions */ 172 173 TEE_Result TEE_OpenPersistentObject(uint32_t storageID, const void *objectID, 174 uint32_t objectIDLen, uint32_t flags, 175 TEE_ObjectHandle *object); 176 177 TEE_Result TEE_CreatePersistentObject(uint32_t storageID, const void *objectID, 178 uint32_t objectIDLen, uint32_t flags, 179 TEE_ObjectHandle attributes, 180 const void *initialData, 181 uint32_t initialDataLen, 182 TEE_ObjectHandle *object); 183 184 void TEE_CloseAndDeletePersistentObject(TEE_ObjectHandle object); 185 186 TEE_Result TEE_CloseAndDeletePersistentObject1(TEE_ObjectHandle object); 187 188 TEE_Result TEE_RenamePersistentObject(TEE_ObjectHandle object, 189 const void *newObjectID, 190 uint32_t newObjectIDLen); 191 192 TEE_Result TEE_AllocatePersistentObjectEnumerator(TEE_ObjectEnumHandle * 193 objectEnumerator); 194 195 void TEE_FreePersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 196 197 void TEE_ResetPersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 198 199 TEE_Result TEE_StartPersistentObjectEnumerator(TEE_ObjectEnumHandle 200 objectEnumerator, 201 uint32_t storageID); 202 203 TEE_Result TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 204 TEE_ObjectInfo *objectInfo, 205 void *objectID, uint32_t *objectIDLen); 206 207 /* Data and Key Storage API - Data Stream Access Functions */ 208 209 TEE_Result TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 210 uint32_t size, uint32_t *count); 211 212 TEE_Result TEE_WriteObjectData(TEE_ObjectHandle object, const void *buffer, 213 uint32_t size); 214 215 TEE_Result TEE_TruncateObjectData(TEE_ObjectHandle object, uint32_t size); 216 217 TEE_Result TEE_SeekObjectData(TEE_ObjectHandle object, int32_t offset, 218 TEE_Whence whence); 219 220 /* Cryptographic Operations API - Generic Operation Functions */ 221 222 TEE_Result TEE_AllocateOperation(TEE_OperationHandle *operation, 223 uint32_t algorithm, uint32_t mode, 224 uint32_t maxKeySize); 225 226 void TEE_FreeOperation(TEE_OperationHandle operation); 227 228 void TEE_GetOperationInfo(TEE_OperationHandle operation, 229 TEE_OperationInfo *operationInfo); 230 231 TEE_Result TEE_GetOperationInfoMultiple(TEE_OperationHandle operation, 232 TEE_OperationInfoMultiple *operationInfoMultiple, 233 uint32_t *operationSize); 234 235 void TEE_ResetOperation(TEE_OperationHandle operation); 236 237 TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 238 TEE_ObjectHandle key); 239 240 TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 241 TEE_ObjectHandle key1, TEE_ObjectHandle key2); 242 243 void TEE_CopyOperation(TEE_OperationHandle dstOperation, 244 TEE_OperationHandle srcOperation); 245 246 /* Cryptographic Operations API - Message Digest Functions */ 247 248 void TEE_DigestUpdate(TEE_OperationHandle operation, 249 const void *chunk, uint32_t chunkSize); 250 251 TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 252 uint32_t chunkLen, void *hash, uint32_t *hashLen); 253 254 /* Cryptographic Operations API - Symmetric Cipher Functions */ 255 256 void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 257 uint32_t IVLen); 258 259 TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 260 uint32_t srcLen, void *destData, uint32_t *destLen); 261 262 TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 263 const void *srcData, uint32_t srcLen, 264 void *destData, uint32_t *destLen); 265 266 /* Cryptographic Operations API - MAC Functions */ 267 268 void TEE_MACInit(TEE_OperationHandle operation, const void *IV, 269 uint32_t IVLen); 270 271 void TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 272 uint32_t chunkSize); 273 274 TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 275 const void *message, uint32_t messageLen, 276 void *mac, uint32_t *macLen); 277 278 TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 279 const void *message, uint32_t messageLen, 280 const void *mac, uint32_t macLen); 281 282 /* Cryptographic Operations API - Authenticated Encryption Functions */ 283 284 TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 285 uint32_t nonceLen, uint32_t tagLen, uint32_t AADLen, 286 uint32_t payloadLen); 287 288 void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 289 uint32_t AADdataLen); 290 291 TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 292 uint32_t srcLen, void *destData, uint32_t *destLen); 293 294 TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 295 const void *srcData, uint32_t srcLen, 296 void *destData, uint32_t *destLen, void *tag, 297 uint32_t *tagLen); 298 299 TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 300 const void *srcData, uint32_t srcLen, 301 void *destData, uint32_t *destLen, void *tag, 302 uint32_t tagLen); 303 304 /* Cryptographic Operations API - Asymmetric Functions */ 305 306 TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 307 const TEE_Attribute *params, 308 uint32_t paramCount, const void *srcData, 309 uint32_t srcLen, void *destData, 310 uint32_t *destLen); 311 312 TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 313 const TEE_Attribute *params, 314 uint32_t paramCount, const void *srcData, 315 uint32_t srcLen, void *destData, 316 uint32_t *destLen); 317 318 TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 319 const TEE_Attribute *params, 320 uint32_t paramCount, const void *digest, 321 uint32_t digestLen, void *signature, 322 uint32_t *signatureLen); 323 324 TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 325 const TEE_Attribute *params, 326 uint32_t paramCount, const void *digest, 327 uint32_t digestLen, const void *signature, 328 uint32_t signatureLen); 329 330 /* Cryptographic Operations API - Key Derivation Functions */ 331 332 void TEE_DeriveKey(TEE_OperationHandle operation, 333 const TEE_Attribute *params, uint32_t paramCount, 334 TEE_ObjectHandle derivedKey); 335 336 /* Cryptographic Operations API - Random Number Generation Functions */ 337 338 void TEE_GenerateRandom(void *randomBuffer, uint32_t randomBufferLen); 339 340 /* Date & Time API */ 341 342 void TEE_GetSystemTime(TEE_Time *time); 343 344 TEE_Result TEE_Wait(uint32_t timeout); 345 346 TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 347 348 TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 349 350 void TEE_GetREETime(TEE_Time *time); 351 352 /* TEE Arithmetical API - Memory allocation and size of objects */ 353 354 uint32_t TEE_BigIntFMMSizeInU32(uint32_t modulusSizeInBits); 355 356 uint32_t TEE_BigIntFMMContextSizeInU32(uint32_t modulusSizeInBits); 357 358 /* TEE Arithmetical API - Initialization functions */ 359 360 void TEE_BigIntInit(TEE_BigInt *bigInt, uint32_t len); 361 362 void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, uint32_t len, 363 const TEE_BigInt *modulus); 364 365 void TEE_BigIntInitFMM(TEE_BigIntFMM *bigIntFMM, uint32_t len); 366 367 /* TEE Arithmetical API - Converter functions */ 368 369 TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 370 const uint8_t *buffer, 371 uint32_t bufferLen, 372 int32_t sign); 373 374 TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, uint32_t *bufferLen, 375 const TEE_BigInt *bigInt); 376 377 void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 378 379 TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 380 381 /* TEE Arithmetical API - Logical operations */ 382 383 int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 384 385 int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 386 387 void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 388 size_t bits); 389 390 bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 391 392 uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 393 394 void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 395 const TEE_BigInt *op2); 396 397 void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 398 const TEE_BigInt *op2); 399 400 void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 401 402 void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 403 const TEE_BigInt *op2); 404 405 void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 406 407 void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 408 const TEE_BigInt *op1, const TEE_BigInt *op2); 409 410 /* TEE Arithmetical API - Modular arithmetic operations */ 411 412 void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 413 const TEE_BigInt *n); 414 415 void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 416 const TEE_BigInt *op2, const TEE_BigInt *n); 417 418 void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 419 const TEE_BigInt *op2, const TEE_BigInt *n); 420 421 void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 422 const TEE_BigInt *op2, const TEE_BigInt *n); 423 424 void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 425 const TEE_BigInt *n); 426 427 void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 428 const TEE_BigInt *n); 429 430 /* TEE Arithmetical API - Other arithmetic operations */ 431 432 bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 433 434 void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 435 TEE_BigInt *v, const TEE_BigInt *op1, 436 const TEE_BigInt *op2); 437 438 int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 439 uint32_t confidenceLevel); 440 441 /* TEE Arithmetical API - Fast modular multiplication operations */ 442 443 void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 444 const TEE_BigInt *n, 445 const TEE_BigIntFMMContext *context); 446 447 void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 448 const TEE_BigInt *n, 449 const TEE_BigIntFMMContext *context); 450 451 void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 452 const TEE_BigInt *n, 453 const TEE_BigIntFMMContext *context); 454 455 void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 456 const TEE_BigIntFMM *op2, const TEE_BigInt *n, 457 const TEE_BigIntFMMContext *context); 458 459 #endif /* TEE_API_H */ 460