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