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