libcacard/vcard_emul_nss.c

   1 /*
   2  * This is the actual card emulator.
   3  *
   4  * These functions can be implemented in different ways on different platforms
   5  * using the underlying system primitives. For Linux it uses NSS, though direct
   6  * to PKCS #11, openssl+pkcs11, or even gnu crypto libraries+pkcs #11 could be
   7  * used. On Windows CAPI could be used.
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
  10  * See the COPYING.LIB file in the top-level directory.
  11  */
  12
  13 /*
  14  * NSS headers
  15  */
  16
  17 /* avoid including prototypes.h that redefines uint32 */
  18 #define NO_NSPR_10_SUPPORT
  19
  20 #include <nss.h>
  21 #include <pk11pub.h>
  22 #include <cert.h>
  23 #include <key.h>
  24 #include <secmod.h>
  25 #include <prthread.h>
  26 #include <secerr.h>
  27
  28 #include "qemu-common.h"
  29
  30 #include "vcard.h"
  31 #include "card_7816t.h"
  32 #include "vcard_emul.h"
  33 #include "vreader.h"
  34 #include "vevent.h"
  35
  36 #include "libcacard/vcardt_internal.h"
  37
  38
  39 typedef enum {
  40     VCardEmulUnknown = -1,
  41     VCardEmulFalse = 0,
  42     VCardEmulTrue = 1
  43 } VCardEmulTriState;
  44
  45 struct VCardKeyStruct {
  46     CERTCertificate *cert;
  47     PK11SlotInfo *slot;
  48     SECKEYPrivateKey *key;
  49     VCardEmulTriState failedX509;
  50 };
  51
  52
  53 typedef struct VirtualReaderOptionsStruct VirtualReaderOptions;
  54
  55 struct VReaderEmulStruct {
  56     PK11SlotInfo *slot;
  57     VCardEmulType default_type;
  58     char *type_params;
  59     PRBool present;
  60     int     series;
  61     VCard *saved_vcard;
  62 };
  63
  64 /*
  65  *  NSS Specific options
  66  */
  67 struct VirtualReaderOptionsStruct {
  68     char *name;
  69     char *vname;
  70     VCardEmulType card_type;
  71     char *type_params;
  72     char **cert_name;
  73     int cert_count;
  74 };
  75
  76 struct VCardEmulOptionsStruct {
  77     void *nss_db;
  78     VirtualReaderOptions *vreader;
  79     int vreader_count;
  80     VCardEmulType hw_card_type;
  81     const char *hw_type_params;
  82     PRBool use_hw;
  83 };
  84
  85 static int nss_emul_init;
  86
  87 /* if we have more that just the slot, define
  88  * VCardEmulStruct here */
  89
  90 /*
  91  * allocate the set of arrays for certs, cert_len, key
  92  */
  93 static void
  94 vcard_emul_alloc_arrays(unsigned char ***certsp, int **cert_lenp,
  95                         VCardKey ***keysp, int cert_count)
  96 {
  97     *certsp = g_new(unsigned char *, cert_count);
  98     *cert_lenp = g_new(int, cert_count);
  99     *keysp = g_new(VCardKey *, cert_count);
 100 }
 101
 102 /*
 103  * Emulator specific card information
 104  */
 105 typedef struct CardEmulCardStruct CardEmulPrivate;
 106
 107 static VCardEmul *
 108 vcard_emul_new_card(PK11SlotInfo *slot)
 109 {
 110     PK11_ReferenceSlot(slot);
 111     /* currently we don't need anything other than the slot */
 112     return (VCardEmul *)slot;
 113 }
 114
 115 static void
 116 vcard_emul_delete_card(VCardEmul *vcard_emul)
 117 {
 118     PK11SlotInfo *slot = (PK11SlotInfo *)vcard_emul;
 119     if (slot == NULL) {
 120         return;
 121     }
 122     PK11_FreeSlot(slot);
 123 }
 124
 125 static PK11SlotInfo *
 126 vcard_emul_card_get_slot(VCard *card)
 127 {
 128     /* note, the card is holding the reference, no need to get another one */
 129     return (PK11SlotInfo *)vcard_get_private(card);
 130 }
 131
 132
 133 /*
 134  * key functions
 135  */
 136 /* private constructure */
 137 static VCardKey *
 138 vcard_emul_make_key(PK11SlotInfo *slot, CERTCertificate *cert)
 139 {
 140     VCardKey *key;
 141
 142     key = g_new(VCardKey, 1);
 143     key->slot = PK11_ReferenceSlot(slot);
 144     key->cert = CERT_DupCertificate(cert);
 145     /* NOTE: if we aren't logged into the token, this could return NULL */
 146     /* NOTE: the cert is a temp cert, not necessarily the cert in the token,
 147      * use the DER version of this function */
 148     key->key = PK11_FindKeyByDERCert(slot, cert, NULL);
 149     key->failedX509 = VCardEmulUnknown;
 150     return key;
 151 }
 152
 153 /* destructor */
 154 void
 155 vcard_emul_delete_key(VCardKey *key)
 156 {
 157     if (!nss_emul_init || (key == NULL)) {
 158         return;
 159     }
 160     if (key->key) {
 161         SECKEY_DestroyPrivateKey(key->key);
 162         key->key = NULL;
 163     }
 164     if (key->cert) {
 165         CERT_DestroyCertificate(key->cert);
 166     }
 167     if (key->slot) {
 168         PK11_FreeSlot(key->slot);
 169     }
 170 }
 171
 172 /*
 173  * grab the nss key from a VCardKey. If it doesn't exist, try to look it up
 174  */
 175 static SECKEYPrivateKey *
 176 vcard_emul_get_nss_key(VCardKey *key)
 177 {
 178     if (key->key) {
 179         return key->key;
 180     }
 181     /* NOTE: if we aren't logged into the token, this could return NULL */
 182     key->key = PK11_FindPrivateKeyFromCert(key->slot, key->cert, NULL);
 183     return key->key;
 184 }
 185
 186 /*
 187  * Map NSS errors to 7816 errors
 188  */
 189 static vcard_7816_status_t
 190 vcard_emul_map_error(int error)
 191 {
 192     switch (error) {
 193     case SEC_ERROR_TOKEN_NOT_LOGGED_IN:
 194         return VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED;
 195     case SEC_ERROR_BAD_DATA:
 196     case SEC_ERROR_OUTPUT_LEN:
 197     case SEC_ERROR_INPUT_LEN:
 198     case SEC_ERROR_INVALID_ARGS:
 199     case SEC_ERROR_INVALID_ALGORITHM:
 200     case SEC_ERROR_NO_KEY:
 201     case SEC_ERROR_INVALID_KEY:
 202     case SEC_ERROR_DECRYPTION_DISALLOWED:
 203         return VCARD7816_STATUS_ERROR_DATA_INVALID;
 204     case SEC_ERROR_NO_MEMORY:
 205         return VCARD7816_STATUS_EXC_ERROR_MEMORY_FAILURE;
 206     }
 207     return VCARD7816_STATUS_EXC_ERROR_CHANGE;
 208 }
 209
 210 /* RSA sign/decrypt with the key, signature happens 'in place' */
 211 vcard_7816_status_t
 212 vcard_emul_rsa_op(VCard *card, VCardKey *key,
 213                   unsigned char *buffer, int buffer_size)
 214 {
 215     SECKEYPrivateKey *priv_key;
 216     unsigned signature_len;
 217     PK11SlotInfo *slot;
 218     SECStatus rv;
 219     unsigned char buf[2048];
 220     unsigned char *bp = NULL;
 221     int pad_len;
 222     vcard_7816_status_t ret = VCARD7816_STATUS_SUCCESS;
 223
 224     if ((!nss_emul_init) || (key == NULL)) {
 225         /* couldn't get the key, indicate that we aren't logged in */
 226         return VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED;
 227     }
 228     priv_key = vcard_emul_get_nss_key(key);
 229     if (priv_key == NULL) {
 230         /* couldn't get the key, indicate that we aren't logged in */
 231         return VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED;
 232     }
 233     slot = vcard_emul_card_get_slot(card);
 234
 235     /*
 236      * this is only true of the rsa signature
 237      */
 238     signature_len = PK11_SignatureLen(priv_key);
 239     if (buffer_size != signature_len) {
 240         return  VCARD7816_STATUS_ERROR_DATA_INVALID;
 241     }
 242     /* be able to handle larger keys if necessariy */
 243     bp = &buf[0];
 244     if (sizeof(buf) < signature_len) {
 245         bp = g_malloc(signature_len);
 246     }
 247
 248     /*
 249      * do the raw operations. Some tokens claim to do CKM_RSA_X_509, but then
 250      * choke when they try to do the actual operations. Try to detect
 251      * those cases and treat them as if the token didn't claim support for
 252      * X_509.
 253      */
 254     if (key->failedX509 != VCardEmulTrue
 255                               && PK11_DoesMechanism(slot, CKM_RSA_X_509)) {
 256         rv = PK11_PrivDecryptRaw(priv_key, bp, &signature_len, signature_len,
 257                                  buffer, buffer_size);
 258         if (rv == SECSuccess) {
 259             assert(buffer_size == signature_len);
 260             memcpy(buffer, bp, signature_len);
 261             key->failedX509 = VCardEmulFalse;
 262             goto cleanup;
 263         }
 264         /*
 265          * we've had a successful X509 operation, this failure must be
 266          * somethine else
 267          */
 268         if (key->failedX509 == VCardEmulFalse) {
 269             ret = vcard_emul_map_error(PORT_GetError());
 270             goto cleanup;
 271         }
 272         /*
 273          * key->failedX509 must be Unknown at this point, try the
 274          * non-x_509 case
 275          */
 276     }
 277     /* token does not support CKM_RSA_X509, emulate that with CKM_RSA_PKCS */
 278     /* is this a PKCS #1 formatted signature? */
 279     if ((buffer[0] == 0) && (buffer[1] == 1)) {
 280         int i;
 281
 282         for (i = 2; i < buffer_size; i++) {
 283             /* rsa signature pad */
 284             if (buffer[i] != 0xff) {
 285                 break;
 286             }
 287         }
 288         if ((i < buffer_size) && (buffer[i] == 0)) {
 289             /* yes, we have a properly formated PKCS #1 signature */
 290             /*
 291              * NOTE: even if we accidentally got an encrypt buffer, which
 292              * through shear luck started with 00, 01, ff, 00, it won't matter
 293              * because the resulting Sign operation will effectively decrypt
 294              * the real buffer.
 295              */
 296             SECItem signature;
 297             SECItem hash;
 298
 299             i++;
 300             hash.data = &buffer[i];
 301             hash.len = buffer_size - i;
 302             signature.data = bp;
 303             signature.len = signature_len;
 304             rv = PK11_Sign(priv_key,  &signature, &hash);
 305             if (rv != SECSuccess) {
 306                 ret = vcard_emul_map_error(PORT_GetError());
 307                 goto cleanup;
 308             }
 309             assert(buffer_size == signature.len);
 310             memcpy(buffer, bp, signature.len);
 311             /*
 312              * we got here because either the X509 attempt failed, or the
 313              * token couldn't do the X509 operation, in either case stay
 314              * with the PKCS version for future operations on this key
 315              */
 316             key->failedX509 = VCardEmulTrue;
 317             goto cleanup;
 318         }
 319     }
 320     pad_len = buffer_size - signature_len;
 321     assert(pad_len < 4);
 322     /*
 323      * OK now we've decrypted the payload, package it up in PKCS #1 for the
 324      * upper layer.
 325      */
 326     buffer[0] = 0;
 327     buffer[1] = 2; /* RSA_encrypt  */
 328     pad_len -= 3; /* format is 0 || 2 || pad || 0 || data */
 329     /*
 330      * padding for PKCS #1 encrypted data is a string of random bytes. The
 331      * random butes protect against potential decryption attacks against RSA.
 332      * Since PrivDecrypt has already stripped those bytes, we can't reconstruct
 333      * them. This shouldn't matter to the upper level code which should just
 334      * strip this code out anyway, so We'll pad with a constant 3.
 335      */
 336     memset(&buffer[2], 0x03, pad_len);
 337     pad_len += 2; /* index to the end of the pad */
 338     buffer[pad_len] = 0;
 339     pad_len++; /* index to the start of the data */
 340     memcpy(&buffer[pad_len], bp, signature_len);
 341     /*
 342      * we got here because either the X509 attempt failed, or the
 343      * token couldn't do the X509 operation, in either case stay
 344      * with the PKCS version for future operations on this key
 345      */
 346     key->failedX509 = VCardEmulTrue;
 347 cleanup:
 348     if (bp != buf) {
 349         g_free(bp);
 350     }
 351     return ret;
 352 }
 353
 354 /*
 355  * Login functions
 356  */
 357 /* return the number of login attempts still possible on the card. if unknown,
 358  * return -1 */
 359 int
 360 vcard_emul_get_login_count(VCard *card)
 361 {
 362     return -1;
 363 }
 364
 365 /* login into the card, return the 7816 status word (sw2 || sw1) */
 366 vcard_7816_status_t
 367 vcard_emul_login(VCard *card, unsigned char *pin, int pin_len)
 368 {
 369     PK11SlotInfo *slot;
 370     unsigned char *pin_string;
 371     int i;
 372     SECStatus rv;
 373
 374     if (!nss_emul_init) {
 375         return VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED;
 376     }
 377     slot = vcard_emul_card_get_slot(card);
 378      /* We depend on the PKCS #11 module internal login state here because we
 379       * create a separate process to handle each guest instance. If we needed
 380       * to handle multiple guests from one process, then we would need to keep
 381       * a lot of extra state in our card structure
 382       * */
 383     pin_string = g_malloc(pin_len+1);
 384     memcpy(pin_string, pin, pin_len);
 385     pin_string[pin_len] = 0;
 386
 387     /* handle CAC expanded pins correctly */
 388     for (i = pin_len-1; i >= 0 && (pin_string[i] == 0xff); i--) {
 389         pin_string[i] = 0;
 390     }
 391
 392     rv = PK11_Authenticate(slot, PR_FALSE, pin_string);
 393     memset(pin_string, 0, pin_len);  /* don't let the pin hang around in memory
 394                                         to be snooped */
 395     g_free(pin_string);
 396     if (rv == SECSuccess) {
 397         return VCARD7816_STATUS_SUCCESS;
 398     }
 399     /* map the error from port get error */
 400     return VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED;
 401 }
 402
 403 void
 404 vcard_emul_reset(VCard *card, VCardPower power)
 405 {
 406     PK11SlotInfo *slot;
 407
 408     if (!nss_emul_init) {
 409         return;
 410     }
 411
 412     /*
 413      * if we reset the card (either power on or power off), we lose our login
 414      * state
 415      */
 416     /* TODO: we may also need to send insertion/removal events? */
 417     slot = vcard_emul_card_get_slot(card);
 418     PK11_Logout(slot); /* NOTE: ignoring SECStatus return value */
 419 }
 420
 421
 422 static VReader *
 423 vcard_emul_find_vreader_from_slot(PK11SlotInfo *slot)
 424 {
 425     VReaderList *reader_list = vreader_get_reader_list();
 426     VReaderListEntry *current_entry;
 427
 428     if (reader_list == NULL) {
 429         return NULL;
 430     }
 431     for (current_entry = vreader_list_get_first(reader_list); current_entry;
 432                         current_entry = vreader_list_get_next(current_entry)) {
 433         VReader *reader = vreader_list_get_reader(current_entry);
 434         VReaderEmul *reader_emul = vreader_get_private(reader);
 435         if (reader_emul->slot == slot) {
 436             vreader_list_delete(reader_list);
 437             return reader;
 438         }
 439         vreader_free(reader);
 440     }
 441
 442     vreader_list_delete(reader_list);
 443     return NULL;
 444 }
 445
 446 /*
 447  * create a new reader emul
 448  */
 449 static VReaderEmul *
 450 vreader_emul_new(PK11SlotInfo *slot, VCardEmulType type, const char *params)
 451 {
 452     VReaderEmul *new_reader_emul;
 453
 454     new_reader_emul = g_new(VReaderEmul, 1);
 455
 456     new_reader_emul->slot = PK11_ReferenceSlot(slot);
 457     new_reader_emul->default_type = type;
 458     new_reader_emul->type_params = g_strdup(params);
 459     new_reader_emul->present = PR_FALSE;
 460     new_reader_emul->series = 0;
 461     new_reader_emul->saved_vcard = NULL;
 462     return new_reader_emul;
 463 }
 464
 465 static void
 466 vreader_emul_delete(VReaderEmul *vreader_emul)
 467 {
 468     if (vreader_emul == NULL) {
 469         return;
 470     }
 471     if (vreader_emul->slot) {
 472         PK11_FreeSlot(vreader_emul->slot);
 473     }
 474     g_free(vreader_emul->type_params);
 475     g_free(vreader_emul);
 476 }
 477
 478 /*
 479  *  TODO: move this to emulater non-specific file
 480  */
 481 static VCardEmulType
 482 vcard_emul_get_type(VReader *vreader)
 483 {
 484     VReaderEmul *vreader_emul;
 485
 486     vreader_emul = vreader_get_private(vreader);
 487     if (vreader_emul && vreader_emul->default_type != VCARD_EMUL_NONE) {
 488         return vreader_emul->default_type;
 489     }
 490
 491     return vcard_emul_type_select(vreader);
 492 }
 493 /*
 494  *  TODO: move this to emulater non-specific file
 495  */
 496 static const char *
 497 vcard_emul_get_type_params(VReader *vreader)
 498 {
 499     VReaderEmul *vreader_emul;
 500
 501     vreader_emul = vreader_get_private(vreader);
 502     if (vreader_emul && vreader_emul->type_params) {
 503         return vreader_emul->type_params;
 504     }
 505
 506     return "";
 507 }
 508
 509 /* pull the slot out of the reader private data */
 510 static PK11SlotInfo *
 511 vcard_emul_reader_get_slot(VReader *vreader)
 512 {
 513     VReaderEmul *vreader_emul = vreader_get_private(vreader);
 514     if (vreader_emul == NULL) {
 515         return NULL;
 516     }
 517     return vreader_emul->slot;
 518 }
 519
 520 /*
 521  *  Card ATR's map to physical cards. vcard_alloc_atr will set appropriate
 522  *  historical bytes for any software emulated card. The remaining bytes can be
 523  *  used to indicate the actual emulator
 524  */
 525 static unsigned char *nss_atr;
 526 static int nss_atr_len;
 527
 528 void
 529 vcard_emul_get_atr(VCard *card, unsigned char *atr, int *atr_len)
 530 {
 531     int len;
 532     assert(atr != NULL);
 533
 534     if (nss_atr == NULL) {
 535         nss_atr = vcard_alloc_atr("NSS", &nss_atr_len);
 536     }
 537     len = MIN(nss_atr_len, *atr_len);
 538     memcpy(atr, nss_atr, len);
 539     *atr_len = len;
 540 }
 541
 542 /*
 543  * create a new card from certs and keys
 544  */
 545 static VCard *
 546 vcard_emul_make_card(VReader *reader,
 547                      unsigned char * const *certs, int *cert_len,
 548                      VCardKey *keys[], int cert_count)
 549 {
 550     VCardEmul *vcard_emul;
 551     VCard *vcard;
 552     PK11SlotInfo *slot;
 553     VCardEmulType type;
 554     const char *params;
 555
 556     type = vcard_emul_get_type(reader);
 557
 558     /* ignore the inserted card */
 559     if (type == VCARD_EMUL_NONE) {
 560         return NULL;
 561     }
 562     slot = vcard_emul_reader_get_slot(reader);
 563     if (slot == NULL) {
 564         return NULL;
 565     }
 566
 567     params = vcard_emul_get_type_params(reader);
 568     /* params these can be NULL */
 569
 570     vcard_emul = vcard_emul_new_card(slot);
 571     if (vcard_emul == NULL) {
 572         return NULL;
 573     }
 574     vcard = vcard_new(vcard_emul, vcard_emul_delete_card);
 575     if (vcard == NULL) {
 576         vcard_emul_delete_card(vcard_emul);
 577         return NULL;
 578     }
 579     vcard_init(reader, vcard, type, params, certs, cert_len, keys, cert_count);
 580     return vcard;
 581 }
 582
 583
 584 /*
 585  * 'clone' a physical card as a virtual card
 586  */
 587 static VCard *
 588 vcard_emul_mirror_card(VReader *vreader)
 589 {
 590     /*
 591      * lookup certs using the C_FindObjects. The Stan Cert handle won't give
 592      * us the real certs until we log in.
 593      */
 594     PK11GenericObject *firstObj, *thisObj;
 595     int cert_count;
 596     unsigned char **certs;
 597     int *cert_len;
 598     VCardKey **keys;
 599     PK11SlotInfo *slot;
 600     VCard *card;
 601
 602     slot = vcard_emul_reader_get_slot(vreader);
 603     if (slot == NULL) {
 604         return NULL;
 605     }
 606
 607     firstObj = PK11_FindGenericObjects(slot, CKO_CERTIFICATE);
 608     if (firstObj == NULL) {
 609         return NULL;
 610     }
 611
 612     /* count the certs */
 613     cert_count = 0;
 614     for (thisObj = firstObj; thisObj;
 615                              thisObj = PK11_GetNextGenericObject(thisObj)) {
 616         cert_count++;
 617     }
 618
 619     /* allocate the arrays */
 620     vcard_emul_alloc_arrays(&certs, &cert_len, &keys, cert_count);
 621
 622     /* fill in the arrays */
 623     cert_count = 0;
 624     for (thisObj = firstObj; thisObj;
 625                              thisObj = PK11_GetNextGenericObject(thisObj)) {
 626         SECItem derCert;
 627         CERTCertificate *cert;
 628         SECStatus rv;
 629
 630         rv = PK11_ReadRawAttribute(PK11_TypeGeneric, thisObj,
 631                                    CKA_VALUE, &derCert);
 632         if (rv != SECSuccess) {
 633             continue;
 634         }
 635         /* create floating temp cert. This gives us a cert structure even if
 636          * the token isn't logged in */
 637         cert = CERT_NewTempCertificate(CERT_GetDefaultCertDB(), &derCert,
 638                                        NULL, PR_FALSE, PR_TRUE);
 639         SECITEM_FreeItem(&derCert, PR_FALSE);
 640         if (cert == NULL) {
 641             continue;
 642         }
 643
 644         certs[cert_count] = cert->derCert.data;
 645         cert_len[cert_count] = cert->derCert.len;
 646         keys[cert_count] = vcard_emul_make_key(slot, cert);
 647         cert_count++;
 648         CERT_DestroyCertificate(cert); /* key obj still has a reference */
 649     }
 650
 651     /* now create the card */
 652     card = vcard_emul_make_card(vreader, certs, cert_len, keys, cert_count);
 653     g_free(certs);
 654     g_free(cert_len);
 655     g_free(keys);
 656
 657     return card;
 658 }
 659
 660 static VCardEmulType default_card_type = VCARD_EMUL_NONE;
 661 static const char *default_type_params = "";
 662
 663 /*
 664  * This thread looks for card and reader insertions and puts events on the
 665  * event queue
 666  */
 667 static void
 668 vcard_emul_event_thread(void *arg)
 669 {
 670     PK11SlotInfo *slot;
 671     VReader *vreader;
 672     VReaderEmul *vreader_emul;
 673     VCard *vcard;
 674     SECMODModule *module = (SECMODModule *)arg;
 675
 676     do {
 677         /*
 678          * XXX - the latency value doesn't matter one bit. you only get no
 679          * blocking (flags |= CKF_DONT_BLOCK) or PKCS11_WAIT_LATENCY (==500),
 680          * hard coded in coolkey.  And it isn't coolkey's fault - the timeout
 681          * value we pass get's dropped on the floor before C_WaitForSlotEvent
 682          * is called.
 683          */
 684         slot = SECMOD_WaitForAnyTokenEvent(module, 0, 500);
 685         if (slot == NULL) {
 686             /* this could be just a no event indication */
 687             if (PORT_GetError() == SEC_ERROR_NO_EVENT) {
 688                 continue;
 689             }
 690             break;
 691         }
 692         vreader = vcard_emul_find_vreader_from_slot(slot);
 693         if (vreader == NULL) {
 694             /* new vreader */
 695             vreader_emul = vreader_emul_new(slot, default_card_type,
 696                                             default_type_params);
 697             vreader = vreader_new(PK11_GetSlotName(slot), vreader_emul,
 698                                   vreader_emul_delete);
 699             PK11_FreeSlot(slot);
 700             slot = NULL;
 701             vreader_add_reader(vreader);
 702             vreader_free(vreader);
 703             continue;
 704         }
 705         /* card remove/insert */
 706         vreader_emul = vreader_get_private(vreader);
 707         if (PK11_IsPresent(slot)) {
 708             int series = PK11_GetSlotSeries(slot);
 709             if (series != vreader_emul->series) {
 710                 if (vreader_emul->present) {
 711                     vreader_insert_card(vreader, NULL);
 712                 }
 713                 vcard = vcard_emul_mirror_card(vreader);
 714                 vreader_insert_card(vreader, vcard);
 715                 vcard_free(vcard);
 716             }
 717             vreader_emul->series = series;
 718             vreader_emul->present = 1;
 719             vreader_free(vreader);
 720             PK11_FreeSlot(slot);
 721             continue;
 722         }
 723         if (vreader_emul->present) {
 724             vreader_insert_card(vreader, NULL);
 725         }
 726         vreader_emul->series = 0;
 727         vreader_emul->present = 0;
 728         PK11_FreeSlot(slot);
 729         vreader_free(vreader);
 730     } while (1);
 731 }
 732
 733 /* if the card is inserted when we start up, make sure our state is correct */
 734 static void
 735 vcard_emul_init_series(VReader *vreader, VCard *vcard)
 736 {
 737     VReaderEmul *vreader_emul = vreader_get_private(vreader);
 738     PK11SlotInfo *slot = vreader_emul->slot;
 739
 740     vreader_emul->present = PK11_IsPresent(slot);
 741     vreader_emul->series = PK11_GetSlotSeries(slot);
 742     if (vreader_emul->present == 0) {
 743         vreader_insert_card(vreader, NULL);
 744     }
 745 }
 746
 747 /*
 748  * each module has a separate wait call, create a thread for each module that
 749  * we are using.
 750  */
 751 static void
 752 vcard_emul_new_event_thread(SECMODModule *module)
 753 {
 754     PR_CreateThread(PR_SYSTEM_THREAD, vcard_emul_event_thread,
 755                      module, PR_PRIORITY_HIGH, PR_GLOBAL_THREAD,
 756                      PR_UNJOINABLE_THREAD, 0);
 757 }
 758
 759 static const VCardEmulOptions default_options = {
 760     .nss_db = NULL,
 761     .vreader = NULL,
 762     .vreader_count = 0,
 763     .hw_card_type = VCARD_EMUL_CAC,
 764     .hw_type_params = "",
 765     .use_hw = PR_TRUE
 766 };
 767
 768
 769 /*
 770  *  NSS needs the app to supply a password prompt. In our case the only time
 771  *  the password is supplied is as part of the Login APDU. The actual password
 772  *  is passed in the pw_arg in that case. In all other cases pw_arg should be
 773  *  NULL.
 774  */
 775 static char *
 776 vcard_emul_get_password(PK11SlotInfo *slot, PRBool retries, void *pw_arg)
 777 {
 778     /* if it didn't work the first time, don't keep trying */
 779     if (retries) {
 780         return NULL;
 781     }
 782     /* we are looking up a password when we don't have one in hand */
 783     if (pw_arg == NULL) {
 784         return NULL;
 785     }
 786     /* TODO: we really should verify that were are using the right slot */
 787     return PORT_Strdup(pw_arg);
 788 }
 789
 790 /* Force a card removal even if the card is not physically removed */
 791 VCardEmulError
 792 vcard_emul_force_card_remove(VReader *vreader)
 793 {
 794     if (!nss_emul_init || (vreader_card_is_present(vreader) != VREADER_OK)) {
 795         return VCARD_EMUL_FAIL; /* card is already removed */
 796     }
 797
 798     /* OK, remove it */
 799     vreader_insert_card(vreader, NULL);
 800     return VCARD_EMUL_OK;
 801 }
 802
 803 /* Re-insert of a card that has been removed by force removal */
 804 VCardEmulError
 805 vcard_emul_force_card_insert(VReader *vreader)
 806 {
 807     VReaderEmul *vreader_emul;
 808     VCard *vcard;
 809
 810     if (!nss_emul_init || (vreader_card_is_present(vreader) == VREADER_OK)) {
 811         return VCARD_EMUL_FAIL; /* card is already removed */
 812     }
 813     vreader_emul = vreader_get_private(vreader);
 814
 815     /* if it's a softcard, get the saved vcard from the reader emul structure */
 816     if (vreader_emul->saved_vcard) {
 817         vcard = vcard_reference(vreader_emul->saved_vcard);
 818     } else {
 819         /* it must be a physical card, rebuild it */
 820         if (!PK11_IsPresent(vreader_emul->slot)) {
 821             /* physical card has been removed, not way to reinsert it */
 822             return VCARD_EMUL_FAIL;
 823         }
 824         vcard = vcard_emul_mirror_card(vreader);
 825     }
 826     vreader_insert_card(vreader, vcard);
 827     vcard_free(vcard);
 828
 829     return VCARD_EMUL_OK;
 830 }
 831
 832
 833 static PRBool
 834 module_has_removable_hw_slots(SECMODModule *mod)
 835 {
 836     int i;
 837     PRBool ret = PR_FALSE;
 838     SECMODListLock *moduleLock = SECMOD_GetDefaultModuleListLock();
 839
 840     if (!moduleLock) {
 841         PORT_SetError(SEC_ERROR_NOT_INITIALIZED);
 842         return ret;
 843     }
 844     SECMOD_GetReadLock(moduleLock);
 845     for (i = 0; i < mod->slotCount; i++) {
 846         PK11SlotInfo *slot = mod->slots[i];
 847         if (PK11_IsRemovable(slot) && PK11_IsHW(slot)) {
 848             ret = PR_TRUE;
 849             break;
 850         }
 851     }
 852     SECMOD_ReleaseReadLock(moduleLock);
 853     return ret;
 854 }
 855
 856 /* Previously we returned FAIL if no readers found. This makes
 857  * no sense when using hardware, since there may be no readers connected
 858  * at the time vcard_emul_init is called, but they will be properly
 859  * recognized later. So Instead return FAIL only if no_hw==1 and no
 860  * vcards can be created (indicates error with certificates provided
 861  * or db), or if any other higher level error (NSS error, missing coolkey). */
 862 static int vcard_emul_init_called;
 863
 864 VCardEmulError
 865 vcard_emul_init(const VCardEmulOptions *options)
 866 {
 867     SECStatus rv;
 868     PRBool has_readers = PR_FALSE;
 869     VReader *vreader;
 870     VReaderEmul *vreader_emul;
 871     SECMODListLock *module_lock;
 872     SECMODModuleList *module_list;
 873     SECMODModuleList *mlp;
 874     int i;
 875
 876     if (vcard_emul_init_called) {
 877         return VCARD_EMUL_INIT_ALREADY_INITED;
 878     }
 879     vcard_emul_init_called = 1;
 880     vreader_init();
 881     vevent_queue_init();
 882
 883     if (options == NULL) {
 884         options = &default_options;
 885     }
 886
 887     /* first initialize NSS */
 888     if (options->nss_db) {
 889         rv = NSS_Init(options->nss_db);
 890     } else {
 891         gchar *path;
 892 #ifndef _WIN32
 893         path = g_strdup("/etc/pki/nssdb");
 894 #else
 895         if (g_get_system_config_dirs() == NULL ||
 896             g_get_system_config_dirs()[0] == NULL) {
 897             return VCARD_EMUL_FAIL;
 898         }
 899
 900         path = g_build_filename(
 901             g_get_system_config_dirs()[0], "pki", "nssdb", NULL);
 902 #endif
 903
 904         rv = NSS_Init(path);
 905         g_free(path);
 906     }
 907     if (rv != SECSuccess) {
 908         return VCARD_EMUL_FAIL;
 909     }
 910     /* Set password callback function */
 911     PK11_SetPasswordFunc(vcard_emul_get_password);
 912
 913     /* set up soft cards emulated by software certs rather than physical cards
 914      * */
 915     for (i = 0; i < options->vreader_count; i++) {
 916         int j;
 917         int cert_count;
 918         unsigned char **certs;
 919         int *cert_len;
 920         VCardKey **keys;
 921         PK11SlotInfo *slot;
 922
 923         slot = PK11_FindSlotByName(options->vreader[i].name);
 924         if (slot == NULL) {
 925             continue;
 926         }
 927         vreader_emul = vreader_emul_new(slot, options->vreader[i].card_type,
 928                                         options->vreader[i].type_params);
 929         vreader = vreader_new(options->vreader[i].vname, vreader_emul,
 930                               vreader_emul_delete);
 931         vreader_add_reader(vreader);
 932
 933         vcard_emul_alloc_arrays(&certs, &cert_len, &keys,
 934                                 options->vreader[i].cert_count);
 935
 936         cert_count = 0;
 937         for (j = 0; j < options->vreader[i].cert_count; j++) {
 938             /* we should have a better way of identifying certs than by
 939              * nickname here */
 940             CERTCertificate *cert = PK11_FindCertFromNickname(
 941                                         options->vreader[i].cert_name[j],
 942                                         NULL);
 943             if (cert == NULL) {
 944                 continue;
 945             }
 946             certs[cert_count] = cert->derCert.data;
 947             cert_len[cert_count] = cert->derCert.len;
 948             keys[cert_count] = vcard_emul_make_key(slot, cert);
 949             /* this is safe because the key is still holding a cert reference */
 950             CERT_DestroyCertificate(cert);
 951             cert_count++;
 952         }
 953         if (cert_count) {
 954             VCard *vcard = vcard_emul_make_card(vreader, certs, cert_len,
 955                                                 keys, cert_count);
 956             vreader_insert_card(vreader, vcard);
 957             vcard_emul_init_series(vreader, vcard);
 958             /* allow insertion and removal of soft cards */
 959             vreader_emul->saved_vcard = vcard_reference(vcard);
 960             vcard_free(vcard);
 961             vreader_free(vreader);
 962             has_readers = PR_TRUE;
 963         }
 964         g_free(certs);
 965         g_free(cert_len);
 966         g_free(keys);
 967     }
 968
 969     /* if we aren't suppose to use hw, skip looking up hardware tokens */
 970     if (!options->use_hw) {
 971         nss_emul_init = has_readers;
 972         return has_readers ? VCARD_EMUL_OK : VCARD_EMUL_FAIL;
 973     }
 974
 975     /* make sure we have some PKCS #11 module loaded */
 976     module_lock = SECMOD_GetDefaultModuleListLock();
 977     module_list = SECMOD_GetDefaultModuleList();
 978     SECMOD_GetReadLock(module_lock);
 979     for (mlp = module_list; mlp; mlp = mlp->next) {
 980         SECMODModule *module = mlp->module;
 981         if (module_has_removable_hw_slots(module)) {
 982             break;
 983         }
 984     }
 985     SECMOD_ReleaseReadLock(module_lock);
 986
 987     /* now examine all the slots, finding which should be readers */
 988     /* We should control this with options. For now we mirror out any
 989      * removable hardware slot */
 990     default_card_type = options->hw_card_type;
 991     default_type_params = g_strdup(options->hw_type_params);
 992
 993     SECMOD_GetReadLock(module_lock);
 994     for (mlp = module_list; mlp; mlp = mlp->next) {
 995         SECMODModule *module = mlp->module;
 996
 997         /* Ignore the internal module */
 998         if (module == NULL || module == SECMOD_GetInternalModule()) {
 999             continue;
1000         }
1001
1002         for (i = 0; i < module->slotCount; i++) {
1003             PK11SlotInfo *slot = module->slots[i];
1004
1005             /* only map removable HW slots */
1006             if (slot == NULL || !PK11_IsRemovable(slot) || !PK11_IsHW(slot)) {
1007                 continue;
1008             }
1009             if (strcmp("E-Gate 0 0", PK11_GetSlotName(slot)) == 0) {
1010                 /*
1011                  * coolkey <= 1.1.0-20 emulates this reader if it can't find
1012                  * any hardware readers. This causes problems, warn user of
1013                  * problems.
1014                  */
1015                 fprintf(stderr, "known bad coolkey version - see "
1016                         "https://bugzilla.redhat.com/show_bug.cgi?id=802435\n");
1017                 continue;
1018             }
1019             vreader_emul = vreader_emul_new(slot, options->hw_card_type,
1020                                             options->hw_type_params);
1021             vreader = vreader_new(PK11_GetSlotName(slot), vreader_emul,
1022                                   vreader_emul_delete);
1023             vreader_add_reader(vreader);
1024
1025             if (PK11_IsPresent(slot)) {
1026                 VCard *vcard;
1027                 vcard = vcard_emul_mirror_card(vreader);
1028                 vreader_insert_card(vreader, vcard);
1029                 vcard_emul_init_series(vreader, vcard);
1030                 vcard_free(vcard);
1031             }
1032         }
1033         vcard_emul_new_event_thread(module);
1034     }
1035     SECMOD_ReleaseReadLock(module_lock);
1036     nss_emul_init = PR_TRUE;
1037
1038     return VCARD_EMUL_OK;
1039 }
1040
1041 /* Recreate card insert events for all readers (user should
1042  * deduce implied reader insert. perhaps do a reader insert as well?)
1043  */
1044 void
1045 vcard_emul_replay_insertion_events(void)
1046 {
1047     VReaderListEntry *current_entry;
1048     VReaderListEntry *next_entry;
1049     VReaderList *list = vreader_get_reader_list();
1050
1051     for (current_entry = vreader_list_get_first(list); current_entry;
1052             current_entry = next_entry) {
1053         VReader *vreader = vreader_list_get_reader(current_entry);
1054         next_entry = vreader_list_get_next(current_entry);
1055         vreader_queue_card_event(vreader);
1056     }
1057
1058     vreader_list_delete(list);
1059 }
1060
1061 /*
1062  *  Silly little functions to help parsing our argument string
1063  */
1064 static int
1065 count_tokens(const char *str, char token, char token_end)
1066 {
1067     int count = 0;
1068
1069     for (; *str; str++) {
1070         if (*str == token) {
1071             count++;
1072         }
1073         if (*str == token_end) {
1074             break;
1075         }
1076     }
1077     return count;
1078 }
1079
1080 static const char *
1081 strip(const char *str)
1082 {
1083     for (; *str && isspace(*str); str++) {
1084     }
1085     return str;
1086 }
1087
1088 static const char *
1089 find_blank(const char *str)
1090 {
1091     for (; *str && !isspace(*str); str++) {
1092     }
1093     return str;
1094 }
1095
1096
1097 /*
1098  *  We really want to use some existing argument parsing library here. That
1099  *  would give us a consistent look */
1100 static VCardEmulOptions options;
1101 #define READER_STEP 4
1102
1103 /* Expects "args" to be at the beginning of a token (ie right after the ','
1104  * ending the previous token), and puts the next token start in "token",
1105  * and its length in "token_length". "token" will not be nul-terminated.
1106  * After calling the macro, "args" will be advanced to the beginning of
1107  * the next token.
1108  * This macro may call continue or break.
1109  */
1110 #define NEXT_TOKEN(token) \
1111             (token) = args; \
1112             args = strpbrk(args, ",)"); \
1113             if (*args == 0) { \
1114                 break; \
1115             } \
1116             if (*args == ')') { \
1117                 args++; \
1118                 continue; \
1119             } \
1120             (token##_length) = args - (token); \
1121             args = strip(args+1);
1122
1123 VCardEmulOptions *
1124 vcard_emul_options(const char *args)
1125 {
1126     int reader_count = 0;
1127     VCardEmulOptions *opts;
1128
1129     /* Allow the future use of allocating the options structure on the fly */
1130     memcpy(&options, &default_options, sizeof(options));
1131     opts = &options;
1132
1133     do {
1134         args = strip(args); /* strip off the leading spaces */
1135         if (*args == ',') {
1136             continue;
1137         }
1138         /* soft=(slot_name,virt_name,emul_type,emul_flags,cert_1, (no eol)
1139          *       cert_2,cert_3...) */
1140         if (strncmp(args, "soft=", 5) == 0) {
1141             const char *name;
1142             size_t name_length;
1143             const char *vname;
1144             size_t vname_length;
1145             const char *type_params;
1146             size_t type_params_length;
1147             char type_str[100];
1148             VCardEmulType type;
1149             int count, i;
1150             VirtualReaderOptions *vreaderOpt;
1151
1152             args = strip(args + 5);
1153             if (*args != '(') {
1154                 continue;
1155             }
1156             args = strip(args+1);
1157
1158             NEXT_TOKEN(name)
1159             NEXT_TOKEN(vname)
1160             NEXT_TOKEN(type_params)
1161             type_params_length = MIN(type_params_length, sizeof(type_str)-1);
1162             memcpy(type_str, type_params, type_params_length);
1163             type_str[type_params_length] = '\0';
1164             type = vcard_emul_type_from_string(type_str);
1165
1166             NEXT_TOKEN(type_params)
1167
1168             if (*args == 0) {
1169                 break;
1170             }
1171
1172             if (opts->vreader_count >= reader_count) {
1173                 reader_count += READER_STEP;
1174                 opts->vreader = g_renew(VirtualReaderOptions, opts->vreader,
1175                                         reader_count);
1176             }
1177             vreaderOpt = &opts->vreader[opts->vreader_count];
1178             vreaderOpt->name = g_strndup(name, name_length);
1179             vreaderOpt->vname = g_strndup(vname, vname_length);
1180             vreaderOpt->card_type = type;
1181             vreaderOpt->type_params =
1182                 g_strndup(type_params, type_params_length);
1183             count = count_tokens(args, ',', ')') + 1;
1184             vreaderOpt->cert_count = count;
1185             vreaderOpt->cert_name = g_new(char *, count);
1186             for (i = 0; i < count; i++) {
1187                 const char *cert = args;
1188                 args = strpbrk(args, ",)");
1189                 vreaderOpt->cert_name[i] = g_strndup(cert, args - cert);
1190                 args = strip(args+1);
1191             }
1192             if (*args == ')') {
1193                 args++;
1194             }
1195             opts->vreader_count++;
1196         /* use_hw= */
1197         } else if (strncmp(args, "use_hw=", 7) == 0) {
1198             args = strip(args+7);
1199             if (*args == '0' || *args == 'N' || *args == 'n' || *args == 'F') {
1200                 opts->use_hw = PR_FALSE;
1201             } else {
1202                 opts->use_hw = PR_TRUE;
1203             }
1204             args = find_blank(args);
1205         /* hw_type= */
1206         } else if (strncmp(args, "hw_type=", 8) == 0) {
1207             args = strip(args+8);
1208             opts->hw_card_type = vcard_emul_type_from_string(args);
1209             args = find_blank(args);
1210         /* hw_params= */
1211         } else if (strncmp(args, "hw_params=", 10) == 0) {
1212             const char *params;
1213             args = strip(args+10);
1214             params = args;
1215             args = find_blank(args);
1216             opts->hw_type_params = g_strndup(params, args-params);
1217         /* db="/data/base/path" */
1218         } else if (strncmp(args, "db=", 3) == 0) {
1219             const char *db;
1220             args = strip(args+3);
1221             if (*args != '"') {
1222                 continue;
1223             }
1224             args++;
1225             db = args;
1226             args = strpbrk(args, "\"\n");
1227             opts->nss_db = g_strndup(db, args-db);
1228             if (*args != 0) {
1229                 args++;
1230             }
1231         } else {
1232             args = find_blank(args);
1233         }
1234     } while (*args != 0);
1235
1236     return opts;
1237 }
1238
1239 void
1240 vcard_emul_usage(void)
1241 {
1242    fprintf(stderr,
1243 "emul args: comma separated list of the following arguments\n"
1244 " db={nss_database}               (default sql:/etc/pki/nssdb)\n"
1245 " use_hw=[yes|no]                 (default yes)\n"
1246 " hw_type={card_type_to_emulate}  (default CAC)\n"
1247 " hw_param={param_for_card}       (default \"\")\n"
1248 " soft=({slot_name},{vreader_name},{card_type_to_emulate},{params_for_card},\n"
1249 "       {cert1},{cert2},{cert3}    (default none)\n"
1250 "\n"
1251 "  {nss_database}          The location of the NSS cert & key database\n"
1252 "  {card_type_to_emulate}  What card interface to present to the guest\n"
1253 "  {param_for_card}        Card interface specific parameters\n"
1254 "  {slot_name}             NSS slot that contains the certs\n"
1255 "  {vreader_name}          Virtual reader name to present to the guest\n"
1256 "  {certN}                 Nickname of the certificate n on the virtual card\n"
1257 "\n"
1258 "These parameters come as a single string separated by blanks or newlines."
1259 "\n"
1260 "Unless use_hw is set to no, all tokens that look like removable hardware\n"
1261 "tokens will be presented to the guest using the emulator specified by\n"
1262 "hw_type, and parameters of hw_param.\n"
1263 "\n"
1264 "If more one or more soft= parameters are specified, these readers will be\n"
1265 "presented to the guest\n");
1266 }