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