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