1 /* $OpenBSD: ssh-pkcs11.c,v 1.52 2020/11/22 22:38:26 djm Exp $ */ 2 /* 3 * Copyright (c) 2010 Markus Friedl. All rights reserved. 4 * Copyright (c) 2014 Pedro Martelletto. All rights reserved. 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19 #include <sys/types.h> 20 #include <sys/queue.h> 21 #include <stdarg.h> 22 #include <stdio.h> 23 24 #include <ctype.h> 25 #include <string.h> 26 #include <dlfcn.h> 27 28 #include <openssl/ecdsa.h> 29 #include <openssl/x509.h> 30 #include <openssl/err.h> 31 32 #define CRYPTOKI_COMPAT 33 #include "pkcs11.h" 34 35 #include "log.h" 36 #include "misc.h" 37 #include "sshkey.h" 38 #include "ssh-pkcs11.h" 39 #include "digest.h" 40 #include "xmalloc.h" 41 42 struct pkcs11_slotinfo { 43 CK_TOKEN_INFO token; 44 CK_SESSION_HANDLE session; 45 int logged_in; 46 }; 47 48 struct pkcs11_provider { 49 char *name; 50 void *handle; 51 CK_FUNCTION_LIST *function_list; 52 CK_INFO info; 53 CK_ULONG nslots; 54 CK_SLOT_ID *slotlist; 55 struct pkcs11_slotinfo *slotinfo; 56 int valid; 57 int refcount; 58 TAILQ_ENTRY(pkcs11_provider) next; 59 }; 60 61 TAILQ_HEAD(, pkcs11_provider) pkcs11_providers; 62 63 struct pkcs11_key { 64 struct pkcs11_provider *provider; 65 CK_ULONG slotidx; 66 char *keyid; 67 int keyid_len; 68 }; 69 70 int pkcs11_interactive = 0; 71 72 #ifdef HAVE_DLOPEN 73 static void 74 ossl_error(const char *msg) 75 { 76 unsigned long e; 77 78 error_f("%s", msg); 79 while ((e = ERR_get_error()) != 0) 80 error_f("libcrypto error: %s", ERR_error_string(e, NULL)); 81 } 82 #endif 83 84 int 85 pkcs11_init(int interactive) 86 { 87 pkcs11_interactive = interactive; 88 TAILQ_INIT(&pkcs11_providers); 89 return (0); 90 } 91 92 /* 93 * finalize a provider shared library, it's no longer usable. 94 * however, there might still be keys referencing this provider, 95 * so the actual freeing of memory is handled by pkcs11_provider_unref(). 96 * this is called when a provider gets unregistered. 97 */ 98 static void 99 pkcs11_provider_finalize(struct pkcs11_provider *p) 100 { 101 CK_RV rv; 102 CK_ULONG i; 103 104 debug("pkcs11_provider_finalize: %p refcount %d valid %d", 105 p, p->refcount, p->valid); 106 if (!p->valid) 107 return; 108 for (i = 0; i < p->nslots; i++) { 109 if (p->slotinfo[i].session && 110 (rv = p->function_list->C_CloseSession( 111 p->slotinfo[i].session)) != CKR_OK) 112 error("C_CloseSession failed: %lu", rv); 113 } 114 if ((rv = p->function_list->C_Finalize(NULL)) != CKR_OK) 115 error("C_Finalize failed: %lu", rv); 116 p->valid = 0; 117 p->function_list = NULL; 118 #ifdef HAVE_DLOPEN 119 dlclose(p->handle); 120 #endif 121 } 122 123 /* 124 * remove a reference to the provider. 125 * called when a key gets destroyed or when the provider is unregistered. 126 */ 127 static void 128 pkcs11_provider_unref(struct pkcs11_provider *p) 129 { 130 debug("pkcs11_provider_unref: %p refcount %d", p, p->refcount); 131 if (--p->refcount <= 0) { 132 if (p->valid) 133 error("pkcs11_provider_unref: %p still valid", p); 134 free(p->name); 135 free(p->slotlist); 136 free(p->slotinfo); 137 free(p); 138 } 139 } 140 141 /* unregister all providers, keys might still point to the providers */ 142 void 143 pkcs11_terminate(void) 144 { 145 struct pkcs11_provider *p; 146 147 while ((p = TAILQ_FIRST(&pkcs11_providers)) != NULL) { 148 TAILQ_REMOVE(&pkcs11_providers, p, next); 149 pkcs11_provider_finalize(p); 150 pkcs11_provider_unref(p); 151 } 152 } 153 154 /* lookup provider by name */ 155 static struct pkcs11_provider * 156 pkcs11_provider_lookup(char *provider_id) 157 { 158 struct pkcs11_provider *p; 159 160 TAILQ_FOREACH(p, &pkcs11_providers, next) { 161 debug("check %p %s", p, p->name); 162 if (!strcmp(provider_id, p->name)) 163 return (p); 164 } 165 return (NULL); 166 } 167 168 /* unregister provider by name */ 169 int 170 pkcs11_del_provider(char *provider_id) 171 { 172 struct pkcs11_provider *p; 173 174 if ((p = pkcs11_provider_lookup(provider_id)) != NULL) { 175 TAILQ_REMOVE(&pkcs11_providers, p, next); 176 pkcs11_provider_finalize(p); 177 pkcs11_provider_unref(p); 178 return (0); 179 } 180 return (-1); 181 } 182 183 #ifdef HAVE_DLOPEN 184 static RSA_METHOD *rsa_method; 185 static int rsa_idx = 0; 186 static EC_KEY_METHOD *ec_key_method; 187 static int ec_key_idx = 0; 188 189 /* release a wrapped object */ 190 static void 191 pkcs11_k11_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx, 192 long argl, void *argp) 193 { 194 struct pkcs11_key *k11 = ptr; 195 196 debug_f("parent %p ptr %p idx %d", parent, ptr, idx); 197 if (k11 == NULL) 198 return; 199 if (k11->provider) 200 pkcs11_provider_unref(k11->provider); 201 free(k11->keyid); 202 free(k11); 203 } 204 205 /* find a single 'obj' for given attributes */ 206 static int 207 pkcs11_find(struct pkcs11_provider *p, CK_ULONG slotidx, CK_ATTRIBUTE *attr, 208 CK_ULONG nattr, CK_OBJECT_HANDLE *obj) 209 { 210 CK_FUNCTION_LIST *f; 211 CK_SESSION_HANDLE session; 212 CK_ULONG nfound = 0; 213 CK_RV rv; 214 int ret = -1; 215 216 f = p->function_list; 217 session = p->slotinfo[slotidx].session; 218 if ((rv = f->C_FindObjectsInit(session, attr, nattr)) != CKR_OK) { 219 error("C_FindObjectsInit failed (nattr %lu): %lu", nattr, rv); 220 return (-1); 221 } 222 if ((rv = f->C_FindObjects(session, obj, 1, &nfound)) != CKR_OK || 223 nfound != 1) { 224 debug("C_FindObjects failed (nfound %lu nattr %lu): %lu", 225 nfound, nattr, rv); 226 } else 227 ret = 0; 228 if ((rv = f->C_FindObjectsFinal(session)) != CKR_OK) 229 error("C_FindObjectsFinal failed: %lu", rv); 230 return (ret); 231 } 232 233 static int 234 pkcs11_login_slot(struct pkcs11_provider *provider, struct pkcs11_slotinfo *si, 235 CK_USER_TYPE type) 236 { 237 char *pin = NULL, prompt[1024]; 238 CK_RV rv; 239 240 if (provider == NULL || si == NULL || !provider->valid) { 241 error("no pkcs11 (valid) provider found"); 242 return (-1); 243 } 244 245 if (!pkcs11_interactive) { 246 error("need pin entry%s", 247 (si->token.flags & CKF_PROTECTED_AUTHENTICATION_PATH) ? 248 " on reader keypad" : ""); 249 return (-1); 250 } 251 if (si->token.flags & CKF_PROTECTED_AUTHENTICATION_PATH) 252 verbose("Deferring PIN entry to reader keypad."); 253 else { 254 snprintf(prompt, sizeof(prompt), "Enter PIN for '%s': ", 255 si->token.label); 256 if ((pin = read_passphrase(prompt, RP_ALLOW_EOF)) == NULL) { 257 debug_f("no pin specified"); 258 return (-1); /* bail out */ 259 } 260 } 261 rv = provider->function_list->C_Login(si->session, type, (u_char *)pin, 262 (pin != NULL) ? strlen(pin) : 0); 263 if (pin != NULL) 264 freezero(pin, strlen(pin)); 265 266 switch (rv) { 267 case CKR_OK: 268 case CKR_USER_ALREADY_LOGGED_IN: 269 /* success */ 270 break; 271 case CKR_PIN_LEN_RANGE: 272 error("PKCS#11 login failed: PIN length out of range"); 273 return -1; 274 case CKR_PIN_INCORRECT: 275 error("PKCS#11 login failed: PIN incorrect"); 276 return -1; 277 case CKR_PIN_LOCKED: 278 error("PKCS#11 login failed: PIN locked"); 279 return -1; 280 default: 281 error("PKCS#11 login failed: error %lu", rv); 282 return -1; 283 } 284 si->logged_in = 1; 285 return (0); 286 } 287 288 static int 289 pkcs11_login(struct pkcs11_key *k11, CK_USER_TYPE type) 290 { 291 if (k11 == NULL || k11->provider == NULL || !k11->provider->valid) { 292 error("no pkcs11 (valid) provider found"); 293 return (-1); 294 } 295 296 return pkcs11_login_slot(k11->provider, 297 &k11->provider->slotinfo[k11->slotidx], type); 298 } 299 300 301 static int 302 pkcs11_check_obj_bool_attrib(struct pkcs11_key *k11, CK_OBJECT_HANDLE obj, 303 CK_ATTRIBUTE_TYPE type, int *val) 304 { 305 struct pkcs11_slotinfo *si; 306 CK_FUNCTION_LIST *f; 307 CK_BBOOL flag = 0; 308 CK_ATTRIBUTE attr; 309 CK_RV rv; 310 311 *val = 0; 312 313 if (!k11->provider || !k11->provider->valid) { 314 error("no pkcs11 (valid) provider found"); 315 return (-1); 316 } 317 318 f = k11->provider->function_list; 319 si = &k11->provider->slotinfo[k11->slotidx]; 320 321 attr.type = type; 322 attr.pValue = &flag; 323 attr.ulValueLen = sizeof(flag); 324 325 rv = f->C_GetAttributeValue(si->session, obj, &attr, 1); 326 if (rv != CKR_OK) { 327 error("C_GetAttributeValue failed: %lu", rv); 328 return (-1); 329 } 330 *val = flag != 0; 331 debug_f("provider %p slot %lu object %lu: attrib %lu = %d", 332 k11->provider, k11->slotidx, obj, type, *val); 333 return (0); 334 } 335 336 static int 337 pkcs11_get_key(struct pkcs11_key *k11, CK_MECHANISM_TYPE mech_type) 338 { 339 struct pkcs11_slotinfo *si; 340 CK_FUNCTION_LIST *f; 341 CK_OBJECT_HANDLE obj; 342 CK_RV rv; 343 CK_OBJECT_CLASS private_key_class; 344 CK_BBOOL true_val; 345 CK_MECHANISM mech; 346 CK_ATTRIBUTE key_filter[3]; 347 int always_auth = 0; 348 int did_login = 0; 349 350 if (!k11->provider || !k11->provider->valid) { 351 error("no pkcs11 (valid) provider found"); 352 return (-1); 353 } 354 355 f = k11->provider->function_list; 356 si = &k11->provider->slotinfo[k11->slotidx]; 357 358 if ((si->token.flags & CKF_LOGIN_REQUIRED) && !si->logged_in) { 359 if (pkcs11_login(k11, CKU_USER) < 0) { 360 error("login failed"); 361 return (-1); 362 } 363 did_login = 1; 364 } 365 366 memset(&key_filter, 0, sizeof(key_filter)); 367 private_key_class = CKO_PRIVATE_KEY; 368 key_filter[0].type = CKA_CLASS; 369 key_filter[0].pValue = &private_key_class; 370 key_filter[0].ulValueLen = sizeof(private_key_class); 371 372 key_filter[1].type = CKA_ID; 373 key_filter[1].pValue = k11->keyid; 374 key_filter[1].ulValueLen = k11->keyid_len; 375 376 true_val = CK_TRUE; 377 key_filter[2].type = CKA_SIGN; 378 key_filter[2].pValue = &true_val; 379 key_filter[2].ulValueLen = sizeof(true_val); 380 381 /* try to find object w/CKA_SIGN first, retry w/o */ 382 if (pkcs11_find(k11->provider, k11->slotidx, key_filter, 3, &obj) < 0 && 383 pkcs11_find(k11->provider, k11->slotidx, key_filter, 2, &obj) < 0) { 384 error("cannot find private key"); 385 return (-1); 386 } 387 388 memset(&mech, 0, sizeof(mech)); 389 mech.mechanism = mech_type; 390 mech.pParameter = NULL_PTR; 391 mech.ulParameterLen = 0; 392 393 if ((rv = f->C_SignInit(si->session, &mech, obj)) != CKR_OK) { 394 error("C_SignInit failed: %lu", rv); 395 return (-1); 396 } 397 398 pkcs11_check_obj_bool_attrib(k11, obj, CKA_ALWAYS_AUTHENTICATE, 399 &always_auth); /* ignore errors here */ 400 if (always_auth && !did_login) { 401 debug_f("always-auth key"); 402 if (pkcs11_login(k11, CKU_CONTEXT_SPECIFIC) < 0) { 403 error("login failed for always-auth key"); 404 return (-1); 405 } 406 } 407 408 return (0); 409 } 410 411 /* openssl callback doing the actual signing operation */ 412 static int 413 pkcs11_rsa_private_encrypt(int flen, const u_char *from, u_char *to, RSA *rsa, 414 int padding) 415 { 416 struct pkcs11_key *k11; 417 struct pkcs11_slotinfo *si; 418 CK_FUNCTION_LIST *f; 419 CK_ULONG tlen = 0; 420 CK_RV rv; 421 int rval = -1; 422 423 if ((k11 = RSA_get_ex_data(rsa, rsa_idx)) == NULL) { 424 error("RSA_get_ex_data failed for rsa %p", rsa); 425 return (-1); 426 } 427 428 if (pkcs11_get_key(k11, CKM_RSA_PKCS) == -1) { 429 error("pkcs11_get_key failed"); 430 return (-1); 431 } 432 433 f = k11->provider->function_list; 434 si = &k11->provider->slotinfo[k11->slotidx]; 435 tlen = RSA_size(rsa); 436 437 /* XXX handle CKR_BUFFER_TOO_SMALL */ 438 rv = f->C_Sign(si->session, (CK_BYTE *)from, flen, to, &tlen); 439 if (rv == CKR_OK) 440 rval = tlen; 441 else 442 error("C_Sign failed: %lu", rv); 443 444 return (rval); 445 } 446 447 static int 448 pkcs11_rsa_private_decrypt(int flen, const u_char *from, u_char *to, RSA *rsa, 449 int padding) 450 { 451 return (-1); 452 } 453 454 static int 455 pkcs11_rsa_start_wrapper(void) 456 { 457 if (rsa_method != NULL) 458 return (0); 459 rsa_method = RSA_meth_dup(RSA_get_default_method()); 460 if (rsa_method == NULL) 461 return (-1); 462 rsa_idx = RSA_get_ex_new_index(0, "ssh-pkcs11-rsa", 463 NULL, NULL, pkcs11_k11_free); 464 if (rsa_idx == -1) 465 return (-1); 466 if (!RSA_meth_set1_name(rsa_method, "pkcs11") || 467 !RSA_meth_set_priv_enc(rsa_method, pkcs11_rsa_private_encrypt) || 468 !RSA_meth_set_priv_dec(rsa_method, pkcs11_rsa_private_decrypt)) { 469 error_f("setup pkcs11 method failed"); 470 return (-1); 471 } 472 return (0); 473 } 474 475 /* redirect private key operations for rsa key to pkcs11 token */ 476 static int 477 pkcs11_rsa_wrap(struct pkcs11_provider *provider, CK_ULONG slotidx, 478 CK_ATTRIBUTE *keyid_attrib, RSA *rsa) 479 { 480 struct pkcs11_key *k11; 481 482 if (pkcs11_rsa_start_wrapper() == -1) 483 return (-1); 484 485 k11 = xcalloc(1, sizeof(*k11)); 486 k11->provider = provider; 487 provider->refcount++; /* provider referenced by RSA key */ 488 k11->slotidx = slotidx; 489 /* identify key object on smartcard */ 490 k11->keyid_len = keyid_attrib->ulValueLen; 491 if (k11->keyid_len > 0) { 492 k11->keyid = xmalloc(k11->keyid_len); 493 memcpy(k11->keyid, keyid_attrib->pValue, k11->keyid_len); 494 } 495 496 RSA_set_method(rsa, rsa_method); 497 RSA_set_ex_data(rsa, rsa_idx, k11); 498 return (0); 499 } 500 501 /* openssl callback doing the actual signing operation */ 502 static ECDSA_SIG * 503 ecdsa_do_sign(const unsigned char *dgst, int dgst_len, const BIGNUM *inv, 504 const BIGNUM *rp, EC_KEY *ec) 505 { 506 struct pkcs11_key *k11; 507 struct pkcs11_slotinfo *si; 508 CK_FUNCTION_LIST *f; 509 CK_ULONG siglen = 0, bnlen; 510 CK_RV rv; 511 ECDSA_SIG *ret = NULL; 512 u_char *sig; 513 BIGNUM *r = NULL, *s = NULL; 514 515 if ((k11 = EC_KEY_get_ex_data(ec, ec_key_idx)) == NULL) { 516 ossl_error("EC_KEY_get_key_method_data failed for ec"); 517 return (NULL); 518 } 519 520 if (pkcs11_get_key(k11, CKM_ECDSA) == -1) { 521 error("pkcs11_get_key failed"); 522 return (NULL); 523 } 524 525 f = k11->provider->function_list; 526 si = &k11->provider->slotinfo[k11->slotidx]; 527 528 siglen = ECDSA_size(ec); 529 sig = xmalloc(siglen); 530 531 /* XXX handle CKR_BUFFER_TOO_SMALL */ 532 rv = f->C_Sign(si->session, (CK_BYTE *)dgst, dgst_len, sig, &siglen); 533 if (rv != CKR_OK) { 534 error("C_Sign failed: %lu", rv); 535 goto done; 536 } 537 if (siglen < 64 || siglen > 132 || siglen % 2) { 538 ossl_error("d2i_ECDSA_SIG failed"); 539 goto done; 540 } 541 bnlen = siglen/2; 542 if ((ret = ECDSA_SIG_new()) == NULL) { 543 error("ECDSA_SIG_new failed"); 544 goto done; 545 } 546 if ((r = BN_bin2bn(sig, bnlen, NULL)) == NULL || 547 (s = BN_bin2bn(sig+bnlen, bnlen, NULL)) == NULL) { 548 ossl_error("d2i_ECDSA_SIG failed"); 549 ECDSA_SIG_free(ret); 550 ret = NULL; 551 goto done; 552 } 553 if (!ECDSA_SIG_set0(ret, r, s)) { 554 error_f("ECDSA_SIG_set0 failed"); 555 ECDSA_SIG_free(ret); 556 ret = NULL; 557 goto done; 558 } 559 r = s = NULL; /* now owned by ret */ 560 /* success */ 561 done: 562 BN_free(r); 563 BN_free(s); 564 free(sig); 565 566 return (ret); 567 } 568 569 static int 570 pkcs11_ecdsa_start_wrapper(void) 571 { 572 int (*orig_sign)(int, const unsigned char *, int, unsigned char *, 573 unsigned int *, const BIGNUM *, const BIGNUM *, EC_KEY *) = NULL; 574 575 if (ec_key_method != NULL) 576 return (0); 577 ec_key_idx = EC_KEY_get_ex_new_index(0, "ssh-pkcs11-ecdsa", 578 NULL, NULL, pkcs11_k11_free); 579 if (ec_key_idx == -1) 580 return (-1); 581 ec_key_method = EC_KEY_METHOD_new(EC_KEY_OpenSSL()); 582 if (ec_key_method == NULL) 583 return (-1); 584 EC_KEY_METHOD_get_sign(ec_key_method, &orig_sign, NULL, NULL); 585 EC_KEY_METHOD_set_sign(ec_key_method, orig_sign, NULL, ecdsa_do_sign); 586 return (0); 587 } 588 589 static int 590 pkcs11_ecdsa_wrap(struct pkcs11_provider *provider, CK_ULONG slotidx, 591 CK_ATTRIBUTE *keyid_attrib, EC_KEY *ec) 592 { 593 struct pkcs11_key *k11; 594 595 if (pkcs11_ecdsa_start_wrapper() == -1) 596 return (-1); 597 598 k11 = xcalloc(1, sizeof(*k11)); 599 k11->provider = provider; 600 provider->refcount++; /* provider referenced by ECDSA key */ 601 k11->slotidx = slotidx; 602 /* identify key object on smartcard */ 603 k11->keyid_len = keyid_attrib->ulValueLen; 604 k11->keyid = xmalloc(k11->keyid_len); 605 memcpy(k11->keyid, keyid_attrib->pValue, k11->keyid_len); 606 607 EC_KEY_set_method(ec, ec_key_method); 608 EC_KEY_set_ex_data(ec, ec_key_idx, k11); 609 610 return (0); 611 } 612 613 /* remove trailing spaces */ 614 static void 615 rmspace(u_char *buf, size_t len) 616 { 617 size_t i; 618 619 if (!len) 620 return; 621 for (i = len - 1; i > 0; i--) 622 if (i == len - 1 || buf[i] == ' ') 623 buf[i] = '\0'; 624 else 625 break; 626 } 627 628 /* 629 * open a pkcs11 session and login if required. 630 * if pin == NULL we delay login until key use 631 */ 632 static int 633 pkcs11_open_session(struct pkcs11_provider *p, CK_ULONG slotidx, char *pin, 634 CK_ULONG user) 635 { 636 struct pkcs11_slotinfo *si; 637 CK_FUNCTION_LIST *f; 638 CK_RV rv; 639 CK_SESSION_HANDLE session; 640 int login_required, ret; 641 642 f = p->function_list; 643 si = &p->slotinfo[slotidx]; 644 645 login_required = si->token.flags & CKF_LOGIN_REQUIRED; 646 647 /* fail early before opening session */ 648 if (login_required && !pkcs11_interactive && 649 (pin == NULL || strlen(pin) == 0)) { 650 error("pin required"); 651 return (-SSH_PKCS11_ERR_PIN_REQUIRED); 652 } 653 if ((rv = f->C_OpenSession(p->slotlist[slotidx], CKF_RW_SESSION| 654 CKF_SERIAL_SESSION, NULL, NULL, &session)) != CKR_OK) { 655 error("C_OpenSession failed: %lu", rv); 656 return (-1); 657 } 658 if (login_required && pin != NULL && strlen(pin) != 0) { 659 rv = f->C_Login(session, user, (u_char *)pin, strlen(pin)); 660 if (rv != CKR_OK && rv != CKR_USER_ALREADY_LOGGED_IN) { 661 error("C_Login failed: %lu", rv); 662 ret = (rv == CKR_PIN_LOCKED) ? 663 -SSH_PKCS11_ERR_PIN_LOCKED : 664 -SSH_PKCS11_ERR_LOGIN_FAIL; 665 if ((rv = f->C_CloseSession(session)) != CKR_OK) 666 error("C_CloseSession failed: %lu", rv); 667 return (ret); 668 } 669 si->logged_in = 1; 670 } 671 si->session = session; 672 return (0); 673 } 674 675 static int 676 pkcs11_key_included(struct sshkey ***keysp, int *nkeys, struct sshkey *key) 677 { 678 int i; 679 680 for (i = 0; i < *nkeys; i++) 681 if (sshkey_equal(key, (*keysp)[i])) 682 return (1); 683 return (0); 684 } 685 686 static struct sshkey * 687 pkcs11_fetch_ecdsa_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx, 688 CK_OBJECT_HANDLE *obj) 689 { 690 CK_ATTRIBUTE key_attr[3]; 691 CK_SESSION_HANDLE session; 692 CK_FUNCTION_LIST *f = NULL; 693 CK_RV rv; 694 ASN1_OCTET_STRING *octet = NULL; 695 EC_KEY *ec = NULL; 696 EC_GROUP *group = NULL; 697 struct sshkey *key = NULL; 698 const unsigned char *attrp = NULL; 699 int i; 700 int nid; 701 702 memset(&key_attr, 0, sizeof(key_attr)); 703 key_attr[0].type = CKA_ID; 704 key_attr[1].type = CKA_EC_POINT; 705 key_attr[2].type = CKA_EC_PARAMS; 706 707 session = p->slotinfo[slotidx].session; 708 f = p->function_list; 709 710 /* figure out size of the attributes */ 711 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3); 712 if (rv != CKR_OK) { 713 error("C_GetAttributeValue failed: %lu", rv); 714 return (NULL); 715 } 716 717 /* 718 * Allow CKA_ID (always first attribute) to be empty, but 719 * ensure that none of the others are zero length. 720 * XXX assumes CKA_ID is always first. 721 */ 722 if (key_attr[1].ulValueLen == 0 || 723 key_attr[2].ulValueLen == 0) { 724 error("invalid attribute length"); 725 return (NULL); 726 } 727 728 /* allocate buffers for attributes */ 729 for (i = 0; i < 3; i++) 730 if (key_attr[i].ulValueLen > 0) 731 key_attr[i].pValue = xcalloc(1, key_attr[i].ulValueLen); 732 733 /* retrieve ID, public point and curve parameters of EC key */ 734 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3); 735 if (rv != CKR_OK) { 736 error("C_GetAttributeValue failed: %lu", rv); 737 goto fail; 738 } 739 740 ec = EC_KEY_new(); 741 if (ec == NULL) { 742 error("EC_KEY_new failed"); 743 goto fail; 744 } 745 746 attrp = key_attr[2].pValue; 747 group = d2i_ECPKParameters(NULL, &attrp, key_attr[2].ulValueLen); 748 if (group == NULL) { 749 ossl_error("d2i_ECPKParameters failed"); 750 goto fail; 751 } 752 753 if (EC_KEY_set_group(ec, group) == 0) { 754 ossl_error("EC_KEY_set_group failed"); 755 goto fail; 756 } 757 758 if (key_attr[1].ulValueLen <= 2) { 759 error("CKA_EC_POINT too small"); 760 goto fail; 761 } 762 763 attrp = key_attr[1].pValue; 764 octet = d2i_ASN1_OCTET_STRING(NULL, &attrp, key_attr[1].ulValueLen); 765 if (octet == NULL) { 766 ossl_error("d2i_ASN1_OCTET_STRING failed"); 767 goto fail; 768 } 769 attrp = octet->data; 770 if (o2i_ECPublicKey(&ec, &attrp, octet->length) == NULL) { 771 ossl_error("o2i_ECPublicKey failed"); 772 goto fail; 773 } 774 775 nid = sshkey_ecdsa_key_to_nid(ec); 776 if (nid < 0) { 777 error("couldn't get curve nid"); 778 goto fail; 779 } 780 781 if (pkcs11_ecdsa_wrap(p, slotidx, &key_attr[0], ec)) 782 goto fail; 783 784 key = sshkey_new(KEY_UNSPEC); 785 if (key == NULL) { 786 error("sshkey_new failed"); 787 goto fail; 788 } 789 790 key->ecdsa = ec; 791 key->ecdsa_nid = nid; 792 key->type = KEY_ECDSA; 793 key->flags |= SSHKEY_FLAG_EXT; 794 ec = NULL; /* now owned by key */ 795 796 fail: 797 for (i = 0; i < 3; i++) 798 free(key_attr[i].pValue); 799 if (ec) 800 EC_KEY_free(ec); 801 if (group) 802 EC_GROUP_free(group); 803 if (octet) 804 ASN1_OCTET_STRING_free(octet); 805 806 return (key); 807 } 808 809 static struct sshkey * 810 pkcs11_fetch_rsa_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx, 811 CK_OBJECT_HANDLE *obj) 812 { 813 CK_ATTRIBUTE key_attr[3]; 814 CK_SESSION_HANDLE session; 815 CK_FUNCTION_LIST *f = NULL; 816 CK_RV rv; 817 RSA *rsa = NULL; 818 BIGNUM *rsa_n, *rsa_e; 819 struct sshkey *key = NULL; 820 int i; 821 822 memset(&key_attr, 0, sizeof(key_attr)); 823 key_attr[0].type = CKA_ID; 824 key_attr[1].type = CKA_MODULUS; 825 key_attr[2].type = CKA_PUBLIC_EXPONENT; 826 827 session = p->slotinfo[slotidx].session; 828 f = p->function_list; 829 830 /* figure out size of the attributes */ 831 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3); 832 if (rv != CKR_OK) { 833 error("C_GetAttributeValue failed: %lu", rv); 834 return (NULL); 835 } 836 837 /* 838 * Allow CKA_ID (always first attribute) to be empty, but 839 * ensure that none of the others are zero length. 840 * XXX assumes CKA_ID is always first. 841 */ 842 if (key_attr[1].ulValueLen == 0 || 843 key_attr[2].ulValueLen == 0) { 844 error("invalid attribute length"); 845 return (NULL); 846 } 847 848 /* allocate buffers for attributes */ 849 for (i = 0; i < 3; i++) 850 if (key_attr[i].ulValueLen > 0) 851 key_attr[i].pValue = xcalloc(1, key_attr[i].ulValueLen); 852 853 /* retrieve ID, modulus and public exponent of RSA key */ 854 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3); 855 if (rv != CKR_OK) { 856 error("C_GetAttributeValue failed: %lu", rv); 857 goto fail; 858 } 859 860 rsa = RSA_new(); 861 if (rsa == NULL) { 862 error("RSA_new failed"); 863 goto fail; 864 } 865 866 rsa_n = BN_bin2bn(key_attr[1].pValue, key_attr[1].ulValueLen, NULL); 867 rsa_e = BN_bin2bn(key_attr[2].pValue, key_attr[2].ulValueLen, NULL); 868 if (rsa_n == NULL || rsa_e == NULL) { 869 error("BN_bin2bn failed"); 870 goto fail; 871 } 872 if (!RSA_set0_key(rsa, rsa_n, rsa_e, NULL)) 873 fatal_f("set key"); 874 rsa_n = rsa_e = NULL; /* transferred */ 875 876 if (pkcs11_rsa_wrap(p, slotidx, &key_attr[0], rsa)) 877 goto fail; 878 879 key = sshkey_new(KEY_UNSPEC); 880 if (key == NULL) { 881 error("sshkey_new failed"); 882 goto fail; 883 } 884 885 key->rsa = rsa; 886 key->type = KEY_RSA; 887 key->flags |= SSHKEY_FLAG_EXT; 888 rsa = NULL; /* now owned by key */ 889 890 fail: 891 for (i = 0; i < 3; i++) 892 free(key_attr[i].pValue); 893 RSA_free(rsa); 894 895 return (key); 896 } 897 898 static int 899 pkcs11_fetch_x509_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx, 900 CK_OBJECT_HANDLE *obj, struct sshkey **keyp, char **labelp) 901 { 902 CK_ATTRIBUTE cert_attr[3]; 903 CK_SESSION_HANDLE session; 904 CK_FUNCTION_LIST *f = NULL; 905 CK_RV rv; 906 X509 *x509 = NULL; 907 X509_NAME *x509_name = NULL; 908 EVP_PKEY *evp; 909 RSA *rsa = NULL; 910 EC_KEY *ec = NULL; 911 struct sshkey *key = NULL; 912 int i; 913 int nid; 914 const u_char *cp; 915 char *subject = NULL; 916 917 *keyp = NULL; 918 *labelp = NULL; 919 920 memset(&cert_attr, 0, sizeof(cert_attr)); 921 cert_attr[0].type = CKA_ID; 922 cert_attr[1].type = CKA_SUBJECT; 923 cert_attr[2].type = CKA_VALUE; 924 925 session = p->slotinfo[slotidx].session; 926 f = p->function_list; 927 928 /* figure out size of the attributes */ 929 rv = f->C_GetAttributeValue(session, *obj, cert_attr, 3); 930 if (rv != CKR_OK) { 931 error("C_GetAttributeValue failed: %lu", rv); 932 return -1; 933 } 934 935 /* 936 * Allow CKA_ID (always first attribute) to be empty, but 937 * ensure that none of the others are zero length. 938 * XXX assumes CKA_ID is always first. 939 */ 940 if (cert_attr[1].ulValueLen == 0 || 941 cert_attr[2].ulValueLen == 0) { 942 error("invalid attribute length"); 943 return -1; 944 } 945 946 /* allocate buffers for attributes */ 947 for (i = 0; i < 3; i++) 948 if (cert_attr[i].ulValueLen > 0) 949 cert_attr[i].pValue = xcalloc(1, cert_attr[i].ulValueLen); 950 951 /* retrieve ID, subject and value of certificate */ 952 rv = f->C_GetAttributeValue(session, *obj, cert_attr, 3); 953 if (rv != CKR_OK) { 954 error("C_GetAttributeValue failed: %lu", rv); 955 goto out; 956 } 957 958 /* Decode DER-encoded cert subject */ 959 cp = cert_attr[2].pValue; 960 if ((x509_name = d2i_X509_NAME(NULL, &cp, 961 cert_attr[1].ulValueLen)) == NULL || 962 (subject = X509_NAME_oneline(x509_name, NULL, 0)) == NULL) 963 subject = xstrdup("invalid subject"); 964 X509_NAME_free(x509_name); 965 966 cp = cert_attr[2].pValue; 967 if ((x509 = d2i_X509(NULL, &cp, cert_attr[2].ulValueLen)) == NULL) { 968 error("d2i_x509 failed"); 969 goto out; 970 } 971 972 if ((evp = X509_get_pubkey(x509)) == NULL) { 973 error("X509_get_pubkey failed"); 974 goto out; 975 } 976 977 if (EVP_PKEY_base_id(evp) == EVP_PKEY_RSA) { 978 if (EVP_PKEY_get0_RSA(evp) == NULL) { 979 error("invalid x509; no rsa key"); 980 goto out; 981 } 982 if ((rsa = RSAPublicKey_dup(EVP_PKEY_get0_RSA(evp))) == NULL) { 983 error("RSAPublicKey_dup failed"); 984 goto out; 985 } 986 987 if (pkcs11_rsa_wrap(p, slotidx, &cert_attr[0], rsa)) 988 goto out; 989 990 key = sshkey_new(KEY_UNSPEC); 991 if (key == NULL) { 992 error("sshkey_new failed"); 993 goto out; 994 } 995 996 key->rsa = rsa; 997 key->type = KEY_RSA; 998 key->flags |= SSHKEY_FLAG_EXT; 999 rsa = NULL; /* now owned by key */ 1000 } else if (EVP_PKEY_base_id(evp) == EVP_PKEY_EC) { 1001 if (EVP_PKEY_get0_EC_KEY(evp) == NULL) { 1002 error("invalid x509; no ec key"); 1003 goto out; 1004 } 1005 if ((ec = EC_KEY_dup(EVP_PKEY_get0_EC_KEY(evp))) == NULL) { 1006 error("EC_KEY_dup failed"); 1007 goto out; 1008 } 1009 1010 nid = sshkey_ecdsa_key_to_nid(ec); 1011 if (nid < 0) { 1012 error("couldn't get curve nid"); 1013 goto out; 1014 } 1015 1016 if (pkcs11_ecdsa_wrap(p, slotidx, &cert_attr[0], ec)) 1017 goto out; 1018 1019 key = sshkey_new(KEY_UNSPEC); 1020 if (key == NULL) { 1021 error("sshkey_new failed"); 1022 goto out; 1023 } 1024 1025 key->ecdsa = ec; 1026 key->ecdsa_nid = nid; 1027 key->type = KEY_ECDSA; 1028 key->flags |= SSHKEY_FLAG_EXT; 1029 ec = NULL; /* now owned by key */ 1030 } else { 1031 error("unknown certificate key type"); 1032 goto out; 1033 } 1034 out: 1035 for (i = 0; i < 3; i++) 1036 free(cert_attr[i].pValue); 1037 X509_free(x509); 1038 RSA_free(rsa); 1039 EC_KEY_free(ec); 1040 if (key == NULL) { 1041 free(subject); 1042 return -1; 1043 } 1044 /* success */ 1045 *keyp = key; 1046 *labelp = subject; 1047 return 0; 1048 } 1049 1050 #if 0 1051 static int 1052 have_rsa_key(const RSA *rsa) 1053 { 1054 const BIGNUM *rsa_n, *rsa_e; 1055 1056 RSA_get0_key(rsa, &rsa_n, &rsa_e, NULL); 1057 return rsa_n != NULL && rsa_e != NULL; 1058 } 1059 #endif 1060 1061 static void 1062 note_key(struct pkcs11_provider *p, CK_ULONG slotidx, const char *context, 1063 struct sshkey *key) 1064 { 1065 char *fp; 1066 1067 if ((fp = sshkey_fingerprint(key, SSH_FP_HASH_DEFAULT, 1068 SSH_FP_DEFAULT)) == NULL) { 1069 error_f("sshkey_fingerprint failed"); 1070 return; 1071 } 1072 debug2("%s: provider %s slot %lu: %s %s", context, p->name, 1073 (u_long)slotidx, sshkey_type(key), fp); 1074 free(fp); 1075 } 1076 1077 /* 1078 * lookup certificates for token in slot identified by slotidx, 1079 * add 'wrapped' public keys to the 'keysp' array and increment nkeys. 1080 * keysp points to an (possibly empty) array with *nkeys keys. 1081 */ 1082 static int 1083 pkcs11_fetch_certs(struct pkcs11_provider *p, CK_ULONG slotidx, 1084 struct sshkey ***keysp, char ***labelsp, int *nkeys) 1085 { 1086 struct sshkey *key = NULL; 1087 CK_OBJECT_CLASS key_class; 1088 CK_ATTRIBUTE key_attr[1]; 1089 CK_SESSION_HANDLE session; 1090 CK_FUNCTION_LIST *f = NULL; 1091 CK_RV rv; 1092 CK_OBJECT_HANDLE obj; 1093 CK_ULONG n = 0; 1094 int ret = -1; 1095 char *label; 1096 1097 memset(&key_attr, 0, sizeof(key_attr)); 1098 memset(&obj, 0, sizeof(obj)); 1099 1100 key_class = CKO_CERTIFICATE; 1101 key_attr[0].type = CKA_CLASS; 1102 key_attr[0].pValue = &key_class; 1103 key_attr[0].ulValueLen = sizeof(key_class); 1104 1105 session = p->slotinfo[slotidx].session; 1106 f = p->function_list; 1107 1108 rv = f->C_FindObjectsInit(session, key_attr, 1); 1109 if (rv != CKR_OK) { 1110 error("C_FindObjectsInit failed: %lu", rv); 1111 goto fail; 1112 } 1113 1114 while (1) { 1115 CK_CERTIFICATE_TYPE ck_cert_type; 1116 1117 rv = f->C_FindObjects(session, &obj, 1, &n); 1118 if (rv != CKR_OK) { 1119 error("C_FindObjects failed: %lu", rv); 1120 goto fail; 1121 } 1122 if (n == 0) 1123 break; 1124 1125 memset(&ck_cert_type, 0, sizeof(ck_cert_type)); 1126 memset(&key_attr, 0, sizeof(key_attr)); 1127 key_attr[0].type = CKA_CERTIFICATE_TYPE; 1128 key_attr[0].pValue = &ck_cert_type; 1129 key_attr[0].ulValueLen = sizeof(ck_cert_type); 1130 1131 rv = f->C_GetAttributeValue(session, obj, key_attr, 1); 1132 if (rv != CKR_OK) { 1133 error("C_GetAttributeValue failed: %lu", rv); 1134 goto fail; 1135 } 1136 1137 key = NULL; 1138 label = NULL; 1139 switch (ck_cert_type) { 1140 case CKC_X_509: 1141 if (pkcs11_fetch_x509_pubkey(p, slotidx, &obj, 1142 &key, &label) != 0) { 1143 error("failed to fetch key"); 1144 continue; 1145 } 1146 break; 1147 default: 1148 error("skipping unsupported certificate type %lu", 1149 ck_cert_type); 1150 continue; 1151 } 1152 note_key(p, slotidx, __func__, key); 1153 if (pkcs11_key_included(keysp, nkeys, key)) { 1154 debug2_f("key already included");; 1155 sshkey_free(key); 1156 } else { 1157 /* expand key array and add key */ 1158 *keysp = xrecallocarray(*keysp, *nkeys, 1159 *nkeys + 1, sizeof(struct sshkey *)); 1160 (*keysp)[*nkeys] = key; 1161 if (labelsp != NULL) { 1162 *labelsp = xrecallocarray(*labelsp, *nkeys, 1163 *nkeys + 1, sizeof(char *)); 1164 (*labelsp)[*nkeys] = xstrdup((char *)label); 1165 } 1166 *nkeys = *nkeys + 1; 1167 debug("have %d keys", *nkeys); 1168 } 1169 } 1170 1171 ret = 0; 1172 fail: 1173 rv = f->C_FindObjectsFinal(session); 1174 if (rv != CKR_OK) { 1175 error("C_FindObjectsFinal failed: %lu", rv); 1176 ret = -1; 1177 } 1178 1179 return (ret); 1180 } 1181 1182 /* 1183 * lookup public keys for token in slot identified by slotidx, 1184 * add 'wrapped' public keys to the 'keysp' array and increment nkeys. 1185 * keysp points to an (possibly empty) array with *nkeys keys. 1186 */ 1187 static int 1188 pkcs11_fetch_keys(struct pkcs11_provider *p, CK_ULONG slotidx, 1189 struct sshkey ***keysp, char ***labelsp, int *nkeys) 1190 { 1191 struct sshkey *key = NULL; 1192 CK_OBJECT_CLASS key_class; 1193 CK_ATTRIBUTE key_attr[2]; 1194 CK_SESSION_HANDLE session; 1195 CK_FUNCTION_LIST *f = NULL; 1196 CK_RV rv; 1197 CK_OBJECT_HANDLE obj; 1198 CK_ULONG n = 0; 1199 int ret = -1; 1200 1201 memset(&key_attr, 0, sizeof(key_attr)); 1202 memset(&obj, 0, sizeof(obj)); 1203 1204 key_class = CKO_PUBLIC_KEY; 1205 key_attr[0].type = CKA_CLASS; 1206 key_attr[0].pValue = &key_class; 1207 key_attr[0].ulValueLen = sizeof(key_class); 1208 1209 session = p->slotinfo[slotidx].session; 1210 f = p->function_list; 1211 1212 rv = f->C_FindObjectsInit(session, key_attr, 1); 1213 if (rv != CKR_OK) { 1214 error("C_FindObjectsInit failed: %lu", rv); 1215 goto fail; 1216 } 1217 1218 while (1) { 1219 CK_KEY_TYPE ck_key_type; 1220 CK_UTF8CHAR label[256]; 1221 1222 rv = f->C_FindObjects(session, &obj, 1, &n); 1223 if (rv != CKR_OK) { 1224 error("C_FindObjects failed: %lu", rv); 1225 goto fail; 1226 } 1227 if (n == 0) 1228 break; 1229 1230 memset(&ck_key_type, 0, sizeof(ck_key_type)); 1231 memset(&key_attr, 0, sizeof(key_attr)); 1232 key_attr[0].type = CKA_KEY_TYPE; 1233 key_attr[0].pValue = &ck_key_type; 1234 key_attr[0].ulValueLen = sizeof(ck_key_type); 1235 key_attr[1].type = CKA_LABEL; 1236 key_attr[1].pValue = &label; 1237 key_attr[1].ulValueLen = sizeof(label) - 1; 1238 1239 rv = f->C_GetAttributeValue(session, obj, key_attr, 2); 1240 if (rv != CKR_OK) { 1241 error("C_GetAttributeValue failed: %lu", rv); 1242 goto fail; 1243 } 1244 1245 label[key_attr[1].ulValueLen] = '\0'; 1246 1247 switch (ck_key_type) { 1248 case CKK_RSA: 1249 key = pkcs11_fetch_rsa_pubkey(p, slotidx, &obj); 1250 break; 1251 case CKK_ECDSA: 1252 key = pkcs11_fetch_ecdsa_pubkey(p, slotidx, &obj); 1253 break; 1254 default: 1255 /* XXX print key type? */ 1256 key = NULL; 1257 error("skipping unsupported key type"); 1258 } 1259 1260 if (key == NULL) { 1261 error("failed to fetch key"); 1262 continue; 1263 } 1264 note_key(p, slotidx, __func__, key); 1265 if (pkcs11_key_included(keysp, nkeys, key)) { 1266 debug2_f("key already included");; 1267 sshkey_free(key); 1268 } else { 1269 /* expand key array and add key */ 1270 *keysp = xrecallocarray(*keysp, *nkeys, 1271 *nkeys + 1, sizeof(struct sshkey *)); 1272 (*keysp)[*nkeys] = key; 1273 if (labelsp != NULL) { 1274 *labelsp = xrecallocarray(*labelsp, *nkeys, 1275 *nkeys + 1, sizeof(char *)); 1276 (*labelsp)[*nkeys] = xstrdup((char *)label); 1277 } 1278 *nkeys = *nkeys + 1; 1279 debug("have %d keys", *nkeys); 1280 } 1281 } 1282 1283 ret = 0; 1284 fail: 1285 rv = f->C_FindObjectsFinal(session); 1286 if (rv != CKR_OK) { 1287 error("C_FindObjectsFinal failed: %lu", rv); 1288 ret = -1; 1289 } 1290 1291 return (ret); 1292 } 1293 1294 #ifdef WITH_PKCS11_KEYGEN 1295 #define FILL_ATTR(attr, idx, typ, val, len) \ 1296 { (attr[idx]).type=(typ); (attr[idx]).pValue=(val); (attr[idx]).ulValueLen=len; idx++; } 1297 1298 static struct sshkey * 1299 pkcs11_rsa_generate_private_key(struct pkcs11_provider *p, CK_ULONG slotidx, 1300 char *label, CK_ULONG bits, CK_BYTE keyid, u_int32_t *err) 1301 { 1302 struct pkcs11_slotinfo *si; 1303 char *plabel = label ? label : ""; 1304 int npub = 0, npriv = 0; 1305 CK_RV rv; 1306 CK_FUNCTION_LIST *f; 1307 CK_SESSION_HANDLE session; 1308 CK_BBOOL true_val = CK_TRUE, false_val = CK_FALSE; 1309 CK_OBJECT_HANDLE pubKey, privKey; 1310 CK_ATTRIBUTE tpub[16], tpriv[16]; 1311 CK_MECHANISM mech = { 1312 CKM_RSA_PKCS_KEY_PAIR_GEN, NULL_PTR, 0 1313 }; 1314 CK_BYTE pubExponent[] = { 1315 0x01, 0x00, 0x01 /* RSA_F4 in bytes */ 1316 }; 1317 1318 *err = 0; 1319 1320 FILL_ATTR(tpub, npub, CKA_TOKEN, &true_val, sizeof(true_val)); 1321 FILL_ATTR(tpub, npub, CKA_LABEL, plabel, strlen(plabel)); 1322 FILL_ATTR(tpub, npub, CKA_ENCRYPT, &false_val, sizeof(false_val)); 1323 FILL_ATTR(tpub, npub, CKA_VERIFY, &true_val, sizeof(true_val)); 1324 FILL_ATTR(tpub, npub, CKA_VERIFY_RECOVER, &false_val, 1325 sizeof(false_val)); 1326 FILL_ATTR(tpub, npub, CKA_WRAP, &false_val, sizeof(false_val)); 1327 FILL_ATTR(tpub, npub, CKA_DERIVE, &false_val, sizeof(false_val)); 1328 FILL_ATTR(tpub, npub, CKA_MODULUS_BITS, &bits, sizeof(bits)); 1329 FILL_ATTR(tpub, npub, CKA_PUBLIC_EXPONENT, pubExponent, 1330 sizeof(pubExponent)); 1331 FILL_ATTR(tpub, npub, CKA_ID, &keyid, sizeof(keyid)); 1332 1333 FILL_ATTR(tpriv, npriv, CKA_TOKEN, &true_val, sizeof(true_val)); 1334 FILL_ATTR(tpriv, npriv, CKA_LABEL, plabel, strlen(plabel)); 1335 FILL_ATTR(tpriv, npriv, CKA_PRIVATE, &true_val, sizeof(true_val)); 1336 FILL_ATTR(tpriv, npriv, CKA_SENSITIVE, &true_val, sizeof(true_val)); 1337 FILL_ATTR(tpriv, npriv, CKA_DECRYPT, &false_val, sizeof(false_val)); 1338 FILL_ATTR(tpriv, npriv, CKA_SIGN, &true_val, sizeof(true_val)); 1339 FILL_ATTR(tpriv, npriv, CKA_SIGN_RECOVER, &false_val, 1340 sizeof(false_val)); 1341 FILL_ATTR(tpriv, npriv, CKA_UNWRAP, &false_val, sizeof(false_val)); 1342 FILL_ATTR(tpriv, npriv, CKA_DERIVE, &false_val, sizeof(false_val)); 1343 FILL_ATTR(tpriv, npriv, CKA_ID, &keyid, sizeof(keyid)); 1344 1345 f = p->function_list; 1346 si = &p->slotinfo[slotidx]; 1347 session = si->session; 1348 1349 if ((rv = f->C_GenerateKeyPair(session, &mech, tpub, npub, tpriv, npriv, 1350 &pubKey, &privKey)) != CKR_OK) { 1351 error_f("key generation failed: error 0x%lx", rv); 1352 *err = rv; 1353 return NULL; 1354 } 1355 1356 return pkcs11_fetch_rsa_pubkey(p, slotidx, &pubKey); 1357 } 1358 1359 static int 1360 pkcs11_decode_hex(const char *hex, unsigned char **dest, size_t *rlen) 1361 { 1362 size_t i, len; 1363 char ptr[3]; 1364 1365 if (dest) 1366 *dest = NULL; 1367 if (rlen) 1368 *rlen = 0; 1369 1370 if ((len = strlen(hex)) % 2) 1371 return -1; 1372 len /= 2; 1373 1374 *dest = xmalloc(len); 1375 1376 ptr[2] = '\0'; 1377 for (i = 0; i < len; i++) { 1378 ptr[0] = hex[2 * i]; 1379 ptr[1] = hex[(2 * i) + 1]; 1380 if (!isxdigit(ptr[0]) || !isxdigit(ptr[1])) 1381 return -1; 1382 (*dest)[i] = (unsigned char)strtoul(ptr, NULL, 16); 1383 } 1384 1385 if (rlen) 1386 *rlen = len; 1387 1388 return 0; 1389 } 1390 1391 static struct ec_curve_info { 1392 const char *name; 1393 const char *oid; 1394 const char *oid_encoded; 1395 size_t size; 1396 } ec_curve_infos[] = { 1397 {"prime256v1", "1.2.840.10045.3.1.7", "06082A8648CE3D030107", 256}, 1398 {"secp384r1", "1.3.132.0.34", "06052B81040022", 384}, 1399 {"secp521r1", "1.3.132.0.35", "06052B81040023", 521}, 1400 {NULL, NULL, NULL, 0}, 1401 }; 1402 1403 static struct sshkey * 1404 pkcs11_ecdsa_generate_private_key(struct pkcs11_provider *p, CK_ULONG slotidx, 1405 char *label, CK_ULONG bits, CK_BYTE keyid, u_int32_t *err) 1406 { 1407 struct pkcs11_slotinfo *si; 1408 char *plabel = label ? label : ""; 1409 int i; 1410 size_t ecparams_size; 1411 unsigned char *ecparams = NULL; 1412 int npub = 0, npriv = 0; 1413 CK_RV rv; 1414 CK_FUNCTION_LIST *f; 1415 CK_SESSION_HANDLE session; 1416 CK_BBOOL true_val = CK_TRUE, false_val = CK_FALSE; 1417 CK_OBJECT_HANDLE pubKey, privKey; 1418 CK_MECHANISM mech = { 1419 CKM_EC_KEY_PAIR_GEN, NULL_PTR, 0 1420 }; 1421 CK_ATTRIBUTE tpub[16], tpriv[16]; 1422 1423 *err = 0; 1424 1425 for (i = 0; ec_curve_infos[i].name; i++) { 1426 if (ec_curve_infos[i].size == bits) 1427 break; 1428 } 1429 if (!ec_curve_infos[i].name) { 1430 error_f("invalid key size %lu", bits); 1431 return NULL; 1432 } 1433 if (pkcs11_decode_hex(ec_curve_infos[i].oid_encoded, &ecparams, 1434 &ecparams_size) == -1) { 1435 error_f("invalid oid"); 1436 return NULL; 1437 } 1438 1439 FILL_ATTR(tpub, npub, CKA_TOKEN, &true_val, sizeof(true_val)); 1440 FILL_ATTR(tpub, npub, CKA_LABEL, plabel, strlen(plabel)); 1441 FILL_ATTR(tpub, npub, CKA_ENCRYPT, &false_val, sizeof(false_val)); 1442 FILL_ATTR(tpub, npub, CKA_VERIFY, &true_val, sizeof(true_val)); 1443 FILL_ATTR(tpub, npub, CKA_VERIFY_RECOVER, &false_val, 1444 sizeof(false_val)); 1445 FILL_ATTR(tpub, npub, CKA_WRAP, &false_val, sizeof(false_val)); 1446 FILL_ATTR(tpub, npub, CKA_DERIVE, &false_val, sizeof(false_val)); 1447 FILL_ATTR(tpub, npub, CKA_EC_PARAMS, ecparams, ecparams_size); 1448 FILL_ATTR(tpub, npub, CKA_ID, &keyid, sizeof(keyid)); 1449 1450 FILL_ATTR(tpriv, npriv, CKA_TOKEN, &true_val, sizeof(true_val)); 1451 FILL_ATTR(tpriv, npriv, CKA_LABEL, plabel, strlen(plabel)); 1452 FILL_ATTR(tpriv, npriv, CKA_PRIVATE, &true_val, sizeof(true_val)); 1453 FILL_ATTR(tpriv, npriv, CKA_SENSITIVE, &true_val, sizeof(true_val)); 1454 FILL_ATTR(tpriv, npriv, CKA_DECRYPT, &false_val, sizeof(false_val)); 1455 FILL_ATTR(tpriv, npriv, CKA_SIGN, &true_val, sizeof(true_val)); 1456 FILL_ATTR(tpriv, npriv, CKA_SIGN_RECOVER, &false_val, 1457 sizeof(false_val)); 1458 FILL_ATTR(tpriv, npriv, CKA_UNWRAP, &false_val, sizeof(false_val)); 1459 FILL_ATTR(tpriv, npriv, CKA_DERIVE, &false_val, sizeof(false_val)); 1460 FILL_ATTR(tpriv, npriv, CKA_ID, &keyid, sizeof(keyid)); 1461 1462 f = p->function_list; 1463 si = &p->slotinfo[slotidx]; 1464 session = si->session; 1465 1466 if ((rv = f->C_GenerateKeyPair(session, &mech, tpub, npub, tpriv, npriv, 1467 &pubKey, &privKey)) != CKR_OK) { 1468 error_f("key generation failed: error 0x%lx", rv); 1469 *err = rv; 1470 return NULL; 1471 } 1472 1473 return pkcs11_fetch_ecdsa_pubkey(p, slotidx, &pubKey); 1474 } 1475 #endif /* WITH_PKCS11_KEYGEN */ 1476 1477 /* 1478 * register a new provider, fails if provider already exists. if 1479 * keyp is provided, fetch keys. 1480 */ 1481 static int 1482 pkcs11_register_provider(char *provider_id, char *pin, 1483 struct sshkey ***keyp, char ***labelsp, 1484 struct pkcs11_provider **providerp, CK_ULONG user) 1485 { 1486 int nkeys, need_finalize = 0; 1487 int ret = -1; 1488 struct pkcs11_provider *p = NULL; 1489 void *handle = NULL; 1490 CK_RV (*getfunctionlist)(CK_FUNCTION_LIST **); 1491 CK_RV rv; 1492 CK_FUNCTION_LIST *f = NULL; 1493 CK_TOKEN_INFO *token; 1494 CK_ULONG i; 1495 1496 if (providerp == NULL) 1497 goto fail; 1498 *providerp = NULL; 1499 1500 if (keyp != NULL) 1501 *keyp = NULL; 1502 if (labelsp != NULL) 1503 *labelsp = NULL; 1504 1505 if (pkcs11_provider_lookup(provider_id) != NULL) { 1506 debug_f("provider already registered: %s", provider_id); 1507 goto fail; 1508 } 1509 /* open shared pkcs11-library */ 1510 if ((handle = dlopen(provider_id, RTLD_NOW)) == NULL) { 1511 error("dlopen %s failed: %s", provider_id, dlerror()); 1512 goto fail; 1513 } 1514 if ((getfunctionlist = dlsym(handle, "C_GetFunctionList")) == NULL) { 1515 error("dlsym(C_GetFunctionList) failed: %s", dlerror()); 1516 goto fail; 1517 } 1518 p = xcalloc(1, sizeof(*p)); 1519 p->name = xstrdup(provider_id); 1520 p->handle = handle; 1521 /* setup the pkcs11 callbacks */ 1522 if ((rv = (*getfunctionlist)(&f)) != CKR_OK) { 1523 error("C_GetFunctionList for provider %s failed: %lu", 1524 provider_id, rv); 1525 goto fail; 1526 } 1527 p->function_list = f; 1528 if ((rv = f->C_Initialize(NULL)) != CKR_OK) { 1529 error("C_Initialize for provider %s failed: %lu", 1530 provider_id, rv); 1531 goto fail; 1532 } 1533 need_finalize = 1; 1534 if ((rv = f->C_GetInfo(&p->info)) != CKR_OK) { 1535 error("C_GetInfo for provider %s failed: %lu", 1536 provider_id, rv); 1537 goto fail; 1538 } 1539 rmspace(p->info.manufacturerID, sizeof(p->info.manufacturerID)); 1540 rmspace(p->info.libraryDescription, sizeof(p->info.libraryDescription)); 1541 debug("provider %s: manufacturerID <%s> cryptokiVersion %d.%d" 1542 " libraryDescription <%s> libraryVersion %d.%d", 1543 provider_id, 1544 p->info.manufacturerID, 1545 p->info.cryptokiVersion.major, 1546 p->info.cryptokiVersion.minor, 1547 p->info.libraryDescription, 1548 p->info.libraryVersion.major, 1549 p->info.libraryVersion.minor); 1550 if ((rv = f->C_GetSlotList(CK_TRUE, NULL, &p->nslots)) != CKR_OK) { 1551 error("C_GetSlotList failed: %lu", rv); 1552 goto fail; 1553 } 1554 if (p->nslots == 0) { 1555 debug_f("provider %s returned no slots", provider_id); 1556 ret = -SSH_PKCS11_ERR_NO_SLOTS; 1557 goto fail; 1558 } 1559 p->slotlist = xcalloc(p->nslots, sizeof(CK_SLOT_ID)); 1560 if ((rv = f->C_GetSlotList(CK_TRUE, p->slotlist, &p->nslots)) 1561 != CKR_OK) { 1562 error("C_GetSlotList for provider %s failed: %lu", 1563 provider_id, rv); 1564 goto fail; 1565 } 1566 p->slotinfo = xcalloc(p->nslots, sizeof(struct pkcs11_slotinfo)); 1567 p->valid = 1; 1568 nkeys = 0; 1569 for (i = 0; i < p->nslots; i++) { 1570 token = &p->slotinfo[i].token; 1571 if ((rv = f->C_GetTokenInfo(p->slotlist[i], token)) 1572 != CKR_OK) { 1573 error("C_GetTokenInfo for provider %s slot %lu " 1574 "failed: %lu", provider_id, (u_long)i, rv); 1575 continue; 1576 } 1577 if ((token->flags & CKF_TOKEN_INITIALIZED) == 0) { 1578 debug2_f("ignoring uninitialised token in " 1579 "provider %s slot %lu", provider_id, (u_long)i); 1580 continue; 1581 } 1582 rmspace(token->label, sizeof(token->label)); 1583 rmspace(token->manufacturerID, sizeof(token->manufacturerID)); 1584 rmspace(token->model, sizeof(token->model)); 1585 rmspace(token->serialNumber, sizeof(token->serialNumber)); 1586 debug("provider %s slot %lu: label <%s> manufacturerID <%s> " 1587 "model <%s> serial <%s> flags 0x%lx", 1588 provider_id, (unsigned long)i, 1589 token->label, token->manufacturerID, token->model, 1590 token->serialNumber, token->flags); 1591 /* 1592 * open session, login with pin and retrieve public 1593 * keys (if keyp is provided) 1594 */ 1595 if ((ret = pkcs11_open_session(p, i, pin, user)) != 0 || 1596 keyp == NULL) 1597 continue; 1598 pkcs11_fetch_keys(p, i, keyp, labelsp, &nkeys); 1599 pkcs11_fetch_certs(p, i, keyp, labelsp, &nkeys); 1600 if (nkeys == 0 && !p->slotinfo[i].logged_in && 1601 pkcs11_interactive) { 1602 /* 1603 * Some tokens require login before they will 1604 * expose keys. 1605 */ 1606 if (pkcs11_login_slot(p, &p->slotinfo[i], 1607 CKU_USER) < 0) { 1608 error("login failed"); 1609 continue; 1610 } 1611 pkcs11_fetch_keys(p, i, keyp, labelsp, &nkeys); 1612 pkcs11_fetch_certs(p, i, keyp, labelsp, &nkeys); 1613 } 1614 } 1615 1616 /* now owned by caller */ 1617 *providerp = p; 1618 1619 TAILQ_INSERT_TAIL(&pkcs11_providers, p, next); 1620 p->refcount++; /* add to provider list */ 1621 1622 return (nkeys); 1623 fail: 1624 if (need_finalize && (rv = f->C_Finalize(NULL)) != CKR_OK) 1625 error("C_Finalize for provider %s failed: %lu", 1626 provider_id, rv); 1627 if (p) { 1628 free(p->name); 1629 free(p->slotlist); 1630 free(p->slotinfo); 1631 free(p); 1632 } 1633 if (handle) 1634 dlclose(handle); 1635 if (ret > 0) 1636 ret = -1; 1637 return (ret); 1638 } 1639 1640 /* 1641 * register a new provider and get number of keys hold by the token, 1642 * fails if provider already exists 1643 */ 1644 int 1645 pkcs11_add_provider(char *provider_id, char *pin, struct sshkey ***keyp, 1646 char ***labelsp) 1647 { 1648 struct pkcs11_provider *p = NULL; 1649 int nkeys; 1650 1651 nkeys = pkcs11_register_provider(provider_id, pin, keyp, labelsp, 1652 &p, CKU_USER); 1653 1654 /* no keys found or some other error, de-register provider */ 1655 if (nkeys <= 0 && p != NULL) { 1656 TAILQ_REMOVE(&pkcs11_providers, p, next); 1657 pkcs11_provider_finalize(p); 1658 pkcs11_provider_unref(p); 1659 } 1660 if (nkeys == 0) 1661 debug_f("provider %s returned no keys", provider_id); 1662 1663 return (nkeys); 1664 } 1665 1666 #ifdef WITH_PKCS11_KEYGEN 1667 struct sshkey * 1668 pkcs11_gakp(char *provider_id, char *pin, unsigned int slotidx, char *label, 1669 unsigned int type, unsigned int bits, unsigned char keyid, u_int32_t *err) 1670 { 1671 struct pkcs11_provider *p = NULL; 1672 struct pkcs11_slotinfo *si; 1673 CK_FUNCTION_LIST *f; 1674 CK_SESSION_HANDLE session; 1675 struct sshkey *k = NULL; 1676 int ret = -1, reset_pin = 0, reset_provider = 0; 1677 CK_RV rv; 1678 1679 *err = 0; 1680 1681 if ((p = pkcs11_provider_lookup(provider_id)) != NULL) 1682 debug_f("provider \"%s\" available", provider_id); 1683 else if ((ret = pkcs11_register_provider(provider_id, pin, NULL, NULL, 1684 &p, CKU_SO)) < 0) { 1685 debug_f("could not register provider %s", provider_id); 1686 goto out; 1687 } else 1688 reset_provider = 1; 1689 1690 f = p->function_list; 1691 si = &p->slotinfo[slotidx]; 1692 session = si->session; 1693 1694 if ((rv = f->C_SetOperationState(session , pin, strlen(pin), 1695 CK_INVALID_HANDLE, CK_INVALID_HANDLE)) != CKR_OK) { 1696 debug_f("could not supply SO pin: %lu", rv); 1697 reset_pin = 0; 1698 } else 1699 reset_pin = 1; 1700 1701 switch (type) { 1702 case KEY_RSA: 1703 if ((k = pkcs11_rsa_generate_private_key(p, slotidx, label, 1704 bits, keyid, err)) == NULL) { 1705 debug_f("failed to generate RSA key"); 1706 goto out; 1707 } 1708 break; 1709 case KEY_ECDSA: 1710 if ((k = pkcs11_ecdsa_generate_private_key(p, slotidx, label, 1711 bits, keyid, err)) == NULL) { 1712 debug_f("failed to generate ECDSA key"); 1713 goto out; 1714 } 1715 break; 1716 default: 1717 *err = SSH_PKCS11_ERR_GENERIC; 1718 debug_f("unknown type %d", type); 1719 goto out; 1720 } 1721 1722 out: 1723 if (reset_pin) 1724 f->C_SetOperationState(session , NULL, 0, CK_INVALID_HANDLE, 1725 CK_INVALID_HANDLE); 1726 1727 if (reset_provider) 1728 pkcs11_del_provider(provider_id); 1729 1730 return (k); 1731 } 1732 1733 struct sshkey * 1734 pkcs11_destroy_keypair(char *provider_id, char *pin, unsigned long slotidx, 1735 unsigned char keyid, u_int32_t *err) 1736 { 1737 struct pkcs11_provider *p = NULL; 1738 struct pkcs11_slotinfo *si; 1739 struct sshkey *k = NULL; 1740 int reset_pin = 0, reset_provider = 0; 1741 CK_ULONG nattrs; 1742 CK_FUNCTION_LIST *f; 1743 CK_SESSION_HANDLE session; 1744 CK_ATTRIBUTE attrs[16]; 1745 CK_OBJECT_CLASS key_class; 1746 CK_KEY_TYPE key_type; 1747 CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE; 1748 CK_RV rv; 1749 1750 *err = 0; 1751 1752 if ((p = pkcs11_provider_lookup(provider_id)) != NULL) { 1753 debug_f("using provider \"%s\"", provider_id); 1754 } else if (pkcs11_register_provider(provider_id, pin, NULL, NULL, &p, 1755 CKU_SO) < 0) { 1756 debug_f("could not register provider %s", 1757 provider_id); 1758 goto out; 1759 } else 1760 reset_provider = 1; 1761 1762 f = p->function_list; 1763 si = &p->slotinfo[slotidx]; 1764 session = si->session; 1765 1766 if ((rv = f->C_SetOperationState(session , pin, strlen(pin), 1767 CK_INVALID_HANDLE, CK_INVALID_HANDLE)) != CKR_OK) { 1768 debug_f("could not supply SO pin: %lu", rv); 1769 reset_pin = 0; 1770 } else 1771 reset_pin = 1; 1772 1773 /* private key */ 1774 nattrs = 0; 1775 key_class = CKO_PRIVATE_KEY; 1776 FILL_ATTR(attrs, nattrs, CKA_CLASS, &key_class, sizeof(key_class)); 1777 FILL_ATTR(attrs, nattrs, CKA_ID, &keyid, sizeof(keyid)); 1778 1779 if (pkcs11_find(p, slotidx, attrs, nattrs, &obj) == 0 && 1780 obj != CK_INVALID_HANDLE) { 1781 if ((rv = f->C_DestroyObject(session, obj)) != CKR_OK) { 1782 debug_f("could not destroy private key 0x%hhx", 1783 keyid); 1784 *err = rv; 1785 goto out; 1786 } 1787 } 1788 1789 /* public key */ 1790 nattrs = 0; 1791 key_class = CKO_PUBLIC_KEY; 1792 FILL_ATTR(attrs, nattrs, CKA_CLASS, &key_class, sizeof(key_class)); 1793 FILL_ATTR(attrs, nattrs, CKA_ID, &keyid, sizeof(keyid)); 1794 1795 if (pkcs11_find(p, slotidx, attrs, nattrs, &obj) == 0 && 1796 obj != CK_INVALID_HANDLE) { 1797 1798 /* get key type */ 1799 nattrs = 0; 1800 FILL_ATTR(attrs, nattrs, CKA_KEY_TYPE, &key_type, 1801 sizeof(key_type)); 1802 rv = f->C_GetAttributeValue(session, obj, attrs, nattrs); 1803 if (rv != CKR_OK) { 1804 debug_f("could not get key type of public key 0x%hhx", 1805 keyid); 1806 *err = rv; 1807 key_type = -1; 1808 } 1809 if (key_type == CKK_RSA) 1810 k = pkcs11_fetch_rsa_pubkey(p, slotidx, &obj); 1811 else if (key_type == CKK_ECDSA) 1812 k = pkcs11_fetch_ecdsa_pubkey(p, slotidx, &obj); 1813 1814 if ((rv = f->C_DestroyObject(session, obj)) != CKR_OK) { 1815 debug_f("could not destroy public key 0x%hhx", keyid); 1816 *err = rv; 1817 goto out; 1818 } 1819 } 1820 1821 out: 1822 if (reset_pin) 1823 f->C_SetOperationState(session , NULL, 0, CK_INVALID_HANDLE, 1824 CK_INVALID_HANDLE); 1825 1826 if (reset_provider) 1827 pkcs11_del_provider(provider_id); 1828 1829 return (k); 1830 } 1831 #endif /* WITH_PKCS11_KEYGEN */ 1832 #else 1833 int 1834 pkcs11_add_provider(char *provider_id, char *pin, struct sshkey ***keyp, 1835 char ***labelsp) 1836 { 1837 error("dlopen() not supported"); 1838 return (-1); 1839 } 1840 #endif /* HAVE_DLOPEN */ 1841