1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2017-2020, Linaro Limited 4 */ 5 6 #include <assert.h> 7 #include <pkcs11_ta.h> 8 #include <string.h> 9 #include <util.h> 10 #include <tee_api.h> 11 #include <tee_internal_api_extensions.h> 12 13 #include "pkcs11_helpers.h" 14 #include "token_capabilities.h" 15 16 #define ALLOWED_PKCS11_CKFM \ 17 (PKCS11_CKFM_ENCRYPT | PKCS11_CKFM_DECRYPT | \ 18 PKCS11_CKFM_DERIVE | PKCS11_CKFM_DIGEST | \ 19 PKCS11_CKFM_SIGN | PKCS11_CKFM_SIGN_RECOVER | \ 20 PKCS11_CKFM_VERIFY | PKCS11_CKFM_VERIFY_RECOVER | \ 21 PKCS11_CKFM_GENERATE | PKCS11_CKFM_GENERATE_KEY_PAIR | \ 22 PKCS11_CKFM_WRAP | PKCS11_CKFM_UNWRAP) 23 24 /* 25 * Definition of supported processings for a PKCS#11 mechanisms 26 * @id: Mechanism ID 27 * @flags: Valid PKCS11_CKFM_* for a mechanism as per PKCS#11 28 * @one_shot: true of mechanism can be used for a one-short processing 29 * @string: Helper string of the mechanism ID for debug purpose 30 */ 31 struct pkcs11_mechachism_modes { 32 uint32_t id; 33 uint32_t flags; 34 bool one_shot; 35 #if CFG_TEE_TA_LOG_LEVEL > 0 36 const char *string; 37 #endif 38 }; 39 40 #if CFG_TEE_TA_LOG_LEVEL > 0 41 #define MECHANISM(_label, _flags, _single_part) \ 42 { \ 43 .id = _label, \ 44 .one_shot = (_single_part), \ 45 .flags = (_flags), \ 46 .string = #_label, \ 47 } 48 #else 49 #define MECHANISM(_label, _flags, _single_part) \ 50 { \ 51 .id = _label, \ 52 .one_shot = (_single_part), \ 53 .flags = (_flags), \ 54 } 55 #endif 56 57 #define SINGLE_PART_ONLY true 58 #define ANY_PART false 59 60 #define CKFM_CIPHER (PKCS11_CKFM_ENCRYPT | PKCS11_CKFM_DECRYPT) 61 #define CKFM_WRAP_UNWRAP (PKCS11_CKFM_WRAP | PKCS11_CKFM_UNWRAP) 62 #define CKFM_CIPHER_WRAP (CKFM_CIPHER | CKFM_WRAP_UNWRAP) 63 #define CKFM_CIPHER_WRAP_DERIVE (CKFM_CIPHER_WRAP | PKCS11_CKFM_DERIVE) 64 #define CKFM_AUTH_NO_RECOVER (PKCS11_CKFM_SIGN | PKCS11_CKFM_VERIFY) 65 #define CKFM_AUTH_WITH_RECOVER (PKCS11_CKFM_SIGN_RECOVER | \ 66 PKCS11_CKFM_VERIFY_RECOVER) 67 68 /* PKCS#11 specificies permitted operation for each mechanism */ 69 static const struct pkcs11_mechachism_modes pkcs11_modes[] = { 70 /* AES */ 71 MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER_WRAP, ANY_PART), 72 MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER_WRAP, ANY_PART), 73 MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER_WRAP, ANY_PART), 74 MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER_WRAP, ANY_PART), 75 MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER_WRAP, ANY_PART), 76 MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE, 77 ANY_PART), 78 MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE, 79 ANY_PART), 80 MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE, ANY_PART), 81 MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE, 82 ANY_PART), 83 /* Digest */ 84 MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST, ANY_PART), 85 MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST, ANY_PART), 86 MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST, ANY_PART), 87 MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST, ANY_PART), 88 MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST, ANY_PART), 89 MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST, ANY_PART), 90 /* HMAC */ 91 MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 92 MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 93 MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 94 MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 95 MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 96 MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER, ANY_PART), 97 /* EC */ 98 MECHANISM(PKCS11_CKM_EC_KEY_PAIR_GEN, PKCS11_CKFM_GENERATE_KEY_PAIR, 99 ANY_PART), 100 MECHANISM(PKCS11_CKM_ECDSA, CKFM_AUTH_NO_RECOVER, SINGLE_PART_ONLY), 101 MECHANISM(PKCS11_CKM_ECDSA_SHA1, CKFM_AUTH_NO_RECOVER, ANY_PART), 102 MECHANISM(PKCS11_CKM_ECDSA_SHA224, CKFM_AUTH_NO_RECOVER, ANY_PART), 103 MECHANISM(PKCS11_CKM_ECDSA_SHA256, CKFM_AUTH_NO_RECOVER, ANY_PART), 104 MECHANISM(PKCS11_CKM_ECDSA_SHA384, CKFM_AUTH_NO_RECOVER, ANY_PART), 105 MECHANISM(PKCS11_CKM_ECDSA_SHA512, CKFM_AUTH_NO_RECOVER, ANY_PART), 106 }; 107 108 #if CFG_TEE_TA_LOG_LEVEL > 0 109 const char *mechanism_string_id(enum pkcs11_mechanism_id id) 110 { 111 const size_t offset = sizeof("PKCS11_CKM_") - 1; 112 size_t n = 0; 113 114 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 115 if (pkcs11_modes[n].id == id) 116 return pkcs11_modes[n].string + offset; 117 118 return "Unknown ID"; 119 } 120 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 121 122 /* 123 * Return true if @id is a valid mechanism ID 124 */ 125 bool mechanism_is_valid(enum pkcs11_mechanism_id id) 126 { 127 size_t n = 0; 128 129 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 130 if (id == pkcs11_modes[n].id) 131 return true; 132 133 return false; 134 } 135 136 /* 137 * Return true if mechanism ID is valid and flags matches PKCS#11 compliancy 138 */ 139 bool __maybe_unused mechanism_flags_complies_pkcs11(uint32_t mechanism_type, 140 uint32_t flags) 141 { 142 size_t n = 0; 143 144 assert((flags & ~ALLOWED_PKCS11_CKFM) == 0); 145 146 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) { 147 if (pkcs11_modes[n].id == mechanism_type) { 148 if (flags & ~pkcs11_modes[n].flags) 149 EMSG("%s flags: 0x%"PRIx32" vs 0x%"PRIx32, 150 id2str_mechanism(mechanism_type), 151 flags, pkcs11_modes[n].flags); 152 153 return (flags & ~pkcs11_modes[n].flags) == 0; 154 } 155 } 156 157 /* Mechanism ID unexpectedly not found */ 158 return false; 159 } 160 161 bool mechanism_is_one_shot_only(uint32_t mechanism_type) 162 { 163 size_t n = 0; 164 165 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 166 if (pkcs11_modes[n].id == mechanism_type) 167 return pkcs11_modes[n].one_shot; 168 169 /* Mechanism ID unexpectedly not found */ 170 TEE_Panic(PKCS11_RV_NOT_FOUND); 171 /* Dummy return to keep compiler happy */ 172 return false; 173 } 174 175 /* 176 * Field single_part_only is unused from array token_mechanism[], hence 177 * simply use ANY_PART for all mechanism there. 178 */ 179 #define TA_MECHANISM(_label, _flags) MECHANISM((_label), (_flags), ANY_PART) 180 181 /* 182 * Arrays that centralizes the IDs and processing flags for mechanisms 183 * supported by each embedded token. 184 */ 185 const struct pkcs11_mechachism_modes token_mechanism[] = { 186 TA_MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER), 187 TA_MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER), 188 TA_MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER), 189 TA_MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER), 190 TA_MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER), 191 TA_MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 192 TA_MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 193 TA_MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE), 194 TA_MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE), 195 TA_MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST), 196 TA_MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST), 197 TA_MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST), 198 TA_MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST), 199 TA_MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST), 200 TA_MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST), 201 TA_MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER), 202 TA_MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER), 203 TA_MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER), 204 TA_MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER), 205 TA_MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER), 206 TA_MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER), 207 TA_MECHANISM(PKCS11_CKM_EC_KEY_PAIR_GEN, 208 PKCS11_CKFM_GENERATE_KEY_PAIR), 209 TA_MECHANISM(PKCS11_CKM_ECDSA, CKFM_AUTH_NO_RECOVER), 210 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA1, CKFM_AUTH_NO_RECOVER), 211 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA224, CKFM_AUTH_NO_RECOVER), 212 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA256, CKFM_AUTH_NO_RECOVER), 213 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA384, CKFM_AUTH_NO_RECOVER), 214 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA512, CKFM_AUTH_NO_RECOVER), 215 }; 216 217 /* 218 * tee_malloc_mechanism_array - Allocate and fill array of supported mechanisms 219 * @count: [in] [out] Pointer to number of mechanism IDs in client resource 220 * Return allocated array of the supported mechanism IDs 221 * 222 * Allocates array with 32bit cells mechanism IDs for the supported ones only 223 * if *@count covers number mechanism IDs exposed. 224 */ 225 uint32_t *tee_malloc_mechanism_list(size_t *out_count) 226 { 227 size_t n = 0; 228 size_t count = 0; 229 uint32_t *array = NULL; 230 231 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) 232 if (token_mechanism[n].flags) 233 count++; 234 235 if (*out_count >= count) 236 array = TEE_Malloc(count * sizeof(*array), 237 TEE_USER_MEM_HINT_NO_FILL_ZERO); 238 239 *out_count = count; 240 241 if (!array) 242 return NULL; 243 244 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 245 if (token_mechanism[n].flags) { 246 count--; 247 array[count] = token_mechanism[n].id; 248 } 249 } 250 assert(!count); 251 252 return array; 253 } 254 255 uint32_t mechanism_supported_flags(enum pkcs11_mechanism_id id) 256 { 257 size_t n = 0; 258 259 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 260 if (id == token_mechanism[n].id) { 261 uint32_t flags = token_mechanism[n].flags; 262 263 assert(mechanism_flags_complies_pkcs11(id, flags)); 264 return flags; 265 } 266 } 267 268 return 0; 269 } 270 271 void pkcs11_mechanism_supported_key_sizes(uint32_t proc_id, 272 uint32_t *min_key_size, 273 uint32_t *max_key_size) 274 { 275 switch (proc_id) { 276 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 277 /* This mechanism expects the keysize to be returned in bits */ 278 *min_key_size = 1; /* in bits */ 279 *max_key_size = 4096; /* in bits */ 280 break; 281 case PKCS11_CKM_MD5_HMAC: 282 *min_key_size = 8; 283 *max_key_size = 64; 284 break; 285 case PKCS11_CKM_SHA_1_HMAC: 286 *min_key_size = 10; 287 *max_key_size = 64; 288 break; 289 case PKCS11_CKM_SHA224_HMAC: 290 *min_key_size = 14; 291 *max_key_size = 64; 292 break; 293 case PKCS11_CKM_SHA256_HMAC: 294 *min_key_size = 24; 295 *max_key_size = 128; 296 break; 297 case PKCS11_CKM_SHA384_HMAC: 298 *min_key_size = 32; 299 *max_key_size = 128; 300 break; 301 case PKCS11_CKM_SHA512_HMAC: 302 *min_key_size = 32; 303 *max_key_size = 128; 304 break; 305 case PKCS11_CKM_AES_KEY_GEN: 306 case PKCS11_CKM_AES_ECB: 307 case PKCS11_CKM_AES_CBC: 308 case PKCS11_CKM_AES_CBC_PAD: 309 case PKCS11_CKM_AES_CTR: 310 case PKCS11_CKM_AES_CTS: 311 *min_key_size = 16; 312 *max_key_size = 32; 313 break; 314 case PKCS11_CKM_EC_KEY_PAIR_GEN: 315 case PKCS11_CKM_ECDSA: 316 case PKCS11_CKM_ECDSA_SHA1: 317 case PKCS11_CKM_ECDSA_SHA224: 318 case PKCS11_CKM_ECDSA_SHA256: 319 case PKCS11_CKM_ECDSA_SHA384: 320 case PKCS11_CKM_ECDSA_SHA512: 321 *min_key_size = 160; /* in bits */ 322 *max_key_size = 521; /* in bits */ 323 break; 324 default: 325 *min_key_size = 0; 326 *max_key_size = 0; 327 break; 328 } 329 } 330 331 void mechanism_supported_key_sizes_bytes(uint32_t proc_id, 332 uint32_t *min_key_size, 333 uint32_t *max_key_size) 334 { 335 pkcs11_mechanism_supported_key_sizes(proc_id, min_key_size, 336 max_key_size); 337 338 if (proc_id == PKCS11_CKM_GENERIC_SECRET_KEY_GEN) { 339 *min_key_size = (*min_key_size + 7) / 8; 340 *max_key_size = (*max_key_size + 7) / 8; 341 } 342 } 343