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