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 0.27 */ 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 size_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 size_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, size_t *nameBufferLen); 70 71 TEE_Result TEE_GetNextProperty(TEE_PropSetHandle enumerator); 72 73 /* System API - Misc */ 74 75 void TEE_Panic(TEE_Result panicCode) __noreturn; 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 size_t size); 104 105 void TEE_SetInstanceData(void *instanceData); 106 107 void *TEE_GetInstanceData(void); 108 109 void *TEE_Malloc(size_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 125 void TEE_RestrictObjectUsage(TEE_ObjectHandle object, uint32_t objectUsage); 126 127 TEE_Result TEE_GetObjectBufferAttribute(TEE_ObjectHandle object, 128 uint32_t attributeID, void *buffer, 129 size_t *size); 130 131 TEE_Result TEE_GetObjectValueAttribute(TEE_ObjectHandle object, 132 uint32_t attributeID, uint32_t *a, 133 uint32_t *b); 134 135 void TEE_CloseObject(TEE_ObjectHandle object); 136 137 /* Data and Key Storage API - Transient Object Functions */ 138 139 TEE_Result TEE_AllocateTransientObject(TEE_ObjectType objectType, 140 uint32_t maxObjectSize, 141 TEE_ObjectHandle *object); 142 143 void TEE_FreeTransientObject(TEE_ObjectHandle object); 144 145 void TEE_ResetTransientObject(TEE_ObjectHandle object); 146 147 TEE_Result TEE_PopulateTransientObject(TEE_ObjectHandle object, 148 TEE_Attribute *attrs, 149 uint32_t attrCount); 150 151 void TEE_InitRefAttribute(TEE_Attribute *attr, uint32_t attributeID, 152 void *buffer, size_t length); 153 154 void TEE_InitValueAttribute(TEE_Attribute *attr, uint32_t attributeID, 155 uint32_t a, uint32_t b); 156 157 void TEE_CopyObjectAttributes(TEE_ObjectHandle destObject, 158 TEE_ObjectHandle srcObject); 159 160 TEE_Result TEE_GenerateKey(TEE_ObjectHandle object, uint32_t keySize, 161 TEE_Attribute *params, uint32_t paramCount); 162 163 /* Data and Key Storage API - Persistent Object Functions */ 164 165 TEE_Result TEE_OpenPersistentObject(uint32_t storageID, void *objectID, 166 size_t objectIDLen, uint32_t flags, 167 TEE_ObjectHandle *object); 168 169 TEE_Result TEE_CreatePersistentObject(uint32_t storageID, void *objectID, 170 size_t objectIDLen, uint32_t flags, 171 TEE_ObjectHandle attributes, 172 const void *initialData, 173 size_t initialDataLen, 174 TEE_ObjectHandle *object); 175 176 void TEE_CloseAndDeletePersistentObject(TEE_ObjectHandle object); 177 178 TEE_Result TEE_RenamePersistentObject(TEE_ObjectHandle object, 179 const void *newObjectID, 180 size_t newObjectIDLen); 181 182 TEE_Result TEE_AllocatePersistentObjectEnumerator(TEE_ObjectEnumHandle * 183 objectEnumerator); 184 185 void TEE_FreePersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 186 187 void TEE_ResetPersistentObjectEnumerator(TEE_ObjectEnumHandle objectEnumerator); 188 189 TEE_Result TEE_StartPersistentObjectEnumerator(TEE_ObjectEnumHandle 190 objectEnumerator, 191 uint32_t storageID); 192 193 TEE_Result TEE_GetNextPersistentObject(TEE_ObjectEnumHandle objectEnumerator, 194 TEE_ObjectInfo *objectInfo, 195 void *objectID, size_t *objectIDLen); 196 197 /* Data and Key Storage API - Data Stream Access Functions */ 198 199 TEE_Result TEE_ReadObjectData(TEE_ObjectHandle object, void *buffer, 200 size_t size, uint32_t *count); 201 202 TEE_Result TEE_WriteObjectData(TEE_ObjectHandle object, void *buffer, 203 size_t size); 204 205 TEE_Result TEE_TruncateObjectData(TEE_ObjectHandle object, uint32_t size); 206 207 TEE_Result TEE_SeekObjectData(TEE_ObjectHandle object, int32_t offset, 208 TEE_Whence whence); 209 210 /* Cryptographic Operations API - Generic Operation Functions */ 211 212 TEE_Result TEE_AllocateOperation(TEE_OperationHandle *operation, 213 uint32_t algorithm, uint32_t mode, 214 uint32_t maxKeySize); 215 216 void TEE_FreeOperation(TEE_OperationHandle operation); 217 218 void TEE_GetOperationInfo(TEE_OperationHandle operation, 219 TEE_OperationInfo *operationInfo); 220 221 void TEE_ResetOperation(TEE_OperationHandle operation); 222 223 TEE_Result TEE_SetOperationKey(TEE_OperationHandle operation, 224 TEE_ObjectHandle key); 225 226 TEE_Result TEE_SetOperationKey2(TEE_OperationHandle operation, 227 TEE_ObjectHandle key1, TEE_ObjectHandle key2); 228 229 void TEE_CopyOperation(TEE_OperationHandle dstOperation, 230 TEE_OperationHandle srcOperation); 231 232 /* Cryptographic Operations API - Message Digest Functions */ 233 234 void TEE_DigestUpdate(TEE_OperationHandle operation, 235 void *chunk, size_t chunkSize); 236 237 TEE_Result TEE_DigestDoFinal(TEE_OperationHandle operation, const void *chunk, 238 size_t chunkLen, void *hash, size_t *hashLen); 239 240 /* Cryptographic Operations API - Symmetric Cipher Functions */ 241 242 void TEE_CipherInit(TEE_OperationHandle operation, const void *IV, 243 size_t IVLen); 244 245 TEE_Result TEE_CipherUpdate(TEE_OperationHandle operation, const void *srcData, 246 size_t srcLen, void *destData, size_t *destLen); 247 248 TEE_Result TEE_CipherDoFinal(TEE_OperationHandle operation, 249 const void *srcData, size_t srcLen, void *destData, 250 size_t *destLen); 251 252 /* Cryptographic Operations API - MAC Functions */ 253 254 void TEE_MACInit(TEE_OperationHandle operation, const void *IV, size_t IVLen); 255 256 void TEE_MACUpdate(TEE_OperationHandle operation, const void *chunk, 257 size_t chunkSize); 258 259 TEE_Result TEE_MACComputeFinal(TEE_OperationHandle operation, 260 const void *message, size_t messageLen, 261 void *mac, size_t *macLen); 262 263 TEE_Result TEE_MACCompareFinal(TEE_OperationHandle operation, 264 const void *message, size_t messageLen, 265 const void *mac, size_t macLen); 266 267 /* Cryptographic Operations API - Authenticated Encryption Functions */ 268 269 TEE_Result TEE_AEInit(TEE_OperationHandle operation, const void *nonce, 270 size_t nonceLen, uint32_t tagLen, uint32_t AADLen, 271 uint32_t payloadLen); 272 273 void TEE_AEUpdateAAD(TEE_OperationHandle operation, const void *AADdata, 274 size_t AADdataLen); 275 276 TEE_Result TEE_AEUpdate(TEE_OperationHandle operation, const void *srcData, 277 size_t srcLen, void *destData, size_t *destLen); 278 279 TEE_Result TEE_AEEncryptFinal(TEE_OperationHandle operation, 280 const void *srcData, size_t srcLen, 281 void *destData, size_t *destLen, void *tag, 282 size_t *tagLen); 283 284 TEE_Result TEE_AEDecryptFinal(TEE_OperationHandle operation, 285 const void *srcData, size_t srcLen, 286 void *destData, size_t *destLen, const void *tag, 287 size_t tagLen); 288 289 /* Cryptographic Operations API - Asymmetric Functions */ 290 291 TEE_Result TEE_AsymmetricEncrypt(TEE_OperationHandle operation, 292 const TEE_Attribute *params, 293 uint32_t paramCount, const void *srcData, 294 size_t srcLen, void *destData, 295 size_t *destLen); 296 297 TEE_Result TEE_AsymmetricDecrypt(TEE_OperationHandle operation, 298 const TEE_Attribute *params, 299 uint32_t paramCount, const void *srcData, 300 size_t srcLen, void *destData, 301 size_t *destLen); 302 303 TEE_Result TEE_AsymmetricSignDigest(TEE_OperationHandle operation, 304 const TEE_Attribute *params, 305 uint32_t paramCount, const void *digest, 306 size_t digestLen, void *signature, 307 size_t *signatureLen); 308 309 TEE_Result TEE_AsymmetricVerifyDigest(TEE_OperationHandle operation, 310 const TEE_Attribute *params, 311 uint32_t paramCount, const void *digest, 312 size_t digestLen, const void *signature, 313 size_t signatureLen); 314 315 /* Cryptographic Operations API - Key Derivation Functions */ 316 317 void TEE_DeriveKey(TEE_OperationHandle operation, 318 const TEE_Attribute *params, uint32_t paramCount, 319 TEE_ObjectHandle derivedKey); 320 321 /* Cryptographic Operations API - Random Number Generation Functions */ 322 323 void TEE_GenerateRandom(void *randomBuffer, size_t randomBufferLen); 324 325 /* Date & Time API */ 326 327 void TEE_GetSystemTime(TEE_Time *time); 328 329 TEE_Result TEE_Wait(uint32_t timeout); 330 331 TEE_Result TEE_GetTAPersistentTime(TEE_Time *time); 332 333 TEE_Result TEE_SetTAPersistentTime(const TEE_Time *time); 334 335 void TEE_GetREETime(TEE_Time *time); 336 337 /* TEE Arithmetical API - Memory allocation and size of objects */ 338 339 size_t TEE_BigIntFMMSizeInU32(size_t modulusSizeInBits); 340 341 size_t TEE_BigIntFMMContextSizeInU32(size_t modulusSizeInBits); 342 343 /* TEE Arithmetical API - Initialization functions */ 344 345 void TEE_BigIntInit(TEE_BigInt *bigInt, size_t len); 346 347 void TEE_BigIntInitFMMContext(TEE_BigIntFMMContext *context, size_t len, 348 const TEE_BigInt *modulus); 349 350 void TEE_BigIntInitFMM(const TEE_BigIntFMM *bigIntFMM, size_t len); 351 352 /* TEE Arithmetical API - Converter functions */ 353 354 TEE_Result TEE_BigIntConvertFromOctetString(TEE_BigInt *dest, 355 const uint8_t *buffer, 356 size_t bufferLen, 357 int32_t sign); 358 359 TEE_Result TEE_BigIntConvertToOctetString(uint8_t *buffer, size_t *bufferLen, 360 const TEE_BigInt *bigInt); 361 362 void TEE_BigIntConvertFromS32(TEE_BigInt *dest, int32_t shortVal); 363 364 TEE_Result TEE_BigIntConvertToS32(int32_t *dest, const TEE_BigInt *src); 365 366 void TEE_BigIntSetShort(TEE_BigInt *dest, int32_t shortVal); 367 368 TEE_Result TEE_BigIntGetShort(int32_t *dest, const TEE_BigInt *src); 369 370 /* TEE Arithmetical API - Logical operations */ 371 372 int32_t TEE_BigIntCmp(const TEE_BigInt *op1, const TEE_BigInt *op2); 373 374 int32_t TEE_BigIntCmpS32(const TEE_BigInt *op, int32_t shortVal); 375 376 void TEE_BigIntShiftRight(TEE_BigInt *dest, const TEE_BigInt *op, 377 size_t bits); 378 379 bool TEE_BigIntGetBit(const TEE_BigInt *src, uint32_t bitIndex); 380 381 uint32_t TEE_BigIntGetBitCount(const TEE_BigInt *src); 382 383 void TEE_BigIntAdd(TEE_BigInt *dest, const TEE_BigInt *op1, 384 const TEE_BigInt *op2); 385 386 void TEE_BigIntSub(TEE_BigInt *dest, const TEE_BigInt *op1, 387 const TEE_BigInt *op2); 388 389 void TEE_BigIntNeg(TEE_BigInt *dest, const TEE_BigInt *op); 390 391 void TEE_BigIntMul(TEE_BigInt *dest, const TEE_BigInt *op1, 392 const TEE_BigInt *op2); 393 394 void TEE_BigIntSquare(TEE_BigInt *dest, const TEE_BigInt *op); 395 396 void TEE_BigIntDiv(TEE_BigInt *dest_q, TEE_BigInt *dest_r, 397 const TEE_BigInt *op1, const TEE_BigInt *op2); 398 399 void TEE_BigIntReduceMod(TEE_BigInt *dest, const TEE_BigInt *op, 400 const TEE_BigInt *n); 401 402 /* TEE Arithmetical API - Modular arithmetic operations */ 403 404 void TEE_BigIntMod(TEE_BigInt *dest, const TEE_BigInt *op, 405 const TEE_BigInt *n); 406 407 void TEE_BigIntAddMod(TEE_BigInt *dest, const TEE_BigInt *op1, 408 const TEE_BigInt *op2, const TEE_BigInt *n); 409 410 void TEE_BigIntSubMod(TEE_BigInt *dest, const TEE_BigInt *op1, 411 const TEE_BigInt *op2, const TEE_BigInt *n); 412 413 void TEE_BigIntMulMod(TEE_BigInt *dest, const TEE_BigInt *op1, 414 const TEE_BigInt *op2, const TEE_BigInt *n); 415 416 void TEE_BigIntSquareMod(TEE_BigInt *dest, const TEE_BigInt *op, 417 const TEE_BigInt *n); 418 419 void TEE_BigIntInvMod(TEE_BigInt *dest, const TEE_BigInt *op, 420 const TEE_BigInt *n); 421 422 /* TEE Arithmetical API - Other arithmetic operations */ 423 424 bool TEE_BigIntRelativePrime(const TEE_BigInt *op1, const TEE_BigInt *op2); 425 426 void TEE_BigIntComputeExtendedGcd(TEE_BigInt *gcd, TEE_BigInt *u, 427 TEE_BigInt *v, const TEE_BigInt *op1, 428 const TEE_BigInt *op2); 429 430 int32_t TEE_BigIntIsProbablePrime(const TEE_BigInt *op, 431 uint32_t confidenceLevel); 432 433 /* TEE Arithmetical API - Fast modular multiplication operations */ 434 435 void TEE_BigIntConvertToFMM(TEE_BigIntFMM *dest, const TEE_BigInt *src, 436 const TEE_BigInt *n, 437 const TEE_BigIntFMMContext *context); 438 439 void TEE_BigIntConvertFromFMM(TEE_BigInt *dest, const TEE_BigIntFMM *src, 440 const TEE_BigInt *n, 441 const TEE_BigIntFMMContext *context); 442 443 void TEE_BigIntFMMConvertToBigInt(TEE_BigInt *dest, const TEE_BigIntFMM *src, 444 const TEE_BigInt *n, 445 const TEE_BigIntFMMContext *context); 446 447 void TEE_BigIntComputeFMM(TEE_BigIntFMM *dest, const TEE_BigIntFMM *op1, 448 const TEE_BigIntFMM *op2, const TEE_BigInt *n, 449 const TEE_BigIntFMMContext *context); 450 451 #endif /* TEE_API_H */ 452