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