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