1 // SPDX-License-Identifier: BSD-2-Clause 2 /* 3 * Copyright (c) 2017-2020, Linaro Limited 4 */ 5 6 #include <assert.h> 7 #include <inttypes.h> 8 #include <pkcs11_ta.h> 9 #include <stdlib.h> 10 #include <string_ext.h> 11 #include <tee_internal_api_extensions.h> 12 #include <tee_internal_api.h> 13 #include <trace.h> 14 #include <util.h> 15 16 #include "attributes.h" 17 #include "handle.h" 18 #include "pkcs11_attributes.h" 19 #include "pkcs11_helpers.h" 20 #include "pkcs11_token.h" 21 #include "sanitize_object.h" 22 #include "serializer.h" 23 #include "token_capabilities.h" 24 25 static uint32_t pkcs11_func2ckfm(enum processing_func function) 26 { 27 switch (function) { 28 case PKCS11_FUNCTION_DIGEST: 29 return PKCS11_CKFM_DIGEST; 30 case PKCS11_FUNCTION_GENERATE: 31 return PKCS11_CKFM_GENERATE; 32 case PKCS11_FUNCTION_GENERATE_PAIR: 33 return PKCS11_CKFM_GENERATE_KEY_PAIR; 34 case PKCS11_FUNCTION_DERIVE: 35 return PKCS11_CKFM_DERIVE; 36 case PKCS11_FUNCTION_WRAP: 37 return PKCS11_CKFM_WRAP; 38 case PKCS11_FUNCTION_UNWRAP: 39 return PKCS11_CKFM_UNWRAP; 40 case PKCS11_FUNCTION_ENCRYPT: 41 return PKCS11_CKFM_ENCRYPT; 42 case PKCS11_FUNCTION_DECRYPT: 43 return PKCS11_CKFM_DECRYPT; 44 case PKCS11_FUNCTION_SIGN: 45 return PKCS11_CKFM_SIGN; 46 case PKCS11_FUNCTION_VERIFY: 47 return PKCS11_CKFM_VERIFY; 48 case PKCS11_FUNCTION_SIGN_RECOVER: 49 return PKCS11_CKFM_SIGN_RECOVER; 50 case PKCS11_FUNCTION_VERIFY_RECOVER: 51 return PKCS11_CKFM_VERIFY_RECOVER; 52 default: 53 return 0; 54 } 55 } 56 57 enum pkcs11_rc 58 check_mechanism_against_processing(struct pkcs11_session *session, 59 enum pkcs11_mechanism_id mechanism_type, 60 enum processing_func function, 61 enum processing_step step) 62 { 63 bool allowed = false; 64 65 switch (step) { 66 case PKCS11_FUNC_STEP_INIT: 67 switch (function) { 68 case PKCS11_FUNCTION_IMPORT: 69 case PKCS11_FUNCTION_COPY: 70 case PKCS11_FUNCTION_MODIFY: 71 case PKCS11_FUNCTION_DESTROY: 72 return PKCS11_CKR_OK; 73 default: 74 break; 75 } 76 /* 77 * Check that the returned PKCS11_CKFM_* flag from 78 * pkcs11_func2ckfm() is among the ones from 79 * mechanism_supported_flags(). 80 */ 81 allowed = mechanism_supported_flags(mechanism_type) & 82 pkcs11_func2ckfm(function); 83 break; 84 85 case PKCS11_FUNC_STEP_ONESHOT: 86 if (session->processing->always_authen && 87 !session->processing->relogged) 88 return PKCS11_CKR_USER_NOT_LOGGED_IN; 89 90 if (session->processing->updated) { 91 EMSG("Cannot perform one-shot on updated processing"); 92 return PKCS11_CKR_OPERATION_ACTIVE; 93 } 94 95 allowed = true; 96 break; 97 98 case PKCS11_FUNC_STEP_UPDATE: 99 if (session->processing->always_authen && 100 !session->processing->relogged) 101 return PKCS11_CKR_USER_NOT_LOGGED_IN; 102 103 allowed = !mechanism_is_one_shot_only(mechanism_type); 104 break; 105 106 case PKCS11_FUNC_STEP_UPDATE_KEY: 107 assert(function == PKCS11_FUNCTION_DIGEST); 108 109 if (session->processing->always_authen && 110 !session->processing->relogged) 111 return PKCS11_CKR_USER_NOT_LOGGED_IN; 112 113 allowed = true; 114 break; 115 116 case PKCS11_FUNC_STEP_FINAL: 117 if (session->processing->always_authen && 118 !session->processing->relogged) 119 return PKCS11_CKR_USER_NOT_LOGGED_IN; 120 121 return PKCS11_CKR_OK; 122 123 default: 124 TEE_Panic(step); 125 break; 126 } 127 128 if (!allowed) { 129 EMSG("Processing %#x/%s not permitted (%u/%u)", 130 (unsigned int)mechanism_type, id2str_proc(mechanism_type), 131 function, step); 132 return PKCS11_CKR_MECHANISM_INVALID; 133 } 134 135 return PKCS11_CKR_OK; 136 } 137 138 /* 139 * Object default boolean attributes as per PKCS#11 140 */ 141 static uint8_t *pkcs11_object_default_boolprop(uint32_t attribute) 142 { 143 static const uint8_t bool_true = 1; 144 static const uint8_t bool_false; 145 146 switch (attribute) { 147 /* As per PKCS#11 default value */ 148 case PKCS11_CKA_MODIFIABLE: 149 case PKCS11_CKA_COPYABLE: 150 case PKCS11_CKA_DESTROYABLE: 151 return (uint8_t *)&bool_true; 152 case PKCS11_CKA_TOKEN: 153 case PKCS11_CKA_PRIVATE: 154 case PKCS11_CKA_WRAP_WITH_TRUSTED: 155 case PKCS11_CKA_ALWAYS_AUTHENTICATE: 156 case PKCS11_CKA_SENSITIVE: 157 return (uint8_t *)&bool_false; 158 /* Token specific default value */ 159 case PKCS11_CKA_SIGN: 160 case PKCS11_CKA_VERIFY: 161 case PKCS11_CKA_DERIVE: 162 case PKCS11_CKA_ENCRYPT: 163 case PKCS11_CKA_DECRYPT: 164 case PKCS11_CKA_SIGN_RECOVER: 165 case PKCS11_CKA_VERIFY_RECOVER: 166 case PKCS11_CKA_WRAP: 167 case PKCS11_CKA_UNWRAP: 168 case PKCS11_CKA_EXTRACTABLE: 169 case PKCS11_CKA_TRUSTED: 170 return (uint8_t *)&bool_false; 171 default: 172 DMSG("No default for boolprop attribute %#"PRIx32, attribute); 173 return NULL; 174 } 175 } 176 177 /* 178 * Object expects several boolean attributes to be set to a default value 179 * or to a validate client configuration value. This function append the input 180 * attribute (id/size/value) in the serialized object. 181 */ 182 static enum pkcs11_rc pkcs11_import_object_boolprop(struct obj_attrs **out, 183 struct obj_attrs *templ, 184 uint32_t attribute) 185 { 186 enum pkcs11_rc rc = PKCS11_CKR_OK; 187 uint8_t bbool = 0; 188 uint32_t size = sizeof(uint8_t); 189 void *attr = NULL; 190 191 rc = get_attribute(templ, attribute, &bbool, &size); 192 if (rc) { 193 if (rc != PKCS11_RV_NOT_FOUND) 194 return rc; 195 attr = pkcs11_object_default_boolprop(attribute); 196 if (!attr) 197 return PKCS11_CKR_TEMPLATE_INCOMPLETE; 198 } else { 199 attr = &bbool; 200 } 201 202 /* Boolean attributes are 1byte in the ABI, no alignment issue */ 203 return add_attribute(out, attribute, attr, sizeof(uint8_t)); 204 } 205 206 static enum pkcs11_rc set_mandatory_boolprops(struct obj_attrs **out, 207 struct obj_attrs *temp, 208 uint32_t const *bp, 209 size_t bp_count) 210 { 211 enum pkcs11_rc rc = PKCS11_CKR_OK; 212 size_t n = 0; 213 214 for (n = 0; n < bp_count; n++) { 215 rc = pkcs11_import_object_boolprop(out, temp, bp[n]); 216 if (rc) 217 return rc; 218 } 219 220 return rc; 221 } 222 223 static enum pkcs11_rc set_mandatory_attributes(struct obj_attrs **out, 224 struct obj_attrs *temp, 225 uint32_t const *attrs, 226 size_t attrs_count) 227 { 228 enum pkcs11_rc rc = PKCS11_CKR_OK; 229 size_t n = 0; 230 231 for (n = 0; n < attrs_count; n++) { 232 uint32_t size = 0; 233 void *value = NULL; 234 235 if (get_attribute_ptr(temp, attrs[n], &value, &size)) 236 return PKCS11_CKR_TEMPLATE_INCOMPLETE; 237 238 rc = add_attribute(out, attrs[n], value, size); 239 if (rc) 240 return rc; 241 } 242 243 return rc; 244 } 245 246 static enum pkcs11_rc get_default_value(enum pkcs11_attr_id id, void **value, 247 uint32_t *size) 248 { 249 /* should have been taken care of already */ 250 assert(!pkcs11_attr_is_boolean(id)); 251 252 /* All other attributes have an empty default value */ 253 *value = NULL; 254 *size = 0; 255 return PKCS11_CKR_OK; 256 } 257 258 static enum pkcs11_rc set_optional_attributes_with_def(struct obj_attrs **out, 259 struct obj_attrs *temp, 260 uint32_t const *attrs, 261 size_t attrs_count, 262 bool default_to_null) 263 { 264 enum pkcs11_rc rc = PKCS11_CKR_OK; 265 size_t n = 0; 266 267 for (n = 0; n < attrs_count; n++) { 268 uint32_t size = 0; 269 void *value = NULL; 270 271 rc = get_attribute_ptr(temp, attrs[n], &value, &size); 272 if (rc == PKCS11_RV_NOT_FOUND) { 273 if (default_to_null) { 274 rc = get_default_value(attrs[n], &value, &size); 275 } else { 276 rc = PKCS11_CKR_OK; 277 continue; 278 } 279 } 280 if (rc) 281 return rc; 282 283 rc = add_attribute(out, attrs[n], value, size); 284 if (rc) 285 return rc; 286 } 287 288 return rc; 289 } 290 291 static enum pkcs11_rc set_attributes_opt_or_null(struct obj_attrs **out, 292 struct obj_attrs *temp, 293 uint32_t const *attrs, 294 size_t attrs_count) 295 { 296 return set_optional_attributes_with_def(out, temp, attrs, attrs_count, 297 true /* defaults to empty */); 298 } 299 300 static enum pkcs11_rc set_optional_attributes(struct obj_attrs **out, 301 struct obj_attrs *temp, 302 uint32_t const *attrs, 303 size_t attrs_count) 304 { 305 return set_optional_attributes_with_def(out, temp, attrs, attrs_count, 306 false /* no default value */); 307 } 308 309 /* 310 * Below are listed the mandated or optional expected attributes for 311 * PKCS#11 storage objects. 312 * 313 * Note: boolprops (mandated boolean attributes) PKCS11_CKA_ALWAYS_SENSITIVE, 314 * and PKCS11_CKA_NEVER_EXTRACTABLE are set by the token, not provided 315 * in the client template. 316 */ 317 318 /* PKCS#11 specification for any object (session/token) of the storage */ 319 static const uint32_t any_object_boolprops[] = { 320 PKCS11_CKA_TOKEN, PKCS11_CKA_PRIVATE, 321 PKCS11_CKA_MODIFIABLE, PKCS11_CKA_COPYABLE, PKCS11_CKA_DESTROYABLE, 322 }; 323 324 static const uint32_t any_object_opt_or_null[] = { 325 PKCS11_CKA_LABEL, 326 }; 327 328 /* PKCS#11 specification for raw data object (+any_object_xxx) */ 329 const uint32_t raw_data_opt_or_null[] = { 330 PKCS11_CKA_OBJECT_ID, PKCS11_CKA_APPLICATION, PKCS11_CKA_VALUE, 331 }; 332 333 /* PKCS#11 specification for any key object (+any_object_xxx) */ 334 static const uint32_t any_key_boolprops[] = { 335 PKCS11_CKA_DERIVE, 336 }; 337 338 static const uint32_t any_key_opt_or_null[] = { 339 PKCS11_CKA_ID, 340 PKCS11_CKA_START_DATE, PKCS11_CKA_END_DATE, 341 }; 342 343 static const uint32_t any_key_optional[] = { 344 PKCS11_CKA_ALLOWED_MECHANISMS, 345 }; 346 347 /* PKCS#11 specification for any symmetric key (+any_key_xxx) */ 348 static const uint32_t symm_key_boolprops[] = { 349 PKCS11_CKA_ENCRYPT, PKCS11_CKA_DECRYPT, 350 PKCS11_CKA_SIGN, PKCS11_CKA_VERIFY, 351 PKCS11_CKA_WRAP, PKCS11_CKA_UNWRAP, 352 PKCS11_CKA_SENSITIVE, PKCS11_CKA_EXTRACTABLE, 353 PKCS11_CKA_WRAP_WITH_TRUSTED, PKCS11_CKA_TRUSTED, 354 }; 355 356 static const uint32_t symm_key_opt_or_null[] = { 357 PKCS11_CKA_WRAP_TEMPLATE, PKCS11_CKA_UNWRAP_TEMPLATE, 358 PKCS11_CKA_DERIVE_TEMPLATE, PKCS11_CKA_VALUE, 359 }; 360 361 static const uint32_t symm_key_optional[] = { 362 PKCS11_CKA_VALUE_LEN, 363 }; 364 365 /* PKCS#11 specification for any asymmetric public key (+any_key_xxx) */ 366 static const uint32_t public_key_boolprops[] = { 367 PKCS11_CKA_ENCRYPT, PKCS11_CKA_VERIFY, PKCS11_CKA_VERIFY_RECOVER, 368 PKCS11_CKA_WRAP, 369 PKCS11_CKA_TRUSTED, 370 }; 371 372 static const uint32_t public_key_mandated[] = { 373 }; 374 375 static const uint32_t public_key_opt_or_null[] = { 376 PKCS11_CKA_SUBJECT, PKCS11_CKA_WRAP_TEMPLATE, 377 PKCS11_CKA_PUBLIC_KEY_INFO, 378 }; 379 380 /* PKCS#11 specification for any asymmetric private key (+any_key_xxx) */ 381 static const uint32_t private_key_boolprops[] = { 382 PKCS11_CKA_DECRYPT, PKCS11_CKA_SIGN, PKCS11_CKA_SIGN_RECOVER, 383 PKCS11_CKA_UNWRAP, 384 PKCS11_CKA_SENSITIVE, PKCS11_CKA_EXTRACTABLE, 385 PKCS11_CKA_WRAP_WITH_TRUSTED, PKCS11_CKA_ALWAYS_AUTHENTICATE, 386 }; 387 388 static const uint32_t private_key_mandated[] = { 389 }; 390 391 static const uint32_t private_key_opt_or_null[] = { 392 PKCS11_CKA_SUBJECT, PKCS11_CKA_UNWRAP_TEMPLATE, 393 PKCS11_CKA_PUBLIC_KEY_INFO, 394 }; 395 396 /* PKCS#11 specification for any RSA key (+public/private_key_xxx) */ 397 static const uint32_t rsa_public_key_mandated[] = { 398 PKCS11_CKA_MODULUS_BITS, 399 }; 400 401 static const uint32_t rsa_public_key_opt_or_null[] = { 402 PKCS11_CKA_MODULUS, PKCS11_CKA_PUBLIC_EXPONENT, 403 }; 404 405 static const uint32_t rsa_private_key_opt_or_null[] = { 406 PKCS11_CKA_MODULUS, PKCS11_CKA_PUBLIC_EXPONENT, 407 PKCS11_CKA_PRIVATE_EXPONENT, 408 PKCS11_CKA_PRIME_1, PKCS11_CKA_PRIME_2, 409 PKCS11_CKA_EXPONENT_1, PKCS11_CKA_EXPONENT_2, PKCS11_CKA_COEFFICIENT, 410 }; 411 412 /* PKCS#11 specification for any EC key (+public/private_key_xxx) */ 413 static const uint32_t ec_public_key_mandated[] = { 414 PKCS11_CKA_EC_PARAMS, 415 }; 416 417 static const uint32_t ec_public_key_opt_or_null[] = { 418 PKCS11_CKA_EC_POINT, 419 }; 420 421 static const uint32_t ec_private_key_mandated[] = { 422 }; 423 424 static const uint32_t ec_private_key_opt_or_null[] = { 425 PKCS11_CKA_EC_PARAMS, 426 PKCS11_CKA_VALUE, 427 }; 428 429 static enum pkcs11_rc create_storage_attributes(struct obj_attrs **out, 430 struct obj_attrs *temp) 431 { 432 enum pkcs11_class_id class = PKCS11_CKO_UNDEFINED_ID; 433 enum pkcs11_rc rc = PKCS11_CKR_OK; 434 435 rc = init_attributes_head(out); 436 if (rc) 437 return rc; 438 439 /* Object class is mandatory */ 440 class = get_class(temp); 441 if (class == PKCS11_CKO_UNDEFINED_ID) { 442 EMSG("Class attribute not found"); 443 444 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 445 } 446 rc = add_attribute(out, PKCS11_CKA_CLASS, &class, sizeof(uint32_t)); 447 if (rc) 448 return rc; 449 450 rc = set_mandatory_boolprops(out, temp, any_object_boolprops, 451 ARRAY_SIZE(any_object_boolprops)); 452 if (rc) 453 return rc; 454 455 return set_attributes_opt_or_null(out, temp, any_object_opt_or_null, 456 ARRAY_SIZE(any_object_opt_or_null)); 457 } 458 459 static enum pkcs11_rc create_genkey_attributes(struct obj_attrs **out, 460 struct obj_attrs *temp) 461 { 462 uint32_t type = PKCS11_CKO_UNDEFINED_ID; 463 enum pkcs11_rc rc = PKCS11_CKR_OK; 464 465 rc = create_storage_attributes(out, temp); 466 if (rc) 467 return rc; 468 469 type = get_key_type(temp); 470 if (type == PKCS11_CKK_UNDEFINED_ID) { 471 EMSG("Key type attribute not found"); 472 473 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 474 } 475 rc = add_attribute(out, PKCS11_CKA_KEY_TYPE, &type, sizeof(uint32_t)); 476 if (rc) 477 return rc; 478 479 rc = set_mandatory_boolprops(out, temp, any_key_boolprops, 480 ARRAY_SIZE(any_key_boolprops)); 481 if (rc) 482 return rc; 483 484 rc = set_attributes_opt_or_null(out, temp, any_key_opt_or_null, 485 ARRAY_SIZE(any_key_opt_or_null)); 486 if (rc) 487 return rc; 488 489 return set_optional_attributes(out, temp, any_key_optional, 490 ARRAY_SIZE(any_key_optional)); 491 492 } 493 494 static enum pkcs11_rc create_symm_key_attributes(struct obj_attrs **out, 495 struct obj_attrs *temp) 496 { 497 enum pkcs11_rc rc = PKCS11_CKR_OK; 498 499 assert(get_class(temp) == PKCS11_CKO_SECRET_KEY); 500 501 rc = create_genkey_attributes(out, temp); 502 if (rc) 503 return rc; 504 505 assert(get_class(*out) == PKCS11_CKO_SECRET_KEY); 506 507 switch (get_key_type(*out)) { 508 case PKCS11_CKK_GENERIC_SECRET: 509 case PKCS11_CKK_AES: 510 case PKCS11_CKK_MD5_HMAC: 511 case PKCS11_CKK_SHA_1_HMAC: 512 case PKCS11_CKK_SHA256_HMAC: 513 case PKCS11_CKK_SHA384_HMAC: 514 case PKCS11_CKK_SHA512_HMAC: 515 case PKCS11_CKK_SHA224_HMAC: 516 break; 517 default: 518 EMSG("Invalid key type %#"PRIx32"/%s", 519 get_key_type(*out), id2str_key_type(get_key_type(*out))); 520 521 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 522 } 523 524 rc = set_mandatory_boolprops(out, temp, symm_key_boolprops, 525 ARRAY_SIZE(symm_key_boolprops)); 526 if (rc) 527 return rc; 528 529 rc = set_attributes_opt_or_null(out, temp, symm_key_opt_or_null, 530 ARRAY_SIZE(symm_key_opt_or_null)); 531 if (rc) 532 return rc; 533 534 return set_optional_attributes(out, temp, symm_key_optional, 535 ARRAY_SIZE(symm_key_optional)); 536 } 537 538 static enum pkcs11_rc create_data_attributes(struct obj_attrs **out, 539 struct obj_attrs *temp) 540 { 541 enum pkcs11_rc rc = PKCS11_CKR_OK; 542 543 assert(get_class(temp) == PKCS11_CKO_DATA); 544 545 rc = create_storage_attributes(out, temp); 546 if (rc) 547 return rc; 548 549 assert(get_class(*out) == PKCS11_CKO_DATA); 550 551 return set_attributes_opt_or_null(out, temp, raw_data_opt_or_null, 552 ARRAY_SIZE(raw_data_opt_or_null)); 553 } 554 555 static enum pkcs11_rc create_pub_key_attributes(struct obj_attrs **out, 556 struct obj_attrs *temp) 557 { 558 uint32_t const *mandated = NULL; 559 uint32_t const *opt_or_null = NULL; 560 size_t mandated_count = 0; 561 size_t opt_or_null_count = 0; 562 enum pkcs11_rc rc = PKCS11_CKR_OK; 563 564 assert(get_class(temp) == PKCS11_CKO_PUBLIC_KEY); 565 566 rc = create_genkey_attributes(out, temp); 567 if (rc) 568 return rc; 569 570 assert(get_class(*out) == PKCS11_CKO_PUBLIC_KEY); 571 572 rc = set_mandatory_boolprops(out, temp, public_key_boolprops, 573 ARRAY_SIZE(public_key_boolprops)); 574 if (rc) 575 return rc; 576 577 rc = set_mandatory_attributes(out, temp, public_key_mandated, 578 ARRAY_SIZE(public_key_mandated)); 579 if (rc) 580 return rc; 581 582 rc = set_attributes_opt_or_null(out, temp, 583 public_key_opt_or_null, 584 ARRAY_SIZE(public_key_opt_or_null)); 585 if (rc) 586 return rc; 587 588 switch (get_key_type(*out)) { 589 case PKCS11_CKK_RSA: 590 mandated = rsa_public_key_mandated; 591 opt_or_null = rsa_public_key_opt_or_null; 592 mandated_count = ARRAY_SIZE(rsa_public_key_mandated); 593 opt_or_null_count = ARRAY_SIZE(rsa_public_key_opt_or_null); 594 break; 595 case PKCS11_CKK_EC: 596 mandated = ec_public_key_mandated; 597 opt_or_null = ec_public_key_opt_or_null; 598 mandated_count = ARRAY_SIZE(ec_public_key_mandated); 599 opt_or_null_count = ARRAY_SIZE(ec_public_key_opt_or_null); 600 break; 601 default: 602 EMSG("Invalid key type %#"PRIx32"/%s", 603 get_key_type(*out), id2str_key_type(get_key_type(*out))); 604 605 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 606 } 607 608 rc = set_mandatory_attributes(out, temp, mandated, mandated_count); 609 if (rc) 610 return rc; 611 612 return set_attributes_opt_or_null(out, temp, opt_or_null, 613 opt_or_null_count); 614 } 615 616 static enum pkcs11_rc create_priv_key_attributes(struct obj_attrs **out, 617 struct obj_attrs *temp) 618 { 619 uint32_t const *mandated = NULL; 620 uint32_t const *opt_or_null = NULL; 621 size_t mandated_count = 0; 622 size_t opt_or_null_count = 0; 623 enum pkcs11_rc rc = PKCS11_CKR_OK; 624 625 assert(get_class(temp) == PKCS11_CKO_PRIVATE_KEY); 626 627 rc = create_genkey_attributes(out, temp); 628 if (rc) 629 return rc; 630 631 assert(get_class(*out) == PKCS11_CKO_PRIVATE_KEY); 632 633 rc = set_mandatory_boolprops(out, temp, private_key_boolprops, 634 ARRAY_SIZE(private_key_boolprops)); 635 if (rc) 636 return rc; 637 638 rc = set_mandatory_attributes(out, temp, private_key_mandated, 639 ARRAY_SIZE(private_key_mandated)); 640 if (rc) 641 return rc; 642 643 rc = set_attributes_opt_or_null(out, temp, private_key_opt_or_null, 644 ARRAY_SIZE(private_key_opt_or_null)); 645 if (rc) 646 return rc; 647 648 switch (get_key_type(*out)) { 649 case PKCS11_CKK_RSA: 650 opt_or_null = rsa_private_key_opt_or_null; 651 opt_or_null_count = ARRAY_SIZE(rsa_private_key_opt_or_null); 652 break; 653 case PKCS11_CKK_EC: 654 mandated = ec_private_key_mandated; 655 opt_or_null = ec_private_key_opt_or_null; 656 mandated_count = ARRAY_SIZE(ec_private_key_mandated); 657 opt_or_null_count = ARRAY_SIZE(ec_private_key_opt_or_null); 658 break; 659 default: 660 EMSG("Invalid key type %#"PRIx32"/%s", 661 get_key_type(*out), id2str_key_type(get_key_type(*out))); 662 663 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 664 } 665 666 rc = set_mandatory_attributes(out, temp, mandated, mandated_count); 667 if (rc) 668 return rc; 669 670 return set_attributes_opt_or_null(out, temp, opt_or_null, 671 opt_or_null_count); 672 } 673 674 static enum pkcs11_rc 675 sanitize_symm_key_attributes(struct obj_attrs **temp, 676 enum processing_func function) 677 { 678 enum pkcs11_rc rc = PKCS11_CKR_OK; 679 uint32_t a_size = 0; 680 681 assert(get_class(*temp) == PKCS11_CKO_SECRET_KEY); 682 683 rc = get_attribute_ptr(*temp, PKCS11_CKA_VALUE, NULL, &a_size); 684 685 switch (get_key_type(*temp)) { 686 case PKCS11_CKK_GENERIC_SECRET: 687 case PKCS11_CKK_AES: 688 case PKCS11_CKK_MD5_HMAC: 689 case PKCS11_CKK_SHA_1_HMAC: 690 case PKCS11_CKK_SHA256_HMAC: 691 case PKCS11_CKK_SHA384_HMAC: 692 case PKCS11_CKK_SHA512_HMAC: 693 case PKCS11_CKK_SHA224_HMAC: 694 switch (function) { 695 case PKCS11_FUNCTION_IMPORT: 696 /* CKA_VALUE is a mandatory with C_CreateObject */ 697 if (rc || a_size == 0) 698 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 699 700 if (get_attribute_ptr(*temp, PKCS11_CKA_VALUE_LEN, NULL, 701 NULL) != PKCS11_RV_NOT_FOUND) 702 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 703 704 return add_attribute(temp, PKCS11_CKA_VALUE_LEN, 705 &a_size, sizeof(uint32_t)); 706 case PKCS11_FUNCTION_GENERATE: 707 if (rc != PKCS11_RV_NOT_FOUND) 708 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 709 break; 710 default: 711 break; 712 } 713 break; 714 default: 715 EMSG("Invalid key type %#"PRIx32"/%s", 716 get_key_type(*temp), id2str_key_type(get_key_type(*temp))); 717 718 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 719 } 720 721 return PKCS11_CKR_OK; 722 } 723 724 /* 725 * Create an attribute list for a new object from a template and a parent 726 * object (optional) for an object generation function (generate, copy, 727 * derive...). 728 * 729 * PKCS#11 directives on the supplied template and expected return value: 730 * - template has an invalid attribute ID: ATTRIBUTE_TYPE_INVALID 731 * - template has an invalid value for an attribute: ATTRIBUTE_VALID_INVALID 732 * - template has value for a read-only attribute: ATTRIBUTE_READ_ONLY 733 * - template+default+parent => still miss an attribute: TEMPLATE_INCONSISTENT 734 * 735 * INFO on PKCS11_CMD_COPY_OBJECT: 736 * - parent PKCS11_CKA_COPYIABLE=false => return ACTION_PROHIBITED. 737 * - template can specify PKCS11_CKA_TOKEN, PKCS11_CKA_PRIVATE, 738 * PKCS11_CKA_MODIFIABLE, PKCS11_CKA_DESTROYABLE. 739 * - SENSITIVE can change from false to true, not from true to false. 740 * - LOCAL is the parent LOCAL 741 */ 742 enum pkcs11_rc 743 create_attributes_from_template(struct obj_attrs **out, void *template, 744 size_t template_size, 745 struct obj_attrs *parent, 746 enum processing_func function, 747 enum pkcs11_mechanism_id mecha, 748 enum pkcs11_class_id template_class) 749 { 750 struct obj_attrs *temp = NULL; 751 struct obj_attrs *attrs = NULL; 752 enum pkcs11_rc rc = PKCS11_CKR_OK; 753 uint8_t local = 0; 754 uint8_t always_sensitive = 0; 755 uint8_t never_extract = 0; 756 uint32_t class = PKCS11_UNDEFINED_ID; 757 uint32_t type = PKCS11_UNDEFINED_ID; 758 uint32_t mechanism_id = PKCS11_CKM_UNDEFINED_ID; 759 760 #ifdef DEBUG /* Sanity: check function argument */ 761 trace_attributes_from_api_head("template", template, template_size); 762 switch (function) { 763 case PKCS11_FUNCTION_GENERATE: 764 case PKCS11_FUNCTION_GENERATE_PAIR: 765 case PKCS11_FUNCTION_IMPORT: 766 case PKCS11_FUNCTION_MODIFY: 767 case PKCS11_FUNCTION_DERIVE: 768 case PKCS11_FUNCTION_COPY: 769 break; 770 default: 771 TEE_Panic(TEE_ERROR_NOT_SUPPORTED); 772 } 773 #endif 774 775 /* 776 * For PKCS11_FUNCTION_GENERATE, find the class and type 777 * based on the mechanism. These will be passed as hint 778 * sanitize_client_object() and added in temp if not 779 * already present 780 */ 781 if (function == PKCS11_FUNCTION_GENERATE) { 782 switch (mecha) { 783 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 784 class = PKCS11_CKO_SECRET_KEY; 785 type = PKCS11_CKK_GENERIC_SECRET; 786 break; 787 case PKCS11_CKM_AES_KEY_GEN: 788 class = PKCS11_CKO_SECRET_KEY; 789 type = PKCS11_CKK_AES; 790 break; 791 default: 792 TEE_Panic(TEE_ERROR_NOT_SUPPORTED); 793 } 794 } 795 796 /* 797 * For PKCS11_FUNCTION_GENERATE_PAIR, find the class and type 798 * based on the mechanism. These will be passed as hint 799 * sanitize_client_object() and added in temp if not 800 * already present 801 */ 802 if (function == PKCS11_FUNCTION_GENERATE_PAIR) { 803 switch (mecha) { 804 case PKCS11_CKM_EC_KEY_PAIR_GEN: 805 class = template_class; 806 type = PKCS11_CKK_EC; 807 break; 808 default: 809 TEE_Panic(TEE_ERROR_NOT_SUPPORTED); 810 } 811 } 812 813 /* 814 * Check and remove duplicates if any and create a new temporary 815 * template 816 */ 817 rc = sanitize_client_object(&temp, template, template_size, class, 818 type); 819 if (rc) 820 goto out; 821 822 /* 823 * For function type modify and copy return the created template 824 * from here. Rest of the code below is for creating objects 825 * or generating keys. 826 */ 827 switch (function) { 828 case PKCS11_FUNCTION_MODIFY: 829 case PKCS11_FUNCTION_COPY: 830 *out = temp; 831 return rc; 832 default: 833 break; 834 } 835 836 /* 837 * Check if class and type in temp are consistent with the mechanism 838 */ 839 switch (mecha) { 840 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 841 if (get_class(temp) != PKCS11_CKO_SECRET_KEY || 842 get_key_type(temp) != PKCS11_CKK_GENERIC_SECRET) { 843 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 844 goto out; 845 } 846 break; 847 case PKCS11_CKM_AES_KEY_GEN: 848 if (get_class(temp) != PKCS11_CKO_SECRET_KEY || 849 get_key_type(temp) != PKCS11_CKK_AES) { 850 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 851 goto out; 852 } 853 break; 854 case PKCS11_CKM_EC_KEY_PAIR_GEN: 855 if ((get_class(temp) != PKCS11_CKO_PUBLIC_KEY && 856 get_class(temp) != PKCS11_CKO_PRIVATE_KEY) || 857 get_key_type(temp) != PKCS11_CKK_EC) { 858 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 859 goto out; 860 } 861 break; 862 default: 863 break; 864 } 865 866 if (!sanitize_consistent_class_and_type(temp)) { 867 EMSG("Inconsistent class/type"); 868 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 869 goto out; 870 } 871 872 switch (get_class(temp)) { 873 case PKCS11_CKO_DATA: 874 rc = create_data_attributes(&attrs, temp); 875 break; 876 case PKCS11_CKO_SECRET_KEY: 877 rc = sanitize_symm_key_attributes(&temp, function); 878 if (rc) 879 goto out; 880 rc = create_symm_key_attributes(&attrs, temp); 881 break; 882 case PKCS11_CKO_PUBLIC_KEY: 883 rc = create_pub_key_attributes(&attrs, temp); 884 break; 885 case PKCS11_CKO_PRIVATE_KEY: 886 rc = create_priv_key_attributes(&attrs, temp); 887 break; 888 default: 889 DMSG("Invalid object class %#"PRIx32"/%s", 890 get_class(temp), id2str_class(get_class(temp))); 891 892 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 893 break; 894 } 895 if (rc) 896 goto out; 897 898 if (get_attribute_ptr(temp, PKCS11_CKA_LOCAL, NULL, NULL) != 899 PKCS11_RV_NOT_FOUND) { 900 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 901 goto out; 902 } 903 904 if (get_attribute_ptr(temp, PKCS11_CKA_KEY_GEN_MECHANISM, NULL, NULL) != 905 PKCS11_RV_NOT_FOUND) { 906 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 907 goto out; 908 } 909 910 switch (function) { 911 case PKCS11_FUNCTION_GENERATE: 912 case PKCS11_FUNCTION_GENERATE_PAIR: 913 local = PKCS11_TRUE; 914 break; 915 case PKCS11_FUNCTION_IMPORT: 916 case PKCS11_FUNCTION_DERIVE: 917 default: 918 local = PKCS11_FALSE; 919 break; 920 } 921 rc = add_attribute(&attrs, PKCS11_CKA_LOCAL, &local, sizeof(local)); 922 if (rc) 923 goto out; 924 925 switch (get_class(attrs)) { 926 case PKCS11_CKO_SECRET_KEY: 927 case PKCS11_CKO_PRIVATE_KEY: 928 case PKCS11_CKO_PUBLIC_KEY: 929 always_sensitive = PKCS11_FALSE; 930 never_extract = PKCS11_FALSE; 931 932 switch (function) { 933 case PKCS11_FUNCTION_DERIVE: 934 always_sensitive = 935 get_bool(parent, PKCS11_CKA_ALWAYS_SENSITIVE) && 936 get_bool(attrs, PKCS11_CKA_SENSITIVE); 937 never_extract = 938 get_bool(parent, PKCS11_CKA_NEVER_EXTRACTABLE) && 939 !get_bool(attrs, PKCS11_CKA_EXTRACTABLE); 940 break; 941 case PKCS11_FUNCTION_GENERATE: 942 case PKCS11_FUNCTION_GENERATE_PAIR: 943 always_sensitive = get_bool(attrs, 944 PKCS11_CKA_SENSITIVE); 945 never_extract = !get_bool(attrs, 946 PKCS11_CKA_EXTRACTABLE); 947 break; 948 default: 949 break; 950 } 951 952 rc = add_attribute(&attrs, PKCS11_CKA_ALWAYS_SENSITIVE, 953 &always_sensitive, sizeof(always_sensitive)); 954 if (rc) 955 goto out; 956 957 rc = add_attribute(&attrs, PKCS11_CKA_NEVER_EXTRACTABLE, 958 &never_extract, sizeof(never_extract)); 959 if (rc) 960 goto out; 961 962 /* Keys mandate attribute PKCS11_CKA_KEY_GEN_MECHANISM */ 963 if (local) 964 mechanism_id = mecha; 965 else 966 mechanism_id = PKCS11_CK_UNAVAILABLE_INFORMATION; 967 968 rc = add_attribute(&attrs, PKCS11_CKA_KEY_GEN_MECHANISM, 969 &mechanism_id, sizeof(mechanism_id)); 970 if (rc) 971 goto out; 972 break; 973 974 default: 975 break; 976 } 977 978 *out = attrs; 979 980 #ifdef DEBUG 981 trace_attributes("object", attrs); 982 #endif 983 984 out: 985 TEE_Free(temp); 986 if (rc) 987 TEE_Free(attrs); 988 989 return rc; 990 } 991 992 static enum pkcs11_rc check_attrs_misc_integrity(struct obj_attrs *head) 993 { 994 if (get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE) && 995 get_bool(head, PKCS11_CKA_EXTRACTABLE)) { 996 DMSG("Never/Extractable attributes mismatch %d/%d", 997 get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE), 998 get_bool(head, PKCS11_CKA_EXTRACTABLE)); 999 1000 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1001 } 1002 1003 if (get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE) && 1004 !get_bool(head, PKCS11_CKA_SENSITIVE)) { 1005 DMSG("Sensitive/always attributes mismatch %d/%d", 1006 get_bool(head, PKCS11_CKA_SENSITIVE), 1007 get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE)); 1008 1009 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1010 } 1011 1012 return PKCS11_CKR_OK; 1013 } 1014 1015 bool object_is_private(struct obj_attrs *head) 1016 { 1017 return get_bool(head, PKCS11_CKA_PRIVATE); 1018 } 1019 1020 bool object_is_token(struct obj_attrs *head) 1021 { 1022 return get_bool(head, PKCS11_CKA_TOKEN); 1023 } 1024 1025 bool object_is_modifiable(struct obj_attrs *head) 1026 { 1027 return get_bool(head, PKCS11_CKA_MODIFIABLE); 1028 } 1029 1030 bool object_is_copyable(struct obj_attrs *head) 1031 { 1032 return get_bool(head, PKCS11_CKA_COPYABLE); 1033 } 1034 1035 /* 1036 * Check access to object against authentication to token 1037 */ 1038 enum pkcs11_rc check_access_attrs_against_token(struct pkcs11_session *session, 1039 struct obj_attrs *head) 1040 { 1041 bool private = true; 1042 1043 switch (get_class(head)) { 1044 case PKCS11_CKO_SECRET_KEY: 1045 case PKCS11_CKO_PRIVATE_KEY: 1046 case PKCS11_CKO_PUBLIC_KEY: 1047 case PKCS11_CKO_DATA: 1048 private = object_is_private(head); 1049 break; 1050 default: 1051 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1052 } 1053 1054 if (private && (pkcs11_session_is_public(session) || 1055 pkcs11_session_is_so(session))) { 1056 DMSG("Private object access from a public or SO session"); 1057 1058 return PKCS11_CKR_USER_NOT_LOGGED_IN; 1059 } 1060 1061 return PKCS11_CKR_OK; 1062 } 1063 1064 /* 1065 * Check the attributes of a to-be-created object matches the token state 1066 */ 1067 enum pkcs11_rc check_created_attrs_against_token(struct pkcs11_session *session, 1068 struct obj_attrs *head) 1069 { 1070 enum pkcs11_rc rc = PKCS11_CKR_OK; 1071 1072 rc = check_attrs_misc_integrity(head); 1073 if (rc) 1074 return rc; 1075 1076 if (get_bool(head, PKCS11_CKA_TRUSTED) && 1077 !pkcs11_session_is_so(session)) { 1078 DMSG("Can't create trusted object"); 1079 1080 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1081 } 1082 1083 if (get_bool(head, PKCS11_CKA_TOKEN) && 1084 !pkcs11_session_is_read_write(session)) { 1085 DMSG("Can't create persistent object"); 1086 1087 return PKCS11_CKR_SESSION_READ_ONLY; 1088 } 1089 1090 /* 1091 * TODO: START_DATE and END_DATE: complies with current time? 1092 */ 1093 return PKCS11_CKR_OK; 1094 } 1095 1096 #define DMSG_BAD_BBOOL(attr, proc, head) \ 1097 do { \ 1098 uint32_t __maybe_unused _attr = (attr); \ 1099 uint8_t __maybe_unused _bvalue = 0; \ 1100 enum pkcs11_rc __maybe_unused _rc = PKCS11_CKR_OK; \ 1101 \ 1102 _rc = get_attribute((head), _attr, &_bvalue, NULL); \ 1103 DMSG("%s issue for %s: %sfound, value %"PRIu8, \ 1104 id2str_attr(_attr), id2str_proc((proc)), \ 1105 _rc ? "not " : "", _bvalue); \ 1106 } while (0) 1107 1108 static bool __maybe_unused check_attr_bval(uint32_t proc_id __maybe_unused, 1109 struct obj_attrs *head, 1110 uint32_t attribute, bool val) 1111 { 1112 uint8_t bbool = 0; 1113 uint32_t sz = sizeof(bbool); 1114 1115 if (!get_attribute(head, attribute, &bbool, &sz) && !!bbool == val) 1116 return true; 1117 1118 DMSG_BAD_BBOOL(attribute, proc_id, head); 1119 return false; 1120 } 1121 1122 /* 1123 * Check the attributes of a new secret match the processing/mechanism 1124 * used to create it. 1125 * 1126 * @proc_id - PKCS11_CKM_xxx 1127 * @head - head of the attributes of the to-be-created object. 1128 */ 1129 enum pkcs11_rc check_created_attrs_against_processing(uint32_t proc_id, 1130 struct obj_attrs *head) 1131 { 1132 /* 1133 * Processings that do not create secrets are not expected to call 1134 * this function which would panic. 1135 */ 1136 switch (proc_id) { 1137 case PKCS11_PROCESSING_IMPORT: 1138 case PKCS11_CKM_AES_ECB_ENCRYPT_DATA: 1139 case PKCS11_CKM_AES_CBC_ENCRYPT_DATA: 1140 assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, false)); 1141 break; 1142 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 1143 case PKCS11_CKM_AES_KEY_GEN: 1144 case PKCS11_CKM_EC_KEY_PAIR_GEN: 1145 assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, true)); 1146 break; 1147 default: 1148 TEE_Panic(proc_id); 1149 break; 1150 } 1151 1152 switch (proc_id) { 1153 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 1154 assert(get_key_type(head) == PKCS11_CKK_GENERIC_SECRET); 1155 break; 1156 case PKCS11_CKM_AES_KEY_GEN: 1157 assert(get_key_type(head) == PKCS11_CKK_AES); 1158 break; 1159 case PKCS11_CKM_EC_KEY_PAIR_GEN: 1160 assert(get_key_type(head) == PKCS11_CKK_EC); 1161 break; 1162 case PKCS11_PROCESSING_IMPORT: 1163 default: 1164 break; 1165 } 1166 1167 return PKCS11_CKR_OK; 1168 } 1169 1170 /* Return min and max key size supported for a key_type in bytes */ 1171 static void get_key_min_max_sizes(enum pkcs11_key_type key_type, 1172 uint32_t *min_key_size, 1173 uint32_t *max_key_size) 1174 { 1175 enum pkcs11_mechanism_id mechanism = PKCS11_CKM_UNDEFINED_ID; 1176 1177 switch (key_type) { 1178 case PKCS11_CKK_GENERIC_SECRET: 1179 mechanism = PKCS11_CKM_GENERIC_SECRET_KEY_GEN; 1180 break; 1181 case PKCS11_CKK_AES: 1182 mechanism = PKCS11_CKM_AES_KEY_GEN; 1183 break; 1184 case PKCS11_CKK_MD5_HMAC: 1185 mechanism = PKCS11_CKM_MD5_HMAC; 1186 break; 1187 case PKCS11_CKK_SHA_1_HMAC: 1188 mechanism = PKCS11_CKM_SHA_1_HMAC; 1189 break; 1190 case PKCS11_CKK_SHA224_HMAC: 1191 mechanism = PKCS11_CKM_SHA224_HMAC; 1192 break; 1193 case PKCS11_CKK_SHA256_HMAC: 1194 mechanism = PKCS11_CKM_SHA256_HMAC; 1195 break; 1196 case PKCS11_CKK_SHA384_HMAC: 1197 mechanism = PKCS11_CKM_SHA384_HMAC; 1198 break; 1199 case PKCS11_CKK_SHA512_HMAC: 1200 mechanism = PKCS11_CKM_SHA512_HMAC; 1201 break; 1202 default: 1203 TEE_Panic(key_type); 1204 break; 1205 } 1206 1207 mechanism_supported_key_sizes_bytes(mechanism, min_key_size, 1208 max_key_size); 1209 } 1210 1211 enum pkcs11_rc check_created_attrs(struct obj_attrs *key1, 1212 struct obj_attrs *key2) 1213 { 1214 enum pkcs11_rc rc = PKCS11_CKR_OK; 1215 struct obj_attrs *secret = NULL; 1216 struct obj_attrs *private = NULL; 1217 struct obj_attrs *public = NULL; 1218 uint32_t max_key_size = 0; 1219 uint32_t min_key_size = 0; 1220 uint32_t key_length = 0; 1221 1222 switch (get_class(key1)) { 1223 case PKCS11_CKO_SECRET_KEY: 1224 secret = key1; 1225 break; 1226 case PKCS11_CKO_PUBLIC_KEY: 1227 public = key1; 1228 break; 1229 case PKCS11_CKO_PRIVATE_KEY: 1230 private = key1; 1231 break; 1232 default: 1233 return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID; 1234 } 1235 1236 if (key2) { 1237 switch (get_class(key2)) { 1238 case PKCS11_CKO_PUBLIC_KEY: 1239 public = key2; 1240 if (private == key1) 1241 break; 1242 1243 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1244 case PKCS11_CKO_PRIVATE_KEY: 1245 private = key2; 1246 if (public == key1) 1247 break; 1248 1249 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1250 default: 1251 return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID; 1252 } 1253 1254 if (get_key_type(private) != get_key_type(public)) 1255 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1256 } 1257 1258 if (secret) { 1259 switch (get_key_type(secret)) { 1260 case PKCS11_CKK_AES: 1261 case PKCS11_CKK_GENERIC_SECRET: 1262 case PKCS11_CKK_MD5_HMAC: 1263 case PKCS11_CKK_SHA_1_HMAC: 1264 case PKCS11_CKK_SHA224_HMAC: 1265 case PKCS11_CKK_SHA256_HMAC: 1266 case PKCS11_CKK_SHA384_HMAC: 1267 case PKCS11_CKK_SHA512_HMAC: 1268 break; 1269 default: 1270 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1271 } 1272 1273 /* Get key size */ 1274 rc = get_u32_attribute(secret, PKCS11_CKA_VALUE_LEN, 1275 &key_length); 1276 if (rc) 1277 return PKCS11_CKR_TEMPLATE_INCOMPLETE; 1278 } 1279 if (public) { 1280 switch (get_key_type(public)) { 1281 case PKCS11_CKK_EC: 1282 break; 1283 default: 1284 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1285 } 1286 } 1287 if (private) { 1288 switch (get_key_type(private)) { 1289 case PKCS11_CKK_EC: 1290 break; 1291 default: 1292 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1293 } 1294 } 1295 1296 /* 1297 * Check key size for symmetric keys and RSA keys 1298 * EC is bound to domains, no need to check here. 1299 */ 1300 switch (get_key_type(key1)) { 1301 case PKCS11_CKK_EC: 1302 return PKCS11_CKR_OK; 1303 default: 1304 break; 1305 } 1306 1307 get_key_min_max_sizes(get_key_type(key1), &min_key_size, &max_key_size); 1308 if (key_length < min_key_size || key_length > max_key_size) { 1309 EMSG("Length %"PRIu32" vs range [%"PRIu32" %"PRIu32"]", 1310 key_length, min_key_size, max_key_size); 1311 1312 return PKCS11_CKR_KEY_SIZE_RANGE; 1313 } 1314 1315 if (secret && get_key_type(secret) == PKCS11_CKK_AES) { 1316 if (key_length != 16 && key_length != 24 && key_length != 32) 1317 return PKCS11_CKR_KEY_SIZE_RANGE; 1318 } 1319 1320 return PKCS11_CKR_OK; 1321 } 1322 1323 /* Check processing ID against attribute ALLOWED_MECHANISMS if any */ 1324 static bool parent_key_complies_allowed_processings(uint32_t proc_id, 1325 struct obj_attrs *head) 1326 { 1327 char *attr = NULL; 1328 uint32_t size = 0; 1329 uint32_t proc = 0; 1330 size_t count = 0; 1331 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1332 1333 rc = get_attribute_ptr(head, PKCS11_CKA_ALLOWED_MECHANISMS, 1334 (void *)&attr, &size); 1335 if (rc == PKCS11_RV_NOT_FOUND) 1336 return true; 1337 if (rc) { 1338 EMSG("unexpected attributes state"); 1339 TEE_Panic(TEE_ERROR_BAD_STATE); 1340 } 1341 1342 for (count = size / sizeof(uint32_t); count; count--) { 1343 TEE_MemMove(&proc, attr, sizeof(uint32_t)); 1344 attr += sizeof(uint32_t); 1345 1346 if (proc == proc_id) 1347 return true; 1348 } 1349 1350 DMSG("can't find %s in allowed list", id2str_proc(proc_id)); 1351 return false; 1352 } 1353 1354 static enum pkcs11_attr_id func_to_attr(enum processing_func func) 1355 { 1356 switch (func) { 1357 case PKCS11_FUNCTION_ENCRYPT: 1358 return PKCS11_CKA_ENCRYPT; 1359 case PKCS11_FUNCTION_DECRYPT: 1360 return PKCS11_CKA_DECRYPT; 1361 case PKCS11_FUNCTION_SIGN: 1362 return PKCS11_CKA_SIGN; 1363 case PKCS11_FUNCTION_VERIFY: 1364 return PKCS11_CKA_VERIFY; 1365 case PKCS11_FUNCTION_WRAP: 1366 return PKCS11_CKA_WRAP; 1367 case PKCS11_FUNCTION_UNWRAP: 1368 return PKCS11_CKA_UNWRAP; 1369 case PKCS11_FUNCTION_DERIVE: 1370 return PKCS11_CKA_DERIVE; 1371 default: 1372 return PKCS11_CKA_UNDEFINED_ID; 1373 } 1374 } 1375 1376 enum pkcs11_rc 1377 check_parent_attrs_against_processing(enum pkcs11_mechanism_id proc_id, 1378 enum processing_func function, 1379 struct obj_attrs *head) 1380 { 1381 enum pkcs11_class_id key_class = get_class(head); 1382 enum pkcs11_key_type key_type = get_key_type(head); 1383 enum pkcs11_attr_id attr = func_to_attr(function); 1384 1385 if (!get_bool(head, attr)) { 1386 DMSG("%s not permitted", id2str_attr(attr)); 1387 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1388 } 1389 1390 /* Check processing complies with parent key family */ 1391 switch (proc_id) { 1392 case PKCS11_CKM_AES_ECB: 1393 case PKCS11_CKM_AES_CBC: 1394 case PKCS11_CKM_AES_CBC_PAD: 1395 case PKCS11_CKM_AES_CTS: 1396 case PKCS11_CKM_AES_CTR: 1397 if (key_class == PKCS11_CKO_SECRET_KEY && 1398 key_type == PKCS11_CKK_AES) 1399 break; 1400 1401 DMSG("%s invalid key %s/%s", id2str_proc(proc_id), 1402 id2str_class(key_class), id2str_key_type(key_type)); 1403 1404 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1405 1406 case PKCS11_CKM_AES_ECB_ENCRYPT_DATA: 1407 case PKCS11_CKM_AES_CBC_ENCRYPT_DATA: 1408 if (key_class != PKCS11_CKO_SECRET_KEY && 1409 key_type != PKCS11_CKK_AES) 1410 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1411 1412 if (get_bool(head, PKCS11_CKA_ENCRYPT)) { 1413 /* 1414 * Intentionally refuse to proceed despite 1415 * PKCS#11 specifications v2.40 and v3.0 not expecting 1416 * this behavior to avoid potential security issue 1417 * where keys derived by these mechanisms can be 1418 * revealed by doing data encryption using parent key. 1419 */ 1420 return PKCS11_CKR_FUNCTION_FAILED; 1421 } 1422 1423 break; 1424 case PKCS11_CKM_MD5_HMAC: 1425 case PKCS11_CKM_SHA_1_HMAC: 1426 case PKCS11_CKM_SHA224_HMAC: 1427 case PKCS11_CKM_SHA256_HMAC: 1428 case PKCS11_CKM_SHA384_HMAC: 1429 case PKCS11_CKM_SHA512_HMAC: 1430 if (key_class != PKCS11_CKO_SECRET_KEY) 1431 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1432 1433 if (key_type == PKCS11_CKK_GENERIC_SECRET) 1434 break; 1435 1436 switch (proc_id) { 1437 case PKCS11_CKM_MD5_HMAC: 1438 if (key_type == PKCS11_CKK_MD5_HMAC) 1439 break; 1440 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1441 case PKCS11_CKM_SHA_1_HMAC: 1442 if (key_type == PKCS11_CKK_SHA_1_HMAC) 1443 break; 1444 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1445 case PKCS11_CKM_SHA224_HMAC: 1446 if (key_type == PKCS11_CKK_SHA224_HMAC) 1447 break; 1448 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1449 case PKCS11_CKM_SHA256_HMAC: 1450 if (key_type == PKCS11_CKK_SHA256_HMAC) 1451 break; 1452 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1453 case PKCS11_CKM_SHA384_HMAC: 1454 if (key_type == PKCS11_CKK_SHA384_HMAC) 1455 break; 1456 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1457 case PKCS11_CKM_SHA512_HMAC: 1458 if (key_type == PKCS11_CKK_SHA512_HMAC) 1459 break; 1460 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1461 default: 1462 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1463 } 1464 break; 1465 1466 default: 1467 DMSG("Invalid processing %#"PRIx32"/%s", proc_id, 1468 id2str_proc(proc_id)); 1469 1470 return PKCS11_CKR_MECHANISM_INVALID; 1471 } 1472 1473 if (!parent_key_complies_allowed_processings(proc_id, head)) { 1474 DMSG("Allowed mechanism failed"); 1475 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1476 } 1477 1478 return PKCS11_CKR_OK; 1479 } 1480 1481 bool attribute_is_exportable(struct pkcs11_attribute_head *req_attr, 1482 struct pkcs11_object *obj) 1483 { 1484 uint8_t boolval = 0; 1485 uint32_t boolsize = 0; 1486 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1487 enum pkcs11_class_id key_class = get_class(obj->attributes); 1488 1489 if (key_class != PKCS11_CKO_SECRET_KEY && 1490 key_class != PKCS11_CKO_PRIVATE_KEY) 1491 return true; 1492 1493 switch (req_attr->id) { 1494 case PKCS11_CKA_PRIVATE_EXPONENT: 1495 case PKCS11_CKA_PRIME_1: 1496 case PKCS11_CKA_PRIME_2: 1497 case PKCS11_CKA_EXPONENT_1: 1498 case PKCS11_CKA_EXPONENT_2: 1499 case PKCS11_CKA_COEFFICIENT: 1500 case PKCS11_CKA_VALUE: 1501 boolsize = sizeof(boolval); 1502 rc = get_attribute(obj->attributes, PKCS11_CKA_EXTRACTABLE, 1503 &boolval, &boolsize); 1504 if (rc || boolval == PKCS11_FALSE) 1505 return false; 1506 1507 boolsize = sizeof(boolval); 1508 rc = get_attribute(obj->attributes, PKCS11_CKA_SENSITIVE, 1509 &boolval, &boolsize); 1510 if (rc || boolval == PKCS11_TRUE) 1511 return false; 1512 break; 1513 default: 1514 break; 1515 } 1516 1517 return true; 1518 } 1519 1520 static bool attr_is_modifiable_any_key(struct pkcs11_attribute_head *attr) 1521 { 1522 switch (attr->id) { 1523 case PKCS11_CKA_ID: 1524 case PKCS11_CKA_START_DATE: 1525 case PKCS11_CKA_END_DATE: 1526 case PKCS11_CKA_DERIVE: 1527 return true; 1528 default: 1529 return false; 1530 } 1531 } 1532 1533 static bool attr_is_modifiable_secret_key(struct pkcs11_attribute_head *attr, 1534 struct pkcs11_session *session, 1535 struct pkcs11_object *obj) 1536 { 1537 switch (attr->id) { 1538 case PKCS11_CKA_ENCRYPT: 1539 case PKCS11_CKA_DECRYPT: 1540 case PKCS11_CKA_SIGN: 1541 case PKCS11_CKA_VERIFY: 1542 case PKCS11_CKA_WRAP: 1543 case PKCS11_CKA_UNWRAP: 1544 return true; 1545 /* Can't be modified once set to CK_FALSE - 12 in Table 10 */ 1546 case PKCS11_CKA_EXTRACTABLE: 1547 return get_bool(obj->attributes, attr->id); 1548 /* Can't be modified once set to CK_TRUE - 11 in Table 10 */ 1549 case PKCS11_CKA_SENSITIVE: 1550 case PKCS11_CKA_WRAP_WITH_TRUSTED: 1551 return !get_bool(obj->attributes, attr->id); 1552 /* Change in CKA_TRUSTED can only be done by SO */ 1553 case PKCS11_CKA_TRUSTED: 1554 return pkcs11_session_is_so(session); 1555 case PKCS11_CKA_NEVER_EXTRACTABLE: 1556 case PKCS11_CKA_ALWAYS_SENSITIVE: 1557 return false; 1558 default: 1559 return false; 1560 } 1561 } 1562 1563 static bool attr_is_modifiable_public_key(struct pkcs11_attribute_head *attr, 1564 struct pkcs11_session *session, 1565 struct pkcs11_object *obj __unused) 1566 { 1567 switch (attr->id) { 1568 case PKCS11_CKA_SUBJECT: 1569 case PKCS11_CKA_ENCRYPT: 1570 case PKCS11_CKA_VERIFY: 1571 case PKCS11_CKA_VERIFY_RECOVER: 1572 case PKCS11_CKA_WRAP: 1573 return true; 1574 case PKCS11_CKA_TRUSTED: 1575 /* Change in CKA_TRUSTED can only be done by SO */ 1576 return pkcs11_session_is_so(session); 1577 default: 1578 return false; 1579 } 1580 } 1581 1582 static bool attr_is_modifiable_private_key(struct pkcs11_attribute_head *attr, 1583 struct pkcs11_session *sess __unused, 1584 struct pkcs11_object *obj) 1585 { 1586 switch (attr->id) { 1587 case PKCS11_CKA_SUBJECT: 1588 case PKCS11_CKA_DECRYPT: 1589 case PKCS11_CKA_SIGN: 1590 case PKCS11_CKA_SIGN_RECOVER: 1591 case PKCS11_CKA_UNWRAP: 1592 /* 1593 * TBD: Revisit if we don't support PKCS11_CKA_PUBLIC_KEY_INFO 1594 * Specification mentions that if this attribute is 1595 * supplied as part of a template for C_CreateObject, C_CopyObject or 1596 * C_SetAttributeValue for a private key, the token MUST verify 1597 * correspondence between the private key data and the public key data 1598 * as supplied in CKA_PUBLIC_KEY_INFO. This needs to be 1599 * taken care of when this object type will be implemented 1600 */ 1601 case PKCS11_CKA_PUBLIC_KEY_INFO: 1602 return true; 1603 /* Can't be modified once set to CK_FALSE - 12 in Table 10 */ 1604 case PKCS11_CKA_EXTRACTABLE: 1605 return get_bool(obj->attributes, attr->id); 1606 /* Can't be modified once set to CK_TRUE - 11 in Table 10 */ 1607 case PKCS11_CKA_SENSITIVE: 1608 case PKCS11_CKA_WRAP_WITH_TRUSTED: 1609 return !get_bool(obj->attributes, attr->id); 1610 case PKCS11_CKA_NEVER_EXTRACTABLE: 1611 case PKCS11_CKA_ALWAYS_SENSITIVE: 1612 return false; 1613 default: 1614 return false; 1615 } 1616 } 1617 1618 static bool attribute_is_modifiable(struct pkcs11_session *session, 1619 struct pkcs11_attribute_head *req_attr, 1620 struct pkcs11_object *obj, 1621 enum pkcs11_class_id class, 1622 enum processing_func function) 1623 { 1624 /* Check modifiable attributes common to any object */ 1625 switch (req_attr->id) { 1626 case PKCS11_CKA_LABEL: 1627 return true; 1628 case PKCS11_CKA_TOKEN: 1629 case PKCS11_CKA_MODIFIABLE: 1630 case PKCS11_CKA_DESTROYABLE: 1631 case PKCS11_CKA_PRIVATE: 1632 return function == PKCS11_FUNCTION_COPY; 1633 case PKCS11_CKA_COPYABLE: 1634 /* 1635 * Specification mentions that if the attribute value is false 1636 * it can't be set to true. Reading this we assume that it 1637 * should be possible to modify this attribute even though this 1638 * is not marked as modifiable in Table 10 if done in right 1639 * direction i.e from TRUE -> FALSE. 1640 */ 1641 return get_bool(obj->attributes, req_attr->id); 1642 default: 1643 break; 1644 } 1645 1646 /* Attribute checking based on class type */ 1647 switch (class) { 1648 case PKCS11_CKO_SECRET_KEY: 1649 case PKCS11_CKO_PUBLIC_KEY: 1650 case PKCS11_CKO_PRIVATE_KEY: 1651 if (attr_is_modifiable_any_key(req_attr)) 1652 return true; 1653 if (class == PKCS11_CKO_SECRET_KEY && 1654 attr_is_modifiable_secret_key(req_attr, session, obj)) 1655 return true; 1656 if (class == PKCS11_CKO_PUBLIC_KEY && 1657 attr_is_modifiable_public_key(req_attr, session, obj)) 1658 return true; 1659 if (class == PKCS11_CKO_PRIVATE_KEY && 1660 attr_is_modifiable_private_key(req_attr, session, obj)) 1661 return true; 1662 break; 1663 case PKCS11_CKO_DATA: 1664 /* None of the data object attributes are modifiable */ 1665 return false; 1666 default: 1667 break; 1668 } 1669 1670 return false; 1671 } 1672 1673 enum pkcs11_rc check_attrs_against_modification(struct pkcs11_session *session, 1674 struct obj_attrs *head, 1675 struct pkcs11_object *obj, 1676 enum processing_func function) 1677 { 1678 enum pkcs11_class_id class = PKCS11_CKO_UNDEFINED_ID; 1679 char *cur = NULL; 1680 char *end = NULL; 1681 size_t len = 0; 1682 1683 class = get_class(obj->attributes); 1684 1685 cur = (char *)head + sizeof(struct obj_attrs); 1686 end = cur + head->attrs_size; 1687 1688 for (; cur < end; cur += len) { 1689 /* Structure aligned copy of the pkcs11_ref in the object */ 1690 struct pkcs11_attribute_head cli_ref = { }; 1691 1692 TEE_MemMove(&cli_ref, cur, sizeof(cli_ref)); 1693 len = sizeof(cli_ref) + cli_ref.size; 1694 1695 /* 1696 * Check 1 - Check if attribute belongs to the object 1697 * The obj->attributes has all the attributes in 1698 * it which are allowed for an object. 1699 */ 1700 if (get_attribute_ptr(obj->attributes, cli_ref.id, NULL, 1701 NULL) == PKCS11_RV_NOT_FOUND) 1702 return PKCS11_CKR_ATTRIBUTE_TYPE_INVALID; 1703 1704 /* Check 2 - Is attribute modifiable */ 1705 if (!attribute_is_modifiable(session, &cli_ref, obj, class, 1706 function)) 1707 return PKCS11_CKR_ATTRIBUTE_READ_ONLY; 1708 1709 /* 1710 * Checks for modification in PKCS11_CKA_TOKEN and 1711 * PKCS11_CKA_PRIVATE are required for PKCS11_FUNCTION_COPY 1712 * only, so skip them for PKCS11_FUNCTION_MODIFY. 1713 */ 1714 if (function == PKCS11_FUNCTION_MODIFY) 1715 continue; 1716 1717 /* 1718 * An attempt to copy an object to a token will fail for 1719 * RO session 1720 */ 1721 if (cli_ref.id == PKCS11_CKA_TOKEN && 1722 get_bool(head, PKCS11_CKA_TOKEN)) { 1723 if (!pkcs11_session_is_read_write(session)) { 1724 DMSG("Can't copy to token in a RO session"); 1725 return PKCS11_CKR_SESSION_READ_ONLY; 1726 } 1727 } 1728 1729 if (cli_ref.id == PKCS11_CKA_PRIVATE) { 1730 bool parent_priv = 1731 get_bool(obj->attributes, cli_ref.id); 1732 bool obj_priv = get_bool(head, cli_ref.id); 1733 1734 /* 1735 * If PKCS11_CKA_PRIVATE is being set to TRUE from 1736 * FALSE, user has to be logged in 1737 */ 1738 if (!parent_priv && obj_priv) { 1739 if ((pkcs11_session_is_public(session) || 1740 pkcs11_session_is_so(session))) 1741 return PKCS11_CKR_USER_NOT_LOGGED_IN; 1742 } 1743 1744 /* 1745 * Restriction added - Even for Copy, do not allow 1746 * modification of CKA_PRIVATE from TRUE to FALSE 1747 */ 1748 if (parent_priv && !obj_priv) 1749 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1750 } 1751 } 1752 1753 return PKCS11_CKR_OK; 1754 } 1755 1756 static enum pkcs11_rc set_secret_key_data(struct obj_attrs **head, void *data, 1757 size_t key_size) 1758 { 1759 uint32_t size = sizeof(uint32_t); 1760 uint32_t key_length = 0; 1761 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1762 1763 /* Get key size if present in template */ 1764 rc = get_attribute(*head, PKCS11_CKA_VALUE_LEN, &key_length, &size); 1765 if (rc && rc != PKCS11_RV_NOT_FOUND) 1766 return rc; 1767 1768 if (key_length) { 1769 if (key_size < key_length) 1770 return PKCS11_CKR_DATA_LEN_RANGE; 1771 } else { 1772 key_length = key_size; 1773 rc = set_attribute(head, PKCS11_CKA_VALUE_LEN, &key_length, 1774 sizeof(uint32_t)); 1775 if (rc) 1776 return rc; 1777 } 1778 1779 /* Now we can check the VALUE_LEN field */ 1780 rc = check_created_attrs(*head, NULL); 1781 if (rc) 1782 return rc; 1783 1784 /* Remove the default empty value attribute if found */ 1785 rc = remove_empty_attribute(head, PKCS11_CKA_VALUE); 1786 if (rc != PKCS11_CKR_OK && rc != PKCS11_RV_NOT_FOUND) 1787 return PKCS11_CKR_GENERAL_ERROR; 1788 1789 return add_attribute(head, PKCS11_CKA_VALUE, data, key_length); 1790 } 1791 1792 enum pkcs11_rc set_key_data(struct obj_attrs **head, void *data, 1793 size_t key_size) 1794 { 1795 switch (get_class(*head)) { 1796 case PKCS11_CKO_SECRET_KEY: 1797 return set_secret_key_data(head, data, key_size); 1798 default: 1799 return PKCS11_CKR_GENERAL_ERROR; 1800 } 1801 } 1802 1803 enum pkcs11_rc add_missing_attribute_id(struct obj_attrs **pub_head, 1804 struct obj_attrs **priv_head) 1805 { 1806 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1807 void *id1 = NULL; 1808 uint32_t id1_size = 0; 1809 void *id2 = NULL; 1810 uint32_t id2_size = 0; 1811 1812 assert(pub_head); 1813 assert(priv_head); 1814 1815 rc = get_attribute_ptr(*pub_head, PKCS11_CKA_ID, &id1, &id1_size); 1816 if (rc) { 1817 if (rc != PKCS11_RV_NOT_FOUND) 1818 return rc; 1819 id1 = NULL; 1820 } else if (!id1_size) { 1821 id1 = NULL; 1822 } 1823 1824 rc = get_attribute_ptr(*priv_head, PKCS11_CKA_ID, &id2, &id2_size); 1825 if (rc) { 1826 if (rc != PKCS11_RV_NOT_FOUND) 1827 return rc; 1828 id2 = NULL; 1829 } else if (!id2_size) { 1830 id2 = NULL; 1831 } 1832 1833 /* Both have value -- let them be what caller has specified them */ 1834 if (id1 && id2) 1835 return PKCS11_CKR_OK; 1836 1837 /* Both are empty -- leave empty values */ 1838 if (!id1 && !id2) 1839 return PKCS11_CKR_OK; 1840 1841 /* Cross copy CKA_ID value */ 1842 if (id1) 1843 return set_attribute(priv_head, PKCS11_CKA_ID, id1, id1_size); 1844 else 1845 return set_attribute(pub_head, PKCS11_CKA_ID, id2, id2_size); 1846 } 1847