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