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 /* RSA */ 107 MECHANISM(PKCS11_CKM_RSA_PKCS_KEY_PAIR_GEN, 108 PKCS11_CKFM_GENERATE_KEY_PAIR, ANY_PART), 109 MECHANISM(PKCS11_CKM_RSA_PKCS, CKFM_CIPHER_WRAP | CKFM_AUTH_NO_RECOVER | 110 CKFM_AUTH_WITH_RECOVER, SINGLE_PART_ONLY), 111 MECHANISM(PKCS11_CKM_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, 112 SINGLE_PART_ONLY), 113 MECHANISM(PKCS11_CKM_MD5_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 114 MECHANISM(PKCS11_CKM_SHA1_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 115 MECHANISM(PKCS11_CKM_SHA1_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, ANY_PART), 116 MECHANISM(PKCS11_CKM_SHA256_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 117 MECHANISM(PKCS11_CKM_SHA384_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 118 MECHANISM(PKCS11_CKM_SHA512_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 119 MECHANISM(PKCS11_CKM_SHA256_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, 120 ANY_PART), 121 MECHANISM(PKCS11_CKM_SHA384_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, 122 ANY_PART), 123 MECHANISM(PKCS11_CKM_SHA512_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, 124 ANY_PART), 125 MECHANISM(PKCS11_CKM_SHA224_RSA_PKCS, CKFM_AUTH_NO_RECOVER, ANY_PART), 126 MECHANISM(PKCS11_CKM_SHA224_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER, 127 ANY_PART), 128 }; 129 130 #if CFG_TEE_TA_LOG_LEVEL > 0 131 const char *mechanism_string_id(enum pkcs11_mechanism_id id) 132 { 133 const size_t offset = sizeof("PKCS11_CKM_") - 1; 134 size_t n = 0; 135 136 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 137 if (pkcs11_modes[n].id == id) 138 return pkcs11_modes[n].string + offset; 139 140 return "Unknown ID"; 141 } 142 #endif /*CFG_TEE_TA_LOG_LEVEL*/ 143 144 /* 145 * Return true if @id is a valid mechanism ID 146 */ 147 bool mechanism_is_valid(enum pkcs11_mechanism_id id) 148 { 149 size_t n = 0; 150 151 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 152 if (id == pkcs11_modes[n].id) 153 return true; 154 155 return false; 156 } 157 158 /* 159 * Return true if mechanism ID is valid and flags matches PKCS#11 compliancy 160 */ 161 bool __maybe_unused mechanism_flags_complies_pkcs11(uint32_t mechanism_type, 162 uint32_t flags) 163 { 164 size_t n = 0; 165 166 assert((flags & ~ALLOWED_PKCS11_CKFM) == 0); 167 168 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) { 169 if (pkcs11_modes[n].id == mechanism_type) { 170 if (flags & ~pkcs11_modes[n].flags) 171 EMSG("%s flags: 0x%"PRIx32" vs 0x%"PRIx32, 172 id2str_mechanism(mechanism_type), 173 flags, pkcs11_modes[n].flags); 174 175 return (flags & ~pkcs11_modes[n].flags) == 0; 176 } 177 } 178 179 /* Mechanism ID unexpectedly not found */ 180 return false; 181 } 182 183 bool mechanism_is_one_shot_only(uint32_t mechanism_type) 184 { 185 size_t n = 0; 186 187 for (n = 0; n < ARRAY_SIZE(pkcs11_modes); n++) 188 if (pkcs11_modes[n].id == mechanism_type) 189 return pkcs11_modes[n].one_shot; 190 191 /* Mechanism ID unexpectedly not found */ 192 TEE_Panic(PKCS11_RV_NOT_FOUND); 193 /* Dummy return to keep compiler happy */ 194 return false; 195 } 196 197 /* 198 * Field single_part_only is unused from array token_mechanism[], hence 199 * simply use ANY_PART for all mechanism there. 200 */ 201 #define TA_MECHANISM(_label, _flags) MECHANISM((_label), (_flags), ANY_PART) 202 203 /* 204 * Arrays that centralizes the IDs and processing flags for mechanisms 205 * supported by each embedded token. 206 */ 207 const struct pkcs11_mechachism_modes token_mechanism[] = { 208 TA_MECHANISM(PKCS11_CKM_AES_ECB, CKFM_CIPHER_WRAP), 209 TA_MECHANISM(PKCS11_CKM_AES_CBC, CKFM_CIPHER_WRAP), 210 TA_MECHANISM(PKCS11_CKM_AES_CBC_PAD, CKFM_CIPHER), 211 TA_MECHANISM(PKCS11_CKM_AES_CTR, CKFM_CIPHER), 212 TA_MECHANISM(PKCS11_CKM_AES_CTS, CKFM_CIPHER), 213 TA_MECHANISM(PKCS11_CKM_AES_ECB_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 214 TA_MECHANISM(PKCS11_CKM_AES_CBC_ENCRYPT_DATA, PKCS11_CKFM_DERIVE), 215 TA_MECHANISM(PKCS11_CKM_AES_KEY_GEN, PKCS11_CKFM_GENERATE), 216 TA_MECHANISM(PKCS11_CKM_GENERIC_SECRET_KEY_GEN, PKCS11_CKFM_GENERATE), 217 TA_MECHANISM(PKCS11_CKM_MD5, PKCS11_CKFM_DIGEST), 218 TA_MECHANISM(PKCS11_CKM_SHA_1, PKCS11_CKFM_DIGEST), 219 TA_MECHANISM(PKCS11_CKM_SHA224, PKCS11_CKFM_DIGEST), 220 TA_MECHANISM(PKCS11_CKM_SHA256, PKCS11_CKFM_DIGEST), 221 TA_MECHANISM(PKCS11_CKM_SHA384, PKCS11_CKFM_DIGEST), 222 TA_MECHANISM(PKCS11_CKM_SHA512, PKCS11_CKFM_DIGEST), 223 TA_MECHANISM(PKCS11_CKM_MD5_HMAC, CKFM_AUTH_NO_RECOVER), 224 TA_MECHANISM(PKCS11_CKM_SHA_1_HMAC, CKFM_AUTH_NO_RECOVER), 225 TA_MECHANISM(PKCS11_CKM_SHA224_HMAC, CKFM_AUTH_NO_RECOVER), 226 TA_MECHANISM(PKCS11_CKM_SHA256_HMAC, CKFM_AUTH_NO_RECOVER), 227 TA_MECHANISM(PKCS11_CKM_SHA384_HMAC, CKFM_AUTH_NO_RECOVER), 228 TA_MECHANISM(PKCS11_CKM_SHA512_HMAC, CKFM_AUTH_NO_RECOVER), 229 TA_MECHANISM(PKCS11_CKM_EC_KEY_PAIR_GEN, 230 PKCS11_CKFM_GENERATE_KEY_PAIR), 231 TA_MECHANISM(PKCS11_CKM_ECDSA, CKFM_AUTH_NO_RECOVER), 232 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA1, CKFM_AUTH_NO_RECOVER), 233 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA224, CKFM_AUTH_NO_RECOVER), 234 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA256, CKFM_AUTH_NO_RECOVER), 235 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA384, CKFM_AUTH_NO_RECOVER), 236 TA_MECHANISM(PKCS11_CKM_ECDSA_SHA512, CKFM_AUTH_NO_RECOVER), 237 TA_MECHANISM(PKCS11_CKM_RSA_PKCS_KEY_PAIR_GEN, 238 PKCS11_CKFM_GENERATE_KEY_PAIR), 239 TA_MECHANISM(PKCS11_CKM_RSA_PKCS, CKFM_CIPHER | CKFM_AUTH_NO_RECOVER), 240 TA_MECHANISM(PKCS11_CKM_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 241 TA_MECHANISM(PKCS11_CKM_MD5_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 242 TA_MECHANISM(PKCS11_CKM_SHA1_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 243 TA_MECHANISM(PKCS11_CKM_SHA1_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 244 TA_MECHANISM(PKCS11_CKM_SHA256_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 245 TA_MECHANISM(PKCS11_CKM_SHA384_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 246 TA_MECHANISM(PKCS11_CKM_SHA512_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 247 TA_MECHANISM(PKCS11_CKM_SHA256_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 248 TA_MECHANISM(PKCS11_CKM_SHA384_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 249 TA_MECHANISM(PKCS11_CKM_SHA512_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 250 TA_MECHANISM(PKCS11_CKM_SHA224_RSA_PKCS, CKFM_AUTH_NO_RECOVER), 251 TA_MECHANISM(PKCS11_CKM_SHA224_RSA_PKCS_PSS, CKFM_AUTH_NO_RECOVER), 252 }; 253 254 /* 255 * tee_malloc_mechanism_array - Allocate and fill array of supported mechanisms 256 * @count: [in] [out] Pointer to number of mechanism IDs in client resource 257 * Return allocated array of the supported mechanism IDs 258 * 259 * Allocates array with 32bit cells mechanism IDs for the supported ones only 260 * if *@count covers number mechanism IDs exposed. 261 */ 262 uint32_t *tee_malloc_mechanism_list(size_t *out_count) 263 { 264 size_t n = 0; 265 size_t count = 0; 266 uint32_t *array = NULL; 267 268 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) 269 if (token_mechanism[n].flags) 270 count++; 271 272 if (*out_count >= count) 273 array = TEE_Malloc(count * sizeof(*array), 274 TEE_USER_MEM_HINT_NO_FILL_ZERO); 275 276 *out_count = count; 277 278 if (!array) 279 return NULL; 280 281 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 282 if (token_mechanism[n].flags) { 283 count--; 284 array[count] = token_mechanism[n].id; 285 } 286 } 287 assert(!count); 288 289 return array; 290 } 291 292 uint32_t mechanism_supported_flags(enum pkcs11_mechanism_id id) 293 { 294 size_t n = 0; 295 296 for (n = 0; n < ARRAY_SIZE(token_mechanism); n++) { 297 if (id == token_mechanism[n].id) { 298 uint32_t flags = token_mechanism[n].flags; 299 300 assert(mechanism_flags_complies_pkcs11(id, flags)); 301 return flags; 302 } 303 } 304 305 return 0; 306 } 307 308 void pkcs11_mechanism_supported_key_sizes(uint32_t proc_id, 309 uint32_t *min_key_size, 310 uint32_t *max_key_size) 311 { 312 switch (proc_id) { 313 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 314 /* This mechanism expects the keysize to be returned in bits */ 315 *min_key_size = 1; /* in bits */ 316 *max_key_size = 4096; /* in bits */ 317 break; 318 case PKCS11_CKM_MD5_HMAC: 319 *min_key_size = 8; 320 *max_key_size = 64; 321 break; 322 case PKCS11_CKM_SHA_1_HMAC: 323 *min_key_size = 10; 324 *max_key_size = 64; 325 break; 326 case PKCS11_CKM_SHA224_HMAC: 327 *min_key_size = 14; 328 *max_key_size = 64; 329 break; 330 case PKCS11_CKM_SHA256_HMAC: 331 *min_key_size = 24; 332 *max_key_size = 128; 333 break; 334 case PKCS11_CKM_SHA384_HMAC: 335 *min_key_size = 32; 336 *max_key_size = 128; 337 break; 338 case PKCS11_CKM_SHA512_HMAC: 339 *min_key_size = 32; 340 *max_key_size = 128; 341 break; 342 case PKCS11_CKM_AES_KEY_GEN: 343 case PKCS11_CKM_AES_ECB: 344 case PKCS11_CKM_AES_CBC: 345 case PKCS11_CKM_AES_CBC_PAD: 346 case PKCS11_CKM_AES_CTR: 347 case PKCS11_CKM_AES_CTS: 348 *min_key_size = 16; 349 *max_key_size = 32; 350 break; 351 case PKCS11_CKM_EC_KEY_PAIR_GEN: 352 case PKCS11_CKM_ECDSA: 353 case PKCS11_CKM_ECDSA_SHA1: 354 case PKCS11_CKM_ECDSA_SHA224: 355 case PKCS11_CKM_ECDSA_SHA256: 356 case PKCS11_CKM_ECDSA_SHA384: 357 case PKCS11_CKM_ECDSA_SHA512: 358 *min_key_size = 160; /* in bits */ 359 *max_key_size = 521; /* in bits */ 360 break; 361 case PKCS11_CKM_RSA_PKCS_KEY_PAIR_GEN: 362 case PKCS11_CKM_RSA_PKCS: 363 case PKCS11_CKM_MD5_RSA_PKCS: 364 case PKCS11_CKM_SHA1_RSA_PKCS: 365 case PKCS11_CKM_SHA1_RSA_PKCS_PSS: 366 case PKCS11_CKM_SHA256_RSA_PKCS: 367 case PKCS11_CKM_SHA384_RSA_PKCS: 368 case PKCS11_CKM_SHA512_RSA_PKCS: 369 case PKCS11_CKM_SHA256_RSA_PKCS_PSS: 370 case PKCS11_CKM_SHA384_RSA_PKCS_PSS: 371 case PKCS11_CKM_SHA512_RSA_PKCS_PSS: 372 case PKCS11_CKM_SHA224_RSA_PKCS: 373 case PKCS11_CKM_SHA224_RSA_PKCS_PSS: 374 *min_key_size = 256; /* in bits */ 375 *max_key_size = 4096; /* in bits */ 376 break; 377 default: 378 *min_key_size = 0; 379 *max_key_size = 0; 380 break; 381 } 382 } 383 384 void mechanism_supported_key_sizes_bytes(uint32_t proc_id, 385 uint32_t *min_key_size, 386 uint32_t *max_key_size) 387 { 388 pkcs11_mechanism_supported_key_sizes(proc_id, min_key_size, 389 max_key_size); 390 391 switch (proc_id) { 392 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 393 case PKCS11_CKM_EC_KEY_PAIR_GEN: 394 case PKCS11_CKM_ECDSA: 395 case PKCS11_CKM_ECDSA_SHA1: 396 case PKCS11_CKM_ECDSA_SHA224: 397 case PKCS11_CKM_ECDSA_SHA256: 398 case PKCS11_CKM_ECDSA_SHA384: 399 case PKCS11_CKM_ECDSA_SHA512: 400 case PKCS11_CKM_RSA_PKCS_KEY_PAIR_GEN: 401 /* Size is in bits -> convert to bytes and ceil */ 402 *min_key_size = ROUNDUP(*min_key_size, 8) / 8; 403 *max_key_size = ROUNDUP(*max_key_size, 8) / 8; 404 break; 405 default: 406 /* Size is already in bytes */ 407 break; 408 } 409 } 410