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