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