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