[BACK]Return to ssh-pkcs11.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/ssh-pkcs11.c, Revision 1.18

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