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.11 */ 29 #ifndef TEE_API_DEFINES_H 30 #define TEE_API_DEFINES_H 31 32 #define TEE_HANDLE_NULL 0 33 34 #define TEE_TIMEOUT_INFINITE 0xFFFFFFFF 35 36 /* API Error Codes */ 37 #define TEE_SUCCESS 0x00000000 38 #define TEE_ERROR_GENERIC 0xFFFF0000 39 #define TEE_ERROR_ACCESS_DENIED 0xFFFF0001 40 #define TEE_ERROR_CANCEL 0xFFFF0002 41 #define TEE_ERROR_ACCESS_CONFLICT 0xFFFF0003 42 #define TEE_ERROR_EXCESS_DATA 0xFFFF0004 43 #define TEE_ERROR_BAD_FORMAT 0xFFFF0005 44 #define TEE_ERROR_BAD_PARAMETERS 0xFFFF0006 45 #define TEE_ERROR_BAD_STATE 0xFFFF0007 46 #define TEE_ERROR_ITEM_NOT_FOUND 0xFFFF0008 47 #define TEE_ERROR_NOT_IMPLEMENTED 0xFFFF0009 48 #define TEE_ERROR_NOT_SUPPORTED 0xFFFF000A 49 #define TEE_ERROR_NO_DATA 0xFFFF000B 50 #define TEE_ERROR_OUT_OF_MEMORY 0xFFFF000C 51 #define TEE_ERROR_BUSY 0xFFFF000D 52 #define TEE_ERROR_COMMUNICATION 0xFFFF000E 53 #define TEE_ERROR_SECURITY 0xFFFF000F 54 #define TEE_ERROR_SHORT_BUFFER 0xFFFF0010 55 #define TEE_PENDING 0xFFFF2000 56 #define TEE_ERROR_TIMEOUT 0xFFFF3001 57 #define TEE_ERROR_OVERFLOW 0xFFFF300F 58 #define TEE_ERROR_TARGET_DEAD 0xFFFF3024 59 #define TEE_ERROR_STORAGE_NO_SPACE 0xFFFF3041 60 #define TEE_ERROR_MAC_INVALID 0xFFFF3071 61 #define TEE_ERROR_SIGNATURE_INVALID 0xFFFF3072 62 #define TEE_ERROR_TIME_NOT_SET 0xFFFF5000 63 #define TEE_ERROR_TIME_NEEDS_RESET 0xFFFF5001 64 65 /* 66 * Proprietary error codes. 67 * All proprietary error codes should use the 0xF57E prefix. 68 */ 69 #define TEE_ERROR_SYSTEM_BUSY 0xF57E0000 70 #define TEE_ERROR_FILE_NOT_FOUND 0xF57E0010 71 72 /* Parameter Type Constants */ 73 #define TEE_PARAM_TYPE_NONE 0 74 #define TEE_PARAM_TYPE_VALUE_INPUT 1 75 #define TEE_PARAM_TYPE_VALUE_OUTPUT 2 76 #define TEE_PARAM_TYPE_VALUE_INOUT 3 77 #define TEE_PARAM_TYPE_MEMREF_INPUT 5 78 #define TEE_PARAM_TYPE_MEMREF_OUTPUT 6 79 #define TEE_PARAM_TYPE_MEMREF_INOUT 7 80 81 /* Login Type Constants */ 82 #define TEE_LOGIN_PUBLIC 0x00000000 83 #define TEE_LOGIN_USER 0x00000001 84 #define TEE_LOGIN_GROUP 0x00000002 85 #define TEE_LOGIN_APPLICATION 0x00000004 86 #define TEE_LOGIN_APPLICATION_USER 0x00000005 87 #define TEE_LOGIN_APPLICATION_GROUP 0x00000006 88 #define TEE_LOGIN_KERNEL 0xA0000000 89 #define TEE_LOGIN_TRUSTED_APP 0xF0000000 90 91 /* Origin Code Constants */ 92 #define TEE_ORIGIN_API 0x00000001 93 #define TEE_ORIGIN_COMMS 0x00000002 94 #define TEE_ORIGIN_TEE 0x00000003 95 #define TEE_ORIGIN_TRUSTED_APP 0x00000004 96 97 /* Property Sets pseudo handles */ 98 #define TEE_PROPSET_CURRENT_TA (TEE_PropSetHandle)0xFFFFFFFF 99 #define TEE_PROPSET_CURRENT_CLIENT (TEE_PropSetHandle)0xFFFFFFFE 100 #define TEE_PROPSET_TEE_IMPLEMENTATION (TEE_PropSetHandle)0xFFFFFFFD 101 102 /* Memory Access Rights Constants */ 103 #define TEE_MEMORY_ACCESS_READ 0x00000001 104 #define TEE_MEMORY_ACCESS_WRITE 0x00000002 105 #define TEE_MEMORY_ACCESS_ANY_OWNER 0x00000004 106 107 /* Other constants */ 108 #define TEE_STORAGE_PRIVATE 0x00000001 109 #define TEE_DATA_FLAG_ACCESS_READ 0x00000001 110 #define TEE_DATA_FLAG_ACCESS_WRITE 0x00000002 111 #define TEE_DATA_FLAG_ACCESS_WRITE_META 0x00000004 112 #define TEE_DATA_FLAG_SHARE_READ 0x00000010 113 #define TEE_DATA_FLAG_SHARE_WRITE 0x00000020 114 #define TEE_DATA_FLAG_CREATE 0x00000200 115 #define TEE_DATA_FLAG_EXCLUSIVE 0x00000400 116 #define TEE_DATA_MAX_POSITION 0xFFFFFFFF 117 #define TEE_OBJECT_ID_MAX_LEN 64 118 #define TEE_USAGE_EXTRACTABLE 0x00000001 119 #define TEE_USAGE_ENCRYPT 0x00000002 120 #define TEE_USAGE_DECRYPT 0x00000004 121 #define TEE_USAGE_MAC 0x00000008 122 #define TEE_USAGE_SIGN 0x00000010 123 #define TEE_USAGE_VERIFY 0x00000020 124 #define TEE_USAGE_DERIVE 0x00000040 125 #define TEE_HANDLE_FLAG_PERSISTENT 0x00010000 126 #define TEE_HANDLE_FLAG_INITIALIZED 0x00020000 127 #define TEE_HANDLE_FLAG_KEY_SET 0x00040000 128 #define TEE_HANDLE_FLAG_EXPECT_TWO_KEYS 0x00080000 129 #define TEE_OPERATION_CIPHER 1 130 #define TEE_OPERATION_MAC 3 131 #define TEE_OPERATION_AE 4 132 #define TEE_OPERATION_DIGEST 5 133 #define TEE_OPERATION_ASYMMETRIC_CIPHER 6 134 #define TEE_OPERATION_ASYMMETRIC_SIGNATURE 7 135 #define TEE_OPERATION_KEY_DERIVATION 8 136 137 /* Algorithm Identifiers */ 138 #define TEE_ALG_AES_ECB_NOPAD 0x10000010 139 #define TEE_ALG_AES_CBC_NOPAD 0x10000110 140 #define TEE_ALG_AES_CTR 0x10000210 141 #define TEE_ALG_AES_CTS 0x10000310 142 #define TEE_ALG_AES_XTS 0x10000410 143 #define TEE_ALG_AES_CBC_MAC_NOPAD 0x30000110 144 #define TEE_ALG_AES_CBC_MAC_PKCS5 0x30000510 145 #define TEE_ALG_AES_CMAC 0x30000610 146 #define TEE_ALG_AES_CCM 0x40000710 147 #define TEE_ALG_AES_GCM 0x40000810 148 #define TEE_ALG_DES_ECB_NOPAD 0x10000011 149 #define TEE_ALG_DES_CBC_NOPAD 0x10000111 150 #define TEE_ALG_DES_CBC_MAC_NOPAD 0x30000111 151 #define TEE_ALG_DES_CBC_MAC_PKCS5 0x30000511 152 #define TEE_ALG_DES3_ECB_NOPAD 0x10000013 153 #define TEE_ALG_DES3_CBC_NOPAD 0x10000113 154 #define TEE_ALG_DES3_CBC_MAC_NOPAD 0x30000113 155 #define TEE_ALG_DES3_CBC_MAC_PKCS5 0x30000513 156 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5 0x70001830 157 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA1 0x70002830 158 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA224 0x70003830 159 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA256 0x70004830 160 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA384 0x70005830 161 #define TEE_ALG_RSASSA_PKCS1_V1_5_SHA512 0x70006830 162 #define TEE_ALG_RSASSA_PKCS1_V1_5_MD5SHA1 0x7000F830 163 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA1 0x70212930 164 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA224 0x70313930 165 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA256 0x70414930 166 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA384 0x70515930 167 #define TEE_ALG_RSASSA_PKCS1_PSS_MGF1_SHA512 0x70616930 168 #define TEE_ALG_RSAES_PKCS1_V1_5 0x60000130 169 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA1 0x60210230 170 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA224 0x60310230 171 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA256 0x60410230 172 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA384 0x60510230 173 #define TEE_ALG_RSAES_PKCS1_OAEP_MGF1_SHA512 0x60610230 174 #define TEE_ALG_RSA_NOPAD 0x60000030 175 #define TEE_ALG_DSA_SHA1 0x70002131 176 #define TEE_ALG_DH_DERIVE_SHARED_SECRET 0x80000032 177 #define TEE_ALG_MD5 0x50000001 178 #define TEE_ALG_SHA1 0x50000002 179 #define TEE_ALG_SHA224 0x50000003 180 #define TEE_ALG_SHA256 0x50000004 181 #define TEE_ALG_SHA384 0x50000005 182 #define TEE_ALG_SHA512 0x50000006 183 #define TEE_ALG_MD5SHA1 0x5000000F 184 #define TEE_ALG_HMAC_MD5 0x30000001 185 #define TEE_ALG_HMAC_SHA1 0x30000002 186 #define TEE_ALG_HMAC_SHA224 0x30000003 187 #define TEE_ALG_HMAC_SHA256 0x30000004 188 #define TEE_ALG_HMAC_SHA384 0x30000005 189 #define TEE_ALG_HMAC_SHA512 0x30000006 190 191 /* Object Types */ 192 193 #define TEE_TYPE_AES 0xA0000010 194 #define TEE_TYPE_DES 0xA0000011 195 #define TEE_TYPE_DES3 0xA0000013 196 #define TEE_TYPE_HMAC_MD5 0xA0000001 197 #define TEE_TYPE_HMAC_SHA1 0xA0000002 198 #define TEE_TYPE_HMAC_SHA224 0xA0000003 199 #define TEE_TYPE_HMAC_SHA256 0xA0000004 200 #define TEE_TYPE_HMAC_SHA384 0xA0000005 201 #define TEE_TYPE_HMAC_SHA512 0xA0000006 202 #define TEE_TYPE_RSA_PUBLIC_KEY 0xA0000030 203 #define TEE_TYPE_RSA_KEYPAIR 0xA1000030 204 #define TEE_TYPE_DSA_PUBLIC_KEY 0xA0000031 205 #define TEE_TYPE_DSA_KEYPAIR 0xA1000031 206 #define TEE_TYPE_DH_KEYPAIR 0xA1000032 207 #define TEE_TYPE_GENERIC_SECRET 0xA0000000 208 209 /* List of Object or Operation Attributes */ 210 211 #define TEE_ATTR_SECRET_VALUE 0xC0000000 212 #define TEE_ATTR_RSA_MODULUS 0xD0000130 213 #define TEE_ATTR_RSA_PUBLIC_EXPONENT 0xD0000230 214 #define TEE_ATTR_RSA_PRIVATE_EXPONENT 0xC0000330 215 #define TEE_ATTR_RSA_PRIME1 0xC0000430 216 #define TEE_ATTR_RSA_PRIME2 0xC0000530 217 #define TEE_ATTR_RSA_EXPONENT1 0xC0000630 218 #define TEE_ATTR_RSA_EXPONENT2 0xC0000730 219 #define TEE_ATTR_RSA_COEFFICIENT 0xC0000830 220 #define TEE_ATTR_DSA_PRIME 0xD0001031 221 #define TEE_ATTR_DSA_SUBPRIME 0xD0001131 222 #define TEE_ATTR_DSA_BASE 0xD0001231 223 #define TEE_ATTR_DSA_PUBLIC_VALUE 0xD0000131 224 #define TEE_ATTR_DSA_PRIVATE_VALUE 0xC0000231 225 #define TEE_ATTR_DH_PRIME 0xD0001032 226 #define TEE_ATTR_DH_SUBPRIME 0xD0001132 227 #define TEE_ATTR_DH_BASE 0xD0001232 228 #define TEE_ATTR_DH_X_BITS 0xF0001332 229 #define TEE_ATTR_DH_PUBLIC_VALUE 0xD0000132 230 #define TEE_ATTR_DH_PRIVATE_VALUE 0xC0000232 231 #define TEE_ATTR_RSA_OAEP_LABEL 0xD0000930 232 #define TEE_ATTR_RSA_PSS_SALT_LENGTH 0xF0000A30 233 234 /* 235 * The macro TEE_PARAM_TYPES can be used to construct a value that you can 236 * compare against an incoming paramTypes to check the type of all the 237 * parameters in one comparison, like in the following example: 238 * if (paramTypes != TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT, 239 * TEE_PARAM_TYPE_MEMREF_OUPUT, 240 * TEE_PARAM_TYPE_NONE, TEE_PARAM_TYPE_NONE)) { 241 * return TEE_ERROR_BAD_PARAMETERS; 242 * } 243 */ 244 #define TEE_PARAM_TYPES(t0,t1,t2,t3) \ 245 ((t0) | ((t1) << 4) | ((t2) << 8) | ((t3) << 12)) 246 247 /* 248 * The macro TEE_PARAM_TYPE_GET can be used to extract the type of a given 249 * parameter from paramTypes if you need more fine-grained type checking. 250 */ 251 #define TEE_PARAM_TYPE_GET(t, i) ((((uint32_t)t) >> ((i)*4)) & 0xF) 252 253 /* 254 * The macro TEE_PARAM_TYPE_SET can be used to load the type of a given 255 * parameter from paramTypes without specifying all types (TEE_PARAM_TYPES) 256 */ 257 #define TEE_PARAM_TYPE_SET(t, i) (((uint32_t)(t) & 0xF) << ((i)*4)) 258 259 /* Not specified in the standard */ 260 #define TEE_NUM_PARAMS 4 261 262 /* TEE Arithmetical APIs */ 263 264 #define TEE_BigIntSizeInU32(n) ((((n)+31)/32)+2) 265 266 #endif /* TEE_API_DEFINES_H */ 267