Home | History | Annotate | Download | only in openssh
      1 /* $OpenBSD: ssh-pkcs11.c,v 1.21 2015/07/18 08:02:17 djm Exp $ */
      2 /*
      3  * Copyright (c) 2010 Markus Friedl.  All rights reserved.
      4  *
      5  * Permission to use, copy, modify, and distribute this software for any
      6  * purpose with or without fee is hereby granted, provided that the above
      7  * copyright notice and this permission notice appear in all copies.
      8  *
      9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
     10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     16  */
     17 
     18 #include "includes.h"
     19 
     20 #ifdef ENABLE_PKCS11
     21 
     22 #include <sys/types.h>
     23 #ifdef HAVE_SYS_TIME_H
     24 # include <sys/time.h>
     25 #endif
     26 #include <stdarg.h>
     27 #include <stdio.h>
     28 
     29 #include <string.h>
     30 #include <dlfcn.h>
     31 
     32 #include "openbsd-compat/sys-queue.h"
     33 
     34 #include <openssl/x509.h>
     35 
     36 #define CRYPTOKI_COMPAT
     37 #include "pkcs11.h"
     38 
     39 #include "log.h"
     40 #include "misc.h"
     41 #include "sshkey.h"
     42 #include "ssh-pkcs11.h"
     43 #include "xmalloc.h"
     44 
     45 struct pkcs11_slotinfo {
     46 	CK_TOKEN_INFO		token;
     47 	CK_SESSION_HANDLE	session;
     48 	int			logged_in;
     49 };
     50 
     51 struct pkcs11_provider {
     52 	char			*name;
     53 	void			*handle;
     54 	CK_FUNCTION_LIST	*function_list;
     55 	CK_INFO			info;
     56 	CK_ULONG		nslots;
     57 	CK_SLOT_ID		*slotlist;
     58 	struct pkcs11_slotinfo	*slotinfo;
     59 	int			valid;
     60 	int			refcount;
     61 	TAILQ_ENTRY(pkcs11_provider) next;
     62 };
     63 
     64 TAILQ_HEAD(, pkcs11_provider) pkcs11_providers;
     65 
     66 struct pkcs11_key {
     67 	struct pkcs11_provider	*provider;
     68 	CK_ULONG		slotidx;
     69 	int			(*orig_finish)(RSA *rsa);
     70 	RSA_METHOD		rsa_method;
     71 	char			*keyid;
     72 	int			keyid_len;
     73 };
     74 
     75 int pkcs11_interactive = 0;
     76 
     77 int
     78 pkcs11_init(int interactive)
     79 {
     80 	pkcs11_interactive = interactive;
     81 	TAILQ_INIT(&pkcs11_providers);
     82 	return (0);
     83 }
     84 
     85 /*
     86  * finalize a provider shared libarary, it's no longer usable.
     87  * however, there might still be keys referencing this provider,
     88  * so the actuall freeing of memory is handled by pkcs11_provider_unref().
     89  * this is called when a provider gets unregistered.
     90  */
     91 static void
     92 pkcs11_provider_finalize(struct pkcs11_provider *p)
     93 {
     94 	CK_RV rv;
     95 	CK_ULONG i;
     96 
     97 	debug("pkcs11_provider_finalize: %p refcount %d valid %d",
     98 	    p, p->refcount, p->valid);
     99 	if (!p->valid)
    100 		return;
    101 	for (i = 0; i < p->nslots; i++) {
    102 		if (p->slotinfo[i].session &&
    103 		    (rv = p->function_list->C_CloseSession(
    104 		    p->slotinfo[i].session)) != CKR_OK)
    105 			error("C_CloseSession failed: %lu", rv);
    106 	}
    107 	if ((rv = p->function_list->C_Finalize(NULL)) != CKR_OK)
    108 		error("C_Finalize failed: %lu", rv);
    109 	p->valid = 0;
    110 	p->function_list = NULL;
    111 	dlclose(p->handle);
    112 }
    113 
    114 /*
    115  * remove a reference to the provider.
    116  * called when a key gets destroyed or when the provider is unregistered.
    117  */
    118 static void
    119 pkcs11_provider_unref(struct pkcs11_provider *p)
    120 {
    121 	debug("pkcs11_provider_unref: %p refcount %d", p, p->refcount);
    122 	if (--p->refcount <= 0) {
    123 		if (p->valid)
    124 			error("pkcs11_provider_unref: %p still valid", p);
    125 		free(p->slotlist);
    126 		free(p->slotinfo);
    127 		free(p);
    128 	}
    129 }
    130 
    131 /* unregister all providers, keys might still point to the providers */
    132 void
    133 pkcs11_terminate(void)
    134 {
    135 	struct pkcs11_provider *p;
    136 
    137 	while ((p = TAILQ_FIRST(&pkcs11_providers)) != NULL) {
    138 		TAILQ_REMOVE(&pkcs11_providers, p, next);
    139 		pkcs11_provider_finalize(p);
    140 		pkcs11_provider_unref(p);
    141 	}
    142 }
    143 
    144 /* lookup provider by name */
    145 static struct pkcs11_provider *
    146 pkcs11_provider_lookup(char *provider_id)
    147 {
    148 	struct pkcs11_provider *p;
    149 
    150 	TAILQ_FOREACH(p, &pkcs11_providers, next) {
    151 		debug("check %p %s", p, p->name);
    152 		if (!strcmp(provider_id, p->name))
    153 			return (p);
    154 	}
    155 	return (NULL);
    156 }
    157 
    158 /* unregister provider by name */
    159 int
    160 pkcs11_del_provider(char *provider_id)
    161 {
    162 	struct pkcs11_provider *p;
    163 
    164 	if ((p = pkcs11_provider_lookup(provider_id)) != NULL) {
    165 		TAILQ_REMOVE(&pkcs11_providers, p, next);
    166 		pkcs11_provider_finalize(p);
    167 		pkcs11_provider_unref(p);
    168 		return (0);
    169 	}
    170 	return (-1);
    171 }
    172 
    173 /* openssl callback for freeing an RSA key */
    174 static int
    175 pkcs11_rsa_finish(RSA *rsa)
    176 {
    177 	struct pkcs11_key	*k11;
    178 	int rv = -1;
    179 
    180 	if ((k11 = RSA_get_app_data(rsa)) != NULL) {
    181 		if (k11->orig_finish)
    182 			rv = k11->orig_finish(rsa);
    183 		if (k11->provider)
    184 			pkcs11_provider_unref(k11->provider);
    185 		free(k11->keyid);
    186 		free(k11);
    187 	}
    188 	return (rv);
    189 }
    190 
    191 /* find a single 'obj' for given attributes */
    192 static int
    193 pkcs11_find(struct pkcs11_provider *p, CK_ULONG slotidx, CK_ATTRIBUTE *attr,
    194     CK_ULONG nattr, CK_OBJECT_HANDLE *obj)
    195 {
    196 	CK_FUNCTION_LIST	*f;
    197 	CK_SESSION_HANDLE	session;
    198 	CK_ULONG		nfound = 0;
    199 	CK_RV			rv;
    200 	int			ret = -1;
    201 
    202 	f = p->function_list;
    203 	session = p->slotinfo[slotidx].session;
    204 	if ((rv = f->C_FindObjectsInit(session, attr, nattr)) != CKR_OK) {
    205 		error("C_FindObjectsInit failed (nattr %lu): %lu", nattr, rv);
    206 		return (-1);
    207 	}
    208 	if ((rv = f->C_FindObjects(session, obj, 1, &nfound)) != CKR_OK ||
    209 	    nfound != 1) {
    210 		debug("C_FindObjects failed (nfound %lu nattr %lu): %lu",
    211 		    nfound, nattr, rv);
    212 	} else
    213 		ret = 0;
    214 	if ((rv = f->C_FindObjectsFinal(session)) != CKR_OK)
    215 		error("C_FindObjectsFinal failed: %lu", rv);
    216 	return (ret);
    217 }
    218 
    219 /* openssl callback doing the actual signing operation */
    220 static int
    221 pkcs11_rsa_private_encrypt(int flen, const u_char *from, u_char *to, RSA *rsa,
    222     int padding)
    223 {
    224 	struct pkcs11_key	*k11;
    225 	struct pkcs11_slotinfo	*si;
    226 	CK_FUNCTION_LIST	*f;
    227 	CK_OBJECT_HANDLE	obj;
    228 	CK_ULONG		tlen = 0;
    229 	CK_RV			rv;
    230 	CK_OBJECT_CLASS	private_key_class = CKO_PRIVATE_KEY;
    231 	CK_BBOOL		true_val = CK_TRUE;
    232 	CK_MECHANISM		mech = {
    233 		CKM_RSA_PKCS, NULL_PTR, 0
    234 	};
    235 	CK_ATTRIBUTE		key_filter[] = {
    236 		{CKA_CLASS, NULL, sizeof(private_key_class) },
    237 		{CKA_ID, NULL, 0},
    238 		{CKA_SIGN, NULL, sizeof(true_val) }
    239 	};
    240 	char			*pin = NULL, prompt[1024];
    241 	int			rval = -1;
    242 
    243 	key_filter[0].pValue = &private_key_class;
    244 	key_filter[2].pValue = &true_val;
    245 
    246 	if ((k11 = RSA_get_app_data(rsa)) == NULL) {
    247 		error("RSA_get_app_data failed for rsa %p", rsa);
    248 		return (-1);
    249 	}
    250 	if (!k11->provider || !k11->provider->valid) {
    251 		error("no pkcs11 (valid) provider for rsa %p", rsa);
    252 		return (-1);
    253 	}
    254 	f = k11->provider->function_list;
    255 	si = &k11->provider->slotinfo[k11->slotidx];
    256 	if ((si->token.flags & CKF_LOGIN_REQUIRED) && !si->logged_in) {
    257 		if (!pkcs11_interactive) {
    258 			error("need pin entry%s", (si->token.flags &
    259 			    CKF_PROTECTED_AUTHENTICATION_PATH) ?
    260 			    " on reader keypad" : "");
    261 			return (-1);
    262 		}
    263 		if (si->token.flags & CKF_PROTECTED_AUTHENTICATION_PATH)
    264 			verbose("Deferring PIN entry to reader keypad.");
    265 		else {
    266 			snprintf(prompt, sizeof(prompt),
    267 			    "Enter PIN for '%s': ", si->token.label);
    268 			pin = read_passphrase(prompt, RP_ALLOW_EOF);
    269 			if (pin == NULL)
    270 				return (-1);	/* bail out */
    271 		}
    272 		rv = f->C_Login(si->session, CKU_USER, (u_char *)pin,
    273 		    (pin != NULL) ? strlen(pin) : 0);
    274 		if (pin != NULL) {
    275 			explicit_bzero(pin, strlen(pin));
    276 			free(pin);
    277 		}
    278 		if (rv != CKR_OK && rv != CKR_USER_ALREADY_LOGGED_IN) {
    279 			error("C_Login failed: %lu", rv);
    280 			return (-1);
    281 		}
    282 		si->logged_in = 1;
    283 	}
    284 	key_filter[1].pValue = k11->keyid;
    285 	key_filter[1].ulValueLen = k11->keyid_len;
    286 	/* try to find object w/CKA_SIGN first, retry w/o */
    287 	if (pkcs11_find(k11->provider, k11->slotidx, key_filter, 3, &obj) < 0 &&
    288 	    pkcs11_find(k11->provider, k11->slotidx, key_filter, 2, &obj) < 0) {
    289 		error("cannot find private key");
    290 	} else if ((rv = f->C_SignInit(si->session, &mech, obj)) != CKR_OK) {
    291 		error("C_SignInit failed: %lu", rv);
    292 	} else {
    293 		/* XXX handle CKR_BUFFER_TOO_SMALL */
    294 		tlen = RSA_size(rsa);
    295 		rv = f->C_Sign(si->session, (CK_BYTE *)from, flen, to, &tlen);
    296 		if (rv == CKR_OK)
    297 			rval = tlen;
    298 		else
    299 			error("C_Sign failed: %lu", rv);
    300 	}
    301 	return (rval);
    302 }
    303 
    304 static int
    305 pkcs11_rsa_private_decrypt(int flen, const u_char *from, u_char *to, RSA *rsa,
    306     int padding)
    307 {
    308 	return (-1);
    309 }
    310 
    311 /* redirect private key operations for rsa key to pkcs11 token */
    312 static int
    313 pkcs11_rsa_wrap(struct pkcs11_provider *provider, CK_ULONG slotidx,
    314     CK_ATTRIBUTE *keyid_attrib, RSA *rsa)
    315 {
    316 	struct pkcs11_key	*k11;
    317 	const RSA_METHOD	*def = RSA_get_default_method();
    318 
    319 	k11 = xcalloc(1, sizeof(*k11));
    320 	k11->provider = provider;
    321 	provider->refcount++;	/* provider referenced by RSA key */
    322 	k11->slotidx = slotidx;
    323 	/* identify key object on smartcard */
    324 	k11->keyid_len = keyid_attrib->ulValueLen;
    325 	k11->keyid = xmalloc(k11->keyid_len);
    326 	memcpy(k11->keyid, keyid_attrib->pValue, k11->keyid_len);
    327 	k11->orig_finish = def->finish;
    328 	memcpy(&k11->rsa_method, def, sizeof(k11->rsa_method));
    329 	k11->rsa_method.name = "pkcs11";
    330 	k11->rsa_method.rsa_priv_enc = pkcs11_rsa_private_encrypt;
    331 	k11->rsa_method.rsa_priv_dec = pkcs11_rsa_private_decrypt;
    332 	k11->rsa_method.finish = pkcs11_rsa_finish;
    333 	RSA_set_method(rsa, &k11->rsa_method);
    334 	RSA_set_app_data(rsa, k11);
    335 	return (0);
    336 }
    337 
    338 /* remove trailing spaces */
    339 static void
    340 rmspace(u_char *buf, size_t len)
    341 {
    342 	size_t i;
    343 
    344 	if (!len)
    345 		return;
    346 	for (i = len - 1;  i > 0; i--)
    347 		if (i == len - 1 || buf[i] == ' ')
    348 			buf[i] = '\0';
    349 		else
    350 			break;
    351 }
    352 
    353 /*
    354  * open a pkcs11 session and login if required.
    355  * if pin == NULL we delay login until key use
    356  */
    357 static int
    358 pkcs11_open_session(struct pkcs11_provider *p, CK_ULONG slotidx, char *pin)
    359 {
    360 	CK_RV			rv;
    361 	CK_FUNCTION_LIST	*f;
    362 	CK_SESSION_HANDLE	session;
    363 	int			login_required;
    364 
    365 	f = p->function_list;
    366 	login_required = p->slotinfo[slotidx].token.flags & CKF_LOGIN_REQUIRED;
    367 	if (pin && login_required && !strlen(pin)) {
    368 		error("pin required");
    369 		return (-1);
    370 	}
    371 	if ((rv = f->C_OpenSession(p->slotlist[slotidx], CKF_RW_SESSION|
    372 	    CKF_SERIAL_SESSION, NULL, NULL, &session))
    373 	    != CKR_OK) {
    374 		error("C_OpenSession failed: %lu", rv);
    375 		return (-1);
    376 	}
    377 	if (login_required && pin) {
    378 		rv = f->C_Login(session, CKU_USER,
    379 		    (u_char *)pin, strlen(pin));
    380 		if (rv != CKR_OK && rv != CKR_USER_ALREADY_LOGGED_IN) {
    381 			error("C_Login failed: %lu", rv);
    382 			if ((rv = f->C_CloseSession(session)) != CKR_OK)
    383 				error("C_CloseSession failed: %lu", rv);
    384 			return (-1);
    385 		}
    386 		p->slotinfo[slotidx].logged_in = 1;
    387 	}
    388 	p->slotinfo[slotidx].session = session;
    389 	return (0);
    390 }
    391 
    392 /*
    393  * lookup public keys for token in slot identified by slotidx,
    394  * add 'wrapped' public keys to the 'keysp' array and increment nkeys.
    395  * keysp points to an (possibly empty) array with *nkeys keys.
    396  */
    397 static int pkcs11_fetch_keys_filter(struct pkcs11_provider *, CK_ULONG,
    398     CK_ATTRIBUTE [], CK_ATTRIBUTE [3], struct sshkey ***, int *)
    399 	__attribute__((__bounded__(__minbytes__,4, 3 * sizeof(CK_ATTRIBUTE))));
    400 
    401 static int
    402 pkcs11_fetch_keys(struct pkcs11_provider *p, CK_ULONG slotidx,
    403     struct sshkey ***keysp, int *nkeys)
    404 {
    405 	CK_OBJECT_CLASS	pubkey_class = CKO_PUBLIC_KEY;
    406 	CK_OBJECT_CLASS	cert_class = CKO_CERTIFICATE;
    407 	CK_ATTRIBUTE		pubkey_filter[] = {
    408 		{ CKA_CLASS, NULL, sizeof(pubkey_class) }
    409 	};
    410 	CK_ATTRIBUTE		cert_filter[] = {
    411 		{ CKA_CLASS, NULL, sizeof(cert_class) }
    412 	};
    413 	CK_ATTRIBUTE		pubkey_attribs[] = {
    414 		{ CKA_ID, NULL, 0 },
    415 		{ CKA_MODULUS, NULL, 0 },
    416 		{ CKA_PUBLIC_EXPONENT, NULL, 0 }
    417 	};
    418 	CK_ATTRIBUTE		cert_attribs[] = {
    419 		{ CKA_ID, NULL, 0 },
    420 		{ CKA_SUBJECT, NULL, 0 },
    421 		{ CKA_VALUE, NULL, 0 }
    422 	};
    423 	pubkey_filter[0].pValue = &pubkey_class;
    424 	cert_filter[0].pValue = &cert_class;
    425 
    426 	if (pkcs11_fetch_keys_filter(p, slotidx, pubkey_filter, pubkey_attribs,
    427 	    keysp, nkeys) < 0 ||
    428 	    pkcs11_fetch_keys_filter(p, slotidx, cert_filter, cert_attribs,
    429 	    keysp, nkeys) < 0)
    430 		return (-1);
    431 	return (0);
    432 }
    433 
    434 static int
    435 pkcs11_key_included(struct sshkey ***keysp, int *nkeys, struct sshkey *key)
    436 {
    437 	int i;
    438 
    439 	for (i = 0; i < *nkeys; i++)
    440 		if (sshkey_equal(key, (*keysp)[i]))
    441 			return (1);
    442 	return (0);
    443 }
    444 
    445 static int
    446 pkcs11_fetch_keys_filter(struct pkcs11_provider *p, CK_ULONG slotidx,
    447     CK_ATTRIBUTE filter[], CK_ATTRIBUTE attribs[3],
    448     struct sshkey ***keysp, int *nkeys)
    449 {
    450 	struct sshkey		*key;
    451 	RSA			*rsa;
    452 	X509 			*x509;
    453 	EVP_PKEY		*evp;
    454 	int			i;
    455 	const u_char		*cp;
    456 	CK_RV			rv;
    457 	CK_OBJECT_HANDLE	obj;
    458 	CK_ULONG		nfound;
    459 	CK_SESSION_HANDLE	session;
    460 	CK_FUNCTION_LIST	*f;
    461 
    462 	f = p->function_list;
    463 	session = p->slotinfo[slotidx].session;
    464 	/* setup a filter the looks for public keys */
    465 	if ((rv = f->C_FindObjectsInit(session, filter, 1)) != CKR_OK) {
    466 		error("C_FindObjectsInit failed: %lu", rv);
    467 		return (-1);
    468 	}
    469 	while (1) {
    470 		/* XXX 3 attributes in attribs[] */
    471 		for (i = 0; i < 3; i++) {
    472 			attribs[i].pValue = NULL;
    473 			attribs[i].ulValueLen = 0;
    474 		}
    475 		if ((rv = f->C_FindObjects(session, &obj, 1, &nfound)) != CKR_OK
    476 		    || nfound == 0)
    477 			break;
    478 		/* found a key, so figure out size of the attributes */
    479 		if ((rv = f->C_GetAttributeValue(session, obj, attribs, 3))
    480 		    != CKR_OK) {
    481 			error("C_GetAttributeValue failed: %lu", rv);
    482 			continue;
    483 		}
    484 		/*
    485 		 * Allow CKA_ID (always first attribute) to be empty, but
    486 		 * ensure that none of the others are zero length.
    487 		 * XXX assumes CKA_ID is always first.
    488 		 */
    489 		if (attribs[1].ulValueLen == 0 ||
    490 		    attribs[2].ulValueLen == 0) {
    491 			continue;
    492 		}
    493 		/* allocate buffers for attributes */
    494 		for (i = 0; i < 3; i++) {
    495 			if (attribs[i].ulValueLen > 0) {
    496 				attribs[i].pValue = xmalloc(
    497 				    attribs[i].ulValueLen);
    498 			}
    499 		}
    500 
    501 		/*
    502 		 * retrieve ID, modulus and public exponent of RSA key,
    503 		 * or ID, subject and value for certificates.
    504 		 */
    505 		rsa = NULL;
    506 		if ((rv = f->C_GetAttributeValue(session, obj, attribs, 3))
    507 		    != CKR_OK) {
    508 			error("C_GetAttributeValue failed: %lu", rv);
    509 		} else if (attribs[1].type == CKA_MODULUS ) {
    510 			if ((rsa = RSA_new()) == NULL) {
    511 				error("RSA_new failed");
    512 			} else {
    513 				rsa->n = BN_bin2bn(attribs[1].pValue,
    514 				    attribs[1].ulValueLen, NULL);
    515 				rsa->e = BN_bin2bn(attribs[2].pValue,
    516 				    attribs[2].ulValueLen, NULL);
    517 			}
    518 		} else {
    519 			cp = attribs[2].pValue;
    520 			if ((x509 = X509_new()) == NULL) {
    521 				error("X509_new failed");
    522 			} else if (d2i_X509(&x509, &cp, attribs[2].ulValueLen)
    523 			    == NULL) {
    524 				error("d2i_X509 failed");
    525 			} else if ((evp = X509_get_pubkey(x509)) == NULL ||
    526 			    evp->type != EVP_PKEY_RSA ||
    527 			    evp->pkey.rsa == NULL) {
    528 				debug("X509_get_pubkey failed or no rsa");
    529 			} else if ((rsa = RSAPublicKey_dup(evp->pkey.rsa))
    530 			    == NULL) {
    531 				error("RSAPublicKey_dup");
    532 			}
    533 			if (x509)
    534 				X509_free(x509);
    535 		}
    536 		if (rsa && rsa->n && rsa->e &&
    537 		    pkcs11_rsa_wrap(p, slotidx, &attribs[0], rsa) == 0) {
    538 			key = sshkey_new(KEY_UNSPEC);
    539 			key->rsa = rsa;
    540 			key->type = KEY_RSA;
    541 			key->flags |= SSHKEY_FLAG_EXT;
    542 			if (pkcs11_key_included(keysp, nkeys, key)) {
    543 				sshkey_free(key);
    544 			} else {
    545 				/* expand key array and add key */
    546 				*keysp = xreallocarray(*keysp, *nkeys + 1,
    547 				    sizeof(struct sshkey *));
    548 				(*keysp)[*nkeys] = key;
    549 				*nkeys = *nkeys + 1;
    550 				debug("have %d keys", *nkeys);
    551 			}
    552 		} else if (rsa) {
    553 			RSA_free(rsa);
    554 		}
    555 		for (i = 0; i < 3; i++)
    556 			free(attribs[i].pValue);
    557 	}
    558 	if ((rv = f->C_FindObjectsFinal(session)) != CKR_OK)
    559 		error("C_FindObjectsFinal failed: %lu", rv);
    560 	return (0);
    561 }
    562 
    563 /* register a new provider, fails if provider already exists */
    564 int
    565 pkcs11_add_provider(char *provider_id, char *pin, struct sshkey ***keyp)
    566 {
    567 	int nkeys, need_finalize = 0;
    568 	struct pkcs11_provider *p = NULL;
    569 	void *handle = NULL;
    570 	CK_RV (*getfunctionlist)(CK_FUNCTION_LIST **);
    571 	CK_RV rv;
    572 	CK_FUNCTION_LIST *f = NULL;
    573 	CK_TOKEN_INFO *token;
    574 	CK_ULONG i;
    575 
    576 	*keyp = NULL;
    577 	if (pkcs11_provider_lookup(provider_id) != NULL) {
    578 		error("provider already registered: %s", provider_id);
    579 		goto fail;
    580 	}
    581 	/* open shared pkcs11-libarary */
    582 	if ((handle = dlopen(provider_id, RTLD_NOW)) == NULL) {
    583 		error("dlopen %s failed: %s", provider_id, dlerror());
    584 		goto fail;
    585 	}
    586 	if ((getfunctionlist = dlsym(handle, "C_GetFunctionList")) == NULL) {
    587 		error("dlsym(C_GetFunctionList) failed: %s", dlerror());
    588 		goto fail;
    589 	}
    590 	p = xcalloc(1, sizeof(*p));
    591 	p->name = xstrdup(provider_id);
    592 	p->handle = handle;
    593 	/* setup the pkcs11 callbacks */
    594 	if ((rv = (*getfunctionlist)(&f)) != CKR_OK) {
    595 		error("C_GetFunctionList failed: %lu", rv);
    596 		goto fail;
    597 	}
    598 	p->function_list = f;
    599 	if ((rv = f->C_Initialize(NULL)) != CKR_OK) {
    600 		error("C_Initialize failed: %lu", rv);
    601 		goto fail;
    602 	}
    603 	need_finalize = 1;
    604 	if ((rv = f->C_GetInfo(&p->info)) != CKR_OK) {
    605 		error("C_GetInfo failed: %lu", rv);
    606 		goto fail;
    607 	}
    608 	rmspace(p->info.manufacturerID, sizeof(p->info.manufacturerID));
    609 	rmspace(p->info.libraryDescription, sizeof(p->info.libraryDescription));
    610 	debug("manufacturerID <%s> cryptokiVersion %d.%d"
    611 	    " libraryDescription <%s> libraryVersion %d.%d",
    612 	    p->info.manufacturerID,
    613 	    p->info.cryptokiVersion.major,
    614 	    p->info.cryptokiVersion.minor,
    615 	    p->info.libraryDescription,
    616 	    p->info.libraryVersion.major,
    617 	    p->info.libraryVersion.minor);
    618 	if ((rv = f->C_GetSlotList(CK_TRUE, NULL, &p->nslots)) != CKR_OK) {
    619 		error("C_GetSlotList failed: %lu", rv);
    620 		goto fail;
    621 	}
    622 	if (p->nslots == 0) {
    623 		error("no slots");
    624 		goto fail;
    625 	}
    626 	p->slotlist = xcalloc(p->nslots, sizeof(CK_SLOT_ID));
    627 	if ((rv = f->C_GetSlotList(CK_TRUE, p->slotlist, &p->nslots))
    628 	    != CKR_OK) {
    629 		error("C_GetSlotList failed: %lu", rv);
    630 		goto fail;
    631 	}
    632 	p->slotinfo = xcalloc(p->nslots, sizeof(struct pkcs11_slotinfo));
    633 	p->valid = 1;
    634 	nkeys = 0;
    635 	for (i = 0; i < p->nslots; i++) {
    636 		token = &p->slotinfo[i].token;
    637 		if ((rv = f->C_GetTokenInfo(p->slotlist[i], token))
    638 		    != CKR_OK) {
    639 			error("C_GetTokenInfo failed: %lu", rv);
    640 			continue;
    641 		}
    642 		if ((token->flags & CKF_TOKEN_INITIALIZED) == 0) {
    643 			debug2("%s: ignoring uninitialised token in slot %lu",
    644 			    __func__, (unsigned long)i);
    645 			continue;
    646 		}
    647 		rmspace(token->label, sizeof(token->label));
    648 		rmspace(token->manufacturerID, sizeof(token->manufacturerID));
    649 		rmspace(token->model, sizeof(token->model));
    650 		rmspace(token->serialNumber, sizeof(token->serialNumber));
    651 		debug("label <%s> manufacturerID <%s> model <%s> serial <%s>"
    652 		    " flags 0x%lx",
    653 		    token->label, token->manufacturerID, token->model,
    654 		    token->serialNumber, token->flags);
    655 		/* open session, login with pin and retrieve public keys */
    656 		if (pkcs11_open_session(p, i, pin) == 0)
    657 			pkcs11_fetch_keys(p, i, keyp, &nkeys);
    658 	}
    659 	if (nkeys > 0) {
    660 		TAILQ_INSERT_TAIL(&pkcs11_providers, p, next);
    661 		p->refcount++;	/* add to provider list */
    662 		return (nkeys);
    663 	}
    664 	error("no keys");
    665 	/* don't add the provider, since it does not have any keys */
    666 fail:
    667 	if (need_finalize && (rv = f->C_Finalize(NULL)) != CKR_OK)
    668 		error("C_Finalize failed: %lu", rv);
    669 	if (p) {
    670 		free(p->slotlist);
    671 		free(p->slotinfo);
    672 		free(p);
    673 	}
    674 	if (handle)
    675 		dlclose(handle);
    676 	return (-1);
    677 }
    678 
    679 #else
    680 
    681 int
    682 pkcs11_init(int interactive)
    683 {
    684 	return (0);
    685 }
    686 
    687 void
    688 pkcs11_terminate(void)
    689 {
    690 	return;
    691 }
    692 
    693 #endif /* ENABLE_PKCS11 */
    694