1 /* 2 * Copyright (c) 2014, STMicroelectronics International N.V. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, 12 * this list of conditions and the following disclaimer in the documentation 13 * and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 19 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 20 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 21 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 24 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 25 * POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 /* Based on GP TEE Internal API Specification Version 1.1 */ 29 #ifndef TEE_API_H 30 #define TEE_API_H 31 32 #include <stddef.h> 33 #include <compiler.h> 34 #include <tee_api_defines.h> 35 #include <tee_api_types.h> 36 37 /* Property access functions */ 38 39 TEE_Result TEE_GetPropertyAsString(TEE_PropSetHandle propsetOrEnumerator, 40 char *name, char *valueBuffer, 41 uint32_t *valueBufferLen); 42 43 TEE_Result TEE_GetPropertyAsBool(TEE_PropSetHandle propsetOrEnumerator, 44 char *name, bool *value); 45 46 TEE_Result TEE_GetPropertyAsU32(TEE_PropSetHandle propsetOrEnumerator, 47 char *name, uint32_t *value); 48 49 TEE_Result TEE_GetPropertyAsBinaryBlock(TEE_PropSetHandle propsetOrEnumerator, 50 char *name, void *valueBuffer, 51 uint32_t *valueBufferLen); 52 53 TEE_Result TEE_GetPropertyAsUUID(TEE_PropSetHandle propsetOrEnumerator, 54 char *name, TEE_UUID *value); 55 56 TEE_Result TEE_GetPropertyAsIdentity(TEE_PropSetHandle propsetOrEnumerator, 57 char *name, TEE_Identity *value); 58 59 TEE_Result TEE_AllocatePropertyEnumerator(TEE_PropSetHandle *enumerator); 60 61 void TEE_FreePropertyEnumerator(TEE_PropSetHandle enumerator); 62 63 void TEE_StartPropertyEnumerator(TEE_PropSetHandle enumerator, 64 TEE_PropSetHandle propSet); 65 66 void TEE_ResetPropertyEnumerator(TEE_PropSetHandle enumerator); 67 68 TEE_Result TEE_GetPropertyName(TEE_PropSetHandle enumerator, 69 void *nameBuffer, uint32_t *nameBufferLen); 70 71 TEE_Result TEE_GetNextProperty(TEE_PropSetHandle enumerator); 72 73 /* System API - Misc */ 74 75 void TEE_Panic(TEE_Result panicCode); 76 77 /* System API - Internal Client API */ 78 79 TEE_Result TEE_OpenTASession(const TEE_UUID *destination, 80 uint32_t cancellationRequestTimeout, 81 uint32_t paramTypes, TEE_Param params[4], 82 TEE_TASessionHandle *session, 83 uint32_t *returnOrigin); 84 85 void TEE_CloseTASession(TEE_TASessionHandle session); 86 87 TEE_Result TEE_InvokeTACommand(TEE_TASessionHandle session, 88 uint32_t cancellationRequestTimeout, 89 uint32_t commandID, uint32_t paramTypes, 90 TEE_Param params[4], uint32_t *returnOrigin); 91 92 /* System API - Cancellations */ 93 94 bool TEE_GetCancellationFlag(void); 95 96 bool TEE_UnmaskCancellation(void); 97 98 bool TEE_MaskCancellation(void); 99 100 /* System API - Memory Management */ 101 102 TEE_Result TEE_CheckMemoryAccessRights(uint32_t accessFlags, void *buffer, 103 uint32_t size); 104 105 void TEE_SetInstanceData(void *instanceData); 106 107 void *TEE_GetInstanceData(void); 108 109 void *TEE_Malloc(uint32_t size, uint32_t hint); 110 111 void *TEE_Realloc(void *buffer, uint32_t newSize); 112 113 void TEE_Free(void *buffer); 114 115 void *TEE_MemMove(void *dest, const void *src, uint32_t size); 116 117 int32_t TEE_MemCompare(const void *buffer1, const void *buffer2, uint32_t size); 118 119 void *TEE_MemFill(void *buff, uint32_t x, uint32_t size); 120 121 /* Data and Key Storage API - Generic Object Functions */ 122 123 void TEE_GetObjectInfo(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 124 TEE_Result TEE_GetObjectInfo1(TEE_ObjectHandle object, TEE_ObjectInfo *objectInfo); 125 126 void TEE_RestrictObjectUsage(TEE_ObjectHandle object, uint32_t objectUsage); 127 TEE_Result TEE_RestrictObjectUsage1(TEE_ObjectHandle object, uint32_t objectUsage); 128 129 TEE_Result TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 130 uint32_t attributeID, void *buffer, 131 uint32_t *size); 132 133 TEE_Result TEE_GetObjectValueAttribute(TEE_ObjectHandle object, 134 uint32_t attributeID, uint32_t *a, 135 uint32_t *b); 136 137 void TEE_CloseObject(TEE_ObjectHandle object); 138 139 /* Data and Key Storage API - Transient Object Functions */ 140 141 TEE_Result TEE_AllocateTransientObject(TEE_ObjectType objectType, 142 uint32_t maxKeySize, 143 TEE_ObjectHandle *object); 144 145 void TEE_FreeTransientObject(TEE_ObjectHandle object); 146 147 void TEE_ResetTransientObject(TEE_ObjectHandle object); 148 149 TEE_Result TEE_PopulateTransientObject(TEE_ObjectHandle object, 150 TEE_Attribute *attrs, 151 uint32_t attrCount); 152 153 void TEE_InitRefAttribute(TEE_Attribute *attr, uint32_t attributeID, 154 void *buffer, uint32_t length); 155 156 void TEE_InitValueAttribute(TEE_Attribute *attr, uint32_t attributeID, 157 uint32_t a, uint32_t b); 158 159 void TEE_CopyObjectAttributes(TEE_ObjectHandle destObject, 160 TEE_ObjectHandle srcObject); 161 162 TEE_Result TEE_CopyObjectAttributes1(TEE_ObjectHandle destObject, 163 TEE_ObjectHandle srcObject); 164 165 TEE_Result TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 166 TEE_Attribute *params, uint32_t paramCount); 167 168 /* Data and Key Storage API - Persistent Object Functions */ 169 170 TEE_Result TEE_OpenPersistentObject(uint32_t storageID, void *objectID, 171 uint32_t objectIDLen, uint32_t flags, 172 TEE_ObjectHandle *object); 173 174 TEE_Result TEE_CreatePersistentObject(uint32_t storageID, void *objectID, 175 uint32_t objectIDLen, uint32_t flags, 176 TEE_ObjectHandle attributes, 177 const void *initialData, 178 uint32_t initialDataLen, 179 TEE_ObjectHandle *object); 180 181 void TEE_CloseAndDeletePersistentObject(TEE_ObjectHandle object); 182 183 TEE_Result TEE_CloseAndDeletePersistentObject1(TEE_ObjectHandle object); 184 185 TEE_Result TEE_RenamePersistentObject(TEE_ObjectHandle object, 186 const void *newObjectID, 187 uint32_t newObjectIDLen); 188 189 TEE_Result TEE_AllocatePersistentObjectEnumerator(TEE_ObjectEnumHandle * 190 objectEnumerator); 191 192 void TEE_FreePersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 193 194 void TEE_ResetPersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 195 196 TEE_Result TEE_StartPersistentObjectEnumerator(TEE_ObjectEnumHandle 197 objectEnumerator, 198 uint32_t storageID); 199 200 TEE_Result TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 201 TEE_ObjectInfo *objectInfo, 202 void *objectID, uint32_t *objectIDLen); 203 204 /* Data and Key Storage API - Data Stream Access Functions */ 205 206 TEE_Result TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 207 uint32_t size, uint32_t *count); 208 209 TEE_Result TEE_WriteObjectData(TEE_ObjectHandle object, void *buffer, 210 uint32_t size); 211 212 TEE_Result TEE_TruncateObjectData(TEE_ObjectHandle object, uint32_t size); 213 214 TEE_Result TEE_SeekObjectData(TEE_ObjectHandle object, int32_t offset, 215 TEE_Whence whence); 216 217 /* Cryptographic Operations API - Generic Operation Functions */ 218 219 TEE_Result TEE_AllocateOperation(TEE_OperationHandle *operation, 220 uint32_t algorithm, uint32_t mode, 221 uint32_t maxKeySize); 222 223 void TEE_FreeOperation(TEE_OperationHandle operation); 224 225 void TEE_GetOperationInfo(TEE_OperationHandle operation, 226 TEE_OperationInfo *operationInfo); 227 228 void TEE_ResetOperation(TEE_OperationHandle operation); 229 230 TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 231 TEE_ObjectHandle key); 232 233 TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 234 TEE_ObjectHandle key1, TEE_ObjectHandle key2); 235 236 void TEE_CopyOperation(TEE_OperationHandle dstOperation, 237 TEE_OperationHandle srcOperation); 238 239 /* Cryptographic Operations API - Message Digest Functions */ 240 241 void TEE_DigestUpdate(TEE_OperationHandle operation, 242 void *chunk, uint32_t chunkSize); 243 244 TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 245 uint32_t chunkLen, void *hash, uint32_t *hashLen); 246 247 /* Cryptographic Operations API - Symmetric Cipher Functions */ 248 249 void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 250 uint32_t IVLen); 251 252 TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 253 uint32_t srcLen, void *destData, uint32_t *destLen); 254 255 TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 256 const void *srcData, uint32_t srcLen, void *destData, 257 uint32_t *destLen); 258 259 /* Cryptographic Operations API - MAC Functions */ 260 261 void TEE_MACInit(TEE_OperationHandle operation, void *IV, uint32_t IVLen); 262 263 void TEE_MACUpdate(TEE_OperationHandle operation, void *chunk, 264 uint32_t chunkSize); 265 266 TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 267 void *message, uint32_t messageLen, 268 void *mac, uint32_t *macLen); 269 270 TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 271 void *message, uint32_t messageLen, 272 void *mac, uint32_t macLen); 273 274 /* Cryptographic Operations API - Authenticated Encryption Functions */ 275 276 TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 277 uint32_t nonceLen, uint32_t tagLen, uint32_t AADLen, 278 uint32_t payloadLen); 279 280 void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 281 uint32_t AADdataLen); 282 283 TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 284 uint32_t srcLen, void *destData, uint32_t *destLen); 285 286 TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 287 const void *srcData, uint32_t srcLen, 288 void *destData, uint32_t *destLen, void *tag, 289 uint32_t *tagLen); 290 291 TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 292 const void *srcData, uint32_t srcLen, 293 void *destData, uint32_t *destLen, const void *tag, 294 uint32_t tagLen); 295 296 /* Cryptographic Operations API - Asymmetric Functions */ 297 298 TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 299 const TEE_Attribute *params, 300 uint32_t paramCount, const void *srcData, 301 uint32_t srcLen, void *destData, 302 uint32_t *destLen); 303 304 TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 305 const TEE_Attribute *params, 306 uint32_t paramCount, const void *srcData, 307 uint32_t srcLen, void *destData, 308 uint32_t *destLen); 309 310 TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 311 const TEE_Attribute *params, 312 uint32_t paramCount, const void *digest, 313 uint32_t digestLen, void *signature, 314 uint32_t *signatureLen); 315 316 TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 317 const TEE_Attribute *params, 318 uint32_t paramCount, const void *digest, 319 uint32_t digestLen, const void *signature, 320 uint32_t signatureLen); 321 322 /* Cryptographic Operations API - Key Derivation Functions */ 323 324 void TEE_DeriveKey(TEE_OperationHandle operation, 325 const TEE_Attribute *params, uint32_t paramCount, 326 TEE_ObjectHandle derivedKey); 327 328 /* Cryptographic Operations API - Random Number Generation Functions */ 329 330 void TEE_GenerateRandom(void *randomBuffer, uint32_t randomBufferLen); 331 332 /* Date & Time API */ 333 334 void TEE_GetSystemTime(TEE_Time *time); 335 336 TEE_Result TEE_Wait(uint32_t timeout); 337 338 TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 339 340 TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 341 342 void TEE_GetREETime(TEE_Time *time); 343 344 /* TEE Arithmetical API - Memory allocation and size of objects */ 345 346 size_t TEE_BigIntFMMSizeInU32(uint32_t modulusSizeInBits); 347 348 size_t TEE_BigIntFMMContextSizeInU32(uint32_t modulusSizeInBits); 349 350 /* TEE Arithmetical API - Initialization functions */ 351 352 void TEE_BigIntInit(TEE_BigInt *bigInt, uint32_t len); 353 354 void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, uint32_t len, 355 const TEE_BigInt *modulus); 356 357 void TEE_BigIntInitFMM(const TEE_BigIntFMM *bigIntFMM, uint32_t len); 358 359 /* TEE Arithmetical API - Converter functions */ 360 361 TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 362 const uint8_t *buffer, 363 uint32_t bufferLen, 364 int32_t sign); 365 366 TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, uint32_t *bufferLen, 367 const TEE_BigInt *bigInt); 368 369 void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 370 371 TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 372 373 void TEE_BigIntSetShort(TEE_BigInt *dest, int32_t shortVal); 374 375 TEE_Result TEE_BigIntGetShort(int32_t *dest, const TEE_BigInt *src); 376 377 /* TEE Arithmetical API - Logical operations */ 378 379 int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 380 381 int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 382 383 void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 384 size_t bits); 385 386 bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 387 388 uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 389 390 void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 391 const TEE_BigInt *op2); 392 393 void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 394 const TEE_BigInt *op2); 395 396 void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 397 398 void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 399 const TEE_BigInt *op2); 400 401 void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 402 403 void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 404 const TEE_BigInt *op1, const TEE_BigInt *op2); 405 406 void TEE_BigIntReduceMod(TEE_BigInt *dest, const TEE_BigInt *op, 407 const TEE_BigInt *n); 408 409 /* TEE Arithmetical API - Modular arithmetic operations */ 410 411 void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 412 const TEE_BigInt *n); 413 414 void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 415 const TEE_BigInt *op2, const TEE_BigInt *n); 416 417 void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 418 const TEE_BigInt *op2, const TEE_BigInt *n); 419 420 void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 421 const TEE_BigInt *op2, const TEE_BigInt *n); 422 423 void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 424 const TEE_BigInt *n); 425 426 void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 427 const TEE_BigInt *n); 428 429 /* TEE Arithmetical API - Other arithmetic operations */ 430 431 bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 432 433 void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 434 TEE_BigInt *v, const TEE_BigInt *op1, 435 const TEE_BigInt *op2); 436 437 int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 438 uint32_t confidenceLevel); 439 440 /* TEE Arithmetical API - Fast modular multiplication operations */ 441 442 void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 443 const TEE_BigInt *n, 444 const TEE_BigIntFMMContext *context); 445 446 void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 447 const TEE_BigInt *n, 448 const TEE_BigIntFMMContext *context); 449 450 void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 451 const TEE_BigInt *n, 452 const TEE_BigIntFMMContext *context); 453 454 void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 455 const TEE_BigIntFMM *op2, const TEE_BigInt *n, 456 const TEE_BigIntFMMContext *context); 457 458 #endif /* TEE_API_H */ 459