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