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 uint32_t *operationSize); 306 307 void TEE_ResetOperation(TEE_OperationHandle operation); 308 309 TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 310 TEE_ObjectHandle key); 311 312 TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 313 TEE_ObjectHandle key1, TEE_ObjectHandle key2); 314 315 void TEE_CopyOperation(TEE_OperationHandle dstOperation, 316 TEE_OperationHandle srcOperation); 317 318 TEE_Result TEE_IsAlgorithmSupported(uint32_t algId, uint32_t element); 319 320 /* Cryptographic Operations API - Message Digest Functions */ 321 322 void TEE_DigestUpdate(TEE_OperationHandle operation, 323 const void *chunk, uint32_t chunkSize); 324 325 TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 326 uint32_t chunkLen, void *hash, uint32_t *hashLen); 327 328 /* Cryptographic Operations API - Symmetric Cipher Functions */ 329 330 void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 331 uint32_t IVLen); 332 333 TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 334 uint32_t srcLen, void *destData, uint32_t *destLen); 335 336 TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 337 const void *srcData, uint32_t srcLen, 338 void *destData, uint32_t *destLen); 339 340 /* Cryptographic Operations API - MAC Functions */ 341 342 void TEE_MACInit(TEE_OperationHandle operation, const void *IV, 343 uint32_t IVLen); 344 345 void TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 346 uint32_t chunkSize); 347 348 TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 349 const void *message, uint32_t messageLen, 350 void *mac, uint32_t *macLen); 351 352 TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 353 const void *message, uint32_t messageLen, 354 const void *mac, uint32_t macLen); 355 356 /* Cryptographic Operations API - Authenticated Encryption Functions */ 357 358 TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 359 uint32_t nonceLen, uint32_t tagLen, uint32_t AADLen, 360 uint32_t payloadLen); 361 362 void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 363 uint32_t AADdataLen); 364 365 TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 366 uint32_t srcLen, void *destData, uint32_t *destLen); 367 368 TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 369 const void *srcData, uint32_t srcLen, 370 void *destData, uint32_t *destLen, void *tag, 371 uint32_t *tagLen); 372 373 TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 374 const void *srcData, uint32_t srcLen, 375 void *destData, uint32_t *destLen, void *tag, 376 uint32_t tagLen); 377 378 /* Cryptographic Operations API - Asymmetric Functions */ 379 380 TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 381 const TEE_Attribute *params, 382 uint32_t paramCount, const void *srcData, 383 uint32_t srcLen, void *destData, 384 uint32_t *destLen); 385 TEE_Result __GP11_TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 386 const __GP11_TEE_Attribute *params, 387 uint32_t paramCount, 388 const void *srcData, uint32_t srcLen, 389 void *destData, uint32_t *destLen); 390 391 TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 392 const TEE_Attribute *params, 393 uint32_t paramCount, const void *srcData, 394 uint32_t srcLen, void *destData, 395 uint32_t *destLen); 396 TEE_Result __GP11_TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 397 const __GP11_TEE_Attribute *params, 398 uint32_t paramCount, 399 const void *srcData, uint32_t srcLen, 400 void *destData, uint32_t *destLen); 401 402 TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 403 const TEE_Attribute *params, 404 uint32_t paramCount, const void *digest, 405 uint32_t digestLen, void *signature, 406 uint32_t *signatureLen); 407 TEE_Result __GP11_TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 408 const __GP11_TEE_Attribute *params, 409 uint32_t paramCount, 410 const void *digest, 411 uint32_t digestLen, void *signature, 412 uint32_t *signatureLen); 413 414 TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 415 const TEE_Attribute *params, 416 uint32_t paramCount, const void *digest, 417 uint32_t digestLen, const void *signature, 418 uint32_t signatureLen); 419 TEE_Result __GP11_TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 420 const __GP11_TEE_Attribute *params, 421 uint32_t paramCount, 422 const void *digest, 423 uint32_t digestLen, 424 const void *signature, 425 uint32_t signatureLen); 426 427 /* Cryptographic Operations API - Key Derivation Functions */ 428 429 void TEE_DeriveKey(TEE_OperationHandle operation, 430 const TEE_Attribute *params, uint32_t paramCount, 431 TEE_ObjectHandle derivedKey); 432 void __GP11_TEE_DeriveKey(TEE_OperationHandle operation, 433 const __GP11_TEE_Attribute *params, 434 uint32_t paramCount, TEE_ObjectHandle derivedKey); 435 436 /* Cryptographic Operations API - Random Number Generation Functions */ 437 438 void TEE_GenerateRandom(void *randomBuffer, uint32_t randomBufferLen); 439 440 /* Date & Time API */ 441 442 void TEE_GetSystemTime(TEE_Time *time); 443 444 TEE_Result TEE_Wait(uint32_t timeout); 445 446 TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 447 448 TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 449 450 void TEE_GetREETime(TEE_Time *time); 451 452 /* TEE Arithmetical API - Memory allocation and size of objects */ 453 454 uint32_t TEE_BigIntFMMSizeInU32(uint32_t modulusSizeInBits); 455 456 uint32_t TEE_BigIntFMMContextSizeInU32(uint32_t modulusSizeInBits); 457 458 /* TEE Arithmetical API - Initialization functions */ 459 460 void TEE_BigIntInit(TEE_BigInt *bigInt, uint32_t len); 461 462 void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, uint32_t len, 463 const TEE_BigInt *modulus); 464 465 void TEE_BigIntInitFMM(TEE_BigIntFMM *bigIntFMM, uint32_t len); 466 467 /* TEE Arithmetical API - Converter functions */ 468 469 TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 470 const uint8_t *buffer, 471 uint32_t bufferLen, 472 int32_t sign); 473 474 TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, uint32_t *bufferLen, 475 const TEE_BigInt *bigInt); 476 477 void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 478 479 TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 480 481 /* TEE Arithmetical API - Logical operations */ 482 483 int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 484 485 int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 486 487 void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 488 size_t bits); 489 490 bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 491 492 uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 493 494 void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 495 const TEE_BigInt *op2); 496 497 void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 498 const TEE_BigInt *op2); 499 500 void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 501 502 void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 503 const TEE_BigInt *op2); 504 505 void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 506 507 void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 508 const TEE_BigInt *op1, const TEE_BigInt *op2); 509 510 /* TEE Arithmetical API - Modular arithmetic operations */ 511 512 void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 513 const TEE_BigInt *n); 514 515 void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 516 const TEE_BigInt *op2, const TEE_BigInt *n); 517 518 void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 519 const TEE_BigInt *op2, const TEE_BigInt *n); 520 521 void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 522 const TEE_BigInt *op2, const TEE_BigInt *n); 523 524 void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 525 const TEE_BigInt *n); 526 527 void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 528 const TEE_BigInt *n); 529 530 /* TEE Arithmetical API - Other arithmetic operations */ 531 532 bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 533 534 void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 535 TEE_BigInt *v, const TEE_BigInt *op1, 536 const TEE_BigInt *op2); 537 538 int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 539 uint32_t confidenceLevel); 540 541 /* TEE Arithmetical API - Fast modular multiplication operations */ 542 543 void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 544 const TEE_BigInt *n, 545 const TEE_BigIntFMMContext *context); 546 547 void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 548 const TEE_BigInt *n, 549 const TEE_BigIntFMMContext *context); 550 551 void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 552 const TEE_BigInt *n, 553 const TEE_BigIntFMMContext *context); 554 555 void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 556 const TEE_BigIntFMM *op2, const TEE_BigInt *n, 557 const TEE_BigIntFMMContext *context); 558 559 #define TA_EXPORT 560 561 /* 562 * TA Interface 563 * 564 * Each Trusted Application must provide the Implementation with a number 565 * of functions, collectively called the “TA interface”. These functions 566 * are the entry points called by the Trusted Core Framework to create the 567 * instance, notify the instance that a new client is connecting, notify 568 * the instance when the client invokes a command, etc. 569 * 570 * Trusted Application Entry Points: 571 */ 572 573 /* 574 * The function TA_CreateEntryPoint is the Trusted Application's 575 * constructor, which the Framework calls when it creates a new instance of 576 * the Trusted Application. To register instance data, the implementation 577 * of this constructor can use either global variables or the function 578 * TEE_InstanceSetData. 579 * 580 * Return Value: 581 * - TEE_SUCCESS: if the instance is successfully created, the function 582 * must return TEE_SUCCESS. 583 * - Any other value: if any other code is returned the instance is not 584 * created, and no other entry points of this instance will be called. 585 * The Framework MUST reclaim all resources and dereference all objects 586 * related to the creation of the instance. 587 * 588 * If this entry point was called as a result of a client opening a 589 * session, the error code is returned to the client and the session is 590 * not opened. 591 */ 592 TEE_Result TA_EXPORT TA_CreateEntryPoint(void); 593 594 /* 595 * The function TA_DestroyEntryPoint is the Trusted Application‟s 596 * destructor, which the Framework calls when the instance is being 597 * destroyed. 598 * 599 * When the function TA_DestroyEntryPoint is called, the Framework 600 * guarantees that no client session is currently open. Once the call to 601 * TA_DestroyEntryPoint has been completed, no other entry point of this 602 * instance will ever be called. 603 * 604 * Note that when this function is called, all resources opened by the 605 * instance are still available. It is only after the function returns that 606 * the Implementation MUST start automatically reclaiming resources left 607 * opened. 608 * 609 * Return Value: 610 * This function can return no success or error code. After this function 611 * returns the Implementation MUST consider the instance destroyed and 612 * reclaims all resources left open by the instance. 613 */ 614 void TA_EXPORT TA_DestroyEntryPoint(void); 615 616 /* 617 * The Framework calls the function TA_OpenSessionEntryPoint when a client 618 * requests to open a session with the Trusted Application. The open 619 * session request may result in a new Trusted Application instance being 620 * created as defined in section 4.5. 621 * 622 * The client can specify parameters in an open operation which are passed 623 * to the Trusted Application instance in the arguments paramTypes and 624 * params. These arguments can also be used by the Trusted Application 625 * instance to transfer response data back to the client. See section 4.3.6 626 * for a specification of how to handle the operation parameters. 627 * 628 * If this function returns TEE_SUCCESS, the client is connected to a 629 * Trusted Application instance and can invoke Trusted Application 630 * commands. When the client disconnects, the Framework will eventually 631 * call the TA_CloseSessionEntryPoint entry point. 632 * 633 * If the function returns any error, the Framework rejects the connection 634 * and returns the error code and the current content of the parameters the 635 * client. The return origin is then set to TEE_ORIGIN_TRUSTED_APP. 636 * 637 * The Trusted Application instance can register a session data pointer by 638 * setting *psessionContext. The value of this pointer is not interpreted 639 * by the Framework, and is simply passed back to other TA_ functions 640 * within this session. Note that *sessionContext may be set with a pointer 641 * to a memory allocated by the Trusted Application instance or with 642 * anything else, like an integer, a handle etc. The Framework will not 643 * automatically free *sessionContext when the session is closed; the 644 * Trusted Application instance is responsible for freeing memory if 645 * required. 646 * 647 * During the call to TA_OpenSessionEntryPoint the client may request to 648 * cancel the operation. See section 4.10 for more details on 649 * cancellations. If the call to TA_OpenSessionEntryPoint returns 650 * TEE_SUCCESS, the client must consider the session as successfully opened 651 * and explicitly close it if necessary. 652 * 653 * Parameters: 654 * - paramTypes: the types of the four parameters. 655 * - params: a pointer to an array of four parameters. 656 * - sessionContext: A pointer to a variable that can be filled by the 657 * Trusted Application instance with an opaque void* data pointer 658 * 659 * Return Value: 660 * - TEE_SUCCESS if the session is successfully opened. 661 * - Any other value if the session could not be open. 662 * o The error code may be one of the pre-defined codes, or may be a new 663 * error code defined by the Trusted Application implementation itself. 664 */ 665 TEE_Result TA_EXPORT TA_OpenSessionEntryPoint(uint32_t paramTypes, 666 TEE_Param params[TEE_NUM_PARAMS], 667 void **sessionContext); 668 TEE_Result TA_EXPORT 669 __GP11_TA_OpenSessionEntryPoint(uint32_t paramTypes, 670 __GP11_TEE_Param params[TEE_NUM_PARAMS], 671 void **sessionContext); 672 673 /* 674 * The Framework calls this function to close a client session. During the 675 * call to this function the implementation can use any session functions. 676 * 677 * The Trusted Application implementation is responsible for freeing any 678 * resources consumed by the session being closed. Note that the Trusted 679 * Application cannot refuse to close a session, but can hold the closing 680 * until it returns from TA_CloseSessionEntryPoint. This is why this 681 * function cannot return an error code. 682 * 683 * Parameters: 684 * - sessionContext: The value of the void* opaque data pointer set by the 685 * Trusted Application in the function TA_OpenSessionEntryPoint for this 686 * session. 687 */ 688 void TA_EXPORT TA_CloseSessionEntryPoint(void *sessionContext); 689 690 /* 691 * The Framework calls this function when the client invokes a command 692 * within the given session. 693 * 694 * The Trusted Application can access the parameters sent by the client 695 * through the paramTypes and params arguments. It can also use these 696 * arguments to transfer response data back to the client. 697 * 698 * During the call to TA_InvokeCommandEntryPoint the client may request to 699 * cancel the operation. 700 * 701 * A command is always invoked within the context of a client session. 702 * Thus, any session function can be called by the command implementation. 703 * 704 * Parameter: 705 * - sessionContext: The value of the void* opaque data pointer set by the 706 * Trusted Application in the function TA_OpenSessionEntryPoint. 707 * - commandID: A Trusted Application-specific code that identifies the 708 * command to be invoked. 709 * - paramTypes: the types of the four parameters. 710 * - params: a pointer to an array of four parameters. 711 * 712 * Return Value: 713 * - TEE_SUCCESS: if the command is successfully executed, the function 714 * must return this value. 715 * - Any other value: if the invocation of the command fails for any 716 * reason. 717 * o The error code may be one of the pre-defined codes, or may be a new 718 * error code defined by the Trusted Application implementation itself. 719 */ 720 721 TEE_Result TA_EXPORT 722 TA_InvokeCommandEntryPoint(void *sessionContext, uint32_t commandID, 723 uint32_t paramTypes, 724 TEE_Param params[TEE_NUM_PARAMS]); 725 TEE_Result TA_EXPORT 726 __GP11_TA_InvokeCommandEntryPoint(void *sessionContext, uint32_t commandID, 727 uint32_t paramTypes, 728 __GP11_TEE_Param params[TEE_NUM_PARAMS]); 729 730 /* 731 * Matching Client Functions <--> TA Functions 732 * 733 * TEE_OpenSession or TEE_OpenTASession: 734 * If a new Trusted Application instance is needed to handle the session, 735 * TA_CreateEntryPoint is called. 736 * Then, TA_OpenSessionEntryPoint is called. 737 * 738 * TEE_InvokeCommand or TEE_InvokeTACommand: 739 * TA_InvokeCommandEntryPoint is called. 740 * 741 * TEE_CloseSession or TEE_CloseTASession: 742 * TA_CloseSessionEntryPoint is called. 743 * For a multi-instance TA or for a single-instance, non keep-alive TA, if 744 * the session closed was the last session on the instance, then 745 * TA_DestroyEntryPoint is called. Otherwise, the instance is kept until 746 * the TEE shuts down. 747 */ 748 749 #include <tee_api_compat.h> 750 751 #endif /*TEE_INTERNAL_API_H*/ 752