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