1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2014, STMicroelectronics International N.V. 4 * Copyright (c) 2021, SumUp Services GmbH 5 */ 6 #ifndef UTEE_DEFINES_H 7 #define UTEE_DEFINES_H 8 9 #include <compiler.h> 10 #include <tee_api_defines.h> 11 #include <tee_api_defines_extensions.h> 12 #include <types_ext.h> 13 14 /* 15 * Copied from TEE Internal API specificaion v1.0 table 6-9 "Structure of 16 * Algorithm Identifier". 17 */ 18 #define TEE_MAIN_ALGO_MD5 0x01 19 #define TEE_MAIN_ALGO_SHA1 0x02 20 #define TEE_MAIN_ALGO_SHA224 0x03 21 #define TEE_MAIN_ALGO_SHA256 0x04 22 #define TEE_MAIN_ALGO_SHA384 0x05 23 #define TEE_MAIN_ALGO_SHA512 0x06 24 #define TEE_MAIN_ALGO_SM3 0x07 25 #define TEE_MAIN_ALGO_SHA3_224 0x08 26 #define TEE_MAIN_ALGO_SHA3_256 0x09 27 #define TEE_MAIN_ALGO_SHA3_384 0x0A 28 #define TEE_MAIN_ALGO_SHA3_512 0x0B 29 #define TEE_MAIN_ALGO_AES 0x10 30 #define TEE_MAIN_ALGO_DES 0x11 31 #define TEE_MAIN_ALGO_DES2 0x12 32 #define TEE_MAIN_ALGO_DES3 0x13 33 #define TEE_MAIN_ALGO_SM4 0x14 /* Not in v1.2, extrapolated */ 34 #define TEE_MAIN_ALGO_RSA 0x30 35 #define TEE_MAIN_ALGO_DSA 0x31 36 #define TEE_MAIN_ALGO_DH 0x32 37 #define TEE_MAIN_ALGO_ECDSA 0x41 38 #define TEE_MAIN_ALGO_ECDH 0x42 39 #define TEE_MAIN_ALGO_ED25519 0x43 40 #define TEE_MAIN_ALGO_SM2_DSA_SM3 0x45 /* Not in v1.2 spec */ 41 #define TEE_MAIN_ALGO_SM2_KEP 0x46 /* Not in v1.2 spec */ 42 #define TEE_MAIN_ALGO_SM2_PKE 0x47 /* Not in v1.2 spec */ 43 #define TEE_MAIN_ALGO_HKDF 0xC0 /* OP-TEE extension */ 44 #define TEE_MAIN_ALGO_CONCAT_KDF 0xC1 /* OP-TEE extension */ 45 #define TEE_MAIN_ALGO_PBKDF2 0xC2 /* OP-TEE extension */ 46 #define TEE_MAIN_ALGO_X25519 0x44 /* Not in v1.2 spec */ 47 #define TEE_MAIN_ALGO_SHAKE128 0xC3 /* OP-TEE extension */ 48 #define TEE_MAIN_ALGO_SHAKE256 0xC4 /* OP-TEE extension */ 49 50 51 #define TEE_CHAIN_MODE_ECB_NOPAD 0x0 52 #define TEE_CHAIN_MODE_CBC_NOPAD 0x1 53 #define TEE_CHAIN_MODE_CTR 0x2 54 #define TEE_CHAIN_MODE_CTS 0x3 55 #define TEE_CHAIN_MODE_XTS 0x4 56 #define TEE_CHAIN_MODE_CBC_MAC_PKCS5 0x5 57 #define TEE_CHAIN_MODE_CMAC 0x6 58 #define TEE_CHAIN_MODE_CCM 0x7 59 #define TEE_CHAIN_MODE_GCM 0x8 60 #define TEE_CHAIN_MODE_PKCS1_PSS_MGF1 0x9 /* ??? */ 61 62 63 static inline uint32_t __tee_alg_get_class(uint32_t algo) 64 { 65 if (algo == TEE_ALG_SM2_PKE) 66 return TEE_OPERATION_ASYMMETRIC_CIPHER; 67 if (algo == TEE_ALG_SM2_KEP) 68 return TEE_OPERATION_KEY_DERIVATION; 69 if (algo == TEE_ALG_RSASSA_PKCS1_V1_5) 70 return TEE_OPERATION_ASYMMETRIC_SIGNATURE; 71 if (algo == TEE_ALG_DES3_CMAC) 72 return TEE_OPERATION_MAC; 73 if (algo == TEE_ALG_SM4_XTS) 74 return TEE_OPERATION_CIPHER; 75 if (algo == TEE_ALG_RSASSA_PKCS1_PSS_MGF1_MD5) 76 return TEE_OPERATION_ASYMMETRIC_SIGNATURE; 77 if (algo == TEE_ALG_RSAES_PKCS1_OAEP_MGF1_MD5) 78 return TEE_OPERATION_ASYMMETRIC_CIPHER; 79 80 return (algo >> 28) & 0xF; /* Bits [31:28] */ 81 } 82 83 #define TEE_ALG_GET_CLASS(algo) __tee_alg_get_class(algo) 84 85 static inline uint32_t __tee_alg_get_main_alg(uint32_t algo) 86 { 87 switch (algo) { 88 case TEE_ALG_SM2_PKE: 89 return TEE_MAIN_ALGO_SM2_PKE; 90 case TEE_ALG_SM2_KEP: 91 return TEE_MAIN_ALGO_SM2_KEP; 92 case TEE_ALG_X25519: 93 return TEE_MAIN_ALGO_X25519; 94 case TEE_ALG_ED25519: 95 return TEE_MAIN_ALGO_ED25519; 96 case TEE_ALG_ECDSA_SHA1: 97 case TEE_ALG_ECDSA_SHA224: 98 case TEE_ALG_ECDSA_SHA256: 99 case TEE_ALG_ECDSA_SHA384: 100 case TEE_ALG_ECDSA_SHA512: 101 return TEE_MAIN_ALGO_ECDSA; 102 case TEE_ALG_HKDF: 103 return TEE_MAIN_ALGO_HKDF; 104 case TEE_ALG_SHAKE128: 105 return TEE_MAIN_ALGO_SHAKE128; 106 case TEE_ALG_SHAKE256: 107 return TEE_MAIN_ALGO_SHAKE256; 108 default: 109 break; 110 } 111 112 return algo & 0xff; 113 } 114 115 #define TEE_ALG_GET_MAIN_ALG(algo) __tee_alg_get_main_alg(algo) 116 117 /* Bits [11:8] */ 118 #define TEE_ALG_GET_CHAIN_MODE(algo) (((algo) >> 8) & 0xF) 119 120 /* 121 * Value not defined in the GP spec, and not used as bits 15-12 of any TEE_ALG* 122 * value. TEE_ALG_SM2_DSA_SM3 has value 0x6 for bits 15-12 which would yield the 123 * SHA512 digest if we were to apply the bit masks that were valid up to the TEE 124 * Internal Core API v1.1. 125 */ 126 #define __TEE_MAIN_HASH_SM3 0x7 127 128 static inline uint32_t __tee_alg_get_digest_hash(uint32_t algo) 129 { 130 if (algo == TEE_ALG_SM2_DSA_SM3) 131 return __TEE_MAIN_HASH_SM3; 132 133 /* Bits [15:12] */ 134 return (algo >> 12) & 0xF; 135 } 136 137 #define TEE_ALG_GET_DIGEST_HASH(algo) __tee_alg_get_digest_hash(algo) 138 139 /* Bits [23:20] */ 140 #define TEE_ALG_GET_INTERNAL_HASH(algo) (((algo) >> 20) & 0x7) 141 142 static inline uint32_t __tee_alg_get_key_type(uint32_t algo, bool with_priv) 143 { 144 uint32_t key_type = 0xA0000000 | TEE_ALG_GET_MAIN_ALG(algo); 145 146 if (with_priv) 147 key_type |= 0x01000000; 148 149 return key_type; 150 } 151 152 #define TEE_ALG_GET_KEY_TYPE(algo, with_private_key) \ 153 __tee_alg_get_key_type(algo, with_private_key) 154 155 static inline uint32_t __tee_alg_hash_algo(uint32_t main_hash) 156 { 157 if (main_hash == __TEE_MAIN_HASH_SM3) 158 return TEE_ALG_SM3; 159 160 return (TEE_OPERATION_DIGEST << 28) | main_hash; 161 } 162 163 /* Return hash algorithm based on main hash */ 164 #define TEE_ALG_HASH_ALGO(main_hash) __tee_alg_hash_algo(main_hash) 165 166 /* Extract internal hash and return hash algorithm */ 167 #define TEE_INTERNAL_HASH_TO_ALGO(algo) \ 168 TEE_ALG_HASH_ALGO(TEE_ALG_GET_INTERNAL_HASH(algo)) 169 170 /* Extract digest hash and return hash algorithm */ 171 #define TEE_DIGEST_HASH_TO_ALGO(algo) \ 172 TEE_ALG_HASH_ALGO(TEE_ALG_GET_DIGEST_HASH(algo)) 173 174 /* Return HMAC algorithm based on main hash */ 175 #define TEE_ALG_HMAC_ALGO(main_hash) \ 176 (TEE_OPERATION_MAC << 28 | (main_hash)) 177 178 #define TEE_AES_BLOCK_SIZE 16UL 179 #define TEE_DES_BLOCK_SIZE 8UL 180 #define TEE_SM4_BLOCK_SIZE 16UL 181 182 #define TEE_AES_MAX_KEY_SIZE 32UL 183 184 /* SHA-512 */ 185 #ifndef TEE_MD5_HASH_SIZE 186 typedef enum { 187 TEE_MD5_HASH_SIZE = 16, 188 TEE_SHA1_HASH_SIZE = 20, 189 TEE_SHA224_HASH_SIZE = 28, 190 TEE_SHA256_HASH_SIZE = 32, 191 TEE_SM3_HASH_SIZE = 32, 192 TEE_SHA384_HASH_SIZE = 48, 193 TEE_SHA512_HASH_SIZE = 64, 194 TEE_MD5SHA1_HASH_SIZE = (TEE_MD5_HASH_SIZE + TEE_SHA1_HASH_SIZE), 195 TEE_MAX_HASH_SIZE = 64, 196 } t_hash_size; 197 #endif 198 199 #define TEE_MAC_SIZE_AES_CBC_MAC_NOPAD 200 #define TEE_MAC_SIZE_AES_CBC_MAC_PKCS5 201 #define TEE_MAC_SIZE_AES_CMAC 202 #define TEE_MAC_SIZE_DES_CBC_MAC_PKCS5 203 204 static inline size_t __tee_alg_get_digest_size(uint32_t algo) 205 { 206 switch (algo) { 207 case TEE_ALG_MD5: 208 case TEE_ALG_HMAC_MD5: 209 return TEE_MD5_HASH_SIZE; 210 case TEE_ALG_SHA1: 211 case TEE_ALG_HMAC_SHA1: 212 case TEE_ALG_DSA_SHA1: 213 case TEE_ALG_ECDSA_SHA1: 214 return TEE_SHA1_HASH_SIZE; 215 case TEE_ALG_SHA224: 216 case TEE_ALG_SHA3_224: 217 case TEE_ALG_HMAC_SHA224: 218 case TEE_ALG_HMAC_SHA3_224: 219 case TEE_ALG_DSA_SHA224: 220 case TEE_ALG_ECDSA_SHA224: 221 return TEE_SHA224_HASH_SIZE; 222 case TEE_ALG_SHA256: 223 case TEE_ALG_SHA3_256: 224 case TEE_ALG_HMAC_SHA256: 225 case TEE_ALG_HMAC_SHA3_256: 226 case TEE_ALG_DSA_SHA256: 227 case TEE_ALG_ECDSA_SHA256: 228 return TEE_SHA256_HASH_SIZE; 229 case TEE_ALG_SHA384: 230 case TEE_ALG_SHA3_384: 231 case TEE_ALG_HMAC_SHA384: 232 case TEE_ALG_HMAC_SHA3_384: 233 case TEE_ALG_ECDSA_SHA384: 234 return TEE_SHA384_HASH_SIZE; 235 case TEE_ALG_SHA512: 236 case TEE_ALG_SHA3_512: 237 case TEE_ALG_HMAC_SHA512: 238 case TEE_ALG_HMAC_SHA3_512: 239 case TEE_ALG_ECDSA_SHA512: 240 return TEE_SHA512_HASH_SIZE; 241 case TEE_ALG_SM3: 242 case TEE_ALG_HMAC_SM3: 243 return TEE_SM3_HASH_SIZE; 244 case TEE_ALG_AES_CBC_MAC_NOPAD: 245 case TEE_ALG_AES_CBC_MAC_PKCS5: 246 case TEE_ALG_AES_CMAC: 247 return TEE_AES_BLOCK_SIZE; 248 case TEE_ALG_DES_CBC_MAC_NOPAD: 249 case TEE_ALG_DES_CBC_MAC_PKCS5: 250 case TEE_ALG_DES3_CBC_MAC_NOPAD: 251 case TEE_ALG_DES3_CBC_MAC_PKCS5: 252 case TEE_ALG_DES3_CMAC: 253 return TEE_DES_BLOCK_SIZE; 254 default: 255 return 0; 256 } 257 } 258 259 /* Return algorithm digest size */ 260 #define TEE_ALG_GET_DIGEST_SIZE(algo) __tee_alg_get_digest_size(algo) 261 262 /* 263 * Bit indicating that the attribute is a value attribute 264 * See TEE Internal API specificaion v1.0 table 6-12 "Partial Structure of 265 * Attribute Identifier" 266 */ 267 268 269 #ifdef __compiler_bswap64 270 #define TEE_U64_BSWAP(x) __compiler_bswap64((x)) 271 #else 272 #define TEE_U64_BSWAP(x) ((uint64_t)( \ 273 (((uint64_t)(x) & UINT64_C(0xff00000000000000ULL)) >> 56) | \ 274 (((uint64_t)(x) & UINT64_C(0x00ff000000000000ULL)) >> 40) | \ 275 (((uint64_t)(x) & UINT64_C(0x0000ff0000000000ULL)) >> 24) | \ 276 (((uint64_t)(x) & UINT64_C(0x000000ff00000000ULL)) >> 8) | \ 277 (((uint64_t)(x) & UINT64_C(0x00000000ff000000ULL)) << 8) | \ 278 (((uint64_t)(x) & UINT64_C(0x0000000000ff0000ULL)) << 24) | \ 279 (((uint64_t)(x) & UINT64_C(0x000000000000ff00ULL)) << 40) | \ 280 (((uint64_t)(x) & UINT64_C(0x00000000000000ffULL)) << 56))) 281 #endif 282 283 #ifdef __compiler_bswap32 284 #define TEE_U32_BSWAP(x) __compiler_bswap32((x)) 285 #else 286 #define TEE_U32_BSWAP(x) ((uint32_t)( \ 287 (((uint32_t)(x) & UINT32_C(0xff000000)) >> 24) | \ 288 (((uint32_t)(x) & UINT32_C(0x00ff0000)) >> 8) | \ 289 (((uint32_t)(x) & UINT32_C(0x0000ff00)) << 8) | \ 290 (((uint32_t)(x) & UINT32_C(0x000000ff)) << 24))) 291 #endif 292 293 #ifdef __compiler_bswap16 294 #define TEE_U16_BSWAP(x) __compiler_bswap16((x)) 295 #else 296 #define TEE_U16_BSWAP(x) ((uint16_t)( \ 297 (((uint16_t)(x) & UINT16_C(0xff00)) >> 8) | \ 298 (((uint16_t)(x) & UINT16_C(0x00ff)) << 8))) 299 #endif 300 301 /* If we we're on a big endian platform we'll have to update these */ 302 #define TEE_U64_FROM_BIG_ENDIAN(x) TEE_U64_BSWAP(x) 303 #define TEE_U32_FROM_BIG_ENDIAN(x) TEE_U32_BSWAP(x) 304 #define TEE_U16_FROM_BIG_ENDIAN(x) TEE_U16_BSWAP(x) 305 #define TEE_U64_TO_BIG_ENDIAN(x) TEE_U64_BSWAP(x) 306 #define TEE_U32_TO_BIG_ENDIAN(x) TEE_U32_BSWAP(x) 307 #define TEE_U16_TO_BIG_ENDIAN(x) TEE_U16_BSWAP(x) 308 309 #define TEE_TIME_MILLIS_BASE 1000 310 311 #define TEE_TIME_LT(t1, t2) \ 312 (((t1).seconds == (t2).seconds) ? \ 313 ((t1).millis < (t2).millis) : \ 314 ((t1).seconds < (t2).seconds)) 315 316 #define TEE_TIME_LE(t1, t2) \ 317 (((t1).seconds == (t2).seconds) ? \ 318 ((t1).millis <= (t2).millis) : \ 319 ((t1).seconds <= (t2).seconds)) 320 321 #define TEE_TIME_ADD(t1, t2, dst) do { \ 322 (dst).seconds = (t1).seconds + (t2).seconds; \ 323 (dst).millis = (t1).millis + (t2).millis; \ 324 if ((dst).millis >= TEE_TIME_MILLIS_BASE) { \ 325 (dst).seconds++; \ 326 (dst).millis -= TEE_TIME_MILLIS_BASE; \ 327 } \ 328 } while (0) 329 330 #define TEE_TIME_SUB(t1, t2, dst) do { \ 331 (dst).seconds = (t1).seconds - (t2).seconds; \ 332 if ((t1).millis < (t2).millis) { \ 333 (dst).seconds--; \ 334 (dst).millis = (t1).millis + TEE_TIME_MILLIS_BASE - (t2).millis;\ 335 } else { \ 336 (dst).millis = (t1).millis - (t2).millis; \ 337 } \ 338 } while (0) 339 340 /* ------------------------------------------------------------ */ 341 /* OTP mapping */ 342 /* ------------------------------------------------------------ */ 343 #define HW_UNIQUE_KEY_WORD1 (8) 344 #define HW_UNIQUE_KEY_LENGTH (16) 345 #define HW_UNIQUE_KEY_WORD2 (HW_UNIQUE_KEY_WORD1 + 1) 346 #define HW_UNIQUE_KEY_WORD3 (HW_UNIQUE_KEY_WORD1 + 2) 347 #define HW_UNIQUE_KEY_WORD4 (HW_UNIQUE_KEY_WORD1 + 3) 348 349 #define UTEE_SE_READER_PRESENT (1 << 0) 350 #define UTEE_SE_READER_TEE_ONLY (1 << 1) 351 #define UTEE_SE_READER_SELECT_RESPONE_ENABLE (1 << 2) 352 353 #endif /* UTEE_DEFINES_H */ 354