1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2014, STMicroelectronics International N.V. 4 */ 5 6 /* Based on GP TEE Internal API Specification Version 0.27 */ 7 #ifndef TEE_INTERNAL_API_H 8 #define TEE_INTERNAL_API_H 9 10 #ifdef __TEE_API_COMPAT_H 11 #error "<tee_api_compat.h> must not be included before <tee_internal_api.h>" 12 #endif 13 14 #include <compiler.h> 15 #include <stddef.h> 16 #include <tee_api_defines.h> 17 #include <tee_api_types.h> 18 #include <trace.h> 19 20 /* Property access functions */ 21 22 TEE_Result TEE_GetPropertyAsString(TEE_PropSetHandle propsetOrEnumerator, 23 const char *name, char *valueBuffer, 24 size_t *valueBufferLen); 25 TEE_Result __GP11_TEE_GetPropertyAsString(TEE_PropSetHandle propsetOrEnumerator, 26 const char *name, char *valueBuffer, 27 uint32_t *valueBufferLen); 28 29 TEE_Result TEE_GetPropertyAsBool(TEE_PropSetHandle propsetOrEnumerator, 30 const char *name, bool *value); 31 32 TEE_Result TEE_GetPropertyAsU32(TEE_PropSetHandle propsetOrEnumerator, 33 const char *name, uint32_t *value); 34 35 TEE_Result TEE_GetPropertyAsU64(TEE_PropSetHandle propsetOrEnumerator, 36 const char *name, uint64_t *value); 37 38 TEE_Result TEE_GetPropertyAsBinaryBlock(TEE_PropSetHandle propsetOrEnumerator, 39 const char *name, void *valueBuffer, 40 size_t *valueBufferLen); 41 TEE_Result 42 __GP11_TEE_GetPropertyAsBinaryBlock(TEE_PropSetHandle propsetOrEnumerator, 43 const char *name, void *valueBuffer, 44 uint32_t *valueBufferLen); 45 46 TEE_Result TEE_GetPropertyAsUUID(TEE_PropSetHandle propsetOrEnumerator, 47 const char *name, TEE_UUID *value); 48 49 TEE_Result TEE_GetPropertyAsIdentity(TEE_PropSetHandle propsetOrEnumerator, 50 const char *name, TEE_Identity *value); 51 52 TEE_Result TEE_AllocatePropertyEnumerator(TEE_PropSetHandle *enumerator); 53 54 void TEE_FreePropertyEnumerator(TEE_PropSetHandle enumerator); 55 56 void TEE_StartPropertyEnumerator(TEE_PropSetHandle enumerator, 57 TEE_PropSetHandle propSet); 58 59 void TEE_ResetPropertyEnumerator(TEE_PropSetHandle enumerator); 60 61 TEE_Result TEE_GetPropertyName(TEE_PropSetHandle enumerator, 62 void *nameBuffer, size_t *nameBufferLen); 63 TEE_Result __GP11_TEE_GetPropertyName(TEE_PropSetHandle enumerator, 64 void *nameBuffer, 65 uint32_t *nameBufferLen); 66 67 TEE_Result TEE_GetNextProperty(TEE_PropSetHandle enumerator); 68 69 /* System API - Misc */ 70 71 void TEE_Panic(TEE_Result panicCode); 72 73 /* System API - Internal Client API */ 74 75 TEE_Result TEE_OpenTASession(const TEE_UUID *destination, 76 uint32_t cancellationRequestTimeout, 77 uint32_t paramTypes, 78 TEE_Param params[TEE_NUM_PARAMS], 79 TEE_TASessionHandle *session, 80 uint32_t *returnOrigin); 81 TEE_Result __GP11_TEE_OpenTASession(const TEE_UUID *destination, 82 uint32_t cancellationRequestTimeout, 83 uint32_t paramTypes, 84 __GP11_TEE_Param params[TEE_NUM_PARAMS], 85 TEE_TASessionHandle *session, 86 uint32_t *returnOrigin); 87 88 void TEE_CloseTASession(TEE_TASessionHandle session); 89 90 TEE_Result TEE_InvokeTACommand(TEE_TASessionHandle session, 91 uint32_t cancellationRequestTimeout, 92 uint32_t commandID, uint32_t paramTypes, 93 TEE_Param params[TEE_NUM_PARAMS], 94 uint32_t *returnOrigin); 95 TEE_Result __GP11_TEE_InvokeTACommand(TEE_TASessionHandle session, 96 uint32_t cancellationRequestTimeout, 97 uint32_t commandID, uint32_t paramTypes, 98 __GP11_TEE_Param params[TEE_NUM_PARAMS], 99 uint32_t *returnOrigin); 100 101 /* System API - Cancellations */ 102 103 bool TEE_GetCancellationFlag(void); 104 105 bool TEE_UnmaskCancellation(void); 106 107 bool TEE_MaskCancellation(void); 108 109 /* System API - Memory Management */ 110 111 TEE_Result TEE_CheckMemoryAccessRights(uint32_t accessFlags, void *buffer, 112 size_t size); 113 TEE_Result __GP11_TEE_CheckMemoryAccessRights(uint32_t accessFlags, 114 void *buffer, uint32_t size); 115 116 void TEE_SetInstanceData(const void *instanceData); 117 118 const void *TEE_GetInstanceData(void); 119 120 void *TEE_Malloc(size_t size, uint32_t hint); 121 void *__GP11_TEE_Malloc(uint32_t size, uint32_t hint); 122 123 void *TEE_Realloc(void *buffer, size_t newSize); 124 void *__GP11_TEE_Realloc(void *buffer, uint32_t newSize); 125 126 void TEE_Free(void *buffer); 127 128 void *TEE_MemMove(void *dest, const void *src, size_t size); 129 void *__GP11_TEE_MemMove(void *dest, const void *src, uint32_t size); 130 131 /* 132 * Note: TEE_MemCompare() has a constant-time implementation (execution time 133 * does not depend on buffer content but only on buffer size). It is the main 134 * difference with memcmp(). 135 */ 136 int32_t TEE_MemCompare(const void *buffer1, const void *buffer2, size_t size); 137 int32_t __GP11_TEE_MemCompare(const void *buffer1, const void *buffer2, 138 uint32_t size); 139 140 void TEE_MemFill(void *buff, uint32_t x, size_t size); 141 void __GP11_TEE_MemFill(void *buff, uint32_t x, uint32_t size); 142 143 /* Data and Key Storage API - Generic Object Functions */ 144 145 void TEE_GetObjectInfo(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 146 void __GP11_TEE_GetObjectInfo(TEE_ObjectHandle object, 147 __GP11_TEE_ObjectInfo *objectInfo); 148 149 TEE_Result TEE_GetObjectInfo1(TEE_ObjectHandle object, 150 TEE_ObjectInfo *objectInfo); 151 TEE_Result __GP11_TEE_GetObjectInfo1(TEE_ObjectHandle object, 152 __GP11_TEE_ObjectInfo *objectInfo); 153 154 void TEE_RestrictObjectUsage(TEE_ObjectHandle object, uint32_t objectUsage); 155 TEE_Result TEE_RestrictObjectUsage1(TEE_ObjectHandle object, 156 uint32_t objectUsage); 157 158 TEE_Result TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 159 uint32_t attributeID, void *buffer, 160 size_t *size); 161 TEE_Result __GP11_TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 162 uint32_t attributeID, 163 void *buffer, uint32_t *size); 164 165 TEE_Result TEE_GetObjectValueAttribute(TEE_ObjectHandle object, 166 uint32_t attributeID, uint32_t *a, 167 uint32_t *b); 168 169 void TEE_CloseObject(TEE_ObjectHandle object); 170 171 /* Data and Key Storage API - Transient Object Functions */ 172 173 TEE_Result TEE_AllocateTransientObject(TEE_ObjectType objectType, 174 uint32_t maxObjectSize, 175 TEE_ObjectHandle *object); 176 TEE_Result __GP11_TEE_AllocateTransientObject(TEE_ObjectType objectType, 177 uint32_t maxKeySize, 178 TEE_ObjectHandle *object); 179 180 void TEE_FreeTransientObject(TEE_ObjectHandle object); 181 182 void TEE_ResetTransientObject(TEE_ObjectHandle object); 183 184 TEE_Result TEE_PopulateTransientObject(TEE_ObjectHandle object, 185 const TEE_Attribute *attrs, 186 uint32_t attrCount); 187 TEE_Result __GP11_TEE_PopulateTransientObject(TEE_ObjectHandle object, 188 const __GP11_TEE_Attribute *attrs, 189 uint32_t attrCount); 190 191 void TEE_InitRefAttribute(TEE_Attribute *attr, uint32_t attributeID, 192 const void *buffer, size_t length); 193 void __GP11_TEE_InitRefAttribute(__GP11_TEE_Attribute *attr, 194 uint32_t attributeID, 195 const void *buffer, uint32_t length); 196 197 void TEE_InitValueAttribute(TEE_Attribute *attr, uint32_t attributeID, 198 uint32_t a, uint32_t b); 199 void __GP11_TEE_InitValueAttribute(__GP11_TEE_Attribute *attr, 200 uint32_t attributeID, 201 uint32_t a, uint32_t b); 202 203 void TEE_CopyObjectAttributes(TEE_ObjectHandle destObject, 204 TEE_ObjectHandle srcObject); 205 206 TEE_Result TEE_CopyObjectAttributes1(TEE_ObjectHandle destObject, 207 TEE_ObjectHandle srcObject); 208 209 TEE_Result TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 210 const TEE_Attribute *params, uint32_t paramCount); 211 TEE_Result __GP11_TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 212 const __GP11_TEE_Attribute *params, 213 uint32_t paramCount); 214 215 /* Data and Key Storage API - Persistent Object Functions */ 216 217 TEE_Result TEE_OpenPersistentObject(uint32_t storageID, const void *objectID, 218 size_t objectIDLen, uint32_t flags, 219 TEE_ObjectHandle *object); 220 TEE_Result __GP11_TEE_OpenPersistentObject(uint32_t storageID, 221 const void *objectID, 222 uint32_t objectIDLen, uint32_t flags, 223 TEE_ObjectHandle *object); 224 225 TEE_Result TEE_CreatePersistentObject(uint32_t storageID, const void *objectID, 226 size_t objectIDLen, uint32_t flags, 227 TEE_ObjectHandle attributes, 228 const void *initialData, 229 size_t initialDataLen, 230 TEE_ObjectHandle *object); 231 TEE_Result __GP11_TEE_CreatePersistentObject(uint32_t storageID, 232 const void *objectID, 233 uint32_t objectIDLen, 234 uint32_t flags, 235 TEE_ObjectHandle attributes, 236 const void *initialData, 237 uint32_t initialDataLen, 238 TEE_ObjectHandle *object); 239 240 void TEE_CloseAndDeletePersistentObject(TEE_ObjectHandle object); 241 242 TEE_Result TEE_CloseAndDeletePersistentObject1(TEE_ObjectHandle object); 243 244 TEE_Result TEE_RenamePersistentObject(TEE_ObjectHandle object, 245 const void *newObjectID, 246 size_t newObjectIDLen); 247 TEE_Result __GP11_TEE_RenamePersistentObject(TEE_ObjectHandle object, 248 const void *newObjectID, 249 uint32_t newObjectIDLen); 250 251 TEE_Result TEE_AllocatePersistentObjectEnumerator(TEE_ObjectEnumHandle * 252 objectEnumerator); 253 254 void TEE_FreePersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 255 256 void TEE_ResetPersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 257 258 TEE_Result TEE_StartPersistentObjectEnumerator(TEE_ObjectEnumHandle 259 objectEnumerator, 260 uint32_t storageID); 261 262 TEE_Result TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 263 TEE_ObjectInfo *objectInfo, 264 void *objectID, size_t *objectIDLen); 265 TEE_Result 266 __GP11_TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 267 __GP11_TEE_ObjectInfo *objectInfo, 268 void *objectID, uint32_t *objectIDLen); 269 270 /* Data and Key Storage API - Data Stream Access Functions */ 271 272 TEE_Result TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 273 size_t size, size_t *count); 274 TEE_Result __GP11_TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 275 uint32_t size, uint32_t *count); 276 277 TEE_Result TEE_WriteObjectData(TEE_ObjectHandle object, const void *buffer, 278 size_t size); 279 TEE_Result __GP11_TEE_WriteObjectData(TEE_ObjectHandle object, 280 const void *buffer, uint32_t size); 281 282 TEE_Result TEE_TruncateObjectData(TEE_ObjectHandle object, size_t size); 283 TEE_Result __GP11_TEE_TruncateObjectData(TEE_ObjectHandle object, 284 uint32_t size); 285 286 TEE_Result TEE_SeekObjectData(TEE_ObjectHandle object, intmax_t offset, 287 TEE_Whence whence); 288 TEE_Result __GP11_TEE_SeekObjectData(TEE_ObjectHandle object, int32_t offset, 289 TEE_Whence whence); 290 291 /* Cryptographic Operations API - Generic Operation Functions */ 292 293 TEE_Result TEE_AllocateOperation(TEE_OperationHandle *operation, 294 uint32_t algorithm, uint32_t mode, 295 uint32_t maxKeySize); 296 297 void TEE_FreeOperation(TEE_OperationHandle operation); 298 299 void TEE_GetOperationInfo(TEE_OperationHandle operation, 300 TEE_OperationInfo *operationInfo); 301 302 TEE_Result 303 TEE_GetOperationInfoMultiple(TEE_OperationHandle operation, 304 TEE_OperationInfoMultiple *operationInfoMultiple, 305 size_t *operationSize); 306 TEE_Result 307 __GP11_TEE_GetOperationInfoMultiple(TEE_OperationHandle operation, 308 TEE_OperationInfoMultiple *info, 309 uint32_t *operationSize); 310 311 void TEE_ResetOperation(TEE_OperationHandle operation); 312 313 TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 314 TEE_ObjectHandle key); 315 316 TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 317 TEE_ObjectHandle key1, TEE_ObjectHandle key2); 318 319 void TEE_CopyOperation(TEE_OperationHandle dstOperation, 320 TEE_OperationHandle srcOperation); 321 322 TEE_Result TEE_IsAlgorithmSupported(uint32_t algId, uint32_t element); 323 324 /* Cryptographic Operations API - Message Digest Functions */ 325 326 void TEE_DigestUpdate(TEE_OperationHandle operation, 327 const void *chunk, size_t chunkSize); 328 void __GP11_TEE_DigestUpdate(TEE_OperationHandle operation, 329 const void *chunk, uint32_t chunkSize); 330 331 TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 332 size_t chunkLen, void *hash, size_t *hashLen); 333 TEE_Result __GP11_TEE_DigestDoFinal(TEE_OperationHandle operation, 334 const void *chunk, uint32_t chunkLen, 335 void *hash, uint32_t *hashLen); 336 337 /* Cryptographic Operations API - Symmetric Cipher Functions */ 338 339 void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 340 size_t IVLen); 341 void __GP11_TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 342 uint32_t IVLen); 343 344 TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 345 size_t srcLen, void *destData, size_t *destLen); 346 TEE_Result __GP11_TEE_CipherUpdate(TEE_OperationHandle operation, 347 const void *srcData, uint32_t srcLen, 348 void *destData, uint32_t *destLen); 349 350 TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 351 const void *srcData, size_t srcLen, 352 void *destData, size_t *destLen); 353 TEE_Result __GP11_TEE_CipherDoFinal(TEE_OperationHandle operation, 354 const void *srcData, uint32_t srcLen, 355 void *destData, uint32_t *destLen); 356 357 /* Cryptographic Operations API - MAC Functions */ 358 359 void TEE_MACInit(TEE_OperationHandle operation, const void *IV, 360 size_t IVLen); 361 void __GP11_TEE_MACInit(TEE_OperationHandle operation, const void *IV, 362 uint32_t IVLen); 363 364 void TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 365 size_t chunkSize); 366 void __GP11_TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 367 uint32_t chunkSize); 368 369 TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 370 const void *message, size_t messageLen, 371 void *mac, size_t *macLen); 372 TEE_Result __GP11_TEE_MACComputeFinal(TEE_OperationHandle operation, 373 const void *message, uint32_t messageLen, 374 void *mac, uint32_t *macLen); 375 376 TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 377 const void *message, size_t messageLen, 378 const void *mac, size_t macLen); 379 TEE_Result __GP11_TEE_MACCompareFinal(TEE_OperationHandle operation, 380 const void *message, uint32_t messageLen, 381 const void *mac, uint32_t macLen); 382 383 /* Cryptographic Operations API - Authenticated Encryption Functions */ 384 385 TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 386 size_t nonceLen, uint32_t tagLen, size_t AADLen, 387 size_t payloadLen); 388 TEE_Result __GP11_TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 389 uint32_t nonceLen, uint32_t tagLen, 390 uint32_t AADLen, uint32_t payloadLen); 391 392 void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 393 size_t AADdataLen); 394 void __GP11_TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 395 uint32_t AADdataLen); 396 397 TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 398 size_t srcLen, void *destData, size_t *destLen); 399 TEE_Result __GP11_TEE_AEUpdate(TEE_OperationHandle operation, 400 const void *srcData, uint32_t srcLen, 401 void *destData, uint32_t *destLen); 402 403 TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 404 const void *srcData, size_t srcLen, 405 void *destData, size_t *destLen, void *tag, 406 size_t *tagLen); 407 TEE_Result __GP11_TEE_AEEncryptFinal(TEE_OperationHandle operation, 408 const void *srcData, uint32_t srcLen, 409 void *destData, uint32_t *destLen, 410 void *tag, uint32_t *tagLen); 411 412 TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 413 const void *srcData, size_t srcLen, 414 void *destData, size_t *destLen, void *tag, 415 size_t tagLen); 416 TEE_Result __GP11_TEE_AEDecryptFinal(TEE_OperationHandle operation, 417 const void *srcData, uint32_t srcLen, 418 void *destData, uint32_t *destLen, 419 void *tag, uint32_t tagLen); 420 421 /* Cryptographic Operations API - Asymmetric Functions */ 422 423 TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 424 const TEE_Attribute *params, 425 uint32_t paramCount, const void *srcData, 426 size_t srcLen, void *destData, 427 size_t *destLen); 428 TEE_Result __GP11_TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 429 const __GP11_TEE_Attribute *params, 430 uint32_t paramCount, 431 const void *srcData, uint32_t srcLen, 432 void *destData, uint32_t *destLen); 433 434 TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 435 const TEE_Attribute *params, 436 uint32_t paramCount, const void *srcData, 437 size_t srcLen, void *destData, 438 size_t *destLen); 439 TEE_Result __GP11_TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 440 const __GP11_TEE_Attribute *params, 441 uint32_t paramCount, 442 const void *srcData, uint32_t srcLen, 443 void *destData, uint32_t *destLen); 444 445 TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 446 const TEE_Attribute *params, 447 uint32_t paramCount, const void *digest, 448 uint32_t digestLen, void *signature, 449 uint32_t *signatureLen); 450 TEE_Result __GP11_TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 451 const __GP11_TEE_Attribute *params, 452 uint32_t paramCount, 453 const void *digest, 454 uint32_t digestLen, void *signature, 455 uint32_t *signatureLen); 456 457 TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 458 const TEE_Attribute *params, 459 uint32_t paramCount, const void *digest, 460 uint32_t digestLen, const void *signature, 461 uint32_t signatureLen); 462 TEE_Result __GP11_TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 463 const __GP11_TEE_Attribute *params, 464 uint32_t paramCount, 465 const void *digest, 466 uint32_t digestLen, 467 const void *signature, 468 uint32_t signatureLen); 469 470 /* Cryptographic Operations API - Key Derivation Functions */ 471 472 void TEE_DeriveKey(TEE_OperationHandle operation, 473 const TEE_Attribute *params, uint32_t paramCount, 474 TEE_ObjectHandle derivedKey); 475 void __GP11_TEE_DeriveKey(TEE_OperationHandle operation, 476 const __GP11_TEE_Attribute *params, 477 uint32_t paramCount, TEE_ObjectHandle derivedKey); 478 479 /* Cryptographic Operations API - Random Number Generation Functions */ 480 481 void TEE_GenerateRandom(void *randomBuffer, uint32_t randomBufferLen); 482 483 /* Date & Time API */ 484 485 void TEE_GetSystemTime(TEE_Time *time); 486 487 TEE_Result TEE_Wait(uint32_t timeout); 488 489 TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 490 491 TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 492 493 void TEE_GetREETime(TEE_Time *time); 494 495 /* TEE Arithmetical API - Memory allocation and size of objects */ 496 497 uint32_t TEE_BigIntFMMSizeInU32(uint32_t modulusSizeInBits); 498 499 uint32_t TEE_BigIntFMMContextSizeInU32(uint32_t modulusSizeInBits); 500 501 /* TEE Arithmetical API - Initialization functions */ 502 503 void TEE_BigIntInit(TEE_BigInt *bigInt, uint32_t len); 504 505 void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, uint32_t len, 506 const TEE_BigInt *modulus); 507 508 void TEE_BigIntInitFMM(TEE_BigIntFMM *bigIntFMM, uint32_t len); 509 510 /* TEE Arithmetical API - Converter functions */ 511 512 TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 513 const uint8_t *buffer, 514 uint32_t bufferLen, 515 int32_t sign); 516 517 TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, uint32_t *bufferLen, 518 const TEE_BigInt *bigInt); 519 520 void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 521 522 TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 523 524 /* TEE Arithmetical API - Logical operations */ 525 526 int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 527 528 int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 529 530 void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 531 size_t bits); 532 533 bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 534 535 uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 536 537 void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 538 const TEE_BigInt *op2); 539 540 void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 541 const TEE_BigInt *op2); 542 543 void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 544 545 void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 546 const TEE_BigInt *op2); 547 548 void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 549 550 void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 551 const TEE_BigInt *op1, const TEE_BigInt *op2); 552 553 /* TEE Arithmetical API - Modular arithmetic operations */ 554 555 void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 556 const TEE_BigInt *n); 557 558 void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 559 const TEE_BigInt *op2, const TEE_BigInt *n); 560 561 void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 562 const TEE_BigInt *op2, const TEE_BigInt *n); 563 564 void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 565 const TEE_BigInt *op2, const TEE_BigInt *n); 566 567 void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 568 const TEE_BigInt *n); 569 570 void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 571 const TEE_BigInt *n); 572 573 /* TEE Arithmetical API - Other arithmetic operations */ 574 575 bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 576 577 void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 578 TEE_BigInt *v, const TEE_BigInt *op1, 579 const TEE_BigInt *op2); 580 581 int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 582 uint32_t confidenceLevel); 583 584 /* TEE Arithmetical API - Fast modular multiplication operations */ 585 586 void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 587 const TEE_BigInt *n, 588 const TEE_BigIntFMMContext *context); 589 590 void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 591 const TEE_BigInt *n, 592 const TEE_BigIntFMMContext *context); 593 594 void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 595 const TEE_BigInt *n, 596 const TEE_BigIntFMMContext *context); 597 598 void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 599 const TEE_BigIntFMM *op2, const TEE_BigInt *n, 600 const TEE_BigIntFMMContext *context); 601 602 #define TA_EXPORT 603 604 /* 605 * TA Interface 606 * 607 * Each Trusted Application must provide the Implementation with a number 608 * of functions, collectively called the “TA interface”. These functions 609 * are the entry points called by the Trusted Core Framework to create the 610 * instance, notify the instance that a new client is connecting, notify 611 * the instance when the client invokes a command, etc. 612 * 613 * Trusted Application Entry Points: 614 */ 615 616 /* 617 * The function TA_CreateEntryPoint is the Trusted Application's 618 * constructor, which the Framework calls when it creates a new instance of 619 * the Trusted Application. To register instance data, the implementation 620 * of this constructor can use either global variables or the function 621 * TEE_InstanceSetData. 622 * 623 * Return Value: 624 * - TEE_SUCCESS: if the instance is successfully created, the function 625 * must return TEE_SUCCESS. 626 * - Any other value: if any other code is returned the instance is not 627 * created, and no other entry points of this instance will be called. 628 * The Framework MUST reclaim all resources and dereference all objects 629 * related to the creation of the instance. 630 * 631 * If this entry point was called as a result of a client opening a 632 * session, the error code is returned to the client and the session is 633 * not opened. 634 */ 635 TEE_Result TA_EXPORT TA_CreateEntryPoint(void); 636 637 /* 638 * The function TA_DestroyEntryPoint is the Trusted Application‟s 639 * destructor, which the Framework calls when the instance is being 640 * destroyed. 641 * 642 * When the function TA_DestroyEntryPoint is called, the Framework 643 * guarantees that no client session is currently open. Once the call to 644 * TA_DestroyEntryPoint has been completed, no other entry point of this 645 * instance will ever be called. 646 * 647 * Note that when this function is called, all resources opened by the 648 * instance are still available. It is only after the function returns that 649 * the Implementation MUST start automatically reclaiming resources left 650 * opened. 651 * 652 * Return Value: 653 * This function can return no success or error code. After this function 654 * returns the Implementation MUST consider the instance destroyed and 655 * reclaims all resources left open by the instance. 656 */ 657 void TA_EXPORT TA_DestroyEntryPoint(void); 658 659 /* 660 * The Framework calls the function TA_OpenSessionEntryPoint when a client 661 * requests to open a session with the Trusted Application. The open 662 * session request may result in a new Trusted Application instance being 663 * created as defined in section 4.5. 664 * 665 * The client can specify parameters in an open operation which are passed 666 * to the Trusted Application instance in the arguments paramTypes and 667 * params. These arguments can also be used by the Trusted Application 668 * instance to transfer response data back to the client. See section 4.3.6 669 * for a specification of how to handle the operation parameters. 670 * 671 * If this function returns TEE_SUCCESS, the client is connected to a 672 * Trusted Application instance and can invoke Trusted Application 673 * commands. When the client disconnects, the Framework will eventually 674 * call the TA_CloseSessionEntryPoint entry point. 675 * 676 * If the function returns any error, the Framework rejects the connection 677 * and returns the error code and the current content of the parameters the 678 * client. The return origin is then set to TEE_ORIGIN_TRUSTED_APP. 679 * 680 * The Trusted Application instance can register a session data pointer by 681 * setting *psessionContext. The value of this pointer is not interpreted 682 * by the Framework, and is simply passed back to other TA_ functions 683 * within this session. Note that *sessionContext may be set with a pointer 684 * to a memory allocated by the Trusted Application instance or with 685 * anything else, like an integer, a handle etc. The Framework will not 686 * automatically free *sessionContext when the session is closed; the 687 * Trusted Application instance is responsible for freeing memory if 688 * required. 689 * 690 * During the call to TA_OpenSessionEntryPoint the client may request to 691 * cancel the operation. See section 4.10 for more details on 692 * cancellations. If the call to TA_OpenSessionEntryPoint returns 693 * TEE_SUCCESS, the client must consider the session as successfully opened 694 * and explicitly close it if necessary. 695 * 696 * Parameters: 697 * - paramTypes: the types of the four parameters. 698 * - params: a pointer to an array of four parameters. 699 * - sessionContext: A pointer to a variable that can be filled by the 700 * Trusted Application instance with an opaque void* data pointer 701 * 702 * Return Value: 703 * - TEE_SUCCESS if the session is successfully opened. 704 * - Any other value if the session could not be open. 705 * o The error code may be one of the pre-defined codes, or may be a new 706 * error code defined by the Trusted Application implementation itself. 707 */ 708 TEE_Result TA_EXPORT TA_OpenSessionEntryPoint(uint32_t paramTypes, 709 TEE_Param params[TEE_NUM_PARAMS], 710 void **sessionContext); 711 TEE_Result TA_EXPORT 712 __GP11_TA_OpenSessionEntryPoint(uint32_t paramTypes, 713 __GP11_TEE_Param params[TEE_NUM_PARAMS], 714 void **sessionContext); 715 716 /* 717 * The Framework calls this function to close a client session. During the 718 * call to this function the implementation can use any session functions. 719 * 720 * The Trusted Application implementation is responsible for freeing any 721 * resources consumed by the session being closed. Note that the Trusted 722 * Application cannot refuse to close a session, but can hold the closing 723 * until it returns from TA_CloseSessionEntryPoint. This is why this 724 * function cannot return an error code. 725 * 726 * Parameters: 727 * - sessionContext: The value of the void* opaque data pointer set by the 728 * Trusted Application in the function TA_OpenSessionEntryPoint for this 729 * session. 730 */ 731 void TA_EXPORT TA_CloseSessionEntryPoint(void *sessionContext); 732 733 /* 734 * The Framework calls this function when the client invokes a command 735 * within the given session. 736 * 737 * The Trusted Application can access the parameters sent by the client 738 * through the paramTypes and params arguments. It can also use these 739 * arguments to transfer response data back to the client. 740 * 741 * During the call to TA_InvokeCommandEntryPoint the client may request to 742 * cancel the operation. 743 * 744 * A command is always invoked within the context of a client session. 745 * Thus, any session function can be called by the command implementation. 746 * 747 * Parameter: 748 * - sessionContext: The value of the void* opaque data pointer set by the 749 * Trusted Application in the function TA_OpenSessionEntryPoint. 750 * - commandID: A Trusted Application-specific code that identifies the 751 * command to be invoked. 752 * - paramTypes: the types of the four parameters. 753 * - params: a pointer to an array of four parameters. 754 * 755 * Return Value: 756 * - TEE_SUCCESS: if the command is successfully executed, the function 757 * must return this value. 758 * - Any other value: if the invocation of the command fails for any 759 * reason. 760 * o The error code may be one of the pre-defined codes, or may be a new 761 * error code defined by the Trusted Application implementation itself. 762 */ 763 764 TEE_Result TA_EXPORT 765 TA_InvokeCommandEntryPoint(void *sessionContext, uint32_t commandID, 766 uint32_t paramTypes, 767 TEE_Param params[TEE_NUM_PARAMS]); 768 TEE_Result TA_EXPORT 769 __GP11_TA_InvokeCommandEntryPoint(void *sessionContext, uint32_t commandID, 770 uint32_t paramTypes, 771 __GP11_TEE_Param params[TEE_NUM_PARAMS]); 772 773 /* 774 * Matching Client Functions <--> TA Functions 775 * 776 * TEE_OpenSession or TEE_OpenTASession: 777 * If a new Trusted Application instance is needed to handle the session, 778 * TA_CreateEntryPoint is called. 779 * Then, TA_OpenSessionEntryPoint is called. 780 * 781 * TEE_InvokeCommand or TEE_InvokeTACommand: 782 * TA_InvokeCommandEntryPoint is called. 783 * 784 * TEE_CloseSession or TEE_CloseTASession: 785 * TA_CloseSessionEntryPoint is called. 786 * For a multi-instance TA or for a single-instance, non keep-alive TA, if 787 * the session closed was the last session on the instance, then 788 * TA_DestroyEntryPoint is called. Otherwise, the instance is kept until 789 * the TEE shuts down. 790 */ 791 792 #include <tee_api_compat.h> 793 794 #endif /*TEE_INTERNAL_API_H*/ 795