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 PKCS11_CKA_EC_PARAMS, 423 }; 424 425 static const uint32_t ec_private_key_opt_or_null[] = { 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 __unused) 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 default: 805 TEE_Panic(TEE_ERROR_NOT_SUPPORTED); 806 } 807 } 808 809 /* 810 * Check and remove duplicates if any and create a new temporary 811 * template 812 */ 813 rc = sanitize_client_object(&temp, template, template_size, class, 814 type); 815 if (rc) 816 goto out; 817 818 /* 819 * For function type modify and copy return the created template 820 * from here. Rest of the code below is for creating objects 821 * or generating keys. 822 */ 823 switch (function) { 824 case PKCS11_FUNCTION_MODIFY: 825 case PKCS11_FUNCTION_COPY: 826 *out = temp; 827 return rc; 828 default: 829 break; 830 } 831 832 /* 833 * Check if class and type in temp are consistent with the mechanism 834 */ 835 switch (mecha) { 836 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 837 if (get_class(temp) != PKCS11_CKO_SECRET_KEY || 838 get_key_type(temp) != PKCS11_CKK_GENERIC_SECRET) { 839 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 840 goto out; 841 } 842 break; 843 case PKCS11_CKM_AES_KEY_GEN: 844 if (get_class(temp) != PKCS11_CKO_SECRET_KEY || 845 get_key_type(temp) != PKCS11_CKK_AES) { 846 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 847 goto out; 848 } 849 break; 850 default: 851 break; 852 } 853 854 if (!sanitize_consistent_class_and_type(temp)) { 855 EMSG("Inconsistent class/type"); 856 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 857 goto out; 858 } 859 860 switch (get_class(temp)) { 861 case PKCS11_CKO_DATA: 862 rc = create_data_attributes(&attrs, temp); 863 break; 864 case PKCS11_CKO_SECRET_KEY: 865 rc = sanitize_symm_key_attributes(&temp, function); 866 if (rc) 867 goto out; 868 rc = create_symm_key_attributes(&attrs, temp); 869 break; 870 case PKCS11_CKO_PUBLIC_KEY: 871 rc = create_pub_key_attributes(&attrs, temp); 872 break; 873 case PKCS11_CKO_PRIVATE_KEY: 874 rc = create_priv_key_attributes(&attrs, temp); 875 break; 876 default: 877 DMSG("Invalid object class %#"PRIx32"/%s", 878 get_class(temp), id2str_class(get_class(temp))); 879 880 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 881 break; 882 } 883 if (rc) 884 goto out; 885 886 if (get_attribute_ptr(temp, PKCS11_CKA_LOCAL, NULL, NULL) != 887 PKCS11_RV_NOT_FOUND) { 888 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 889 goto out; 890 } 891 892 if (get_attribute_ptr(temp, PKCS11_CKA_KEY_GEN_MECHANISM, NULL, NULL) != 893 PKCS11_RV_NOT_FOUND) { 894 rc = PKCS11_CKR_TEMPLATE_INCONSISTENT; 895 goto out; 896 } 897 898 switch (function) { 899 case PKCS11_FUNCTION_GENERATE: 900 case PKCS11_FUNCTION_GENERATE_PAIR: 901 local = PKCS11_TRUE; 902 break; 903 case PKCS11_FUNCTION_IMPORT: 904 case PKCS11_FUNCTION_DERIVE: 905 default: 906 local = PKCS11_FALSE; 907 break; 908 } 909 rc = add_attribute(&attrs, PKCS11_CKA_LOCAL, &local, sizeof(local)); 910 if (rc) 911 goto out; 912 913 switch (get_class(attrs)) { 914 case PKCS11_CKO_SECRET_KEY: 915 case PKCS11_CKO_PRIVATE_KEY: 916 case PKCS11_CKO_PUBLIC_KEY: 917 always_sensitive = PKCS11_FALSE; 918 never_extract = PKCS11_FALSE; 919 920 switch (function) { 921 case PKCS11_FUNCTION_DERIVE: 922 always_sensitive = 923 get_bool(parent, PKCS11_CKA_ALWAYS_SENSITIVE) && 924 get_bool(attrs, PKCS11_CKA_SENSITIVE); 925 never_extract = 926 get_bool(parent, PKCS11_CKA_NEVER_EXTRACTABLE) && 927 !get_bool(attrs, PKCS11_CKA_EXTRACTABLE); 928 break; 929 case PKCS11_FUNCTION_GENERATE: 930 case PKCS11_FUNCTION_GENERATE_PAIR: 931 always_sensitive = get_bool(attrs, 932 PKCS11_CKA_SENSITIVE); 933 never_extract = !get_bool(attrs, 934 PKCS11_CKA_EXTRACTABLE); 935 break; 936 default: 937 break; 938 } 939 940 rc = add_attribute(&attrs, PKCS11_CKA_ALWAYS_SENSITIVE, 941 &always_sensitive, sizeof(always_sensitive)); 942 if (rc) 943 goto out; 944 945 rc = add_attribute(&attrs, PKCS11_CKA_NEVER_EXTRACTABLE, 946 &never_extract, sizeof(never_extract)); 947 if (rc) 948 goto out; 949 950 /* Keys mandate attribute PKCS11_CKA_KEY_GEN_MECHANISM */ 951 if (local) 952 mechanism_id = mecha; 953 else 954 mechanism_id = PKCS11_CK_UNAVAILABLE_INFORMATION; 955 956 rc = add_attribute(&attrs, PKCS11_CKA_KEY_GEN_MECHANISM, 957 &mechanism_id, sizeof(mechanism_id)); 958 if (rc) 959 goto out; 960 break; 961 962 default: 963 break; 964 } 965 966 *out = attrs; 967 968 #ifdef DEBUG 969 trace_attributes("object", attrs); 970 #endif 971 972 out: 973 TEE_Free(temp); 974 if (rc) 975 TEE_Free(attrs); 976 977 return rc; 978 } 979 980 static enum pkcs11_rc check_attrs_misc_integrity(struct obj_attrs *head) 981 { 982 if (get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE) && 983 get_bool(head, PKCS11_CKA_EXTRACTABLE)) { 984 DMSG("Never/Extractable attributes mismatch %d/%d", 985 get_bool(head, PKCS11_CKA_NEVER_EXTRACTABLE), 986 get_bool(head, PKCS11_CKA_EXTRACTABLE)); 987 988 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 989 } 990 991 if (get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE) && 992 !get_bool(head, PKCS11_CKA_SENSITIVE)) { 993 DMSG("Sensitive/always attributes mismatch %d/%d", 994 get_bool(head, PKCS11_CKA_SENSITIVE), 995 get_bool(head, PKCS11_CKA_ALWAYS_SENSITIVE)); 996 997 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 998 } 999 1000 return PKCS11_CKR_OK; 1001 } 1002 1003 bool object_is_private(struct obj_attrs *head) 1004 { 1005 return get_bool(head, PKCS11_CKA_PRIVATE); 1006 } 1007 1008 bool object_is_token(struct obj_attrs *head) 1009 { 1010 return get_bool(head, PKCS11_CKA_TOKEN); 1011 } 1012 1013 bool object_is_modifiable(struct obj_attrs *head) 1014 { 1015 return get_bool(head, PKCS11_CKA_MODIFIABLE); 1016 } 1017 1018 bool object_is_copyable(struct obj_attrs *head) 1019 { 1020 return get_bool(head, PKCS11_CKA_COPYABLE); 1021 } 1022 1023 /* 1024 * Check access to object against authentication to token 1025 */ 1026 enum pkcs11_rc check_access_attrs_against_token(struct pkcs11_session *session, 1027 struct obj_attrs *head) 1028 { 1029 bool private = true; 1030 1031 switch (get_class(head)) { 1032 case PKCS11_CKO_SECRET_KEY: 1033 case PKCS11_CKO_PRIVATE_KEY: 1034 case PKCS11_CKO_PUBLIC_KEY: 1035 case PKCS11_CKO_DATA: 1036 private = object_is_private(head); 1037 break; 1038 default: 1039 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1040 } 1041 1042 if (private && (pkcs11_session_is_public(session) || 1043 pkcs11_session_is_so(session))) { 1044 DMSG("Private object access from a public or SO session"); 1045 1046 return PKCS11_CKR_USER_NOT_LOGGED_IN; 1047 } 1048 1049 return PKCS11_CKR_OK; 1050 } 1051 1052 /* 1053 * Check the attributes of a to-be-created object matches the token state 1054 */ 1055 enum pkcs11_rc check_created_attrs_against_token(struct pkcs11_session *session, 1056 struct obj_attrs *head) 1057 { 1058 enum pkcs11_rc rc = PKCS11_CKR_OK; 1059 1060 rc = check_attrs_misc_integrity(head); 1061 if (rc) 1062 return rc; 1063 1064 if (get_bool(head, PKCS11_CKA_TRUSTED) && 1065 !pkcs11_session_is_so(session)) { 1066 DMSG("Can't create trusted object"); 1067 1068 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1069 } 1070 1071 if (get_bool(head, PKCS11_CKA_TOKEN) && 1072 !pkcs11_session_is_read_write(session)) { 1073 DMSG("Can't create persistent object"); 1074 1075 return PKCS11_CKR_SESSION_READ_ONLY; 1076 } 1077 1078 /* 1079 * TODO: START_DATE and END_DATE: complies with current time? 1080 */ 1081 return PKCS11_CKR_OK; 1082 } 1083 1084 #define DMSG_BAD_BBOOL(attr, proc, head) \ 1085 do { \ 1086 uint32_t __maybe_unused _attr = (attr); \ 1087 uint8_t __maybe_unused _bvalue = 0; \ 1088 enum pkcs11_rc __maybe_unused _rc = PKCS11_CKR_OK; \ 1089 \ 1090 _rc = get_attribute((head), _attr, &_bvalue, NULL); \ 1091 DMSG("%s issue for %s: %sfound, value %"PRIu8, \ 1092 id2str_attr(_attr), id2str_proc((proc)), \ 1093 _rc ? "not " : "", _bvalue); \ 1094 } while (0) 1095 1096 static bool __maybe_unused check_attr_bval(uint32_t proc_id __maybe_unused, 1097 struct obj_attrs *head, 1098 uint32_t attribute, bool val) 1099 { 1100 uint8_t bbool = 0; 1101 uint32_t sz = sizeof(bbool); 1102 1103 if (!get_attribute(head, attribute, &bbool, &sz) && !!bbool == val) 1104 return true; 1105 1106 DMSG_BAD_BBOOL(attribute, proc_id, head); 1107 return false; 1108 } 1109 1110 /* 1111 * Check the attributes of a new secret match the processing/mechanism 1112 * used to create it. 1113 * 1114 * @proc_id - PKCS11_CKM_xxx 1115 * @head - head of the attributes of the to-be-created object. 1116 */ 1117 enum pkcs11_rc check_created_attrs_against_processing(uint32_t proc_id, 1118 struct obj_attrs *head) 1119 { 1120 /* 1121 * Processings that do not create secrets are not expected to call 1122 * this function which would panic. 1123 */ 1124 switch (proc_id) { 1125 case PKCS11_PROCESSING_IMPORT: 1126 case PKCS11_CKM_AES_ECB_ENCRYPT_DATA: 1127 case PKCS11_CKM_AES_CBC_ENCRYPT_DATA: 1128 assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, false)); 1129 break; 1130 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 1131 case PKCS11_CKM_AES_KEY_GEN: 1132 assert(check_attr_bval(proc_id, head, PKCS11_CKA_LOCAL, true)); 1133 break; 1134 default: 1135 TEE_Panic(proc_id); 1136 break; 1137 } 1138 1139 switch (proc_id) { 1140 case PKCS11_CKM_GENERIC_SECRET_KEY_GEN: 1141 assert(get_key_type(head) == PKCS11_CKK_GENERIC_SECRET); 1142 break; 1143 case PKCS11_CKM_AES_KEY_GEN: 1144 assert(get_key_type(head) == PKCS11_CKK_AES); 1145 break; 1146 case PKCS11_PROCESSING_IMPORT: 1147 default: 1148 break; 1149 } 1150 1151 return PKCS11_CKR_OK; 1152 } 1153 1154 /* Return min and max key size supported for a key_type in bytes */ 1155 static void get_key_min_max_sizes(enum pkcs11_key_type key_type, 1156 uint32_t *min_key_size, 1157 uint32_t *max_key_size) 1158 { 1159 enum pkcs11_mechanism_id mechanism = PKCS11_CKM_UNDEFINED_ID; 1160 1161 switch (key_type) { 1162 case PKCS11_CKK_GENERIC_SECRET: 1163 mechanism = PKCS11_CKM_GENERIC_SECRET_KEY_GEN; 1164 break; 1165 case PKCS11_CKK_AES: 1166 mechanism = PKCS11_CKM_AES_KEY_GEN; 1167 break; 1168 case PKCS11_CKK_MD5_HMAC: 1169 mechanism = PKCS11_CKM_MD5_HMAC; 1170 break; 1171 case PKCS11_CKK_SHA_1_HMAC: 1172 mechanism = PKCS11_CKM_SHA_1_HMAC; 1173 break; 1174 case PKCS11_CKK_SHA224_HMAC: 1175 mechanism = PKCS11_CKM_SHA224_HMAC; 1176 break; 1177 case PKCS11_CKK_SHA256_HMAC: 1178 mechanism = PKCS11_CKM_SHA256_HMAC; 1179 break; 1180 case PKCS11_CKK_SHA384_HMAC: 1181 mechanism = PKCS11_CKM_SHA384_HMAC; 1182 break; 1183 case PKCS11_CKK_SHA512_HMAC: 1184 mechanism = PKCS11_CKM_SHA512_HMAC; 1185 break; 1186 default: 1187 TEE_Panic(key_type); 1188 break; 1189 } 1190 1191 mechanism_supported_key_sizes_bytes(mechanism, min_key_size, 1192 max_key_size); 1193 } 1194 1195 enum pkcs11_rc check_created_attrs(struct obj_attrs *key1, 1196 struct obj_attrs *key2) 1197 { 1198 enum pkcs11_rc rc = PKCS11_CKR_OK; 1199 struct obj_attrs *secret = NULL; 1200 struct obj_attrs *private = NULL; 1201 struct obj_attrs *public = NULL; 1202 uint32_t max_key_size = 0; 1203 uint32_t min_key_size = 0; 1204 uint32_t key_length = 0; 1205 1206 switch (get_class(key1)) { 1207 case PKCS11_CKO_SECRET_KEY: 1208 secret = key1; 1209 break; 1210 case PKCS11_CKO_PUBLIC_KEY: 1211 public = key1; 1212 break; 1213 case PKCS11_CKO_PRIVATE_KEY: 1214 private = key1; 1215 break; 1216 default: 1217 return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID; 1218 } 1219 1220 if (key2) { 1221 switch (get_class(key2)) { 1222 case PKCS11_CKO_PUBLIC_KEY: 1223 public = key2; 1224 if (private == key1) 1225 break; 1226 1227 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1228 case PKCS11_CKO_PRIVATE_KEY: 1229 private = key2; 1230 if (public == key1) 1231 break; 1232 1233 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1234 default: 1235 return PKCS11_CKR_ATTRIBUTE_VALUE_INVALID; 1236 } 1237 1238 if (get_key_type(private) != get_key_type(public)) 1239 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1240 } 1241 1242 if (secret) { 1243 switch (get_key_type(secret)) { 1244 case PKCS11_CKK_AES: 1245 case PKCS11_CKK_GENERIC_SECRET: 1246 case PKCS11_CKK_MD5_HMAC: 1247 case PKCS11_CKK_SHA_1_HMAC: 1248 case PKCS11_CKK_SHA224_HMAC: 1249 case PKCS11_CKK_SHA256_HMAC: 1250 case PKCS11_CKK_SHA384_HMAC: 1251 case PKCS11_CKK_SHA512_HMAC: 1252 break; 1253 default: 1254 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1255 } 1256 1257 /* Get key size */ 1258 rc = get_u32_attribute(secret, PKCS11_CKA_VALUE_LEN, 1259 &key_length); 1260 if (rc) 1261 return PKCS11_CKR_TEMPLATE_INCOMPLETE; 1262 } 1263 if (public) { 1264 switch (get_key_type(public)) { 1265 default: 1266 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1267 } 1268 } 1269 if (private) { 1270 switch (get_key_type(private)) { 1271 default: 1272 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1273 } 1274 } 1275 1276 get_key_min_max_sizes(get_key_type(key1), &min_key_size, &max_key_size); 1277 if (key_length < min_key_size || key_length > max_key_size) { 1278 EMSG("Length %"PRIu32" vs range [%"PRIu32" %"PRIu32"]", 1279 key_length, min_key_size, max_key_size); 1280 1281 return PKCS11_CKR_KEY_SIZE_RANGE; 1282 } 1283 1284 if (secret && get_key_type(secret) == PKCS11_CKK_AES) { 1285 if (key_length != 16 && key_length != 24 && key_length != 32) 1286 return PKCS11_CKR_KEY_SIZE_RANGE; 1287 } 1288 1289 return PKCS11_CKR_OK; 1290 } 1291 1292 /* Check processing ID against attribute ALLOWED_MECHANISMS if any */ 1293 static bool parent_key_complies_allowed_processings(uint32_t proc_id, 1294 struct obj_attrs *head) 1295 { 1296 char *attr = NULL; 1297 uint32_t size = 0; 1298 uint32_t proc = 0; 1299 size_t count = 0; 1300 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1301 1302 rc = get_attribute_ptr(head, PKCS11_CKA_ALLOWED_MECHANISMS, 1303 (void *)&attr, &size); 1304 if (rc == PKCS11_RV_NOT_FOUND) 1305 return true; 1306 if (rc) { 1307 EMSG("unexpected attributes state"); 1308 TEE_Panic(TEE_ERROR_BAD_STATE); 1309 } 1310 1311 for (count = size / sizeof(uint32_t); count; count--) { 1312 TEE_MemMove(&proc, attr, sizeof(uint32_t)); 1313 attr += sizeof(uint32_t); 1314 1315 if (proc == proc_id) 1316 return true; 1317 } 1318 1319 DMSG("can't find %s in allowed list", id2str_proc(proc_id)); 1320 return false; 1321 } 1322 1323 static enum pkcs11_attr_id func_to_attr(enum processing_func func) 1324 { 1325 switch (func) { 1326 case PKCS11_FUNCTION_ENCRYPT: 1327 return PKCS11_CKA_ENCRYPT; 1328 case PKCS11_FUNCTION_DECRYPT: 1329 return PKCS11_CKA_DECRYPT; 1330 case PKCS11_FUNCTION_SIGN: 1331 return PKCS11_CKA_SIGN; 1332 case PKCS11_FUNCTION_VERIFY: 1333 return PKCS11_CKA_VERIFY; 1334 case PKCS11_FUNCTION_WRAP: 1335 return PKCS11_CKA_WRAP; 1336 case PKCS11_FUNCTION_UNWRAP: 1337 return PKCS11_CKA_UNWRAP; 1338 case PKCS11_FUNCTION_DERIVE: 1339 return PKCS11_CKA_DERIVE; 1340 default: 1341 return PKCS11_CKA_UNDEFINED_ID; 1342 } 1343 } 1344 1345 enum pkcs11_rc 1346 check_parent_attrs_against_processing(enum pkcs11_mechanism_id proc_id, 1347 enum processing_func function, 1348 struct obj_attrs *head) 1349 { 1350 enum pkcs11_class_id key_class = get_class(head); 1351 enum pkcs11_key_type key_type = get_key_type(head); 1352 enum pkcs11_attr_id attr = func_to_attr(function); 1353 1354 if (!get_bool(head, attr)) { 1355 DMSG("%s not permitted", id2str_attr(attr)); 1356 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1357 } 1358 1359 /* Check processing complies with parent key family */ 1360 switch (proc_id) { 1361 case PKCS11_CKM_AES_ECB: 1362 case PKCS11_CKM_AES_CBC: 1363 case PKCS11_CKM_AES_CBC_PAD: 1364 case PKCS11_CKM_AES_CTS: 1365 case PKCS11_CKM_AES_CTR: 1366 if (key_class == PKCS11_CKO_SECRET_KEY && 1367 key_type == PKCS11_CKK_AES) 1368 break; 1369 1370 DMSG("%s invalid key %s/%s", id2str_proc(proc_id), 1371 id2str_class(key_class), id2str_key_type(key_type)); 1372 1373 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1374 1375 case PKCS11_CKM_AES_ECB_ENCRYPT_DATA: 1376 case PKCS11_CKM_AES_CBC_ENCRYPT_DATA: 1377 if (key_class != PKCS11_CKO_SECRET_KEY && 1378 key_type != PKCS11_CKK_AES) 1379 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1380 1381 if (get_bool(head, PKCS11_CKA_ENCRYPT)) { 1382 /* 1383 * Intentionally refuse to proceed despite 1384 * PKCS#11 specifications v2.40 and v3.0 not expecting 1385 * this behavior to avoid potential security issue 1386 * where keys derived by these mechanisms can be 1387 * revealed by doing data encryption using parent key. 1388 */ 1389 return PKCS11_CKR_FUNCTION_FAILED; 1390 } 1391 1392 break; 1393 case PKCS11_CKM_MD5_HMAC: 1394 case PKCS11_CKM_SHA_1_HMAC: 1395 case PKCS11_CKM_SHA224_HMAC: 1396 case PKCS11_CKM_SHA256_HMAC: 1397 case PKCS11_CKM_SHA384_HMAC: 1398 case PKCS11_CKM_SHA512_HMAC: 1399 if (key_class != PKCS11_CKO_SECRET_KEY) 1400 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1401 1402 if (key_type == PKCS11_CKK_GENERIC_SECRET) 1403 break; 1404 1405 switch (proc_id) { 1406 case PKCS11_CKM_MD5_HMAC: 1407 if (key_type == PKCS11_CKK_MD5_HMAC) 1408 break; 1409 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1410 case PKCS11_CKM_SHA_1_HMAC: 1411 if (key_type == PKCS11_CKK_SHA_1_HMAC) 1412 break; 1413 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1414 case PKCS11_CKM_SHA224_HMAC: 1415 if (key_type == PKCS11_CKK_SHA224_HMAC) 1416 break; 1417 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1418 case PKCS11_CKM_SHA256_HMAC: 1419 if (key_type == PKCS11_CKK_SHA256_HMAC) 1420 break; 1421 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1422 case PKCS11_CKM_SHA384_HMAC: 1423 if (key_type == PKCS11_CKK_SHA384_HMAC) 1424 break; 1425 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1426 case PKCS11_CKM_SHA512_HMAC: 1427 if (key_type == PKCS11_CKK_SHA512_HMAC) 1428 break; 1429 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1430 default: 1431 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1432 } 1433 break; 1434 1435 default: 1436 DMSG("Invalid processing %#"PRIx32"/%s", proc_id, 1437 id2str_proc(proc_id)); 1438 1439 return PKCS11_CKR_MECHANISM_INVALID; 1440 } 1441 1442 if (!parent_key_complies_allowed_processings(proc_id, head)) { 1443 DMSG("Allowed mechanism failed"); 1444 return PKCS11_CKR_KEY_FUNCTION_NOT_PERMITTED; 1445 } 1446 1447 return PKCS11_CKR_OK; 1448 } 1449 1450 bool attribute_is_exportable(struct pkcs11_attribute_head *req_attr, 1451 struct pkcs11_object *obj) 1452 { 1453 uint8_t boolval = 0; 1454 uint32_t boolsize = 0; 1455 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1456 enum pkcs11_class_id key_class = get_class(obj->attributes); 1457 1458 if (key_class != PKCS11_CKO_SECRET_KEY && 1459 key_class != PKCS11_CKO_PRIVATE_KEY) 1460 return true; 1461 1462 switch (req_attr->id) { 1463 case PKCS11_CKA_PRIVATE_EXPONENT: 1464 case PKCS11_CKA_PRIME_1: 1465 case PKCS11_CKA_PRIME_2: 1466 case PKCS11_CKA_EXPONENT_1: 1467 case PKCS11_CKA_EXPONENT_2: 1468 case PKCS11_CKA_COEFFICIENT: 1469 case PKCS11_CKA_VALUE: 1470 boolsize = sizeof(boolval); 1471 rc = get_attribute(obj->attributes, PKCS11_CKA_EXTRACTABLE, 1472 &boolval, &boolsize); 1473 if (rc || boolval == PKCS11_FALSE) 1474 return false; 1475 1476 boolsize = sizeof(boolval); 1477 rc = get_attribute(obj->attributes, PKCS11_CKA_SENSITIVE, 1478 &boolval, &boolsize); 1479 if (rc || boolval == PKCS11_TRUE) 1480 return false; 1481 break; 1482 default: 1483 break; 1484 } 1485 1486 return true; 1487 } 1488 1489 static bool attr_is_modifiable_any_key(struct pkcs11_attribute_head *attr) 1490 { 1491 switch (attr->id) { 1492 case PKCS11_CKA_ID: 1493 case PKCS11_CKA_START_DATE: 1494 case PKCS11_CKA_END_DATE: 1495 case PKCS11_CKA_DERIVE: 1496 return true; 1497 default: 1498 return false; 1499 } 1500 } 1501 1502 static bool attr_is_modifiable_secret_key(struct pkcs11_attribute_head *attr, 1503 struct pkcs11_session *session, 1504 struct pkcs11_object *obj) 1505 { 1506 switch (attr->id) { 1507 case PKCS11_CKA_ENCRYPT: 1508 case PKCS11_CKA_DECRYPT: 1509 case PKCS11_CKA_SIGN: 1510 case PKCS11_CKA_VERIFY: 1511 case PKCS11_CKA_WRAP: 1512 case PKCS11_CKA_UNWRAP: 1513 return true; 1514 /* Can't be modified once set to CK_FALSE - 12 in Table 10 */ 1515 case PKCS11_CKA_EXTRACTABLE: 1516 return get_bool(obj->attributes, attr->id); 1517 /* Can't be modified once set to CK_TRUE - 11 in Table 10 */ 1518 case PKCS11_CKA_SENSITIVE: 1519 case PKCS11_CKA_WRAP_WITH_TRUSTED: 1520 return !get_bool(obj->attributes, attr->id); 1521 /* Change in CKA_TRUSTED can only be done by SO */ 1522 case PKCS11_CKA_TRUSTED: 1523 return pkcs11_session_is_so(session); 1524 case PKCS11_CKA_NEVER_EXTRACTABLE: 1525 case PKCS11_CKA_ALWAYS_SENSITIVE: 1526 return false; 1527 default: 1528 return false; 1529 } 1530 } 1531 1532 static bool attr_is_modifiable_public_key(struct pkcs11_attribute_head *attr, 1533 struct pkcs11_session *session, 1534 struct pkcs11_object *obj __unused) 1535 { 1536 switch (attr->id) { 1537 case PKCS11_CKA_SUBJECT: 1538 case PKCS11_CKA_ENCRYPT: 1539 case PKCS11_CKA_VERIFY: 1540 case PKCS11_CKA_VERIFY_RECOVER: 1541 case PKCS11_CKA_WRAP: 1542 return true; 1543 case PKCS11_CKA_TRUSTED: 1544 /* Change in CKA_TRUSTED can only be done by SO */ 1545 return pkcs11_session_is_so(session); 1546 default: 1547 return false; 1548 } 1549 } 1550 1551 static bool attr_is_modifiable_private_key(struct pkcs11_attribute_head *attr, 1552 struct pkcs11_session *sess __unused, 1553 struct pkcs11_object *obj) 1554 { 1555 switch (attr->id) { 1556 case PKCS11_CKA_SUBJECT: 1557 case PKCS11_CKA_DECRYPT: 1558 case PKCS11_CKA_SIGN: 1559 case PKCS11_CKA_SIGN_RECOVER: 1560 case PKCS11_CKA_UNWRAP: 1561 /* 1562 * TBD: Revisit if we don't support PKCS11_CKA_PUBLIC_KEY_INFO 1563 * Specification mentions that if this attribute is 1564 * supplied as part of a template for C_CreateObject, C_CopyObject or 1565 * C_SetAttributeValue for a private key, the token MUST verify 1566 * correspondence between the private key data and the public key data 1567 * as supplied in CKA_PUBLIC_KEY_INFO. This needs to be 1568 * taken care of when this object type will be implemented 1569 */ 1570 case PKCS11_CKA_PUBLIC_KEY_INFO: 1571 return true; 1572 /* Can't be modified once set to CK_FALSE - 12 in Table 10 */ 1573 case PKCS11_CKA_EXTRACTABLE: 1574 return get_bool(obj->attributes, attr->id); 1575 /* Can't be modified once set to CK_TRUE - 11 in Table 10 */ 1576 case PKCS11_CKA_SENSITIVE: 1577 case PKCS11_CKA_WRAP_WITH_TRUSTED: 1578 return !get_bool(obj->attributes, attr->id); 1579 case PKCS11_CKA_NEVER_EXTRACTABLE: 1580 case PKCS11_CKA_ALWAYS_SENSITIVE: 1581 return false; 1582 default: 1583 return false; 1584 } 1585 } 1586 1587 static bool attribute_is_modifiable(struct pkcs11_session *session, 1588 struct pkcs11_attribute_head *req_attr, 1589 struct pkcs11_object *obj, 1590 enum pkcs11_class_id class, 1591 enum processing_func function) 1592 { 1593 /* Check modifiable attributes common to any object */ 1594 switch (req_attr->id) { 1595 case PKCS11_CKA_LABEL: 1596 return true; 1597 case PKCS11_CKA_TOKEN: 1598 case PKCS11_CKA_MODIFIABLE: 1599 case PKCS11_CKA_DESTROYABLE: 1600 case PKCS11_CKA_PRIVATE: 1601 return function == PKCS11_FUNCTION_COPY; 1602 case PKCS11_CKA_COPYABLE: 1603 /* 1604 * Specification mentions that if the attribute value is false 1605 * it can't be set to true. Reading this we assume that it 1606 * should be possible to modify this attribute even though this 1607 * is not marked as modifiable in Table 10 if done in right 1608 * direction i.e from TRUE -> FALSE. 1609 */ 1610 return get_bool(obj->attributes, req_attr->id); 1611 default: 1612 break; 1613 } 1614 1615 /* Attribute checking based on class type */ 1616 switch (class) { 1617 case PKCS11_CKO_SECRET_KEY: 1618 case PKCS11_CKO_PUBLIC_KEY: 1619 case PKCS11_CKO_PRIVATE_KEY: 1620 if (attr_is_modifiable_any_key(req_attr)) 1621 return true; 1622 if (class == PKCS11_CKO_SECRET_KEY && 1623 attr_is_modifiable_secret_key(req_attr, session, obj)) 1624 return true; 1625 if (class == PKCS11_CKO_PUBLIC_KEY && 1626 attr_is_modifiable_public_key(req_attr, session, obj)) 1627 return true; 1628 if (class == PKCS11_CKO_PRIVATE_KEY && 1629 attr_is_modifiable_private_key(req_attr, session, obj)) 1630 return true; 1631 break; 1632 case PKCS11_CKO_DATA: 1633 /* None of the data object attributes are modifiable */ 1634 return false; 1635 default: 1636 break; 1637 } 1638 1639 return false; 1640 } 1641 1642 enum pkcs11_rc check_attrs_against_modification(struct pkcs11_session *session, 1643 struct obj_attrs *head, 1644 struct pkcs11_object *obj, 1645 enum processing_func function) 1646 { 1647 enum pkcs11_class_id class = PKCS11_CKO_UNDEFINED_ID; 1648 char *cur = NULL; 1649 char *end = NULL; 1650 size_t len = 0; 1651 1652 class = get_class(obj->attributes); 1653 1654 cur = (char *)head + sizeof(struct obj_attrs); 1655 end = cur + head->attrs_size; 1656 1657 for (; cur < end; cur += len) { 1658 /* Structure aligned copy of the pkcs11_ref in the object */ 1659 struct pkcs11_attribute_head cli_ref = { }; 1660 1661 TEE_MemMove(&cli_ref, cur, sizeof(cli_ref)); 1662 len = sizeof(cli_ref) + cli_ref.size; 1663 1664 /* 1665 * Check 1 - Check if attribute belongs to the object 1666 * The obj->attributes has all the attributes in 1667 * it which are allowed for an object. 1668 */ 1669 if (get_attribute_ptr(obj->attributes, cli_ref.id, NULL, 1670 NULL) == PKCS11_RV_NOT_FOUND) 1671 return PKCS11_CKR_ATTRIBUTE_TYPE_INVALID; 1672 1673 /* Check 2 - Is attribute modifiable */ 1674 if (!attribute_is_modifiable(session, &cli_ref, obj, class, 1675 function)) 1676 return PKCS11_CKR_ATTRIBUTE_READ_ONLY; 1677 1678 /* 1679 * Checks for modification in PKCS11_CKA_TOKEN and 1680 * PKCS11_CKA_PRIVATE are required for PKCS11_FUNCTION_COPY 1681 * only, so skip them for PKCS11_FUNCTION_MODIFY. 1682 */ 1683 if (function == PKCS11_FUNCTION_MODIFY) 1684 continue; 1685 1686 /* 1687 * An attempt to copy an object to a token will fail for 1688 * RO session 1689 */ 1690 if (cli_ref.id == PKCS11_CKA_TOKEN && 1691 get_bool(head, PKCS11_CKA_TOKEN)) { 1692 if (!pkcs11_session_is_read_write(session)) { 1693 DMSG("Can't copy to token in a RO session"); 1694 return PKCS11_CKR_SESSION_READ_ONLY; 1695 } 1696 } 1697 1698 if (cli_ref.id == PKCS11_CKA_PRIVATE) { 1699 bool parent_priv = 1700 get_bool(obj->attributes, cli_ref.id); 1701 bool obj_priv = get_bool(head, cli_ref.id); 1702 1703 /* 1704 * If PKCS11_CKA_PRIVATE is being set to TRUE from 1705 * FALSE, user has to be logged in 1706 */ 1707 if (!parent_priv && obj_priv) { 1708 if ((pkcs11_session_is_public(session) || 1709 pkcs11_session_is_so(session))) 1710 return PKCS11_CKR_USER_NOT_LOGGED_IN; 1711 } 1712 1713 /* 1714 * Restriction added - Even for Copy, do not allow 1715 * modification of CKA_PRIVATE from TRUE to FALSE 1716 */ 1717 if (parent_priv && !obj_priv) 1718 return PKCS11_CKR_TEMPLATE_INCONSISTENT; 1719 } 1720 } 1721 1722 return PKCS11_CKR_OK; 1723 } 1724 1725 static enum pkcs11_rc set_secret_key_data(struct obj_attrs **head, void *data, 1726 size_t key_size) 1727 { 1728 uint32_t size = sizeof(uint32_t); 1729 uint32_t key_length = 0; 1730 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1731 1732 /* Get key size if present in template */ 1733 rc = get_attribute(*head, PKCS11_CKA_VALUE_LEN, &key_length, &size); 1734 if (rc && rc != PKCS11_RV_NOT_FOUND) 1735 return rc; 1736 1737 if (key_length) { 1738 if (key_size < key_length) 1739 return PKCS11_CKR_DATA_LEN_RANGE; 1740 } else { 1741 key_length = key_size; 1742 rc = set_attribute(head, PKCS11_CKA_VALUE_LEN, &key_length, 1743 sizeof(uint32_t)); 1744 if (rc) 1745 return rc; 1746 } 1747 1748 /* Now we can check the VALUE_LEN field */ 1749 rc = check_created_attrs(*head, NULL); 1750 if (rc) 1751 return rc; 1752 1753 /* Remove the default empty value attribute if found */ 1754 rc = remove_empty_attribute(head, PKCS11_CKA_VALUE); 1755 if (rc != PKCS11_CKR_OK && rc != PKCS11_RV_NOT_FOUND) 1756 return PKCS11_CKR_GENERAL_ERROR; 1757 1758 return add_attribute(head, PKCS11_CKA_VALUE, data, key_length); 1759 } 1760 1761 enum pkcs11_rc set_key_data(struct obj_attrs **head, void *data, 1762 size_t key_size) 1763 { 1764 switch (get_class(*head)) { 1765 case PKCS11_CKO_SECRET_KEY: 1766 return set_secret_key_data(head, data, key_size); 1767 default: 1768 return PKCS11_CKR_GENERAL_ERROR; 1769 } 1770 } 1771 1772 enum pkcs11_rc add_missing_attribute_id(struct obj_attrs **pub_head, 1773 struct obj_attrs **priv_head) 1774 { 1775 enum pkcs11_rc rc = PKCS11_CKR_GENERAL_ERROR; 1776 void *id1 = NULL; 1777 uint32_t id1_size = 0; 1778 void *id2 = NULL; 1779 uint32_t id2_size = 0; 1780 1781 assert(pub_head); 1782 assert(priv_head); 1783 1784 rc = get_attribute_ptr(*pub_head, PKCS11_CKA_ID, &id1, &id1_size); 1785 if (rc) { 1786 if (rc != PKCS11_RV_NOT_FOUND) 1787 return rc; 1788 id1 = NULL; 1789 } else if (!id1_size) { 1790 id1 = NULL; 1791 } 1792 1793 rc = get_attribute_ptr(*priv_head, PKCS11_CKA_ID, &id2, &id2_size); 1794 if (rc) { 1795 if (rc != PKCS11_RV_NOT_FOUND) 1796 return rc; 1797 id2 = NULL; 1798 } else if (!id2_size) { 1799 id2 = NULL; 1800 } 1801 1802 /* Both have value -- let them be what caller has specified them */ 1803 if (id1 && id2) 1804 return PKCS11_CKR_OK; 1805 1806 /* Both are empty -- leave empty values */ 1807 if (!id1 && !id2) 1808 return PKCS11_CKR_OK; 1809 1810 /* Cross copy CKA_ID value */ 1811 if (id1) 1812 return set_attribute(priv_head, PKCS11_CKA_ID, id1, id1_size); 1813 else 1814 return set_attribute(pub_head, PKCS11_CKA_ID, id2, id2_size); 1815 } 1816