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