blob: a302c79c0c18ce7ac9b9e3043f88332d20454591 [file] [log] [blame]
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001/* $OpenBSD: ssh-pkcs11.c,v 1.47 2020/01/25 00:03:36 djm Exp $ */
Damien Miller7ea845e2010-02-12 09:21:02 +11002/*
3 * Copyright (c) 2010 Markus Friedl. All rights reserved.
djm@openbsd.org93f02102019-01-20 22:51:37 +00004 * Copyright (c) 2014 Pedro Martelletto. All rights reserved.
Damien Miller7ea845e2010-02-12 09:21:02 +11005 *
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
Damien Miller8ad0fbd2010-02-12 09:49:06 +110019#include "includes.h"
20
Damien Millerdfa41562010-02-12 10:06:28 +110021#ifdef ENABLE_PKCS11
22
Damien Miller8ad0fbd2010-02-12 09:49:06 +110023#ifdef HAVE_SYS_TIME_H
24# include <sys/time.h>
25#endif
djm@openbsd.org93f02102019-01-20 22:51:37 +000026
27#include <sys/types.h>
Damien Miller7ea845e2010-02-12 09:21:02 +110028#include <stdarg.h>
29#include <stdio.h>
30
djm@openbsd.org93f02102019-01-20 22:51:37 +000031#include <ctype.h>
Damien Miller7ea845e2010-02-12 09:21:02 +110032#include <string.h>
33#include <dlfcn.h>
34
Damien Miller8ad0fbd2010-02-12 09:49:06 +110035#include "openbsd-compat/sys-queue.h"
Damien Miller48f54b92018-09-13 12:13:50 +100036#include "openbsd-compat/openssl-compat.h"
Damien Miller8ad0fbd2010-02-12 09:49:06 +110037
djm@openbsd.org93f02102019-01-20 22:51:37 +000038#include <openssl/ecdsa.h>
Damien Millerd2252c72013-11-04 07:41:48 +110039#include <openssl/x509.h>
djm@openbsd.org93f02102019-01-20 22:51:37 +000040#include <openssl/err.h>
Damien Millerd2252c72013-11-04 07:41:48 +110041
Damien Miller7ea845e2010-02-12 09:21:02 +110042#define CRYPTOKI_COMPAT
43#include "pkcs11.h"
44
45#include "log.h"
46#include "misc.h"
djm@openbsd.org1129dcf2015-01-15 09:40:00 +000047#include "sshkey.h"
Damien Miller7ea845e2010-02-12 09:21:02 +110048#include "ssh-pkcs11.h"
49#include "xmalloc.h"
50
51struct pkcs11_slotinfo {
52 CK_TOKEN_INFO token;
53 CK_SESSION_HANDLE session;
54 int logged_in;
55};
56
57struct pkcs11_provider {
58 char *name;
59 void *handle;
60 CK_FUNCTION_LIST *function_list;
61 CK_INFO info;
62 CK_ULONG nslots;
63 CK_SLOT_ID *slotlist;
64 struct pkcs11_slotinfo *slotinfo;
65 int valid;
66 int refcount;
67 TAILQ_ENTRY(pkcs11_provider) next;
68};
69
70TAILQ_HEAD(, pkcs11_provider) pkcs11_providers;
71
72struct pkcs11_key {
73 struct pkcs11_provider *provider;
74 CK_ULONG slotidx;
Damien Miller7ea845e2010-02-12 09:21:02 +110075 char *keyid;
76 int keyid_len;
77};
78
79int pkcs11_interactive = 0;
80
Damien Miller2efcf812019-01-21 11:57:21 +110081#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +000082static void
83ossl_error(const char *msg)
84{
djm@openbsd.org65294092019-01-20 23:11:11 +000085 unsigned long e;
djm@openbsd.org93f02102019-01-20 22:51:37 +000086
djm@openbsd.org662be402019-01-21 02:05:38 +000087 error("%s: %s", __func__, msg);
djm@openbsd.org65294092019-01-20 23:11:11 +000088 while ((e = ERR_get_error()) != 0)
djm@openbsd.org662be402019-01-21 02:05:38 +000089 error("%s: libcrypto error: %.100s", __func__,
djm@openbsd.org65294092019-01-20 23:11:11 +000090 ERR_error_string(e, NULL));
djm@openbsd.org93f02102019-01-20 22:51:37 +000091}
Damien Miller2efcf812019-01-21 11:57:21 +110092#endif /* HAVE_EC_KEY_METHOD_NEW */
djm@openbsd.org93f02102019-01-20 22:51:37 +000093
Damien Miller7ea845e2010-02-12 09:21:02 +110094int
95pkcs11_init(int interactive)
96{
97 pkcs11_interactive = interactive;
98 TAILQ_INIT(&pkcs11_providers);
99 return (0);
100}
101
102/*
djm@openbsd.org93f02102019-01-20 22:51:37 +0000103 * finalize a provider shared library, it's no longer usable.
Damien Miller7ea845e2010-02-12 09:21:02 +1100104 * however, there might still be keys referencing this provider,
djm@openbsd.org93f02102019-01-20 22:51:37 +0000105 * so the actual freeing of memory is handled by pkcs11_provider_unref().
Damien Miller7ea845e2010-02-12 09:21:02 +1100106 * this is called when a provider gets unregistered.
107 */
108static void
109pkcs11_provider_finalize(struct pkcs11_provider *p)
110{
111 CK_RV rv;
112 CK_ULONG i;
113
114 debug("pkcs11_provider_finalize: %p refcount %d valid %d",
115 p, p->refcount, p->valid);
116 if (!p->valid)
117 return;
118 for (i = 0; i < p->nslots; i++) {
119 if (p->slotinfo[i].session &&
120 (rv = p->function_list->C_CloseSession(
121 p->slotinfo[i].session)) != CKR_OK)
122 error("C_CloseSession failed: %lu", rv);
123 }
124 if ((rv = p->function_list->C_Finalize(NULL)) != CKR_OK)
125 error("C_Finalize failed: %lu", rv);
126 p->valid = 0;
127 p->function_list = NULL;
128 dlclose(p->handle);
129}
130
131/*
132 * remove a reference to the provider.
133 * called when a key gets destroyed or when the provider is unregistered.
134 */
135static void
136pkcs11_provider_unref(struct pkcs11_provider *p)
137{
138 debug("pkcs11_provider_unref: %p refcount %d", p, p->refcount);
139 if (--p->refcount <= 0) {
140 if (p->valid)
141 error("pkcs11_provider_unref: %p still valid", p);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000142 free(p->name);
Darren Tuckera627d422013-06-02 07:31:17 +1000143 free(p->slotlist);
144 free(p->slotinfo);
145 free(p);
Damien Miller7ea845e2010-02-12 09:21:02 +1100146 }
147}
148
149/* unregister all providers, keys might still point to the providers */
150void
151pkcs11_terminate(void)
152{
153 struct pkcs11_provider *p;
154
155 while ((p = TAILQ_FIRST(&pkcs11_providers)) != NULL) {
156 TAILQ_REMOVE(&pkcs11_providers, p, next);
157 pkcs11_provider_finalize(p);
158 pkcs11_provider_unref(p);
159 }
160}
161
162/* lookup provider by name */
163static struct pkcs11_provider *
164pkcs11_provider_lookup(char *provider_id)
165{
166 struct pkcs11_provider *p;
167
168 TAILQ_FOREACH(p, &pkcs11_providers, next) {
169 debug("check %p %s", p, p->name);
170 if (!strcmp(provider_id, p->name))
171 return (p);
172 }
173 return (NULL);
174}
175
176/* unregister provider by name */
177int
178pkcs11_del_provider(char *provider_id)
179{
180 struct pkcs11_provider *p;
181
182 if ((p = pkcs11_provider_lookup(provider_id)) != NULL) {
183 TAILQ_REMOVE(&pkcs11_providers, p, next);
184 pkcs11_provider_finalize(p);
185 pkcs11_provider_unref(p);
186 return (0);
187 }
188 return (-1);
189}
190
djm@openbsd.orgce46c3a2019-01-21 02:01:03 +0000191static RSA_METHOD *rsa_method;
192static int rsa_idx = 0;
Damien Miller23490a62019-01-21 15:05:43 +1100193#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.orgce46c3a2019-01-21 02:01:03 +0000194static EC_KEY_METHOD *ec_key_method;
195static int ec_key_idx = 0;
Darren Tuckerb6dd3272019-01-21 13:50:17 +1100196#endif
djm@openbsd.orgce46c3a2019-01-21 02:01:03 +0000197
djm@openbsd.org58622a82019-01-20 23:10:33 +0000198/* release a wrapped object */
199static void
200pkcs11_k11_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad, int idx,
201 long argl, void *argp)
Damien Miller7ea845e2010-02-12 09:21:02 +1100202{
Darren Tucker5590f532019-04-26 18:22:10 +1000203 struct pkcs11_key *k11 = ptr;
Damien Miller7ea845e2010-02-12 09:21:02 +1100204
Darren Tucker5590f532019-04-26 18:22:10 +1000205 debug("%s: parent %p ptr %p idx %d", __func__, parent, ptr, idx);
206 if (k11 == NULL)
207 return;
208 if (k11->provider)
209 pkcs11_provider_unref(k11->provider);
210 free(k11->keyid);
211 free(k11);
Damien Miller7ea845e2010-02-12 09:21:02 +1100212}
213
Damien Miller031c9102010-04-16 15:54:44 +1000214/* find a single 'obj' for given attributes */
215static int
216pkcs11_find(struct pkcs11_provider *p, CK_ULONG slotidx, CK_ATTRIBUTE *attr,
217 CK_ULONG nattr, CK_OBJECT_HANDLE *obj)
218{
219 CK_FUNCTION_LIST *f;
220 CK_SESSION_HANDLE session;
221 CK_ULONG nfound = 0;
222 CK_RV rv;
223 int ret = -1;
224
225 f = p->function_list;
226 session = p->slotinfo[slotidx].session;
227 if ((rv = f->C_FindObjectsInit(session, attr, nattr)) != CKR_OK) {
228 error("C_FindObjectsInit failed (nattr %lu): %lu", nattr, rv);
229 return (-1);
230 }
231 if ((rv = f->C_FindObjects(session, obj, 1, &nfound)) != CKR_OK ||
232 nfound != 1) {
233 debug("C_FindObjects failed (nfound %lu nattr %lu): %lu",
234 nfound, nattr, rv);
235 } else
236 ret = 0;
237 if ((rv = f->C_FindObjectsFinal(session)) != CKR_OK)
238 error("C_FindObjectsFinal failed: %lu", rv);
239 return (ret);
240}
241
Damien Miller7ea845e2010-02-12 09:21:02 +1100242static int
djm@openbsd.org7d6034b2019-09-05 10:05:51 +0000243pkcs11_login_slot(struct pkcs11_provider *provider, struct pkcs11_slotinfo *si,
244 CK_USER_TYPE type)
djm@openbsd.org21621712019-01-22 12:00:50 +0000245{
djm@openbsd.org21621712019-01-22 12:00:50 +0000246 char *pin = NULL, prompt[1024];
247 CK_RV rv;
248
djm@openbsd.org7d6034b2019-09-05 10:05:51 +0000249 if (provider == NULL || si == NULL || !provider->valid) {
djm@openbsd.org21621712019-01-22 12:00:50 +0000250 error("no pkcs11 (valid) provider found");
251 return (-1);
252 }
253
djm@openbsd.org21621712019-01-22 12:00:50 +0000254 if (!pkcs11_interactive) {
255 error("need pin entry%s",
256 (si->token.flags & CKF_PROTECTED_AUTHENTICATION_PATH) ?
257 " on reader keypad" : "");
258 return (-1);
259 }
260 if (si->token.flags & CKF_PROTECTED_AUTHENTICATION_PATH)
261 verbose("Deferring PIN entry to reader keypad.");
262 else {
263 snprintf(prompt, sizeof(prompt), "Enter PIN for '%s': ",
264 si->token.label);
265 if ((pin = read_passphrase(prompt, RP_ALLOW_EOF)) == NULL) {
266 debug("%s: no pin specified", __func__);
267 return (-1); /* bail out */
268 }
269 }
djm@openbsd.org7d6034b2019-09-05 10:05:51 +0000270 rv = provider->function_list->C_Login(si->session, type, (u_char *)pin,
djm@openbsd.org21621712019-01-22 12:00:50 +0000271 (pin != NULL) ? strlen(pin) : 0);
272 if (pin != NULL)
273 freezero(pin, strlen(pin));
274 if (rv != CKR_OK && rv != CKR_USER_ALREADY_LOGGED_IN) {
275 error("C_Login failed: %lu", rv);
276 return (-1);
277 }
278 si->logged_in = 1;
279 return (0);
280}
281
282static int
djm@openbsd.org7d6034b2019-09-05 10:05:51 +0000283pkcs11_login(struct pkcs11_key *k11, CK_USER_TYPE type)
284{
285 if (k11 == NULL || k11->provider == NULL || !k11->provider->valid) {
286 error("no pkcs11 (valid) provider found");
287 return (-1);
288 }
289
290 return pkcs11_login_slot(k11->provider,
291 &k11->provider->slotinfo[k11->slotidx], type);
292}
293
294
295static int
djm@openbsd.org21621712019-01-22 12:00:50 +0000296pkcs11_check_obj_bool_attrib(struct pkcs11_key *k11, CK_OBJECT_HANDLE obj,
297 CK_ATTRIBUTE_TYPE type, int *val)
298{
299 struct pkcs11_slotinfo *si;
300 CK_FUNCTION_LIST *f;
301 CK_BBOOL flag = 0;
302 CK_ATTRIBUTE attr;
303 CK_RV rv;
304
305 *val = 0;
306
307 if (!k11->provider || !k11->provider->valid) {
308 error("no pkcs11 (valid) provider found");
309 return (-1);
310 }
311
312 f = k11->provider->function_list;
313 si = &k11->provider->slotinfo[k11->slotidx];
314
315 attr.type = type;
316 attr.pValue = &flag;
317 attr.ulValueLen = sizeof(flag);
318
319 rv = f->C_GetAttributeValue(si->session, obj, &attr, 1);
320 if (rv != CKR_OK) {
321 error("C_GetAttributeValue failed: %lu", rv);
322 return (-1);
323 }
324 *val = flag != 0;
325 debug("%s: provider %p slot %lu object %lu: attrib %lu = %d",
326 __func__, k11->provider, k11->slotidx, obj, type, *val);
327 return (0);
328}
329
330static int
djm@openbsd.org93f02102019-01-20 22:51:37 +0000331pkcs11_get_key(struct pkcs11_key *k11, CK_MECHANISM_TYPE mech_type)
Damien Miller7ea845e2010-02-12 09:21:02 +1100332{
Damien Miller7ea845e2010-02-12 09:21:02 +1100333 struct pkcs11_slotinfo *si;
334 CK_FUNCTION_LIST *f;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000335 CK_OBJECT_HANDLE obj;
336 CK_RV rv;
337 CK_OBJECT_CLASS private_key_class;
338 CK_BBOOL true_val;
339 CK_MECHANISM mech;
340 CK_ATTRIBUTE key_filter[3];
djm@openbsd.org21621712019-01-22 12:00:50 +0000341 int always_auth = 0;
342 int did_login = 0;
Damien Miller7ea845e2010-02-12 09:21:02 +1100343
Damien Miller7ea845e2010-02-12 09:21:02 +1100344 if (!k11->provider || !k11->provider->valid) {
djm@openbsd.org93f02102019-01-20 22:51:37 +0000345 error("no pkcs11 (valid) provider found");
Damien Miller7ea845e2010-02-12 09:21:02 +1100346 return (-1);
347 }
djm@openbsd.org93f02102019-01-20 22:51:37 +0000348
Damien Miller7ea845e2010-02-12 09:21:02 +1100349 f = k11->provider->function_list;
350 si = &k11->provider->slotinfo[k11->slotidx];
djm@openbsd.org93f02102019-01-20 22:51:37 +0000351
Damien Miller7ea845e2010-02-12 09:21:02 +1100352 if ((si->token.flags & CKF_LOGIN_REQUIRED) && !si->logged_in) {
djm@openbsd.org21621712019-01-22 12:00:50 +0000353 if (pkcs11_login(k11, CKU_USER) < 0) {
354 error("login failed");
Damien Miller7ea845e2010-02-12 09:21:02 +1100355 return (-1);
356 }
djm@openbsd.org21621712019-01-22 12:00:50 +0000357 did_login = 1;
Damien Miller7ea845e2010-02-12 09:21:02 +1100358 }
djm@openbsd.org93f02102019-01-20 22:51:37 +0000359
360 memset(&key_filter, 0, sizeof(key_filter));
361 private_key_class = CKO_PRIVATE_KEY;
362 key_filter[0].type = CKA_CLASS;
363 key_filter[0].pValue = &private_key_class;
364 key_filter[0].ulValueLen = sizeof(private_key_class);
365
366 key_filter[1].type = CKA_ID;
Damien Miller7ea845e2010-02-12 09:21:02 +1100367 key_filter[1].pValue = k11->keyid;
368 key_filter[1].ulValueLen = k11->keyid_len;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000369
370 true_val = CK_TRUE;
371 key_filter[2].type = CKA_SIGN;
372 key_filter[2].pValue = &true_val;
373 key_filter[2].ulValueLen = sizeof(true_val);
374
Damien Miller031c9102010-04-16 15:54:44 +1000375 /* try to find object w/CKA_SIGN first, retry w/o */
376 if (pkcs11_find(k11->provider, k11->slotidx, key_filter, 3, &obj) < 0 &&
377 pkcs11_find(k11->provider, k11->slotidx, key_filter, 2, &obj) < 0) {
378 error("cannot find private key");
djm@openbsd.org93f02102019-01-20 22:51:37 +0000379 return (-1);
Damien Miller7ea845e2010-02-12 09:21:02 +1100380 }
djm@openbsd.org93f02102019-01-20 22:51:37 +0000381
382 memset(&mech, 0, sizeof(mech));
383 mech.mechanism = mech_type;
384 mech.pParameter = NULL_PTR;
385 mech.ulParameterLen = 0;
386
387 if ((rv = f->C_SignInit(si->session, &mech, obj)) != CKR_OK) {
388 error("C_SignInit failed: %lu", rv);
389 return (-1);
390 }
391
djm@openbsd.org21621712019-01-22 12:00:50 +0000392 pkcs11_check_obj_bool_attrib(k11, obj, CKA_ALWAYS_AUTHENTICATE,
393 &always_auth); /* ignore errors here */
394 if (always_auth && !did_login) {
395 debug("%s: always-auth key", __func__);
396 if (pkcs11_login(k11, CKU_CONTEXT_SPECIFIC) < 0) {
397 error("login failed for always-auth key");
398 return (-1);
399 }
400 }
401
djm@openbsd.org93f02102019-01-20 22:51:37 +0000402 return (0);
403}
404
405/* openssl callback doing the actual signing operation */
406static int
407pkcs11_rsa_private_encrypt(int flen, const u_char *from, u_char *to, RSA *rsa,
408 int padding)
409{
410 struct pkcs11_key *k11;
411 struct pkcs11_slotinfo *si;
412 CK_FUNCTION_LIST *f;
413 CK_ULONG tlen = 0;
414 CK_RV rv;
415 int rval = -1;
416
djm@openbsd.orgce46c3a2019-01-21 02:01:03 +0000417 if ((k11 = RSA_get_ex_data(rsa, rsa_idx)) == NULL) {
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000418 error("RSA_get_ex_data failed for rsa %p", rsa);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000419 return (-1);
420 }
421
422 if (pkcs11_get_key(k11, CKM_RSA_PKCS) == -1) {
423 error("pkcs11_get_key failed");
424 return (-1);
425 }
426
427 f = k11->provider->function_list;
428 si = &k11->provider->slotinfo[k11->slotidx];
429 tlen = RSA_size(rsa);
430
431 /* XXX handle CKR_BUFFER_TOO_SMALL */
432 rv = f->C_Sign(si->session, (CK_BYTE *)from, flen, to, &tlen);
433 if (rv == CKR_OK)
434 rval = tlen;
435 else
436 error("C_Sign failed: %lu", rv);
437
Damien Miller7ea845e2010-02-12 09:21:02 +1100438 return (rval);
439}
440
441static int
442pkcs11_rsa_private_decrypt(int flen, const u_char *from, u_char *to, RSA *rsa,
443 int padding)
444{
445 return (-1);
446}
447
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000448static int
449pkcs11_rsa_start_wrapper(void)
450{
451 if (rsa_method != NULL)
452 return (0);
453 rsa_method = RSA_meth_dup(RSA_get_default_method());
454 if (rsa_method == NULL)
455 return (-1);
djm@openbsd.org58622a82019-01-20 23:10:33 +0000456 rsa_idx = RSA_get_ex_new_index(0, "ssh-pkcs11-rsa",
457 NULL, NULL, pkcs11_k11_free);
458 if (rsa_idx == -1)
459 return (-1);
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000460 if (!RSA_meth_set1_name(rsa_method, "pkcs11") ||
461 !RSA_meth_set_priv_enc(rsa_method, pkcs11_rsa_private_encrypt) ||
djm@openbsd.org58622a82019-01-20 23:10:33 +0000462 !RSA_meth_set_priv_dec(rsa_method, pkcs11_rsa_private_decrypt)) {
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000463 error("%s: setup pkcs11 method failed", __func__);
464 return (-1);
465 }
466 return (0);
467}
468
Damien Miller7ea845e2010-02-12 09:21:02 +1100469/* redirect private key operations for rsa key to pkcs11 token */
470static int
471pkcs11_rsa_wrap(struct pkcs11_provider *provider, CK_ULONG slotidx,
472 CK_ATTRIBUTE *keyid_attrib, RSA *rsa)
473{
474 struct pkcs11_key *k11;
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000475
476 if (pkcs11_rsa_start_wrapper() == -1)
477 return (-1);
Damien Miller7ea845e2010-02-12 09:21:02 +1100478
479 k11 = xcalloc(1, sizeof(*k11));
480 k11->provider = provider;
481 provider->refcount++; /* provider referenced by RSA key */
482 k11->slotidx = slotidx;
483 /* identify key object on smartcard */
484 k11->keyid_len = keyid_attrib->ulValueLen;
djm@openbsd.orgd2d772f2016-02-12 00:20:30 +0000485 if (k11->keyid_len > 0) {
486 k11->keyid = xmalloc(k11->keyid_len);
487 memcpy(k11->keyid, keyid_attrib->pValue, k11->keyid_len);
488 }
djm@openbsd.orgf1185422019-01-20 23:08:24 +0000489
djm@openbsd.orgfcb1b092019-01-20 23:12:35 +0000490 RSA_set_method(rsa, rsa_method);
djm@openbsd.org58622a82019-01-20 23:10:33 +0000491 RSA_set_ex_data(rsa, rsa_idx, k11);
Damien Miller7ea845e2010-02-12 09:21:02 +1100492 return (0);
493}
494
Damien Millere2cb4452019-01-21 11:32:28 +1100495#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +0000496/* openssl callback doing the actual signing operation */
497static ECDSA_SIG *
498ecdsa_do_sign(const unsigned char *dgst, int dgst_len, const BIGNUM *inv,
499 const BIGNUM *rp, EC_KEY *ec)
500{
501 struct pkcs11_key *k11;
502 struct pkcs11_slotinfo *si;
503 CK_FUNCTION_LIST *f;
504 CK_ULONG siglen = 0, bnlen;
505 CK_RV rv;
506 ECDSA_SIG *ret = NULL;
507 u_char *sig;
djm@openbsd.org63297642019-01-21 00:47:34 +0000508 BIGNUM *r = NULL, *s = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000509
djm@openbsd.orgce46c3a2019-01-21 02:01:03 +0000510 if ((k11 = EC_KEY_get_ex_data(ec, ec_key_idx)) == NULL) {
djm@openbsd.org93f02102019-01-20 22:51:37 +0000511 ossl_error("EC_KEY_get_key_method_data failed for ec");
512 return (NULL);
513 }
514
515 if (pkcs11_get_key(k11, CKM_ECDSA) == -1) {
516 error("pkcs11_get_key failed");
517 return (NULL);
518 }
519
520 f = k11->provider->function_list;
521 si = &k11->provider->slotinfo[k11->slotidx];
522
523 siglen = ECDSA_size(ec);
524 sig = xmalloc(siglen);
525
526 /* XXX handle CKR_BUFFER_TOO_SMALL */
527 rv = f->C_Sign(si->session, (CK_BYTE *)dgst, dgst_len, sig, &siglen);
528 if (rv != CKR_OK) {
529 error("C_Sign failed: %lu", rv);
530 goto done;
531 }
djm@openbsd.org749aef32019-01-20 23:00:12 +0000532 if (siglen < 64 || siglen > 132 || siglen % 2) {
533 ossl_error("d2i_ECDSA_SIG failed");
534 goto done;
535 }
536 bnlen = siglen/2;
537 if ((ret = ECDSA_SIG_new()) == NULL) {
538 error("ECDSA_SIG_new failed");
539 goto done;
540 }
djm@openbsd.org63297642019-01-21 00:47:34 +0000541 if ((r = BN_bin2bn(sig, bnlen, NULL)) == NULL ||
542 (s = BN_bin2bn(sig+bnlen, bnlen, NULL)) == NULL) {
djm@openbsd.org749aef32019-01-20 23:00:12 +0000543 ossl_error("d2i_ECDSA_SIG failed");
544 ECDSA_SIG_free(ret);
545 ret = NULL;
546 goto done;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000547 }
djm@openbsd.org63297642019-01-21 00:47:34 +0000548 if (!ECDSA_SIG_set0(ret, r, s)) {
549 error("%s: ECDSA_SIG_set0 failed", __func__);
550 ECDSA_SIG_free(ret);
551 ret = NULL;
552 goto done;
553 }
554 r = s = NULL; /* now owned by ret */
555 /* success */
djm@openbsd.org93f02102019-01-20 22:51:37 +0000556 done:
djm@openbsd.org63297642019-01-21 00:47:34 +0000557 BN_free(r);
558 BN_free(s);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000559 free(sig);
560
561 return (ret);
562}
563
djm@openbsd.org93f02102019-01-20 22:51:37 +0000564static int
565pkcs11_ecdsa_start_wrapper(void)
566{
567 int (*orig_sign)(int, const unsigned char *, int, unsigned char *,
568 unsigned int *, const BIGNUM *, const BIGNUM *, EC_KEY *) = NULL;
569
570 if (ec_key_method != NULL)
571 return (0);
djm@openbsd.org445cfce2019-01-20 23:05:52 +0000572 ec_key_idx = EC_KEY_get_ex_new_index(0, "ssh-pkcs11-ecdsa",
573 NULL, NULL, pkcs11_k11_free);
574 if (ec_key_idx == -1)
575 return (-1);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000576 ec_key_method = EC_KEY_METHOD_new(EC_KEY_OpenSSL());
577 if (ec_key_method == NULL)
578 return (-1);
579 EC_KEY_METHOD_get_sign(ec_key_method, &orig_sign, NULL, NULL);
580 EC_KEY_METHOD_set_sign(ec_key_method, orig_sign, NULL, ecdsa_do_sign);
581 return (0);
582}
583
584static int
585pkcs11_ecdsa_wrap(struct pkcs11_provider *provider, CK_ULONG slotidx,
586 CK_ATTRIBUTE *keyid_attrib, EC_KEY *ec)
587{
588 struct pkcs11_key *k11;
589
590 if (pkcs11_ecdsa_start_wrapper() == -1)
591 return (-1);
592
593 k11 = xcalloc(1, sizeof(*k11));
594 k11->provider = provider;
595 provider->refcount++; /* provider referenced by ECDSA key */
596 k11->slotidx = slotidx;
597 /* identify key object on smartcard */
598 k11->keyid_len = keyid_attrib->ulValueLen;
599 k11->keyid = xmalloc(k11->keyid_len);
600 memcpy(k11->keyid, keyid_attrib->pValue, k11->keyid_len);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000601
djm@openbsd.orgfcb1b092019-01-20 23:12:35 +0000602 EC_KEY_set_method(ec, ec_key_method);
djm@openbsd.org445cfce2019-01-20 23:05:52 +0000603 EC_KEY_set_ex_data(ec, ec_key_idx, k11);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000604
605 return (0);
606}
Damien Millere2cb4452019-01-21 11:32:28 +1100607#endif /* HAVE_EC_KEY_METHOD_NEW */
djm@openbsd.org93f02102019-01-20 22:51:37 +0000608
Damien Miller7ea845e2010-02-12 09:21:02 +1100609/* remove trailing spaces */
610static void
Damien Miller746d1a62013-07-18 16:13:02 +1000611rmspace(u_char *buf, size_t len)
Damien Miller7ea845e2010-02-12 09:21:02 +1100612{
613 size_t i;
614
615 if (!len)
616 return;
617 for (i = len - 1; i > 0; i--)
618 if (i == len - 1 || buf[i] == ' ')
619 buf[i] = '\0';
620 else
621 break;
622}
623
624/*
625 * open a pkcs11 session and login if required.
626 * if pin == NULL we delay login until key use
627 */
628static int
djm@openbsd.org93f02102019-01-20 22:51:37 +0000629pkcs11_open_session(struct pkcs11_provider *p, CK_ULONG slotidx, char *pin,
630 CK_ULONG user)
Damien Miller7ea845e2010-02-12 09:21:02 +1100631{
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000632 struct pkcs11_slotinfo *si;
Damien Miller7ea845e2010-02-12 09:21:02 +1100633 CK_FUNCTION_LIST *f;
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000634 CK_RV rv;
Damien Miller7ea845e2010-02-12 09:21:02 +1100635 CK_SESSION_HANDLE session;
djm@openbsd.org08468272019-10-01 10:22:53 +0000636 int login_required, ret;
Damien Miller7ea845e2010-02-12 09:21:02 +1100637
638 f = p->function_list;
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000639 si = &p->slotinfo[slotidx];
640
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000641 login_required = si->token.flags & CKF_LOGIN_REQUIRED;
642
643 /* fail early before opening session */
djm@openbsd.org08468272019-10-01 10:22:53 +0000644 if (login_required && !pkcs11_interactive &&
djm@openbsd.org7a7fdca2019-02-04 23:37:54 +0000645 (pin == NULL || strlen(pin) == 0)) {
Damien Miller7ea845e2010-02-12 09:21:02 +1100646 error("pin required");
djm@openbsd.org93f02102019-01-20 22:51:37 +0000647 return (-SSH_PKCS11_ERR_PIN_REQUIRED);
Damien Miller7ea845e2010-02-12 09:21:02 +1100648 }
649 if ((rv = f->C_OpenSession(p->slotlist[slotidx], CKF_RW_SESSION|
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000650 CKF_SERIAL_SESSION, NULL, NULL, &session)) != CKR_OK) {
Damien Miller7ea845e2010-02-12 09:21:02 +1100651 error("C_OpenSession failed: %lu", rv);
652 return (-1);
653 }
djm@openbsd.org08468272019-10-01 10:22:53 +0000654 if (login_required && pin != NULL && strlen(pin) != 0) {
655 rv = f->C_Login(session, user, (u_char *)pin, strlen(pin));
djm@openbsd.orgcb3bde32015-02-02 22:48:53 +0000656 if (rv != CKR_OK && rv != CKR_USER_ALREADY_LOGGED_IN) {
Damien Miller7ea845e2010-02-12 09:21:02 +1100657 error("C_Login failed: %lu", rv);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000658 ret = (rv == CKR_PIN_LOCKED) ?
659 -SSH_PKCS11_ERR_PIN_LOCKED :
660 -SSH_PKCS11_ERR_LOGIN_FAIL;
Damien Miller7ea845e2010-02-12 09:21:02 +1100661 if ((rv = f->C_CloseSession(session)) != CKR_OK)
662 error("C_CloseSession failed: %lu", rv);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000663 return (ret);
Damien Miller7ea845e2010-02-12 09:21:02 +1100664 }
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000665 si->logged_in = 1;
Damien Miller7ea845e2010-02-12 09:21:02 +1100666 }
djm@openbsd.org41923ce2019-01-22 12:03:58 +0000667 si->session = session;
Damien Miller7ea845e2010-02-12 09:21:02 +1100668 return (0);
669}
670
Damien Millerd2252c72013-11-04 07:41:48 +1100671static int
djm@openbsd.org1129dcf2015-01-15 09:40:00 +0000672pkcs11_key_included(struct sshkey ***keysp, int *nkeys, struct sshkey *key)
Damien Millerd2252c72013-11-04 07:41:48 +1100673{
674 int i;
675
676 for (i = 0; i < *nkeys; i++)
djm@openbsd.org1129dcf2015-01-15 09:40:00 +0000677 if (sshkey_equal(key, (*keysp)[i]))
Damien Millerd2252c72013-11-04 07:41:48 +1100678 return (1);
679 return (0);
680}
681
Damien Millere2cb4452019-01-21 11:32:28 +1100682#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +0000683static struct sshkey *
684pkcs11_fetch_ecdsa_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx,
685 CK_OBJECT_HANDLE *obj)
686{
687 CK_ATTRIBUTE key_attr[3];
688 CK_SESSION_HANDLE session;
689 CK_FUNCTION_LIST *f = NULL;
690 CK_RV rv;
djm@openbsd.org24757c12019-01-20 23:01:59 +0000691 ASN1_OCTET_STRING *octet = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000692 EC_KEY *ec = NULL;
693 EC_GROUP *group = NULL;
694 struct sshkey *key = NULL;
695 const unsigned char *attrp = NULL;
696 int i;
697 int nid;
698
699 memset(&key_attr, 0, sizeof(key_attr));
700 key_attr[0].type = CKA_ID;
701 key_attr[1].type = CKA_EC_POINT;
702 key_attr[2].type = CKA_EC_PARAMS;
703
704 session = p->slotinfo[slotidx].session;
705 f = p->function_list;
706
707 /* figure out size of the attributes */
708 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3);
709 if (rv != CKR_OK) {
710 error("C_GetAttributeValue failed: %lu", rv);
711 return (NULL);
712 }
713
714 /*
715 * Allow CKA_ID (always first attribute) to be empty, but
716 * ensure that none of the others are zero length.
717 * XXX assumes CKA_ID is always first.
718 */
719 if (key_attr[1].ulValueLen == 0 ||
720 key_attr[2].ulValueLen == 0) {
721 error("invalid attribute length");
722 return (NULL);
723 }
724
725 /* allocate buffers for attributes */
726 for (i = 0; i < 3; i++)
727 if (key_attr[i].ulValueLen > 0)
728 key_attr[i].pValue = xcalloc(1, key_attr[i].ulValueLen);
729
730 /* retrieve ID, public point and curve parameters of EC key */
731 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3);
732 if (rv != CKR_OK) {
733 error("C_GetAttributeValue failed: %lu", rv);
734 goto fail;
735 }
736
737 ec = EC_KEY_new();
738 if (ec == NULL) {
739 error("EC_KEY_new failed");
740 goto fail;
741 }
742
743 attrp = key_attr[2].pValue;
744 group = d2i_ECPKParameters(NULL, &attrp, key_attr[2].ulValueLen);
745 if (group == NULL) {
746 ossl_error("d2i_ECPKParameters failed");
747 goto fail;
748 }
749
750 if (EC_KEY_set_group(ec, group) == 0) {
751 ossl_error("EC_KEY_set_group failed");
752 goto fail;
753 }
754
755 if (key_attr[1].ulValueLen <= 2) {
756 error("CKA_EC_POINT too small");
757 goto fail;
758 }
759
djm@openbsd.org24757c12019-01-20 23:01:59 +0000760 attrp = key_attr[1].pValue;
761 octet = d2i_ASN1_OCTET_STRING(NULL, &attrp, key_attr[1].ulValueLen);
762 if (octet == NULL) {
763 ossl_error("d2i_ASN1_OCTET_STRING failed");
764 goto fail;
765 }
766 attrp = octet->data;
767 if (o2i_ECPublicKey(&ec, &attrp, octet->length) == NULL) {
768 ossl_error("o2i_ECPublicKey failed");
769 goto fail;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000770 }
771
772 nid = sshkey_ecdsa_key_to_nid(ec);
773 if (nid < 0) {
774 error("couldn't get curve nid");
775 goto fail;
776 }
777
778 if (pkcs11_ecdsa_wrap(p, slotidx, &key_attr[0], ec))
779 goto fail;
780
781 key = sshkey_new(KEY_UNSPEC);
782 if (key == NULL) {
783 error("sshkey_new failed");
784 goto fail;
785 }
786
787 key->ecdsa = ec;
788 key->ecdsa_nid = nid;
789 key->type = KEY_ECDSA;
790 key->flags |= SSHKEY_FLAG_EXT;
791 ec = NULL; /* now owned by key */
792
793fail:
794 for (i = 0; i < 3; i++)
795 free(key_attr[i].pValue);
796 if (ec)
797 EC_KEY_free(ec);
798 if (group)
799 EC_GROUP_free(group);
djm@openbsd.org24757c12019-01-20 23:01:59 +0000800 if (octet)
801 ASN1_OCTET_STRING_free(octet);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000802
803 return (key);
804}
Damien Millere2cb4452019-01-21 11:32:28 +1100805#endif /* HAVE_EC_KEY_METHOD_NEW */
djm@openbsd.org93f02102019-01-20 22:51:37 +0000806
807static struct sshkey *
808pkcs11_fetch_rsa_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx,
809 CK_OBJECT_HANDLE *obj)
810{
811 CK_ATTRIBUTE key_attr[3];
812 CK_SESSION_HANDLE session;
813 CK_FUNCTION_LIST *f = NULL;
814 CK_RV rv;
815 RSA *rsa = NULL;
816 BIGNUM *rsa_n, *rsa_e;
817 struct sshkey *key = NULL;
818 int i;
819
820 memset(&key_attr, 0, sizeof(key_attr));
821 key_attr[0].type = CKA_ID;
822 key_attr[1].type = CKA_MODULUS;
823 key_attr[2].type = CKA_PUBLIC_EXPONENT;
824
825 session = p->slotinfo[slotidx].session;
826 f = p->function_list;
827
828 /* figure out size of the attributes */
829 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3);
830 if (rv != CKR_OK) {
831 error("C_GetAttributeValue failed: %lu", rv);
832 return (NULL);
833 }
834
835 /*
836 * Allow CKA_ID (always first attribute) to be empty, but
837 * ensure that none of the others are zero length.
838 * XXX assumes CKA_ID is always first.
839 */
840 if (key_attr[1].ulValueLen == 0 ||
841 key_attr[2].ulValueLen == 0) {
842 error("invalid attribute length");
843 return (NULL);
844 }
845
846 /* allocate buffers for attributes */
847 for (i = 0; i < 3; i++)
848 if (key_attr[i].ulValueLen > 0)
849 key_attr[i].pValue = xcalloc(1, key_attr[i].ulValueLen);
850
851 /* retrieve ID, modulus and public exponent of RSA key */
852 rv = f->C_GetAttributeValue(session, *obj, key_attr, 3);
853 if (rv != CKR_OK) {
854 error("C_GetAttributeValue failed: %lu", rv);
855 goto fail;
856 }
857
858 rsa = RSA_new();
859 if (rsa == NULL) {
860 error("RSA_new failed");
861 goto fail;
862 }
863
864 rsa_n = BN_bin2bn(key_attr[1].pValue, key_attr[1].ulValueLen, NULL);
865 rsa_e = BN_bin2bn(key_attr[2].pValue, key_attr[2].ulValueLen, NULL);
866 if (rsa_n == NULL || rsa_e == NULL) {
867 error("BN_bin2bn failed");
868 goto fail;
869 }
870 if (!RSA_set0_key(rsa, rsa_n, rsa_e, NULL))
871 fatal("%s: set key", __func__);
872 rsa_n = rsa_e = NULL; /* transferred */
873
874 if (pkcs11_rsa_wrap(p, slotidx, &key_attr[0], rsa))
875 goto fail;
876
877 key = sshkey_new(KEY_UNSPEC);
878 if (key == NULL) {
879 error("sshkey_new failed");
880 goto fail;
881 }
882
883 key->rsa = rsa;
884 key->type = KEY_RSA;
885 key->flags |= SSHKEY_FLAG_EXT;
886 rsa = NULL; /* now owned by key */
887
888fail:
889 for (i = 0; i < 3; i++)
890 free(key_attr[i].pValue);
891 RSA_free(rsa);
892
893 return (key);
894}
895
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000896static int
djm@openbsd.org93f02102019-01-20 22:51:37 +0000897pkcs11_fetch_x509_pubkey(struct pkcs11_provider *p, CK_ULONG slotidx,
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000898 CK_OBJECT_HANDLE *obj, struct sshkey **keyp, char **labelp)
djm@openbsd.org93f02102019-01-20 22:51:37 +0000899{
900 CK_ATTRIBUTE cert_attr[3];
901 CK_SESSION_HANDLE session;
902 CK_FUNCTION_LIST *f = NULL;
903 CK_RV rv;
904 X509 *x509 = NULL;
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000905 X509_NAME *x509_name = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000906 EVP_PKEY *evp;
907 RSA *rsa = NULL;
Darren Tucker97370f62019-05-17 10:54:51 +1000908#ifdef OPENSSL_HAS_ECC
djm@openbsd.org93f02102019-01-20 22:51:37 +0000909 EC_KEY *ec = NULL;
Darren Tucker97370f62019-05-17 10:54:51 +1000910#endif
djm@openbsd.org93f02102019-01-20 22:51:37 +0000911 struct sshkey *key = NULL;
912 int i;
Damien Millere2cb4452019-01-21 11:32:28 +1100913#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +0000914 int nid;
Damien Millere2cb4452019-01-21 11:32:28 +1100915#endif
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000916 const u_char *cp;
917 char *subject = NULL;
918
919 *keyp = NULL;
920 *labelp = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000921
922 memset(&cert_attr, 0, sizeof(cert_attr));
923 cert_attr[0].type = CKA_ID;
924 cert_attr[1].type = CKA_SUBJECT;
925 cert_attr[2].type = CKA_VALUE;
926
927 session = p->slotinfo[slotidx].session;
928 f = p->function_list;
929
930 /* figure out size of the attributes */
931 rv = f->C_GetAttributeValue(session, *obj, cert_attr, 3);
932 if (rv != CKR_OK) {
933 error("C_GetAttributeValue failed: %lu", rv);
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000934 return -1;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000935 }
936
937 /*
938 * Allow CKA_ID (always first attribute) to be empty, but
939 * ensure that none of the others are zero length.
940 * XXX assumes CKA_ID is always first.
941 */
942 if (cert_attr[1].ulValueLen == 0 ||
943 cert_attr[2].ulValueLen == 0) {
944 error("invalid attribute length");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000945 return -1;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000946 }
947
948 /* allocate buffers for attributes */
949 for (i = 0; i < 3; i++)
950 if (cert_attr[i].ulValueLen > 0)
951 cert_attr[i].pValue = xcalloc(1, cert_attr[i].ulValueLen);
952
953 /* retrieve ID, subject and value of certificate */
954 rv = f->C_GetAttributeValue(session, *obj, cert_attr, 3);
955 if (rv != CKR_OK) {
956 error("C_GetAttributeValue failed: %lu", rv);
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000957 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000958 }
959
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000960 /* Decode DER-encoded cert subject */
961 cp = cert_attr[2].pValue;
962 if ((x509_name = d2i_X509_NAME(NULL, &cp,
963 cert_attr[1].ulValueLen)) == NULL ||
964 (subject = X509_NAME_oneline(x509_name, NULL, 0)) == NULL)
965 subject = xstrdup("invalid subject");
966 X509_NAME_free(x509_name);
djm@openbsd.org93f02102019-01-20 22:51:37 +0000967
968 cp = cert_attr[2].pValue;
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000969 if ((x509 = d2i_X509(NULL, &cp, cert_attr[2].ulValueLen)) == NULL) {
djm@openbsd.org93f02102019-01-20 22:51:37 +0000970 error("d2i_x509 failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000971 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000972 }
973
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000974 if ((evp = X509_get_pubkey(x509)) == NULL) {
djm@openbsd.org93f02102019-01-20 22:51:37 +0000975 error("X509_get_pubkey failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000976 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000977 }
978
979 if (EVP_PKEY_base_id(evp) == EVP_PKEY_RSA) {
980 if (EVP_PKEY_get0_RSA(evp) == NULL) {
981 error("invalid x509; no rsa key");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000982 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000983 }
984 if ((rsa = RSAPublicKey_dup(EVP_PKEY_get0_RSA(evp))) == NULL) {
985 error("RSAPublicKey_dup failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000986 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000987 }
988
989 if (pkcs11_rsa_wrap(p, slotidx, &cert_attr[0], rsa))
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000990 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000991
992 key = sshkey_new(KEY_UNSPEC);
993 if (key == NULL) {
994 error("sshkey_new failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +0000995 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +0000996 }
997
998 key->rsa = rsa;
999 key->type = KEY_RSA;
1000 key->flags |= SSHKEY_FLAG_EXT;
1001 rsa = NULL; /* now owned by key */
Damien Millere2cb4452019-01-21 11:32:28 +11001002#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +00001003 } else if (EVP_PKEY_base_id(evp) == EVP_PKEY_EC) {
djm@openbsd.org8a246752019-01-20 23:03:26 +00001004 if (EVP_PKEY_get0_EC_KEY(evp) == NULL) {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001005 error("invalid x509; no ec key");
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001006 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001007 }
djm@openbsd.org8a246752019-01-20 23:03:26 +00001008 if ((ec = EC_KEY_dup(EVP_PKEY_get0_EC_KEY(evp))) == NULL) {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001009 error("EC_KEY_dup failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001010 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001011 }
1012
1013 nid = sshkey_ecdsa_key_to_nid(ec);
1014 if (nid < 0) {
1015 error("couldn't get curve nid");
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001016 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001017 }
1018
1019 if (pkcs11_ecdsa_wrap(p, slotidx, &cert_attr[0], ec))
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001020 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001021
1022 key = sshkey_new(KEY_UNSPEC);
1023 if (key == NULL) {
1024 error("sshkey_new failed");
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001025 goto out;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001026 }
1027
1028 key->ecdsa = ec;
1029 key->ecdsa_nid = nid;
1030 key->type = KEY_ECDSA;
1031 key->flags |= SSHKEY_FLAG_EXT;
1032 ec = NULL; /* now owned by key */
Damien Millere2cb4452019-01-21 11:32:28 +11001033#endif /* HAVE_EC_KEY_METHOD_NEW */
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001034 } else {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001035 error("unknown certificate key type");
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001036 goto out;
1037 }
1038 out:
djm@openbsd.org93f02102019-01-20 22:51:37 +00001039 for (i = 0; i < 3; i++)
1040 free(cert_attr[i].pValue);
1041 X509_free(x509);
1042 RSA_free(rsa);
Darren Tucker97370f62019-05-17 10:54:51 +10001043#ifdef OPENSSL_HAS_ECC
djm@openbsd.org93f02102019-01-20 22:51:37 +00001044 EC_KEY_free(ec);
Darren Tucker97370f62019-05-17 10:54:51 +10001045#endif
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001046 if (key == NULL) {
1047 free(subject);
1048 return -1;
1049 }
1050 /* success */
1051 *keyp = key;
1052 *labelp = subject;
1053 return 0;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001054}
1055
1056#if 0
Damien Millerd2252c72013-11-04 07:41:48 +11001057static int
djm@openbsd.org482d23b2018-09-13 02:08:33 +00001058have_rsa_key(const RSA *rsa)
1059{
1060 const BIGNUM *rsa_n, *rsa_e;
1061
1062 RSA_get0_key(rsa, &rsa_n, &rsa_e, NULL);
1063 return rsa_n != NULL && rsa_e != NULL;
1064}
djm@openbsd.org93f02102019-01-20 22:51:37 +00001065#endif
djm@openbsd.org482d23b2018-09-13 02:08:33 +00001066
djm@openbsd.org93f02102019-01-20 22:51:37 +00001067/*
1068 * lookup certificates for token in slot identified by slotidx,
1069 * add 'wrapped' public keys to the 'keysp' array and increment nkeys.
1070 * keysp points to an (possibly empty) array with *nkeys keys.
1071 */
djm@openbsd.org482d23b2018-09-13 02:08:33 +00001072static int
djm@openbsd.org93f02102019-01-20 22:51:37 +00001073pkcs11_fetch_certs(struct pkcs11_provider *p, CK_ULONG slotidx,
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001074 struct sshkey ***keysp, char ***labelsp, int *nkeys)
Damien Miller7ea845e2010-02-12 09:21:02 +11001075{
djm@openbsd.org93f02102019-01-20 22:51:37 +00001076 struct sshkey *key = NULL;
1077 CK_OBJECT_CLASS key_class;
1078 CK_ATTRIBUTE key_attr[1];
1079 CK_SESSION_HANDLE session;
1080 CK_FUNCTION_LIST *f = NULL;
1081 CK_RV rv;
1082 CK_OBJECT_HANDLE obj;
1083 CK_ULONG n = 0;
1084 int ret = -1;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001085 char *label;
Tim Rice179eee02010-03-04 12:48:05 -08001086
djm@openbsd.org93f02102019-01-20 22:51:37 +00001087 memset(&key_attr, 0, sizeof(key_attr));
1088 memset(&obj, 0, sizeof(obj));
1089
1090 key_class = CKO_CERTIFICATE;
1091 key_attr[0].type = CKA_CLASS;
1092 key_attr[0].pValue = &key_class;
1093 key_attr[0].ulValueLen = sizeof(key_class);
1094
Damien Miller7ea845e2010-02-12 09:21:02 +11001095 session = p->slotinfo[slotidx].session;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001096 f = p->function_list;
1097
1098 rv = f->C_FindObjectsInit(session, key_attr, 1);
1099 if (rv != CKR_OK) {
Damien Miller7ea845e2010-02-12 09:21:02 +11001100 error("C_FindObjectsInit failed: %lu", rv);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001101 goto fail;
Damien Miller7ea845e2010-02-12 09:21:02 +11001102 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001103
Damien Miller7ea845e2010-02-12 09:21:02 +11001104 while (1) {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001105 CK_CERTIFICATE_TYPE ck_cert_type;
1106
1107 rv = f->C_FindObjects(session, &obj, 1, &n);
1108 if (rv != CKR_OK) {
1109 error("C_FindObjects failed: %lu", rv);
1110 goto fail;
Damien Miller7ea845e2010-02-12 09:21:02 +11001111 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001112 if (n == 0)
Damien Miller7ea845e2010-02-12 09:21:02 +11001113 break;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001114
1115 memset(&ck_cert_type, 0, sizeof(ck_cert_type));
1116 memset(&key_attr, 0, sizeof(key_attr));
1117 key_attr[0].type = CKA_CERTIFICATE_TYPE;
1118 key_attr[0].pValue = &ck_cert_type;
1119 key_attr[0].ulValueLen = sizeof(ck_cert_type);
1120
1121 rv = f->C_GetAttributeValue(session, obj, key_attr, 1);
1122 if (rv != CKR_OK) {
Damien Miller7ea845e2010-02-12 09:21:02 +11001123 error("C_GetAttributeValue failed: %lu", rv);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001124 goto fail;
djm@openbsd.org63ebcd02015-07-18 08:02:17 +00001125 }
1126
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001127 key = NULL;
1128 label = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001129 switch (ck_cert_type) {
1130 case CKC_X_509:
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001131 if (pkcs11_fetch_x509_pubkey(p, slotidx, &obj,
1132 &key, &label) != 0) {
1133 error("failed to fetch key");
1134 continue;
1135 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001136 break;
1137 default:
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001138 error("skipping unsupported certificate type %lu",
1139 ck_cert_type);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001140 continue;
1141 }
1142
1143 if (pkcs11_key_included(keysp, nkeys, key)) {
1144 sshkey_free(key);
Damien Miller7ea845e2010-02-12 09:21:02 +11001145 } else {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001146 /* expand key array and add key */
1147 *keysp = xrecallocarray(*keysp, *nkeys,
1148 *nkeys + 1, sizeof(struct sshkey *));
1149 (*keysp)[*nkeys] = key;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001150 if (labelsp != NULL) {
1151 *labelsp = xrecallocarray(*labelsp, *nkeys,
1152 *nkeys + 1, sizeof(char *));
1153 (*labelsp)[*nkeys] = xstrdup((char *)label);
1154 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001155 *nkeys = *nkeys + 1;
1156 debug("have %d keys", *nkeys);
Damien Millerd2252c72013-11-04 07:41:48 +11001157 }
Damien Miller7ea845e2010-02-12 09:21:02 +11001158 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001159
1160 ret = 0;
1161fail:
1162 rv = f->C_FindObjectsFinal(session);
1163 if (rv != CKR_OK) {
Damien Miller7ea845e2010-02-12 09:21:02 +11001164 error("C_FindObjectsFinal failed: %lu", rv);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001165 ret = -1;
1166 }
1167
1168 return (ret);
Damien Miller7ea845e2010-02-12 09:21:02 +11001169}
1170
djm@openbsd.org93f02102019-01-20 22:51:37 +00001171/*
1172 * lookup public keys for token in slot identified by slotidx,
1173 * add 'wrapped' public keys to the 'keysp' array and increment nkeys.
1174 * keysp points to an (possibly empty) array with *nkeys keys.
1175 */
1176static int
1177pkcs11_fetch_keys(struct pkcs11_provider *p, CK_ULONG slotidx,
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001178 struct sshkey ***keysp, char ***labelsp, int *nkeys)
djm@openbsd.org93f02102019-01-20 22:51:37 +00001179{
1180 struct sshkey *key = NULL;
1181 CK_OBJECT_CLASS key_class;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001182 CK_ATTRIBUTE key_attr[2];
djm@openbsd.org93f02102019-01-20 22:51:37 +00001183 CK_SESSION_HANDLE session;
1184 CK_FUNCTION_LIST *f = NULL;
1185 CK_RV rv;
1186 CK_OBJECT_HANDLE obj;
1187 CK_ULONG n = 0;
1188 int ret = -1;
1189
1190 memset(&key_attr, 0, sizeof(key_attr));
1191 memset(&obj, 0, sizeof(obj));
1192
1193 key_class = CKO_PUBLIC_KEY;
1194 key_attr[0].type = CKA_CLASS;
1195 key_attr[0].pValue = &key_class;
1196 key_attr[0].ulValueLen = sizeof(key_class);
1197
1198 session = p->slotinfo[slotidx].session;
1199 f = p->function_list;
1200
1201 rv = f->C_FindObjectsInit(session, key_attr, 1);
1202 if (rv != CKR_OK) {
1203 error("C_FindObjectsInit failed: %lu", rv);
1204 goto fail;
1205 }
1206
1207 while (1) {
1208 CK_KEY_TYPE ck_key_type;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001209 CK_UTF8CHAR label[256];
djm@openbsd.org93f02102019-01-20 22:51:37 +00001210
1211 rv = f->C_FindObjects(session, &obj, 1, &n);
1212 if (rv != CKR_OK) {
1213 error("C_FindObjects failed: %lu", rv);
1214 goto fail;
1215 }
1216 if (n == 0)
1217 break;
1218
1219 memset(&ck_key_type, 0, sizeof(ck_key_type));
1220 memset(&key_attr, 0, sizeof(key_attr));
1221 key_attr[0].type = CKA_KEY_TYPE;
1222 key_attr[0].pValue = &ck_key_type;
1223 key_attr[0].ulValueLen = sizeof(ck_key_type);
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001224 key_attr[1].type = CKA_LABEL;
1225 key_attr[1].pValue = &label;
1226 key_attr[1].ulValueLen = sizeof(label) - 1;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001227
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001228 rv = f->C_GetAttributeValue(session, obj, key_attr, 2);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001229 if (rv != CKR_OK) {
1230 error("C_GetAttributeValue failed: %lu", rv);
1231 goto fail;
1232 }
1233
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001234 label[key_attr[1].ulValueLen] = '\0';
1235
djm@openbsd.org93f02102019-01-20 22:51:37 +00001236 switch (ck_key_type) {
1237 case CKK_RSA:
1238 key = pkcs11_fetch_rsa_pubkey(p, slotidx, &obj);
1239 break;
Damien Millere2cb4452019-01-21 11:32:28 +11001240#ifdef HAVE_EC_KEY_METHOD_NEW
djm@openbsd.org93f02102019-01-20 22:51:37 +00001241 case CKK_ECDSA:
1242 key = pkcs11_fetch_ecdsa_pubkey(p, slotidx, &obj);
1243 break;
Damien Millere2cb4452019-01-21 11:32:28 +11001244#endif /* HAVE_EC_KEY_METHOD_NEW */
djm@openbsd.org93f02102019-01-20 22:51:37 +00001245 default:
1246 /* XXX print key type? */
markus@openbsd.org2aee9a42019-03-08 17:24:43 +00001247 key = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001248 error("skipping unsupported key type");
1249 }
1250
1251 if (key == NULL) {
1252 error("failed to fetch key");
1253 continue;
1254 }
1255
1256 if (pkcs11_key_included(keysp, nkeys, key)) {
1257 sshkey_free(key);
1258 } else {
1259 /* expand key array and add key */
1260 *keysp = xrecallocarray(*keysp, *nkeys,
1261 *nkeys + 1, sizeof(struct sshkey *));
1262 (*keysp)[*nkeys] = key;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001263 if (labelsp != NULL) {
1264 *labelsp = xrecallocarray(*labelsp, *nkeys,
1265 *nkeys + 1, sizeof(char *));
1266 (*labelsp)[*nkeys] = xstrdup((char *)label);
1267 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001268 *nkeys = *nkeys + 1;
1269 debug("have %d keys", *nkeys);
1270 }
1271 }
1272
1273 ret = 0;
1274fail:
1275 rv = f->C_FindObjectsFinal(session);
1276 if (rv != CKR_OK) {
1277 error("C_FindObjectsFinal failed: %lu", rv);
1278 ret = -1;
1279 }
1280
1281 return (ret);
1282}
1283
1284#ifdef WITH_PKCS11_KEYGEN
1285#define FILL_ATTR(attr, idx, typ, val, len) \
1286 { (attr[idx]).type=(typ); (attr[idx]).pValue=(val); (attr[idx]).ulValueLen=len; idx++; }
1287
1288static struct sshkey *
1289pkcs11_rsa_generate_private_key(struct pkcs11_provider *p, CK_ULONG slotidx,
1290 char *label, CK_ULONG bits, CK_BYTE keyid, u_int32_t *err)
1291{
1292 struct pkcs11_slotinfo *si;
1293 char *plabel = label ? label : "";
1294 int npub = 0, npriv = 0;
1295 CK_RV rv;
1296 CK_FUNCTION_LIST *f;
1297 CK_SESSION_HANDLE session;
1298 CK_BBOOL true_val = CK_TRUE, false_val = CK_FALSE;
1299 CK_OBJECT_HANDLE pubKey, privKey;
1300 CK_ATTRIBUTE tpub[16], tpriv[16];
1301 CK_MECHANISM mech = {
1302 CKM_RSA_PKCS_KEY_PAIR_GEN, NULL_PTR, 0
1303 };
1304 CK_BYTE pubExponent[] = {
1305 0x01, 0x00, 0x01 /* RSA_F4 in bytes */
1306 };
1307 pubkey_filter[0].pValue = &pubkey_class;
1308 cert_filter[0].pValue = &cert_class;
1309
1310 *err = 0;
1311
1312 FILL_ATTR(tpub, npub, CKA_TOKEN, &true_val, sizeof(true_val));
1313 FILL_ATTR(tpub, npub, CKA_LABEL, plabel, strlen(plabel));
1314 FILL_ATTR(tpub, npub, CKA_ENCRYPT, &false_val, sizeof(false_val));
1315 FILL_ATTR(tpub, npub, CKA_VERIFY, &true_val, sizeof(true_val));
1316 FILL_ATTR(tpub, npub, CKA_VERIFY_RECOVER, &false_val,
1317 sizeof(false_val));
1318 FILL_ATTR(tpub, npub, CKA_WRAP, &false_val, sizeof(false_val));
1319 FILL_ATTR(tpub, npub, CKA_DERIVE, &false_val, sizeof(false_val));
1320 FILL_ATTR(tpub, npub, CKA_MODULUS_BITS, &bits, sizeof(bits));
1321 FILL_ATTR(tpub, npub, CKA_PUBLIC_EXPONENT, pubExponent,
1322 sizeof(pubExponent));
1323 FILL_ATTR(tpub, npub, CKA_ID, &keyid, sizeof(keyid));
1324
1325 FILL_ATTR(tpriv, npriv, CKA_TOKEN, &true_val, sizeof(true_val));
1326 FILL_ATTR(tpriv, npriv, CKA_LABEL, plabel, strlen(plabel));
1327 FILL_ATTR(tpriv, npriv, CKA_PRIVATE, &true_val, sizeof(true_val));
1328 FILL_ATTR(tpriv, npriv, CKA_SENSITIVE, &true_val, sizeof(true_val));
1329 FILL_ATTR(tpriv, npriv, CKA_DECRYPT, &false_val, sizeof(false_val));
1330 FILL_ATTR(tpriv, npriv, CKA_SIGN, &true_val, sizeof(true_val));
1331 FILL_ATTR(tpriv, npriv, CKA_SIGN_RECOVER, &false_val,
1332 sizeof(false_val));
1333 FILL_ATTR(tpriv, npriv, CKA_UNWRAP, &false_val, sizeof(false_val));
1334 FILL_ATTR(tpriv, npriv, CKA_DERIVE, &false_val, sizeof(false_val));
1335 FILL_ATTR(tpriv, npriv, CKA_ID, &keyid, sizeof(keyid));
1336
1337 f = p->function_list;
1338 si = &p->slotinfo[slotidx];
1339 session = si->session;
1340
1341 if ((rv = f->C_GenerateKeyPair(session, &mech, tpub, npub, tpriv, npriv,
1342 &pubKey, &privKey)) != CKR_OK) {
1343 error("%s: key generation failed: error 0x%lx", __func__, rv);
1344 *err = rv;
1345 return NULL;
1346 }
1347
1348 return pkcs11_fetch_rsa_pubkey(p, slotidx, &pubKey);
1349}
1350
1351static int
1352pkcs11_decode_hex(const char *hex, unsigned char **dest, size_t *rlen)
1353{
1354 size_t i, len;
1355 char ptr[3];
1356
1357 if (dest)
1358 *dest = NULL;
1359 if (rlen)
1360 *rlen = 0;
1361
1362 if ((len = strlen(hex)) % 2)
1363 return -1;
1364 len /= 2;
1365
1366 *dest = xmalloc(len);
1367
1368 ptr[2] = '\0';
1369 for (i = 0; i < len; i++) {
1370 ptr[0] = hex[2 * i];
1371 ptr[1] = hex[(2 * i) + 1];
1372 if (!isxdigit(ptr[0]) || !isxdigit(ptr[1]))
1373 return -1;
1374 (*dest)[i] = (unsigned char)strtoul(ptr, NULL, 16);
1375 }
1376
1377 if (rlen)
1378 *rlen = len;
1379
1380 return 0;
1381}
1382
1383static struct ec_curve_info {
1384 const char *name;
1385 const char *oid;
1386 const char *oid_encoded;
1387 size_t size;
1388} ec_curve_infos[] = {
1389 {"prime256v1", "1.2.840.10045.3.1.7", "06082A8648CE3D030107", 256},
1390 {"secp384r1", "1.3.132.0.34", "06052B81040022", 384},
1391 {"secp521r1", "1.3.132.0.35", "06052B81040023", 521},
djm@openbsd.org65294092019-01-20 23:11:11 +00001392 {NULL, NULL, NULL, 0},
djm@openbsd.org93f02102019-01-20 22:51:37 +00001393};
1394
1395static struct sshkey *
1396pkcs11_ecdsa_generate_private_key(struct pkcs11_provider *p, CK_ULONG slotidx,
1397 char *label, CK_ULONG bits, CK_BYTE keyid, u_int32_t *err)
1398{
1399 struct pkcs11_slotinfo *si;
1400 char *plabel = label ? label : "";
1401 int i;
1402 size_t ecparams_size;
1403 unsigned char *ecparams = NULL;
1404 int npub = 0, npriv = 0;
1405 CK_RV rv;
1406 CK_FUNCTION_LIST *f;
1407 CK_SESSION_HANDLE session;
1408 CK_BBOOL true_val = CK_TRUE, false_val = CK_FALSE;
1409 CK_OBJECT_HANDLE pubKey, privKey;
1410 CK_MECHANISM mech = {
1411 CKM_EC_KEY_PAIR_GEN, NULL_PTR, 0
1412 };
1413 CK_ATTRIBUTE tpub[16], tpriv[16];
1414
1415 *err = 0;
1416
1417 for (i = 0; ec_curve_infos[i].name; i++) {
1418 if (ec_curve_infos[i].size == bits)
1419 break;
1420 }
1421 if (!ec_curve_infos[i].name) {
1422 error("%s: invalid key size %lu", __func__, bits);
1423 return NULL;
1424 }
1425 if (pkcs11_decode_hex(ec_curve_infos[i].oid_encoded, &ecparams,
1426 &ecparams_size) == -1) {
1427 error("%s: invalid oid", __func__);
1428 return NULL;
1429 }
1430
1431 FILL_ATTR(tpub, npub, CKA_TOKEN, &true_val, sizeof(true_val));
1432 FILL_ATTR(tpub, npub, CKA_LABEL, plabel, strlen(plabel));
1433 FILL_ATTR(tpub, npub, CKA_ENCRYPT, &false_val, sizeof(false_val));
1434 FILL_ATTR(tpub, npub, CKA_VERIFY, &true_val, sizeof(true_val));
1435 FILL_ATTR(tpub, npub, CKA_VERIFY_RECOVER, &false_val,
1436 sizeof(false_val));
1437 FILL_ATTR(tpub, npub, CKA_WRAP, &false_val, sizeof(false_val));
1438 FILL_ATTR(tpub, npub, CKA_DERIVE, &false_val, sizeof(false_val));
1439 FILL_ATTR(tpub, npub, CKA_EC_PARAMS, ecparams, ecparams_size);
1440 FILL_ATTR(tpub, npub, CKA_ID, &keyid, sizeof(keyid));
1441
1442 FILL_ATTR(tpriv, npriv, CKA_TOKEN, &true_val, sizeof(true_val));
1443 FILL_ATTR(tpriv, npriv, CKA_LABEL, plabel, strlen(plabel));
1444 FILL_ATTR(tpriv, npriv, CKA_PRIVATE, &true_val, sizeof(true_val));
1445 FILL_ATTR(tpriv, npriv, CKA_SENSITIVE, &true_val, sizeof(true_val));
1446 FILL_ATTR(tpriv, npriv, CKA_DECRYPT, &false_val, sizeof(false_val));
1447 FILL_ATTR(tpriv, npriv, CKA_SIGN, &true_val, sizeof(true_val));
1448 FILL_ATTR(tpriv, npriv, CKA_SIGN_RECOVER, &false_val,
1449 sizeof(false_val));
1450 FILL_ATTR(tpriv, npriv, CKA_UNWRAP, &false_val, sizeof(false_val));
1451 FILL_ATTR(tpriv, npriv, CKA_DERIVE, &false_val, sizeof(false_val));
1452 FILL_ATTR(tpriv, npriv, CKA_ID, &keyid, sizeof(keyid));
1453
1454 f = p->function_list;
1455 si = &p->slotinfo[slotidx];
1456 session = si->session;
1457
1458 if ((rv = f->C_GenerateKeyPair(session, &mech, tpub, npub, tpriv, npriv,
1459 &pubKey, &privKey)) != CKR_OK) {
1460 error("%s: key generation failed: error 0x%lx", __func__, rv);
1461 *err = rv;
1462 return NULL;
1463 }
1464
1465 return pkcs11_fetch_ecdsa_pubkey(p, slotidx, &pubKey);
1466}
1467#endif /* WITH_PKCS11_KEYGEN */
1468
1469/*
1470 * register a new provider, fails if provider already exists. if
1471 * keyp is provided, fetch keys.
1472 */
1473static int
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001474pkcs11_register_provider(char *provider_id, char *pin,
1475 struct sshkey ***keyp, char ***labelsp,
djm@openbsd.org93f02102019-01-20 22:51:37 +00001476 struct pkcs11_provider **providerp, CK_ULONG user)
Damien Miller7ea845e2010-02-12 09:21:02 +11001477{
1478 int nkeys, need_finalize = 0;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001479 int ret = -1;
Damien Miller7ea845e2010-02-12 09:21:02 +11001480 struct pkcs11_provider *p = NULL;
1481 void *handle = NULL;
1482 CK_RV (*getfunctionlist)(CK_FUNCTION_LIST **);
1483 CK_RV rv;
1484 CK_FUNCTION_LIST *f = NULL;
1485 CK_TOKEN_INFO *token;
1486 CK_ULONG i;
1487
djm@openbsd.org93f02102019-01-20 22:51:37 +00001488 if (providerp == NULL)
1489 goto fail;
1490 *providerp = NULL;
1491
1492 if (keyp != NULL)
1493 *keyp = NULL;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001494 if (labelsp != NULL)
1495 *labelsp = NULL;
djm@openbsd.org93f02102019-01-20 22:51:37 +00001496
Damien Miller7ea845e2010-02-12 09:21:02 +11001497 if (pkcs11_provider_lookup(provider_id) != NULL) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001498 debug("%s: provider already registered: %s",
1499 __func__, provider_id);
Damien Miller7ea845e2010-02-12 09:21:02 +11001500 goto fail;
1501 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001502 /* open shared pkcs11-library */
Damien Miller7ea845e2010-02-12 09:21:02 +11001503 if ((handle = dlopen(provider_id, RTLD_NOW)) == NULL) {
1504 error("dlopen %s failed: %s", provider_id, dlerror());
1505 goto fail;
1506 }
1507 if ((getfunctionlist = dlsym(handle, "C_GetFunctionList")) == NULL) {
1508 error("dlsym(C_GetFunctionList) failed: %s", dlerror());
1509 goto fail;
1510 }
1511 p = xcalloc(1, sizeof(*p));
1512 p->name = xstrdup(provider_id);
1513 p->handle = handle;
1514 /* setup the pkcs11 callbacks */
1515 if ((rv = (*getfunctionlist)(&f)) != CKR_OK) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001516 error("C_GetFunctionList for provider %s failed: %lu",
1517 provider_id, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001518 goto fail;
1519 }
1520 p->function_list = f;
1521 if ((rv = f->C_Initialize(NULL)) != CKR_OK) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001522 error("C_Initialize for provider %s failed: %lu",
1523 provider_id, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001524 goto fail;
1525 }
1526 need_finalize = 1;
1527 if ((rv = f->C_GetInfo(&p->info)) != CKR_OK) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001528 error("C_GetInfo for provider %s failed: %lu",
1529 provider_id, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001530 goto fail;
1531 }
1532 rmspace(p->info.manufacturerID, sizeof(p->info.manufacturerID));
1533 rmspace(p->info.libraryDescription, sizeof(p->info.libraryDescription));
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001534 debug("provider %s: manufacturerID <%s> cryptokiVersion %d.%d"
Damien Miller7ea845e2010-02-12 09:21:02 +11001535 " libraryDescription <%s> libraryVersion %d.%d",
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001536 provider_id,
Damien Miller7ea845e2010-02-12 09:21:02 +11001537 p->info.manufacturerID,
1538 p->info.cryptokiVersion.major,
1539 p->info.cryptokiVersion.minor,
1540 p->info.libraryDescription,
1541 p->info.libraryVersion.major,
1542 p->info.libraryVersion.minor);
1543 if ((rv = f->C_GetSlotList(CK_TRUE, NULL, &p->nslots)) != CKR_OK) {
1544 error("C_GetSlotList failed: %lu", rv);
1545 goto fail;
1546 }
1547 if (p->nslots == 0) {
djm@openbsd.orgb52c0c22019-09-02 00:19:25 +00001548 debug("%s: provider %s returned no slots", __func__,
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001549 provider_id);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001550 ret = -SSH_PKCS11_ERR_NO_SLOTS;
Damien Miller7ea845e2010-02-12 09:21:02 +11001551 goto fail;
1552 }
1553 p->slotlist = xcalloc(p->nslots, sizeof(CK_SLOT_ID));
1554 if ((rv = f->C_GetSlotList(CK_TRUE, p->slotlist, &p->nslots))
1555 != CKR_OK) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001556 error("C_GetSlotList for provider %s failed: %lu",
1557 provider_id, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001558 goto fail;
1559 }
1560 p->slotinfo = xcalloc(p->nslots, sizeof(struct pkcs11_slotinfo));
1561 p->valid = 1;
1562 nkeys = 0;
1563 for (i = 0; i < p->nslots; i++) {
1564 token = &p->slotinfo[i].token;
1565 if ((rv = f->C_GetTokenInfo(p->slotlist[i], token))
1566 != CKR_OK) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001567 error("C_GetTokenInfo for provider %s slot %lu "
1568 "failed: %lu", provider_id, (unsigned long)i, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001569 continue;
1570 }
djm@openbsd.orgb15fd982015-07-18 08:00:21 +00001571 if ((token->flags & CKF_TOKEN_INITIALIZED) == 0) {
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001572 debug2("%s: ignoring uninitialised token in "
1573 "provider %s slot %lu", __func__,
1574 provider_id, (unsigned long)i);
djm@openbsd.orgb15fd982015-07-18 08:00:21 +00001575 continue;
1576 }
Damien Miller7ea845e2010-02-12 09:21:02 +11001577 rmspace(token->label, sizeof(token->label));
1578 rmspace(token->manufacturerID, sizeof(token->manufacturerID));
1579 rmspace(token->model, sizeof(token->model));
1580 rmspace(token->serialNumber, sizeof(token->serialNumber));
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001581 debug("provider %s slot %lu: label <%s> manufacturerID <%s> "
1582 "model <%s> serial <%s> flags 0x%lx",
1583 provider_id, (unsigned long)i,
Damien Miller7ea845e2010-02-12 09:21:02 +11001584 token->label, token->manufacturerID, token->model,
1585 token->serialNumber, token->flags);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001586 /*
1587 * open session, login with pin and retrieve public
1588 * keys (if keyp is provided)
1589 */
djm@openbsd.org7d6034b2019-09-05 10:05:51 +00001590 if ((ret = pkcs11_open_session(p, i, pin, user)) != 0 ||
1591 keyp == NULL)
1592 continue;
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001593 pkcs11_fetch_keys(p, i, keyp, labelsp, &nkeys);
1594 pkcs11_fetch_certs(p, i, keyp, labelsp, &nkeys);
djm@openbsd.org7d6034b2019-09-05 10:05:51 +00001595 if (nkeys == 0 && !p->slotinfo[i].logged_in &&
1596 pkcs11_interactive) {
1597 /*
1598 * Some tokens require login before they will
1599 * expose keys.
1600 */
1601 if (pkcs11_login_slot(p, &p->slotinfo[i],
1602 CKU_USER) < 0) {
1603 error("login failed");
djm@openbsd.org93f02102019-01-20 22:51:37 +00001604 continue;
djm@openbsd.org7d6034b2019-09-05 10:05:51 +00001605 }
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001606 pkcs11_fetch_keys(p, i, keyp, labelsp, &nkeys);
1607 pkcs11_fetch_certs(p, i, keyp, labelsp, &nkeys);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001608 }
Damien Miller7ea845e2010-02-12 09:21:02 +11001609 }
djm@openbsd.org93f02102019-01-20 22:51:37 +00001610
1611 /* now owned by caller */
1612 *providerp = p;
1613
1614 TAILQ_INSERT_TAIL(&pkcs11_providers, p, next);
1615 p->refcount++; /* add to provider list */
1616
1617 return (nkeys);
Damien Miller7ea845e2010-02-12 09:21:02 +11001618fail:
1619 if (need_finalize && (rv = f->C_Finalize(NULL)) != CKR_OK)
djm@openbsd.orgefb494e2016-10-28 03:33:52 +00001620 error("C_Finalize for provider %s failed: %lu",
1621 provider_id, rv);
Damien Miller7ea845e2010-02-12 09:21:02 +11001622 if (p) {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001623 free(p->name);
Darren Tuckera627d422013-06-02 07:31:17 +10001624 free(p->slotlist);
1625 free(p->slotinfo);
1626 free(p);
Damien Miller7ea845e2010-02-12 09:21:02 +11001627 }
1628 if (handle)
1629 dlclose(handle);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001630 return (ret);
Damien Miller7ea845e2010-02-12 09:21:02 +11001631}
Damien Millerdfa41562010-02-12 10:06:28 +11001632
djm@openbsd.org93f02102019-01-20 22:51:37 +00001633/*
1634 * register a new provider and get number of keys hold by the token,
1635 * fails if provider already exists
1636 */
1637int
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001638pkcs11_add_provider(char *provider_id, char *pin, struct sshkey ***keyp,
1639 char ***labelsp)
djm@openbsd.org93f02102019-01-20 22:51:37 +00001640{
1641 struct pkcs11_provider *p = NULL;
1642 int nkeys;
Darren Tucker0dd24e02011-09-04 19:59:26 +10001643
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001644 nkeys = pkcs11_register_provider(provider_id, pin, keyp, labelsp,
1645 &p, CKU_USER);
djm@openbsd.org93f02102019-01-20 22:51:37 +00001646
1647 /* no keys found or some other error, de-register provider */
1648 if (nkeys <= 0 && p != NULL) {
1649 TAILQ_REMOVE(&pkcs11_providers, p, next);
1650 pkcs11_provider_finalize(p);
1651 pkcs11_provider_unref(p);
1652 }
1653 if (nkeys == 0)
1654 debug("%s: provider %s returned no keys", __func__,
1655 provider_id);
1656
1657 return (nkeys);
1658}
1659
1660#ifdef WITH_PKCS11_KEYGEN
1661struct sshkey *
1662pkcs11_gakp(char *provider_id, char *pin, unsigned int slotidx, char *label,
1663 unsigned int type, unsigned int bits, unsigned char keyid, u_int32_t *err)
1664{
1665 struct pkcs11_provider *p = NULL;
1666 struct pkcs11_slotinfo *si;
1667 CK_FUNCTION_LIST *f;
1668 CK_SESSION_HANDLE session;
1669 struct sshkey *k = NULL;
1670 int ret = -1, reset_pin = 0, reset_provider = 0;
1671 CK_RV rv;
1672
1673 *err = 0;
1674
1675 if ((p = pkcs11_provider_lookup(provider_id)) != NULL)
1676 debug("%s: provider \"%s\" available", __func__, provider_id);
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001677 else if ((ret = pkcs11_register_provider(provider_id, pin, NULL, NULL,
1678 &p, CKU_SO)) < 0) {
djm@openbsd.org93f02102019-01-20 22:51:37 +00001679 debug("%s: could not register provider %s", __func__,
1680 provider_id);
1681 goto out;
1682 } else
1683 reset_provider = 1;
1684
1685 f = p->function_list;
1686 si = &p->slotinfo[slotidx];
1687 session = si->session;
1688
1689 if ((rv = f->C_SetOperationState(session , pin, strlen(pin),
1690 CK_INVALID_HANDLE, CK_INVALID_HANDLE)) != CKR_OK) {
1691 debug("%s: could not supply SO pin: %lu", __func__, rv);
1692 reset_pin = 0;
1693 } else
1694 reset_pin = 1;
1695
1696 switch (type) {
1697 case KEY_RSA:
1698 if ((k = pkcs11_rsa_generate_private_key(p, slotidx, label,
1699 bits, keyid, err)) == NULL) {
1700 debug("%s: failed to generate RSA key", __func__);
1701 goto out;
1702 }
1703 break;
1704 case KEY_ECDSA:
1705 if ((k = pkcs11_ecdsa_generate_private_key(p, slotidx, label,
1706 bits, keyid, err)) == NULL) {
1707 debug("%s: failed to generate ECDSA key", __func__);
1708 goto out;
1709 }
1710 break;
1711 default:
1712 *err = SSH_PKCS11_ERR_GENERIC;
1713 debug("%s: unknown type %d", __func__, type);
1714 goto out;
1715 }
1716
1717out:
1718 if (reset_pin)
1719 f->C_SetOperationState(session , NULL, 0, CK_INVALID_HANDLE,
1720 CK_INVALID_HANDLE);
1721
1722 if (reset_provider)
1723 pkcs11_del_provider(provider_id);
1724
1725 return (k);
1726}
1727
1728struct sshkey *
1729pkcs11_destroy_keypair(char *provider_id, char *pin, unsigned long slotidx,
1730 unsigned char keyid, u_int32_t *err)
1731{
1732 struct pkcs11_provider *p = NULL;
1733 struct pkcs11_slotinfo *si;
1734 struct sshkey *k = NULL;
1735 int reset_pin = 0, reset_provider = 0;
1736 CK_ULONG nattrs;
1737 CK_FUNCTION_LIST *f;
1738 CK_SESSION_HANDLE session;
1739 CK_ATTRIBUTE attrs[16];
1740 CK_OBJECT_CLASS key_class;
1741 CK_KEY_TYPE key_type;
1742 CK_OBJECT_HANDLE obj = CK_INVALID_HANDLE;
1743 CK_RV rv;
1744
1745 *err = 0;
1746
1747 if ((p = pkcs11_provider_lookup(provider_id)) != NULL) {
1748 debug("%s: using provider \"%s\"", __func__, provider_id);
djm@openbsd.org89a8d452020-01-25 00:03:36 +00001749 } else if (pkcs11_register_provider(provider_id, pin, NULL, NULL, &p,
djm@openbsd.org93f02102019-01-20 22:51:37 +00001750 CKU_SO) < 0) {
1751 debug("%s: could not register provider %s", __func__,
1752 provider_id);
1753 goto out;
1754 } else
1755 reset_provider = 1;
1756
1757 f = p->function_list;
1758 si = &p->slotinfo[slotidx];
1759 session = si->session;
1760
1761 if ((rv = f->C_SetOperationState(session , pin, strlen(pin),
1762 CK_INVALID_HANDLE, CK_INVALID_HANDLE)) != CKR_OK) {
1763 debug("%s: could not supply SO pin: %lu", __func__, rv);
1764 reset_pin = 0;
1765 } else
1766 reset_pin = 1;
1767
1768 /* private key */
1769 nattrs = 0;
1770 key_class = CKO_PRIVATE_KEY;
1771 FILL_ATTR(attrs, nattrs, CKA_CLASS, &key_class, sizeof(key_class));
1772 FILL_ATTR(attrs, nattrs, CKA_ID, &keyid, sizeof(keyid));
1773
1774 if (pkcs11_find(p, slotidx, attrs, nattrs, &obj) == 0 &&
1775 obj != CK_INVALID_HANDLE) {
1776 if ((rv = f->C_DestroyObject(session, obj)) != CKR_OK) {
1777 debug("%s: could not destroy private key 0x%hhx",
1778 __func__, keyid);
1779 *err = rv;
1780 goto out;
1781 }
1782 }
1783
1784 /* public key */
1785 nattrs = 0;
1786 key_class = CKO_PUBLIC_KEY;
1787 FILL_ATTR(attrs, nattrs, CKA_CLASS, &key_class, sizeof(key_class));
1788 FILL_ATTR(attrs, nattrs, CKA_ID, &keyid, sizeof(keyid));
1789
1790 if (pkcs11_find(p, slotidx, attrs, nattrs, &obj) == 0 &&
1791 obj != CK_INVALID_HANDLE) {
1792
1793 /* get key type */
1794 nattrs = 0;
1795 FILL_ATTR(attrs, nattrs, CKA_KEY_TYPE, &key_type,
1796 sizeof(key_type));
1797 rv = f->C_GetAttributeValue(session, obj, attrs, nattrs);
1798 if (rv != CKR_OK) {
1799 debug("%s: could not get key type of public key 0x%hhx",
1800 __func__, keyid);
1801 *err = rv;
1802 key_type = -1;
1803 }
1804 if (key_type == CKK_RSA)
1805 k = pkcs11_fetch_rsa_pubkey(p, slotidx, &obj);
1806 else if (key_type == CKK_ECDSA)
1807 k = pkcs11_fetch_ecdsa_pubkey(p, slotidx, &obj);
1808
1809 if ((rv = f->C_DestroyObject(session, obj)) != CKR_OK) {
1810 debug("%s: could not destroy public key 0x%hhx",
1811 __func__, keyid);
1812 *err = rv;
1813 goto out;
1814 }
1815 }
1816
1817out:
1818 if (reset_pin)
1819 f->C_SetOperationState(session , NULL, 0, CK_INVALID_HANDLE,
1820 CK_INVALID_HANDLE);
1821
1822 if (reset_provider)
1823 pkcs11_del_provider(provider_id);
1824
1825 return (k);
1826}
1827#endif /* WITH_PKCS11_KEYGEN */
Damien Miller5de6ac22019-01-21 11:44:19 +11001828#else /* ENABLE_PKCS11 */
Darren Tucker9634ffb2019-07-23 22:25:44 +10001829
1830#include <sys/types.h>
1831#include <stdarg.h>
1832#include <stdio.h>
1833
1834#include "log.h"
1835#include "sshkey.h"
1836
Darren Tucker0dd24e02011-09-04 19:59:26 +10001837int
1838pkcs11_init(int interactive)
1839{
djm@openbsd.org93f02102019-01-20 22:51:37 +00001840 error("%s: dlopen() not supported", __func__);
1841 return (-1);
1842}
1843
1844int
1845pkcs11_add_provider(char *provider_id, char *pin, struct sshkey ***keyp)
1846{
1847 error("%s: dlopen() not supported", __func__);
1848 return (-1);
Darren Tucker0dd24e02011-09-04 19:59:26 +10001849}
1850
1851void
1852pkcs11_terminate(void)
1853{
djm@openbsd.org93f02102019-01-20 22:51:37 +00001854 error("%s: dlopen() not supported", __func__);
Darren Tucker0dd24e02011-09-04 19:59:26 +10001855}
Damien Miller5de6ac22019-01-21 11:44:19 +11001856#endif /* ENABLE_PKCS11 */