lib/hx509/ks_p11.c

   1 /*
   2  * Copyright (c) 2004 - 2006 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  *
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * 3. Neither the name of the Institute nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 #include "hx_locl.h"
  35 RCSID("$Id$");
  36 #ifdef HAVE_DLFCN_H
  37 #include <dlfcn.h>
  38 #endif
  39
  40 #ifdef HAVE_DLOPEN
  41
  42 #include "pkcs11.h"
  43
  44 struct p11_slot {
  45     int flags;
  46 #define P11_SESSION             1
  47 #define P11_SESSION_IN_USE      2
  48 #define P11_LOGIN_REQ           4
  49 #define P11_LOGIN_DONE          8
  50 #define P11_TOKEN_PRESENT       16
  51     CK_SESSION_HANDLE session;
  52     CK_SLOT_ID id;
  53     CK_BBOOL token;
  54     char *name;
  55     hx509_certs certs;
  56     char *pin;
  57     struct {
  58         CK_MECHANISM_TYPE_PTR list;
  59         CK_ULONG num;
  60         CK_MECHANISM_INFO_PTR *infos;
  61     } mechs;
  62 };
  63
  64 struct p11_module {
  65     void *dl_handle;
  66     CK_FUNCTION_LIST_PTR funcs;
  67     CK_ULONG num_slots;
  68     unsigned int ref;
  69     struct p11_slot *slot;
  70 };
  71
  72 #define P11FUNC(module,f,args) (*(module)->funcs->C_##f)args
  73
  74 static int p11_get_session(hx509_context,
  75                            struct p11_module *,
  76                            struct p11_slot *,
  77                            hx509_lock,
  78                            CK_SESSION_HANDLE *);
  79 static int p11_put_session(struct p11_module *,
  80                            struct p11_slot *,
  81                            CK_SESSION_HANDLE);
  82 static void p11_release_module(struct p11_module *);
  83
  84 static int p11_list_keys(hx509_context,
  85                          struct p11_module *,
  86                          struct p11_slot *,
  87                          CK_SESSION_HANDLE,
  88                          hx509_lock,
  89                          hx509_certs *);
  90
  91 /*
  92  *
  93  */
  94
  95 struct p11_rsa {
  96     struct p11_module *p;
  97     struct p11_slot *slot;
  98     CK_OBJECT_HANDLE private_key;
  99     CK_OBJECT_HANDLE public_key;
 100 };
 101
 102 static int
 103 p11_rsa_public_encrypt(int flen,
 104                        const unsigned char *from,
 105                        unsigned char *to,
 106                        RSA *rsa,
 107                        int padding)
 108 {
 109     return -1;
 110 }
 111
 112 static int
 113 p11_rsa_public_decrypt(int flen,
 114                        const unsigned char *from,
 115                        unsigned char *to,
 116                        RSA *rsa,
 117                        int padding)
 118 {
 119     return -1;
 120 }
 121
 122
 123 static int
 124 p11_rsa_private_encrypt(int flen,
 125                         const unsigned char *from,
 126                         unsigned char *to,
 127                         RSA *rsa,
 128                         int padding)
 129 {
 130     struct p11_rsa *p11rsa = RSA_get_app_data(rsa);
 131     CK_OBJECT_HANDLE key = p11rsa->private_key;
 132     CK_SESSION_HANDLE session;
 133     CK_MECHANISM mechanism;
 134     CK_ULONG ck_sigsize;
 135     int ret;
 136
 137     if (padding != RSA_PKCS1_PADDING)
 138         return -1;
 139
 140     memset(&mechanism, 0, sizeof(mechanism));
 141     mechanism.mechanism = CKM_RSA_PKCS;
 142
 143     ck_sigsize = RSA_size(rsa);
 144
 145     ret = p11_get_session(NULL, p11rsa->p, p11rsa->slot, NULL, &session);
 146     if (ret)
 147         return -1;
 148
 149     ret = P11FUNC(p11rsa->p, SignInit, (session, &mechanism, key));
 150     if (ret != CKR_OK) {
 151         p11_put_session(p11rsa->p, p11rsa->slot, session);
 152         return -1;
 153     }
 154
 155     ret = P11FUNC(p11rsa->p, Sign,
 156                   (session, (CK_BYTE *)from, flen, to, &ck_sigsize));
 157     p11_put_session(p11rsa->p, p11rsa->slot, session);
 158     if (ret != CKR_OK)
 159         return -1;
 160
 161     return ck_sigsize;
 162 }
 163
 164 static int
 165 p11_rsa_private_decrypt(int flen, const unsigned char *from, unsigned char *to,
 166                         RSA * rsa, int padding)
 167 {
 168     struct p11_rsa *p11rsa = RSA_get_app_data(rsa);
 169     CK_OBJECT_HANDLE key = p11rsa->private_key;
 170     CK_SESSION_HANDLE session;
 171     CK_MECHANISM mechanism;
 172     CK_ULONG ck_sigsize;
 173     int ret;
 174
 175     if (padding != RSA_PKCS1_PADDING)
 176         return -1;
 177
 178     memset(&mechanism, 0, sizeof(mechanism));
 179     mechanism.mechanism = CKM_RSA_PKCS;
 180
 181     ck_sigsize = RSA_size(rsa);
 182
 183     ret = p11_get_session(NULL, p11rsa->p, p11rsa->slot, NULL, &session);
 184     if (ret)
 185         return -1;
 186
 187     ret = P11FUNC(p11rsa->p, DecryptInit, (session, &mechanism, key));
 188     if (ret != CKR_OK) {
 189         p11_put_session(p11rsa->p, p11rsa->slot, session);
 190         return -1;
 191     }
 192
 193     ret = P11FUNC(p11rsa->p, Decrypt,
 194                   (session, (CK_BYTE *)from, flen, to, &ck_sigsize));
 195     p11_put_session(p11rsa->p, p11rsa->slot, session);
 196     if (ret != CKR_OK)
 197         return -1;
 198
 199     return ck_sigsize;
 200 }
 201
 202 static int
 203 p11_rsa_init(RSA *rsa)
 204 {
 205     return 1;
 206 }
 207
 208 static int
 209 p11_rsa_finish(RSA *rsa)
 210 {
 211     struct p11_rsa *p11rsa = RSA_get_app_data(rsa);
 212     p11_release_module(p11rsa->p);
 213     free(p11rsa);
 214     return 1;
 215 }
 216
 217 static const RSA_METHOD p11_rsa_pkcs1_method = {
 218     "hx509 PKCS11 PKCS#1 RSA",
 219     p11_rsa_public_encrypt,
 220     p11_rsa_public_decrypt,
 221     p11_rsa_private_encrypt,
 222     p11_rsa_private_decrypt,
 223     NULL,
 224     NULL,
 225     p11_rsa_init,
 226     p11_rsa_finish,
 227     0,
 228     NULL,
 229     NULL,
 230     NULL
 231 };
 232
 233 /*
 234  *
 235  */
 236
 237 static int
 238 p11_mech_info(hx509_context context,
 239               struct p11_module *p,
 240               struct p11_slot *slot,
 241               int num)
 242 {
 243     CK_ULONG i;
 244     int ret;
 245
 246     ret = P11FUNC(p, GetMechanismList, (slot->id, NULL_PTR, &i));
 247     if (ret) {
 248         hx509_set_error_string(context, 0, HX509_PKCS11_NO_MECH,
 249                                "Failed to get mech list count for slot %d",
 250                                num);
 251         return HX509_PKCS11_NO_MECH;
 252     }
 253     if (i == 0) {
 254         hx509_set_error_string(context, 0, HX509_PKCS11_NO_MECH,
 255                                "no mech supported for slot %d", num);
 256         return HX509_PKCS11_NO_MECH;
 257     }
 258     slot->mechs.list = calloc(i, sizeof(slot->mechs.list[0]));
 259     if (slot->mechs.list == NULL) {
 260         hx509_set_error_string(context, 0, ENOMEM,
 261                                "out of memory");
 262         return ENOMEM;
 263     }
 264     slot->mechs.num = i;
 265     ret = P11FUNC(p, GetMechanismList, (slot->id, slot->mechs.list, &i));
 266     if (ret) {
 267         hx509_set_error_string(context, 0, HX509_PKCS11_NO_MECH,
 268                                "Failed to get mech list for slot %d",
 269                                num);
 270         return HX509_PKCS11_NO_MECH;
 271     }
 272     assert(i == slot->mechs.num);
 273
 274     slot->mechs.infos = calloc(i, sizeof(*slot->mechs.infos));
 275     if (slot->mechs.list == NULL) {
 276         hx509_set_error_string(context, 0, ENOMEM,
 277                                "out of memory");
 278         return ENOMEM;
 279     }
 280
 281     for (i = 0; i < slot->mechs.num; i++) {
 282         slot->mechs.infos[i] = calloc(1, sizeof(*(slot->mechs.infos[0])));
 283         if (slot->mechs.infos[i] == NULL) {
 284             hx509_set_error_string(context, 0, ENOMEM,
 285                                    "out of memory");
 286             return ENOMEM;
 287         }
 288         ret = P11FUNC(p, GetMechanismInfo, (slot->id, slot->mechs.list[i],
 289                                             slot->mechs.infos[i]));
 290         if (ret) {
 291             hx509_set_error_string(context, 0, HX509_PKCS11_NO_MECH,
 292                                    "Failed to get mech info for slot %d",
 293                                    num);
 294             return HX509_PKCS11_NO_MECH;
 295         }
 296     }
 297
 298     return 0;
 299 }
 300
 301 static int
 302 p11_init_slot(hx509_context context,
 303               struct p11_module *p,
 304               hx509_lock lock,
 305               CK_SLOT_ID id,
 306               int num,
 307               struct p11_slot *slot)
 308 {
 309     CK_SESSION_HANDLE session;
 310     CK_SLOT_INFO slot_info;
 311     CK_TOKEN_INFO token_info;
 312     size_t i;
 313     int ret;
 314
 315     slot->certs = NULL;
 316     slot->id = id;
 317
 318     ret = P11FUNC(p, GetSlotInfo, (slot->id, &slot_info));
 319     if (ret) {
 320         hx509_set_error_string(context, 0, HX509_PKCS11_TOKEN_CONFUSED,
 321                                "Failed to init PKCS11 slot %d",
 322                                num);
 323         return HX509_PKCS11_TOKEN_CONFUSED;
 324     }
 325
 326     for (i = sizeof(slot_info.slotDescription) - 1; i > 0; i--) {
 327         char c = slot_info.slotDescription[i];
 328         if (c == ' ' || c == '\t' || c == '\n' || c == '\r' || c == '\0')
 329             continue;
 330         i++;
 331         break;
 332     }
 333
 334     asprintf(&slot->name, "%.*s",
 335              i, slot_info.slotDescription);
 336
 337     if ((slot_info.flags & CKF_TOKEN_PRESENT) == 0)
 338         return 0;
 339
 340     ret = P11FUNC(p, GetTokenInfo, (slot->id, &token_info));
 341     if (ret) {
 342         hx509_set_error_string(context, 0, HX509_PKCS11_NO_TOKEN,
 343                                "Failed to init PKCS11 slot %d "
 344                                "with error 0x08x",
 345                                num, ret);
 346         return HX509_PKCS11_NO_TOKEN;
 347     }
 348     slot->flags |= P11_TOKEN_PRESENT;
 349
 350     if (token_info.flags & CKF_LOGIN_REQUIRED)
 351         slot->flags |= P11_LOGIN_REQ;
 352
 353     ret = p11_get_session(context, p, slot, lock, &session);
 354     if (ret)
 355         return ret;
 356
 357     ret = p11_mech_info(context, p, slot, num);
 358     if (ret)
 359         goto out;
 360
 361     ret = p11_list_keys(context, p, slot, session, lock, &slot->certs);
 362  out:
 363     p11_put_session(p, slot, session);
 364
 365     return ret;
 366 }
 367
 368 static int
 369 p11_get_session(hx509_context context,
 370                 struct p11_module *p,
 371                 struct p11_slot *slot,
 372                 hx509_lock lock,
 373                 CK_SESSION_HANDLE *psession)
 374 {
 375     CK_RV ret;
 376
 377     if (slot->flags & P11_SESSION_IN_USE)
 378         _hx509_abort("slot already in session");
 379
 380     if (slot->flags & P11_SESSION) {
 381         slot->flags |= P11_SESSION_IN_USE;
 382         *psession = slot->session;
 383         return 0;
 384     }
 385
 386     ret = P11FUNC(p, OpenSession, (slot->id,
 387                                    CKF_SERIAL_SESSION,
 388                                    NULL,
 389                                    NULL,
 390                                    &slot->session));
 391     if (ret != CKR_OK) {
 392         if (context)
 393             hx509_set_error_string(context, 0, HX509_PKCS11_OPEN_SESSION,
 394                                    "Failed to OpenSession for slot id %d "
 395                                    "with error: 0x%08x",
 396                                    (int)slot->id, ret);
 397         return HX509_PKCS11_OPEN_SESSION;
 398     }
 399
 400     slot->flags |= P11_SESSION;
 401
 402     /*
 403      * If we have have to login, and haven't tried before and have a
 404      * prompter or known to work pin code.
 405      *
 406      * This code is very conversative and only uses the prompter in
 407      * the hx509_lock, the reason is that it's bad to try many
 408      * passwords on a pkcs11 token, it might lock up and have to be
 409      * unlocked by a administrator.
 410      *
 411      * XXX try harder to not use pin several times on the same card.
 412      */
 413
 414     if (   (slot->flags & P11_LOGIN_REQ)
 415         && (slot->flags & P11_LOGIN_DONE) == 0
 416         && (lock || slot->pin))
 417     {
 418         hx509_prompt prompt;
 419         char pin[20];
 420         char *str;
 421
 422         slot->flags |= P11_LOGIN_DONE;
 423
 424         if (slot->pin == NULL) {
 425
 426             memset(&prompt, 0, sizeof(prompt));
 427
 428             asprintf(&str, "PIN code for %s: ", slot->name);
 429             prompt.prompt = str;
 430             prompt.type = HX509_PROMPT_TYPE_PASSWORD;
 431             prompt.reply.data = pin;
 432             prompt.reply.length = sizeof(pin);
 433
 434             ret = hx509_lock_prompt(lock, &prompt);
 435             if (ret) {
 436                 free(str);
 437                 if (context)
 438                     hx509_set_error_string(context, 0, ret,
 439                                            "Failed to get pin code for slot "
 440                                            "id %d with error: %d",
 441                                            (int)slot->id, ret);
 442                 return ret;
 443             }
 444             free(str);
 445         } else {
 446             strlcpy(pin, slot->pin, sizeof(pin));
 447         }
 448
 449         ret = P11FUNC(p, Login, (slot->session, CKU_USER,
 450                                  (unsigned char*)pin, strlen(pin)));
 451         if (ret != CKR_OK) {
 452             if (context)
 453                 hx509_set_error_string(context, 0, HX509_PKCS11_LOGIN,
 454                                        "Failed to login on slot id %d "
 455                                        "with error: 0x%08x",
 456                                        (int)slot->id, ret);
 457             p11_put_session(p, slot, slot->session);
 458             return HX509_PKCS11_LOGIN;
 459         }
 460         if (slot->pin == NULL) {
 461             slot->pin = strdup(pin);
 462             if (slot->pin == NULL) {
 463                 if (context)
 464                     hx509_set_error_string(context, 0, ENOMEM,
 465                                            "out of memory");
 466                 p11_put_session(p, slot, slot->session);
 467                 return ENOMEM;
 468             }
 469         }
 470     } else
 471         slot->flags |= P11_LOGIN_DONE;
 472
 473     slot->flags |= P11_SESSION_IN_USE;
 474
 475     *psession = slot->session;
 476
 477     return 0;
 478 }
 479
 480 static int
 481 p11_put_session(struct p11_module *p,
 482                 struct p11_slot *slot,
 483                 CK_SESSION_HANDLE session)
 484 {
 485     if ((slot->flags & P11_SESSION_IN_USE) == 0)
 486         _hx509_abort("slot not in session");
 487     slot->flags &= ~P11_SESSION_IN_USE;
 488
 489     return 0;
 490 }
 491
 492 static int
 493 iterate_entries(hx509_context context,
 494                 struct p11_module *p, struct p11_slot *slot,
 495                 CK_SESSION_HANDLE session,
 496                 CK_ATTRIBUTE *search_data, int num_search_data,
 497                 CK_ATTRIBUTE *query, int num_query,
 498                 int (*func)(hx509_context,
 499                             struct p11_module *, struct p11_slot *,
 500                             CK_SESSION_HANDLE session,
 501                             CK_OBJECT_HANDLE object,
 502                             void *, CK_ATTRIBUTE *, int), void *ptr)
 503 {
 504     CK_OBJECT_HANDLE object;
 505     CK_ULONG object_count;
 506     int ret, i;
 507
 508     ret = P11FUNC(p, FindObjectsInit, (session, search_data, num_search_data));
 509     if (ret != CKR_OK) {
 510         return -1;
 511     }
 512     while (1) {
 513         ret = P11FUNC(p, FindObjects, (session, &object, 1, &object_count));
 514         if (ret != CKR_OK) {
 515             return -1;
 516         }
 517         if (object_count == 0)
 518             break;
 519
 520         for (i = 0; i < num_query; i++)
 521             query[i].pValue = NULL;
 522
 523         ret = P11FUNC(p, GetAttributeValue,
 524                       (session, object, query, num_query));
 525         if (ret != CKR_OK) {
 526             return -1;
 527         }
 528         for (i = 0; i < num_query; i++) {
 529             query[i].pValue = malloc(query[i].ulValueLen);
 530             if (query[i].pValue == NULL) {
 531                 ret = ENOMEM;
 532                 goto out;
 533             }
 534         }
 535         ret = P11FUNC(p, GetAttributeValue,
 536                       (session, object, query, num_query));
 537         if (ret != CKR_OK) {
 538             ret = -1;
 539             goto out;
 540         }
 541
 542         ret = (*func)(context, p, slot, session, object, ptr, query, num_query);
 543         if (ret)
 544             goto out;
 545
 546         for (i = 0; i < num_query; i++) {
 547             if (query[i].pValue)
 548                 free(query[i].pValue);
 549             query[i].pValue = NULL;
 550         }
 551     }
 552  out:
 553
 554     for (i = 0; i < num_query; i++) {
 555         if (query[i].pValue)
 556             free(query[i].pValue);
 557         query[i].pValue = NULL;
 558     }
 559
 560     ret = P11FUNC(p, FindObjectsFinal, (session));
 561     if (ret != CKR_OK) {
 562         return -2;
 563     }
 564
 565
 566     return 0;
 567 }
 568
 569 static BIGNUM *
 570 getattr_bn(struct p11_module *p,
 571            struct p11_slot *slot,
 572            CK_SESSION_HANDLE session,
 573            CK_OBJECT_HANDLE object,
 574            unsigned int type)
 575 {
 576     CK_ATTRIBUTE query;
 577     BIGNUM *bn;
 578     int ret;
 579
 580     query.type = type;
 581     query.pValue = NULL;
 582     query.ulValueLen = 0;
 583
 584     ret = P11FUNC(p, GetAttributeValue,
 585                   (session, object, &query, 1));
 586     if (ret != CKR_OK)
 587         return NULL;
 588
 589     query.pValue = malloc(query.ulValueLen);
 590
 591     ret = P11FUNC(p, GetAttributeValue,
 592                   (session, object, &query, 1));
 593     if (ret != CKR_OK) {
 594         free(query.pValue);
 595         return NULL;
 596     }
 597     bn = BN_bin2bn(query.pValue, query.ulValueLen, NULL);
 598     free(query.pValue);
 599
 600     return bn;
 601 }
 602
 603 static int
 604 collect_private_key(hx509_context context,
 605                     struct p11_module *p, struct p11_slot *slot,
 606                     CK_SESSION_HANDLE session,
 607                     CK_OBJECT_HANDLE object,
 608                     void *ptr, CK_ATTRIBUTE *query, int num_query)
 609 {
 610     struct hx509_collector *collector = ptr;
 611     hx509_private_key key;
 612     heim_octet_string localKeyId;
 613     int ret;
 614     RSA *rsa;
 615     struct p11_rsa *p11rsa;
 616
 617     localKeyId.data = query[0].pValue;
 618     localKeyId.length = query[0].ulValueLen;
 619
 620     ret = _hx509_private_key_init(&key, NULL, NULL);
 621     if (ret)
 622         return ret;
 623
 624     rsa = RSA_new();
 625     if (rsa == NULL)
 626         _hx509_abort("out of memory");
 627
 628     /*
 629      * The exponent and modulus should always be present according to
 630      * the pkcs11 specification, but some smartcards leaves it out,
 631      * let ignore any failure to fetch it.
 632      */
 633     rsa->n = getattr_bn(p, slot, session, object, CKA_MODULUS);
 634     rsa->e = getattr_bn(p, slot, session, object, CKA_PUBLIC_EXPONENT);
 635
 636     p11rsa = calloc(1, sizeof(*p11rsa));
 637     if (p11rsa == NULL)
 638         _hx509_abort("out of memory");
 639
 640     p11rsa->p = p;
 641     p11rsa->slot = slot;
 642     p11rsa->private_key = object;
 643
 644     if (p->ref == 0)
 645         _hx509_abort("pkcs11 ref == 0 on alloc");
 646     p->ref++;
 647     if (p->ref == UINT_MAX)
 648         _hx509_abort("pkcs11 ref == UINT_MAX on alloc");
 649
 650     RSA_set_method(rsa, &p11_rsa_pkcs1_method);
 651     ret = RSA_set_app_data(rsa, p11rsa);
 652     if (ret != 1)
 653         _hx509_abort("RSA_set_app_data");
 654
 655     _hx509_private_key_assign_rsa(key, rsa);
 656
 657     ret = _hx509_collector_private_key_add(context,
 658                                            collector,
 659                                            hx509_signature_rsa(),
 660                                            key,
 661                                            NULL,
 662                                            &localKeyId);
 663
 664     if (ret) {
 665         _hx509_private_key_free(&key);
 666         return ret;
 667     }
 668     return 0;
 669 }
 670
 671 static void
 672 p11_cert_release(hx509_cert cert, void *ctx)
 673 {
 674     struct p11_module *p = ctx;
 675     p11_release_module(p);
 676 }
 677
 678
 679 static int
 680 collect_cert(hx509_context context,
 681              struct p11_module *p, struct p11_slot *slot,
 682              CK_SESSION_HANDLE session,
 683              CK_OBJECT_HANDLE object,
 684              void *ptr, CK_ATTRIBUTE *query, int num_query)
 685 {
 686     struct hx509_collector *collector = ptr;
 687     hx509_cert cert;
 688     int ret;
 689
 690     if ((CK_LONG)query[0].ulValueLen == -1 ||
 691         (CK_LONG)query[1].ulValueLen == -1)
 692     {
 693         return 0;
 694     }
 695
 696     ret = hx509_cert_init_data(context, query[1].pValue,
 697                                query[1].ulValueLen, &cert);
 698     if (ret)
 699         return ret;
 700
 701     if (p->ref == 0)
 702         _hx509_abort("pkcs11 ref == 0 on alloc");
 703     p->ref++;
 704     if (p->ref == UINT_MAX)
 705         _hx509_abort("pkcs11 ref to high");
 706
 707     _hx509_cert_set_release(cert, p11_cert_release, p);
 708
 709     {
 710         heim_octet_string data;
 711
 712         data.data = query[0].pValue;
 713         data.length = query[0].ulValueLen;
 714
 715         _hx509_set_cert_attribute(context,
 716                                   cert,
 717                                   oid_id_pkcs_9_at_localKeyId(),
 718                                   &data);
 719     }
 720
 721     if ((CK_LONG)query[2].ulValueLen != -1) {
 722         char *str;
 723
 724         asprintf(&str, "%.*s",
 725                  (int)query[2].ulValueLen, (char *)query[2].pValue);
 726         if (str) {
 727             hx509_cert_set_friendly_name(cert, str);
 728             free(str);
 729         }
 730     }
 731
 732     ret = _hx509_collector_certs_add(context, collector, cert);
 733     hx509_cert_free(cert);
 734
 735     return ret;
 736 }
 737
 738
 739 static int
 740 p11_list_keys(hx509_context context,
 741               struct p11_module *p,
 742               struct p11_slot *slot,
 743               CK_SESSION_HANDLE session,
 744               hx509_lock lock,
 745               hx509_certs *certs)
 746 {
 747     struct hx509_collector *collector;
 748     CK_OBJECT_CLASS key_class;
 749     CK_ATTRIBUTE search_data[] = {
 750         {CKA_CLASS, NULL, 0},
 751     };
 752     CK_ATTRIBUTE query_data[3] = {
 753         {CKA_ID, NULL, 0},
 754         {CKA_VALUE, NULL, 0},
 755         {CKA_LABEL, NULL, 0}
 756     };
 757     int ret;
 758
 759     search_data[0].pValue = &key_class;
 760     search_data[0].ulValueLen = sizeof(key_class);
 761
 762     if (lock == NULL)
 763         lock = _hx509_empty_lock;
 764
 765     ret = _hx509_collector_alloc(context, lock, &collector);
 766     if (ret)
 767         return ret;
 768
 769     key_class = CKO_PRIVATE_KEY;
 770     ret = iterate_entries(context, p, slot, session,
 771                           search_data, 1,
 772                           query_data, 1,
 773                           collect_private_key, collector);
 774     if (ret)
 775         goto out;
 776
 777     key_class = CKO_CERTIFICATE;
 778     ret = iterate_entries(context, p, slot, session,
 779                           search_data, 1,
 780                           query_data, 3,
 781                           collect_cert, collector);
 782     if (ret)
 783         goto out;
 784
 785     ret = _hx509_collector_collect_certs(context, collector, &slot->certs);
 786
 787 out:
 788     _hx509_collector_free(collector);
 789
 790     return ret;
 791 }
 792
 793
 794 static int
 795 p11_init(hx509_context context,
 796          hx509_certs certs, void **data, int flags,
 797          const char *residue, hx509_lock lock)
 798 {
 799     CK_C_GetFunctionList getFuncs;
 800     struct p11_module *p;
 801     char *list, *str;
 802     int ret;
 803
 804     *data = NULL;
 805
 806     list = strdup(residue);
 807     if (list == NULL)
 808         return ENOMEM;
 809
 810     p = calloc(1, sizeof(*p));
 811     if (p == NULL) {
 812         free(list);
 813         return ENOMEM;
 814     }
 815
 816     p->ref = 1;
 817
 818     str = strchr(list, ',');
 819     if (str)
 820         *str++ = '\0';
 821     while (str) {
 822         char *strnext;
 823         strnext = strchr(str, ',');
 824         if (strnext)
 825             *strnext++ = '\0';
 826 #if 0
 827         if (strncasecmp(str, "slot=", 5) == 0)
 828             p->selected_slot = atoi(str + 5);
 829 #endif
 830         str = strnext;
 831     }
 832
 833     p->dl_handle = dlopen(list, RTLD_NOW);
 834     free(list);
 835     if (p->dl_handle == NULL) {
 836         ret = HX509_PKCS11_LOAD;
 837         hx509_set_error_string(context, 0, ret,
 838                                "Failed to open %s: %s", list, dlerror());
 839         goto out;
 840     }
 841
 842     getFuncs = dlsym(p->dl_handle, "C_GetFunctionList");
 843     if (getFuncs == NULL) {
 844         ret = HX509_PKCS11_LOAD;
 845         hx509_set_error_string(context, 0, ret,
 846                                "C_GetFunctionList missing in %s: %s",
 847                                list, dlerror());
 848         goto out;
 849     }
 850
 851     ret = (*getFuncs)(&p->funcs);
 852     if (ret) {
 853         ret = HX509_PKCS11_LOAD;
 854         hx509_set_error_string(context, 0, ret,
 855                                "C_GetFunctionList failed in %s", list);
 856         goto out;
 857     }
 858
 859     ret = P11FUNC(p, Initialize, (NULL_PTR));
 860     if (ret != CKR_OK) {
 861         ret = HX509_PKCS11_TOKEN_CONFUSED;
 862         hx509_set_error_string(context, 0, ret,
 863                                "Failed initialize the PKCS11 module");
 864         goto out;
 865     }
 866
 867     ret = P11FUNC(p, GetSlotList, (FALSE, NULL, &p->num_slots));
 868     if (ret) {
 869         ret = HX509_PKCS11_TOKEN_CONFUSED;
 870         hx509_set_error_string(context, 0, ret,
 871                                "Failed to get number of PKCS11 slots");
 872         goto out;
 873     }
 874
 875    if (p->num_slots == 0) {
 876         ret = HX509_PKCS11_NO_SLOT;
 877         hx509_set_error_string(context, 0, ret,
 878                                "Selected PKCS11 module have no slots");
 879         goto out;
 880    }
 881
 882
 883     {
 884         CK_SLOT_ID_PTR slot_ids;
 885         int i, num_tokens = 0;
 886
 887         slot_ids = malloc(p->num_slots * sizeof(*slot_ids));
 888         if (slot_ids == NULL) {
 889             hx509_clear_error_string(context);
 890             ret = ENOMEM;
 891             goto out;
 892         }
 893
 894         ret = P11FUNC(p, GetSlotList, (FALSE, slot_ids, &p->num_slots));
 895         if (ret) {
 896             free(slot_ids);
 897             hx509_set_error_string(context, 0, HX509_PKCS11_TOKEN_CONFUSED,
 898                                    "Failed getting slot-list from "
 899                                    "PKCS11 module");
 900             ret = HX509_PKCS11_TOKEN_CONFUSED;
 901             goto out;
 902         }
 903
 904         p->slot = calloc(p->num_slots, sizeof(p->slot[0]));
 905         if (p->slot == NULL) {
 906             free(slot_ids);
 907             hx509_set_error_string(context, 0, ENOMEM,
 908                                    "Failed to get memory for slot-list");
 909             ret = ENOMEM;
 910             goto out;
 911         }
 912
 913         for (i = 0; i < p->num_slots; i++) {
 914             ret = p11_init_slot(context, p, lock, slot_ids[i], i, &p->slot[i]);
 915             if (ret)
 916                 break;
 917             if (p->slot[i].flags & P11_TOKEN_PRESENT)
 918                 num_tokens++;
 919         }
 920         free(slot_ids);
 921         if (ret)
 922             goto out;
 923         if (num_tokens == 0) {
 924             ret = HX509_PKCS11_NO_TOKEN;
 925             goto out;
 926         }
 927     }
 928
 929     *data = p;
 930
 931     return 0;
 932  out:
 933     p11_release_module(p);
 934     return ret;
 935 }
 936
 937 static void
 938 p11_release_module(struct p11_module *p)
 939 {
 940     int i;
 941
 942     if (p->ref == 0)
 943         _hx509_abort("pkcs11 ref to low");
 944     if (--p->ref > 0)
 945         return;
 946
 947     for (i = 0; i < p->num_slots; i++) {
 948         if (p->slot[i].flags & P11_SESSION_IN_USE)
 949             _hx509_abort("pkcs11 module release while session in use");
 950         if (p->slot[i].flags & P11_SESSION) {
 951             int ret;
 952
 953             ret = P11FUNC(p, CloseSession, (p->slot[i].session));
 954             if (ret != CKR_OK)
 955                 ;
 956         }
 957
 958         if (p->slot[i].name)
 959             free(p->slot[i].name);
 960         if (p->slot[i].pin) {
 961             memset(p->slot[i].pin, 0, strlen(p->slot[i].pin));
 962             free(p->slot[i].pin);
 963         }
 964         if (p->slot[i].mechs.num) {
 965             free(p->slot[i].mechs.list);
 966
 967             if (p->slot[i].mechs.infos) {
 968                 int j;
 969
 970                 for (j = 0 ; j < p->slot[i].mechs.num ; j++)
 971                     free(p->slot[i].mechs.infos[j]);
 972                 free(p->slot[i].mechs.infos);
 973             }
 974         }
 975     }
 976     free(p->slot);
 977
 978     if (p->funcs)
 979         P11FUNC(p, Finalize, (NULL));
 980
 981     if (p->dl_handle)
 982         dlclose(p->dl_handle);
 983
 984     memset(p, 0, sizeof(*p));
 985     free(p);
 986 }
 987
 988 static int
 989 p11_free(hx509_certs certs, void *data)
 990 {
 991     struct p11_module *p = data;
 992     int i;
 993
 994     for (i = 0; i < p->num_slots; i++) {
 995         if (p->slot[i].certs)
 996             hx509_certs_free(&p->slot[i].certs);
 997     }
 998     p11_release_module(p);
 999     return 0;
1000 }
1001
1002 struct p11_cursor {
1003     hx509_certs certs;
1004     void *cursor;
1005 };
1006
1007 static int
1008 p11_iter_start(hx509_context context,
1009                hx509_certs certs, void *data, void **cursor)
1010 {
1011     struct p11_module *p = data;
1012     struct p11_cursor *c;
1013     int ret, i;
1014
1015     c = malloc(sizeof(*c));
1016     if (c == NULL) {
1017         hx509_clear_error_string(context);
1018         return ENOMEM;
1019     }
1020     ret = hx509_certs_init(context, "MEMORY:pkcs11-iter", 0, NULL, &c->certs);
1021     if (ret) {
1022         free(c);
1023         return ret;
1024     }
1025
1026     for (i = 0 ; i < p->num_slots; i++) {
1027         if (p->slot[i].certs == NULL)
1028             continue;
1029         ret = hx509_certs_merge(context, c->certs, p->slot[i].certs);
1030         if (ret) {
1031             hx509_certs_free(&c->certs);
1032             free(c);
1033             return ret;
1034         }
1035     }
1036
1037     ret = hx509_certs_start_seq(context, c->certs, &c->cursor);
1038     if (ret) {
1039         hx509_certs_free(&c->certs);
1040         free(c);
1041         return 0;
1042     }
1043     *cursor = c;
1044
1045     return 0;
1046 }
1047
1048 static int
1049 p11_iter(hx509_context context,
1050          hx509_certs certs, void *data, void *cursor, hx509_cert *cert)
1051 {
1052     struct p11_cursor *c = cursor;
1053     return hx509_certs_next_cert(context, c->certs, c->cursor, cert);
1054 }
1055
1056 static int
1057 p11_iter_end(hx509_context context,
1058              hx509_certs certs, void *data, void *cursor)
1059 {
1060     struct p11_cursor *c = cursor;
1061     int ret;
1062     ret = hx509_certs_end_seq(context, c->certs, c->cursor);
1063     hx509_certs_free(&c->certs);
1064     free(c);
1065     return ret;
1066 }
1067
1068 #define MECHFLAG(x) { "unknown-flag-" #x, x }
1069 static struct units mechflags[] = {
1070         MECHFLAG(0x80000000),
1071         MECHFLAG(0x40000000),
1072         MECHFLAG(0x20000000),
1073         MECHFLAG(0x10000000),
1074         MECHFLAG(0x08000000),
1075         MECHFLAG(0x04000000),
1076         {"ec-compress",         0x2000000 },
1077         {"ec-uncompress",       0x1000000 },
1078         {"ec-namedcurve",       0x0800000 },
1079         {"ec-ecparameters",     0x0400000 },
1080         {"ec-f-2m",             0x0200000 },
1081         {"ec-f-p",              0x0100000 },
1082         {"derive",              0x0080000 },
1083         {"unwrap",              0x0040000 },
1084         {"wrap",                0x0020000 },
1085         {"genereate-key-pair",  0x0010000 },
1086         {"generate",            0x0008000 },
1087         {"verify-recover",      0x0004000 },
1088         {"verify",              0x0002000 },
1089         {"sign-recover",        0x0001000 },
1090         {"sign",                0x0000800 },
1091         {"digest",              0x0000400 },
1092         {"decrypt",             0x0000200 },
1093         {"encrypt",             0x0000100 },
1094         MECHFLAG(0x00080),
1095         MECHFLAG(0x00040),
1096         MECHFLAG(0x00020),
1097         MECHFLAG(0x00010),
1098         MECHFLAG(0x00008),
1099         MECHFLAG(0x00004),
1100         MECHFLAG(0x00002),
1101         {"hw",                  0x0000001 },
1102         { NULL,                 0x0000000 }
1103 };
1104 #undef MECHFLAG
1105
1106 static int
1107 p11_printinfo(hx509_context context,
1108               hx509_certs certs,
1109               void *data,
1110               int (*func)(void *, const char *),
1111               void *ctx)
1112 {
1113     struct p11_module *p = data;
1114     int i, j;
1115
1116     _hx509_pi_printf(func, ctx, "pkcs11 driver with %d slot%s",
1117                      p->num_slots, p->num_slots > 1 ? "s" : "");
1118
1119     for (i = 0; i < p->num_slots; i++) {
1120         struct p11_slot *s = &p->slot[i];
1121
1122         _hx509_pi_printf(func, ctx, "slot %d: id: %d name: %s flags: %08x",
1123                          i, (int)s->id, s->name, s->flags);
1124
1125         _hx509_pi_printf(func, ctx, "number of supported mechanisms: %lu",
1126                          (unsigned long)s->mechs.num);
1127         for (j = 0; j < s->mechs.num; j++) {
1128             const char *mechname = "unknown";
1129             char flags[256], unknownname[40];
1130 #define MECHNAME(s,n) case s: mechname = n; break
1131             switch(s->mechs.list[j]) {
1132                 MECHNAME(CKM_RSA_PKCS_KEY_PAIR_GEN, "rsa-pkcs-key-pair-gen");
1133                 MECHNAME(CKM_RSA_PKCS, "rsa-pkcs");
1134                 MECHNAME(CKM_RSA_X_509, "rsa-x-509");
1135                 MECHNAME(CKM_MD5_RSA_PKCS, "md5-rsa-pkcs");
1136                 MECHNAME(CKM_SHA1_RSA_PKCS, "sha1-rsa-pkcs");
1137                 MECHNAME(CKM_SHA256_RSA_PKCS, "sha256-rsa-pkcs");
1138                 MECHNAME(CKM_SHA384_RSA_PKCS, "sha384-rsa-pkcs");
1139                 MECHNAME(CKM_SHA512_RSA_PKCS, "sha512-rsa-pkcs");
1140                 MECHNAME(CKM_RIPEMD160_RSA_PKCS, "ripemd160-rsa-pkcs");
1141                 MECHNAME(CKM_RSA_PKCS_OAEP, "rsa-pkcs-oaep");
1142                 MECHNAME(CKM_SHA512_HMAC, "sha512-hmac");
1143                 MECHNAME(CKM_SHA512, "sha512");
1144                 MECHNAME(CKM_SHA384_HMAC, "sha384-hmac");
1145                 MECHNAME(CKM_SHA384, "sha384");
1146                 MECHNAME(CKM_SHA256_HMAC, "sha256-hmac");
1147                 MECHNAME(CKM_SHA256, "sha256");
1148                 MECHNAME(CKM_SHA_1, "sha1");
1149                 MECHNAME(CKM_MD5, "md5");
1150                 MECHNAME(CKM_MD2, "md2");
1151                 MECHNAME(CKM_RIPEMD160, "ripemd-160");
1152                 MECHNAME(CKM_DES_ECB, "des-ecb");
1153                 MECHNAME(CKM_DES_CBC, "des-cbc");
1154                 MECHNAME(CKM_AES_ECB, "aes-ecb");
1155                 MECHNAME(CKM_AES_CBC, "aes-cbc");
1156                 MECHNAME(CKM_DH_PKCS_PARAMETER_GEN, "dh-pkcs-parameter-gen");
1157             default:
1158                 snprintf(unknownname, sizeof(unknownname),
1159                          "unknown-mech-%lu",
1160                          (unsigned long)s->mechs.list[j]);
1161                 mechname = unknownname;
1162                 break;
1163             }
1164 #undef MECHNAME
1165             unparse_flags(s->mechs.infos[j]->flags, mechflags,
1166                           flags, sizeof(flags));
1167
1168             _hx509_pi_printf(func, ctx, "  %s: %s", mechname, flags);
1169         }
1170     }
1171
1172     return 0;
1173 }
1174
1175 static struct hx509_keyset_ops keyset_pkcs11 = {
1176     "PKCS11",
1177     0,
1178     p11_init,
1179     NULL,
1180     p11_free,
1181     NULL,
1182     NULL,
1183     p11_iter_start,
1184     p11_iter,
1185     p11_iter_end,
1186     p11_printinfo
1187 };
1188
1189 #endif /* HAVE_DLOPEN */
1190
1191 void
1192 _hx509_ks_pkcs11_register(hx509_context context)
1193 {
1194 #ifdef HAVE_DLOPEN
1195     _hx509_ks_register(context, &keyset_pkcs11);
1196 #endif
1197 }