[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.45

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