149ab747fSPaolo Bonzini /*
249ab747fSPaolo Bonzini * CCID Card Device. Emulated card.
349ab747fSPaolo Bonzini *
449ab747fSPaolo Bonzini * Copyright (c) 2011 Red Hat.
549ab747fSPaolo Bonzini * Written by Alon Levy.
649ab747fSPaolo Bonzini *
749ab747fSPaolo Bonzini * This code is licensed under the GNU LGPL, version 2 or later.
849ab747fSPaolo Bonzini */
949ab747fSPaolo Bonzini
1049ab747fSPaolo Bonzini /*
1149ab747fSPaolo Bonzini * It can be used to provide access to the local hardware in a non exclusive
1249ab747fSPaolo Bonzini * way, or it can use certificates. It requires the usb-ccid bus.
1349ab747fSPaolo Bonzini *
1449ab747fSPaolo Bonzini * Usage 1: standard, mirror hardware reader+card:
1549ab747fSPaolo Bonzini * qemu .. -usb -device usb-ccid -device ccid-card-emulated
1649ab747fSPaolo Bonzini *
1749ab747fSPaolo Bonzini * Usage 2: use certificates, no hardware required
1849ab747fSPaolo Bonzini * one time: create the certificates:
1949ab747fSPaolo Bonzini * for i in 1 2 3; do
2049ab747fSPaolo Bonzini * certutil -d /etc/pki/nssdb -x -t "CT,CT,CT" -S -s "CN=user$i" -n user$i
2149ab747fSPaolo Bonzini * done
2249ab747fSPaolo Bonzini * qemu .. -usb -device usb-ccid \
2349ab747fSPaolo Bonzini * -device ccid-card-emulated,cert1=user1,cert2=user2,cert3=user3
2449ab747fSPaolo Bonzini *
2549ab747fSPaolo Bonzini * If you use a non default db for the certificates you can specify it using
2649ab747fSPaolo Bonzini * the db parameter.
2749ab747fSPaolo Bonzini */
2849ab747fSPaolo Bonzini
29e532b2e0SPeter Maydell #include "qemu/osdep.h"
300f5c642dSMichal Privoznik #include <libcacard.h>
3149ab747fSPaolo Bonzini
3249ab747fSPaolo Bonzini #include "qemu/thread.h"
335c43b603SAmey Narkhede #include "qemu/lockable.h"
34f664b882SMarc-André Lureau #include "qemu/main-loop.h"
350b8fa32fSMarkus Armbruster #include "qemu/module.h"
3647b43a1fSPaolo Bonzini #include "ccid.h"
37a27bd6c7SMarkus Armbruster #include "hw/qdev-properties.h"
38cc847bfdSMao Zhongyi #include "qapi/error.h"
39db1015e9SEduardo Habkost #include "qom/object.h"
4049ab747fSPaolo Bonzini
4149ab747fSPaolo Bonzini #define DPRINTF(card, lvl, fmt, ...) \
4249ab747fSPaolo Bonzini do {\
4349ab747fSPaolo Bonzini if (lvl <= card->debug) {\
4449ab747fSPaolo Bonzini printf("ccid-card-emul: %s: " fmt , __func__, ## __VA_ARGS__);\
4549ab747fSPaolo Bonzini } \
4649ab747fSPaolo Bonzini } while (0)
4749ab747fSPaolo Bonzini
4835997599SCao jin
4935997599SCao jin #define TYPE_EMULATED_CCID "ccid-card-emulated"
50db1015e9SEduardo Habkost typedef struct EmulatedState EmulatedState;
518110fa1dSEduardo Habkost DECLARE_INSTANCE_CHECKER(EmulatedState, EMULATED_CCID_CARD,
528110fa1dSEduardo Habkost TYPE_EMULATED_CCID)
5349ab747fSPaolo Bonzini
5449ab747fSPaolo Bonzini #define BACKEND_NSS_EMULATED_NAME "nss-emulated"
5549ab747fSPaolo Bonzini #define BACKEND_CERTIFICATES_NAME "certificates"
5649ab747fSPaolo Bonzini
5749ab747fSPaolo Bonzini enum {
5849ab747fSPaolo Bonzini BACKEND_NSS_EMULATED = 1,
5949ab747fSPaolo Bonzini BACKEND_CERTIFICATES
6049ab747fSPaolo Bonzini };
6149ab747fSPaolo Bonzini
6249ab747fSPaolo Bonzini #define DEFAULT_BACKEND BACKEND_NSS_EMULATED
6349ab747fSPaolo Bonzini
6449ab747fSPaolo Bonzini
6549ab747fSPaolo Bonzini enum {
6649ab747fSPaolo Bonzini EMUL_READER_INSERT = 0,
6749ab747fSPaolo Bonzini EMUL_READER_REMOVE,
6849ab747fSPaolo Bonzini EMUL_CARD_INSERT,
6949ab747fSPaolo Bonzini EMUL_CARD_REMOVE,
7049ab747fSPaolo Bonzini EMUL_GUEST_APDU,
7149ab747fSPaolo Bonzini EMUL_RESPONSE_APDU,
7249ab747fSPaolo Bonzini EMUL_ERROR,
7349ab747fSPaolo Bonzini };
7449ab747fSPaolo Bonzini
emul_event_to_string(uint32_t emul_event)7549ab747fSPaolo Bonzini static const char *emul_event_to_string(uint32_t emul_event)
7649ab747fSPaolo Bonzini {
7749ab747fSPaolo Bonzini switch (emul_event) {
7849ab747fSPaolo Bonzini case EMUL_READER_INSERT:
7949ab747fSPaolo Bonzini return "EMUL_READER_INSERT";
8049ab747fSPaolo Bonzini case EMUL_READER_REMOVE:
8149ab747fSPaolo Bonzini return "EMUL_READER_REMOVE";
8249ab747fSPaolo Bonzini case EMUL_CARD_INSERT:
8349ab747fSPaolo Bonzini return "EMUL_CARD_INSERT";
8449ab747fSPaolo Bonzini case EMUL_CARD_REMOVE:
8549ab747fSPaolo Bonzini return "EMUL_CARD_REMOVE";
8649ab747fSPaolo Bonzini case EMUL_GUEST_APDU:
8749ab747fSPaolo Bonzini return "EMUL_GUEST_APDU";
8849ab747fSPaolo Bonzini case EMUL_RESPONSE_APDU:
8949ab747fSPaolo Bonzini return "EMUL_RESPONSE_APDU";
9049ab747fSPaolo Bonzini case EMUL_ERROR:
9149ab747fSPaolo Bonzini return "EMUL_ERROR";
9249ab747fSPaolo Bonzini }
9349ab747fSPaolo Bonzini return "UNKNOWN";
9449ab747fSPaolo Bonzini }
9549ab747fSPaolo Bonzini
9649ab747fSPaolo Bonzini typedef struct EmulEvent {
9749ab747fSPaolo Bonzini QSIMPLEQ_ENTRY(EmulEvent) entry;
9849ab747fSPaolo Bonzini union {
9949ab747fSPaolo Bonzini struct {
10049ab747fSPaolo Bonzini uint32_t type;
10149ab747fSPaolo Bonzini } gen;
10249ab747fSPaolo Bonzini struct {
10349ab747fSPaolo Bonzini uint32_t type;
10449ab747fSPaolo Bonzini uint64_t code;
10549ab747fSPaolo Bonzini } error;
10649ab747fSPaolo Bonzini struct {
10749ab747fSPaolo Bonzini uint32_t type;
10849ab747fSPaolo Bonzini uint32_t len;
10949ab747fSPaolo Bonzini uint8_t data[];
11049ab747fSPaolo Bonzini } data;
11149ab747fSPaolo Bonzini } p;
11249ab747fSPaolo Bonzini } EmulEvent;
11349ab747fSPaolo Bonzini
11449ab747fSPaolo Bonzini #define MAX_ATR_SIZE 40
11549ab747fSPaolo Bonzini struct EmulatedState {
11649ab747fSPaolo Bonzini CCIDCardState base;
11749ab747fSPaolo Bonzini uint8_t debug;
11849ab747fSPaolo Bonzini char *backend_str;
11949ab747fSPaolo Bonzini uint32_t backend;
12049ab747fSPaolo Bonzini char *cert1;
12149ab747fSPaolo Bonzini char *cert2;
12249ab747fSPaolo Bonzini char *cert3;
12349ab747fSPaolo Bonzini char *db;
12449ab747fSPaolo Bonzini uint8_t atr[MAX_ATR_SIZE];
12549ab747fSPaolo Bonzini uint8_t atr_length;
126b58deb34SPaolo Bonzini QSIMPLEQ_HEAD(, EmulEvent) event_list;
12749ab747fSPaolo Bonzini QemuMutex event_list_mutex;
12849ab747fSPaolo Bonzini QemuThread event_thread_id;
12949ab747fSPaolo Bonzini VReader *reader;
130b58deb34SPaolo Bonzini QSIMPLEQ_HEAD(, EmulEvent) guest_apdu_list;
13149ab747fSPaolo Bonzini QemuMutex vreader_mutex; /* and guest_apdu_list mutex */
13249ab747fSPaolo Bonzini QemuMutex handle_apdu_mutex;
13349ab747fSPaolo Bonzini QemuCond handle_apdu_cond;
134c1129f6bSPaolo Bonzini EventNotifier notifier;
13549ab747fSPaolo Bonzini int quit_apdu_thread;
13649ab747fSPaolo Bonzini QemuThread apdu_thread_id;
13749ab747fSPaolo Bonzini };
13849ab747fSPaolo Bonzini
emulated_apdu_from_guest(CCIDCardState * base,const uint8_t * apdu,uint32_t len)13949ab747fSPaolo Bonzini static void emulated_apdu_from_guest(CCIDCardState *base,
14049ab747fSPaolo Bonzini const uint8_t *apdu, uint32_t len)
14149ab747fSPaolo Bonzini {
14235997599SCao jin EmulatedState *card = EMULATED_CCID_CARD(base);
1430a553c12SMarkus Armbruster EmulEvent *event = g_malloc(sizeof(EmulEvent) + len);
14449ab747fSPaolo Bonzini
14549ab747fSPaolo Bonzini assert(event);
14649ab747fSPaolo Bonzini event->p.data.type = EMUL_GUEST_APDU;
14749ab747fSPaolo Bonzini event->p.data.len = len;
14849ab747fSPaolo Bonzini memcpy(event->p.data.data, apdu, len);
14949ab747fSPaolo Bonzini qemu_mutex_lock(&card->vreader_mutex);
15049ab747fSPaolo Bonzini QSIMPLEQ_INSERT_TAIL(&card->guest_apdu_list, event, entry);
15149ab747fSPaolo Bonzini qemu_mutex_unlock(&card->vreader_mutex);
15249ab747fSPaolo Bonzini qemu_mutex_lock(&card->handle_apdu_mutex);
15349ab747fSPaolo Bonzini qemu_cond_signal(&card->handle_apdu_cond);
15449ab747fSPaolo Bonzini qemu_mutex_unlock(&card->handle_apdu_mutex);
15549ab747fSPaolo Bonzini }
15649ab747fSPaolo Bonzini
emulated_get_atr(CCIDCardState * base,uint32_t * len)15749ab747fSPaolo Bonzini static const uint8_t *emulated_get_atr(CCIDCardState *base, uint32_t *len)
15849ab747fSPaolo Bonzini {
15935997599SCao jin EmulatedState *card = EMULATED_CCID_CARD(base);
16049ab747fSPaolo Bonzini
16149ab747fSPaolo Bonzini *len = card->atr_length;
16249ab747fSPaolo Bonzini return card->atr;
16349ab747fSPaolo Bonzini }
16449ab747fSPaolo Bonzini
emulated_push_event(EmulatedState * card,EmulEvent * event)16549ab747fSPaolo Bonzini static void emulated_push_event(EmulatedState *card, EmulEvent *event)
16649ab747fSPaolo Bonzini {
16749ab747fSPaolo Bonzini qemu_mutex_lock(&card->event_list_mutex);
16849ab747fSPaolo Bonzini QSIMPLEQ_INSERT_TAIL(&(card->event_list), event, entry);
16949ab747fSPaolo Bonzini qemu_mutex_unlock(&card->event_list_mutex);
170c1129f6bSPaolo Bonzini event_notifier_set(&card->notifier);
17149ab747fSPaolo Bonzini }
17249ab747fSPaolo Bonzini
emulated_push_type(EmulatedState * card,uint32_t type)17349ab747fSPaolo Bonzini static void emulated_push_type(EmulatedState *card, uint32_t type)
17449ab747fSPaolo Bonzini {
17598f34339SMarkus Armbruster EmulEvent *event = g_new(EmulEvent, 1);
17649ab747fSPaolo Bonzini
17749ab747fSPaolo Bonzini assert(event);
17849ab747fSPaolo Bonzini event->p.gen.type = type;
17949ab747fSPaolo Bonzini emulated_push_event(card, event);
18049ab747fSPaolo Bonzini }
18149ab747fSPaolo Bonzini
emulated_push_error(EmulatedState * card,uint64_t code)18249ab747fSPaolo Bonzini static void emulated_push_error(EmulatedState *card, uint64_t code)
18349ab747fSPaolo Bonzini {
18498f34339SMarkus Armbruster EmulEvent *event = g_new(EmulEvent, 1);
18549ab747fSPaolo Bonzini
18649ab747fSPaolo Bonzini assert(event);
18749ab747fSPaolo Bonzini event->p.error.type = EMUL_ERROR;
18849ab747fSPaolo Bonzini event->p.error.code = code;
18949ab747fSPaolo Bonzini emulated_push_event(card, event);
19049ab747fSPaolo Bonzini }
19149ab747fSPaolo Bonzini
emulated_push_data_type(EmulatedState * card,uint32_t type,const uint8_t * data,uint32_t len)19249ab747fSPaolo Bonzini static void emulated_push_data_type(EmulatedState *card, uint32_t type,
19349ab747fSPaolo Bonzini const uint8_t *data, uint32_t len)
19449ab747fSPaolo Bonzini {
19549ab747fSPaolo Bonzini EmulEvent *event = (EmulEvent *)g_malloc(sizeof(EmulEvent) + len);
19649ab747fSPaolo Bonzini
19749ab747fSPaolo Bonzini assert(event);
19849ab747fSPaolo Bonzini event->p.data.type = type;
19949ab747fSPaolo Bonzini event->p.data.len = len;
20049ab747fSPaolo Bonzini memcpy(event->p.data.data, data, len);
20149ab747fSPaolo Bonzini emulated_push_event(card, event);
20249ab747fSPaolo Bonzini }
20349ab747fSPaolo Bonzini
emulated_push_reader_insert(EmulatedState * card)20449ab747fSPaolo Bonzini static void emulated_push_reader_insert(EmulatedState *card)
20549ab747fSPaolo Bonzini {
20649ab747fSPaolo Bonzini emulated_push_type(card, EMUL_READER_INSERT);
20749ab747fSPaolo Bonzini }
20849ab747fSPaolo Bonzini
emulated_push_reader_remove(EmulatedState * card)20949ab747fSPaolo Bonzini static void emulated_push_reader_remove(EmulatedState *card)
21049ab747fSPaolo Bonzini {
21149ab747fSPaolo Bonzini emulated_push_type(card, EMUL_READER_REMOVE);
21249ab747fSPaolo Bonzini }
21349ab747fSPaolo Bonzini
emulated_push_card_insert(EmulatedState * card,const uint8_t * atr,uint32_t len)21449ab747fSPaolo Bonzini static void emulated_push_card_insert(EmulatedState *card,
21549ab747fSPaolo Bonzini const uint8_t *atr, uint32_t len)
21649ab747fSPaolo Bonzini {
21749ab747fSPaolo Bonzini emulated_push_data_type(card, EMUL_CARD_INSERT, atr, len);
21849ab747fSPaolo Bonzini }
21949ab747fSPaolo Bonzini
emulated_push_card_remove(EmulatedState * card)22049ab747fSPaolo Bonzini static void emulated_push_card_remove(EmulatedState *card)
22149ab747fSPaolo Bonzini {
22249ab747fSPaolo Bonzini emulated_push_type(card, EMUL_CARD_REMOVE);
22349ab747fSPaolo Bonzini }
22449ab747fSPaolo Bonzini
emulated_push_response_apdu(EmulatedState * card,const uint8_t * apdu,uint32_t len)22549ab747fSPaolo Bonzini static void emulated_push_response_apdu(EmulatedState *card,
22649ab747fSPaolo Bonzini const uint8_t *apdu, uint32_t len)
22749ab747fSPaolo Bonzini {
22849ab747fSPaolo Bonzini emulated_push_data_type(card, EMUL_RESPONSE_APDU, apdu, len);
22949ab747fSPaolo Bonzini }
23049ab747fSPaolo Bonzini
23149ab747fSPaolo Bonzini #define APDU_BUF_SIZE 270
handle_apdu_thread(void * arg)23249ab747fSPaolo Bonzini static void *handle_apdu_thread(void* arg)
23349ab747fSPaolo Bonzini {
23449ab747fSPaolo Bonzini EmulatedState *card = arg;
23549ab747fSPaolo Bonzini uint8_t recv_data[APDU_BUF_SIZE];
23649ab747fSPaolo Bonzini int recv_len;
23749ab747fSPaolo Bonzini VReaderStatus reader_status;
23849ab747fSPaolo Bonzini EmulEvent *event;
23949ab747fSPaolo Bonzini
24049ab747fSPaolo Bonzini while (1) {
24149ab747fSPaolo Bonzini qemu_mutex_lock(&card->handle_apdu_mutex);
24249ab747fSPaolo Bonzini qemu_cond_wait(&card->handle_apdu_cond, &card->handle_apdu_mutex);
24349ab747fSPaolo Bonzini qemu_mutex_unlock(&card->handle_apdu_mutex);
24449ab747fSPaolo Bonzini if (card->quit_apdu_thread) {
24549ab747fSPaolo Bonzini card->quit_apdu_thread = 0; /* debugging */
24649ab747fSPaolo Bonzini break;
24749ab747fSPaolo Bonzini }
2485c43b603SAmey Narkhede WITH_QEMU_LOCK_GUARD(&card->vreader_mutex) {
24949ab747fSPaolo Bonzini while (!QSIMPLEQ_EMPTY(&card->guest_apdu_list)) {
25049ab747fSPaolo Bonzini event = QSIMPLEQ_FIRST(&card->guest_apdu_list);
251daa500caSMarc-André Lureau assert(event != NULL);
25249ab747fSPaolo Bonzini QSIMPLEQ_REMOVE_HEAD(&card->guest_apdu_list, entry);
25349ab747fSPaolo Bonzini if (event->p.data.type != EMUL_GUEST_APDU) {
25449ab747fSPaolo Bonzini DPRINTF(card, 1, "unexpected message in handle_apdu_thread\n");
25549ab747fSPaolo Bonzini g_free(event);
25649ab747fSPaolo Bonzini continue;
25749ab747fSPaolo Bonzini }
25849ab747fSPaolo Bonzini if (card->reader == NULL) {
25949ab747fSPaolo Bonzini DPRINTF(card, 1, "reader is NULL\n");
26049ab747fSPaolo Bonzini g_free(event);
26149ab747fSPaolo Bonzini continue;
26249ab747fSPaolo Bonzini }
26349ab747fSPaolo Bonzini recv_len = sizeof(recv_data);
26449ab747fSPaolo Bonzini reader_status = vreader_xfr_bytes(card->reader,
26549ab747fSPaolo Bonzini event->p.data.data, event->p.data.len,
26649ab747fSPaolo Bonzini recv_data, &recv_len);
26749ab747fSPaolo Bonzini DPRINTF(card, 2, "got back apdu of length %d\n", recv_len);
26849ab747fSPaolo Bonzini if (reader_status == VREADER_OK) {
26949ab747fSPaolo Bonzini emulated_push_response_apdu(card, recv_data, recv_len);
27049ab747fSPaolo Bonzini } else {
27149ab747fSPaolo Bonzini emulated_push_error(card, reader_status);
27249ab747fSPaolo Bonzini }
27349ab747fSPaolo Bonzini g_free(event);
27449ab747fSPaolo Bonzini }
2755c43b603SAmey Narkhede }
27649ab747fSPaolo Bonzini }
27749ab747fSPaolo Bonzini return NULL;
27849ab747fSPaolo Bonzini }
27949ab747fSPaolo Bonzini
event_thread(void * arg)28049ab747fSPaolo Bonzini static void *event_thread(void *arg)
28149ab747fSPaolo Bonzini {
28249ab747fSPaolo Bonzini int atr_len = MAX_ATR_SIZE;
28349ab747fSPaolo Bonzini uint8_t atr[MAX_ATR_SIZE];
28449ab747fSPaolo Bonzini VEvent *event = NULL;
28549ab747fSPaolo Bonzini EmulatedState *card = arg;
28649ab747fSPaolo Bonzini
28749ab747fSPaolo Bonzini while (1) {
28849ab747fSPaolo Bonzini const char *reader_name;
28949ab747fSPaolo Bonzini
29049ab747fSPaolo Bonzini event = vevent_wait_next_vevent();
29149ab747fSPaolo Bonzini if (event == NULL || event->type == VEVENT_LAST) {
29249ab747fSPaolo Bonzini break;
29349ab747fSPaolo Bonzini }
29449ab747fSPaolo Bonzini if (event->type != VEVENT_READER_INSERT) {
29549ab747fSPaolo Bonzini if (card->reader == NULL && event->reader != NULL) {
29649ab747fSPaolo Bonzini /* Happens after device_add followed by card remove or insert.
29749ab747fSPaolo Bonzini * XXX: create synthetic add_reader events if vcard_emul_init
29849ab747fSPaolo Bonzini * already called, which happens if device_del and device_add
29949ab747fSPaolo Bonzini * are called */
30049ab747fSPaolo Bonzini card->reader = vreader_reference(event->reader);
30149ab747fSPaolo Bonzini } else {
30249ab747fSPaolo Bonzini if (event->reader != card->reader) {
30349ab747fSPaolo Bonzini fprintf(stderr,
304cba42d61SMichael Tokarev "ERROR: wrong reader: quitting event_thread\n");
30549ab747fSPaolo Bonzini break;
30649ab747fSPaolo Bonzini }
30749ab747fSPaolo Bonzini }
30849ab747fSPaolo Bonzini }
30949ab747fSPaolo Bonzini switch (event->type) {
31049ab747fSPaolo Bonzini case VEVENT_READER_INSERT:
31149ab747fSPaolo Bonzini /* TODO: take a specific reader. i.e. track which reader
31249ab747fSPaolo Bonzini * we are seeing here, check it is the one we want (the first,
31349ab747fSPaolo Bonzini * or by a particular name), and ignore if we don't want it.
31449ab747fSPaolo Bonzini */
31549ab747fSPaolo Bonzini reader_name = vreader_get_name(event->reader);
31649ab747fSPaolo Bonzini if (card->reader != NULL) {
31749ab747fSPaolo Bonzini DPRINTF(card, 2, "READER INSERT - replacing %s with %s\n",
31849ab747fSPaolo Bonzini vreader_get_name(card->reader), reader_name);
31949ab747fSPaolo Bonzini qemu_mutex_lock(&card->vreader_mutex);
32049ab747fSPaolo Bonzini vreader_free(card->reader);
32149ab747fSPaolo Bonzini qemu_mutex_unlock(&card->vreader_mutex);
32249ab747fSPaolo Bonzini emulated_push_reader_remove(card);
32349ab747fSPaolo Bonzini }
32449ab747fSPaolo Bonzini qemu_mutex_lock(&card->vreader_mutex);
32549ab747fSPaolo Bonzini DPRINTF(card, 2, "READER INSERT %s\n", reader_name);
32649ab747fSPaolo Bonzini card->reader = vreader_reference(event->reader);
32749ab747fSPaolo Bonzini qemu_mutex_unlock(&card->vreader_mutex);
32849ab747fSPaolo Bonzini emulated_push_reader_insert(card);
32949ab747fSPaolo Bonzini break;
33049ab747fSPaolo Bonzini case VEVENT_READER_REMOVE:
33149ab747fSPaolo Bonzini DPRINTF(card, 2, " READER REMOVE: %s\n",
33249ab747fSPaolo Bonzini vreader_get_name(event->reader));
33349ab747fSPaolo Bonzini qemu_mutex_lock(&card->vreader_mutex);
33449ab747fSPaolo Bonzini vreader_free(card->reader);
33549ab747fSPaolo Bonzini card->reader = NULL;
33649ab747fSPaolo Bonzini qemu_mutex_unlock(&card->vreader_mutex);
33749ab747fSPaolo Bonzini emulated_push_reader_remove(card);
33849ab747fSPaolo Bonzini break;
33949ab747fSPaolo Bonzini case VEVENT_CARD_INSERT:
34049ab747fSPaolo Bonzini /* get the ATR (intended as a response to a power on from the
34149ab747fSPaolo Bonzini * reader */
34249ab747fSPaolo Bonzini atr_len = MAX_ATR_SIZE;
34349ab747fSPaolo Bonzini vreader_power_on(event->reader, atr, &atr_len);
34449ab747fSPaolo Bonzini card->atr_length = (uint8_t)atr_len;
34549ab747fSPaolo Bonzini DPRINTF(card, 2, " CARD INSERT\n");
34649ab747fSPaolo Bonzini emulated_push_card_insert(card, atr, atr_len);
34749ab747fSPaolo Bonzini break;
34849ab747fSPaolo Bonzini case VEVENT_CARD_REMOVE:
34949ab747fSPaolo Bonzini DPRINTF(card, 2, " CARD REMOVE\n");
35049ab747fSPaolo Bonzini emulated_push_card_remove(card);
35149ab747fSPaolo Bonzini break;
35249ab747fSPaolo Bonzini case VEVENT_LAST: /* quit */
35349ab747fSPaolo Bonzini vevent_delete(event);
35449ab747fSPaolo Bonzini return NULL;
35549ab747fSPaolo Bonzini default:
35649ab747fSPaolo Bonzini break;
35749ab747fSPaolo Bonzini }
35849ab747fSPaolo Bonzini vevent_delete(event);
35949ab747fSPaolo Bonzini }
36049ab747fSPaolo Bonzini return NULL;
36149ab747fSPaolo Bonzini }
36249ab747fSPaolo Bonzini
card_event_handler(EventNotifier * notifier)363c1129f6bSPaolo Bonzini static void card_event_handler(EventNotifier *notifier)
36449ab747fSPaolo Bonzini {
365c1129f6bSPaolo Bonzini EmulatedState *card = container_of(notifier, EmulatedState, notifier);
36649ab747fSPaolo Bonzini EmulEvent *event, *next;
36749ab747fSPaolo Bonzini
368c1129f6bSPaolo Bonzini event_notifier_test_and_clear(&card->notifier);
3695c43b603SAmey Narkhede QEMU_LOCK_GUARD(&card->event_list_mutex);
37049ab747fSPaolo Bonzini QSIMPLEQ_FOREACH_SAFE(event, &card->event_list, entry, next) {
37149ab747fSPaolo Bonzini DPRINTF(card, 2, "event %s\n", emul_event_to_string(event->p.gen.type));
37249ab747fSPaolo Bonzini switch (event->p.gen.type) {
37349ab747fSPaolo Bonzini case EMUL_RESPONSE_APDU:
37449ab747fSPaolo Bonzini ccid_card_send_apdu_to_guest(&card->base, event->p.data.data,
37549ab747fSPaolo Bonzini event->p.data.len);
37649ab747fSPaolo Bonzini break;
37749ab747fSPaolo Bonzini case EMUL_READER_INSERT:
37849ab747fSPaolo Bonzini ccid_card_ccid_attach(&card->base);
37949ab747fSPaolo Bonzini break;
38049ab747fSPaolo Bonzini case EMUL_READER_REMOVE:
38149ab747fSPaolo Bonzini ccid_card_ccid_detach(&card->base);
38249ab747fSPaolo Bonzini break;
38349ab747fSPaolo Bonzini case EMUL_CARD_INSERT:
38449ab747fSPaolo Bonzini assert(event->p.data.len <= MAX_ATR_SIZE);
38549ab747fSPaolo Bonzini card->atr_length = event->p.data.len;
38649ab747fSPaolo Bonzini memcpy(card->atr, event->p.data.data, card->atr_length);
38749ab747fSPaolo Bonzini ccid_card_card_inserted(&card->base);
38849ab747fSPaolo Bonzini break;
38949ab747fSPaolo Bonzini case EMUL_CARD_REMOVE:
39049ab747fSPaolo Bonzini ccid_card_card_removed(&card->base);
39149ab747fSPaolo Bonzini break;
39249ab747fSPaolo Bonzini case EMUL_ERROR:
39349ab747fSPaolo Bonzini ccid_card_card_error(&card->base, event->p.error.code);
39449ab747fSPaolo Bonzini break;
39549ab747fSPaolo Bonzini default:
39649ab747fSPaolo Bonzini DPRINTF(card, 2, "unexpected event\n");
39749ab747fSPaolo Bonzini break;
39849ab747fSPaolo Bonzini }
39949ab747fSPaolo Bonzini g_free(event);
40049ab747fSPaolo Bonzini }
40149ab747fSPaolo Bonzini QSIMPLEQ_INIT(&card->event_list);
40249ab747fSPaolo Bonzini }
40349ab747fSPaolo Bonzini
init_event_notifier(EmulatedState * card,Error ** errp)404cc847bfdSMao Zhongyi static int init_event_notifier(EmulatedState *card, Error **errp)
40549ab747fSPaolo Bonzini {
406c1129f6bSPaolo Bonzini if (event_notifier_init(&card->notifier, false) < 0) {
407cc847bfdSMao Zhongyi error_setg(errp, "ccid-card-emul: event notifier creation failed");
40849ab747fSPaolo Bonzini return -1;
40949ab747fSPaolo Bonzini }
410d6da1e9eSPaolo Bonzini event_notifier_set_handler(&card->notifier, card_event_handler);
41149ab747fSPaolo Bonzini return 0;
41249ab747fSPaolo Bonzini }
41349ab747fSPaolo Bonzini
clean_event_notifier(EmulatedState * card)414ca1d4102SLi Qiang static void clean_event_notifier(EmulatedState *card)
415ca1d4102SLi Qiang {
416ca1d4102SLi Qiang event_notifier_set_handler(&card->notifier, NULL);
417ca1d4102SLi Qiang event_notifier_cleanup(&card->notifier);
418ca1d4102SLi Qiang }
419ca1d4102SLi Qiang
42049ab747fSPaolo Bonzini #define CERTIFICATES_DEFAULT_DB "/etc/pki/nssdb"
42149ab747fSPaolo Bonzini #define CERTIFICATES_ARGS_TEMPLATE\
42249ab747fSPaolo Bonzini "db=\"%s\" use_hw=no soft=(,Virtual Reader,CAC,,%s,%s,%s)"
42349ab747fSPaolo Bonzini
wrap_vcard_emul_init(VCardEmulOptions * options)42449ab747fSPaolo Bonzini static int wrap_vcard_emul_init(VCardEmulOptions *options)
42549ab747fSPaolo Bonzini {
42649ab747fSPaolo Bonzini static int called;
42749ab747fSPaolo Bonzini static int options_was_null;
42849ab747fSPaolo Bonzini
42949ab747fSPaolo Bonzini if (called) {
43049ab747fSPaolo Bonzini if ((options == NULL) != options_was_null) {
43149ab747fSPaolo Bonzini printf("%s: warning: running emulated with certificates"
43249ab747fSPaolo Bonzini " and emulated side by side is not supported\n",
43349ab747fSPaolo Bonzini __func__);
43449ab747fSPaolo Bonzini return VCARD_EMUL_FAIL;
43549ab747fSPaolo Bonzini }
43649ab747fSPaolo Bonzini vcard_emul_replay_insertion_events();
43749ab747fSPaolo Bonzini return VCARD_EMUL_OK;
43849ab747fSPaolo Bonzini }
43949ab747fSPaolo Bonzini options_was_null = (options == NULL);
44049ab747fSPaolo Bonzini called = 1;
44149ab747fSPaolo Bonzini return vcard_emul_init(options);
44249ab747fSPaolo Bonzini }
44349ab747fSPaolo Bonzini
emulated_initialize_vcard_from_certificates(EmulatedState * card)44449ab747fSPaolo Bonzini static int emulated_initialize_vcard_from_certificates(EmulatedState *card)
44549ab747fSPaolo Bonzini {
44649ab747fSPaolo Bonzini char emul_args[200];
44749ab747fSPaolo Bonzini VCardEmulOptions *options = NULL;
44849ab747fSPaolo Bonzini
44949ab747fSPaolo Bonzini snprintf(emul_args, sizeof(emul_args) - 1, CERTIFICATES_ARGS_TEMPLATE,
45049ab747fSPaolo Bonzini card->db ? card->db : CERTIFICATES_DEFAULT_DB,
45149ab747fSPaolo Bonzini card->cert1, card->cert2, card->cert3);
45249ab747fSPaolo Bonzini options = vcard_emul_options(emul_args);
45349ab747fSPaolo Bonzini if (options == NULL) {
45449ab747fSPaolo Bonzini printf("%s: warning: not using certificates due to"
45549ab747fSPaolo Bonzini " initialization error\n", __func__);
45649ab747fSPaolo Bonzini }
45749ab747fSPaolo Bonzini return wrap_vcard_emul_init(options);
45849ab747fSPaolo Bonzini }
45949ab747fSPaolo Bonzini
46049ab747fSPaolo Bonzini typedef struct EnumTable {
46149ab747fSPaolo Bonzini const char *name;
46249ab747fSPaolo Bonzini uint32_t value;
46349ab747fSPaolo Bonzini } EnumTable;
46449ab747fSPaolo Bonzini
465d18c7117SJim Meyering static const EnumTable backend_enum_table[] = {
46649ab747fSPaolo Bonzini {BACKEND_NSS_EMULATED_NAME, BACKEND_NSS_EMULATED},
46749ab747fSPaolo Bonzini {BACKEND_CERTIFICATES_NAME, BACKEND_CERTIFICATES},
46849ab747fSPaolo Bonzini {NULL, 0},
46949ab747fSPaolo Bonzini };
47049ab747fSPaolo Bonzini
parse_enumeration(char * str,const EnumTable * table,uint32_t not_found_value)47149ab747fSPaolo Bonzini static uint32_t parse_enumeration(char *str,
472d18c7117SJim Meyering const EnumTable *table, uint32_t not_found_value)
47349ab747fSPaolo Bonzini {
47449ab747fSPaolo Bonzini uint32_t ret = not_found_value;
47549ab747fSPaolo Bonzini
476d0ebd788SMarc-André Lureau if (str == NULL)
477d0ebd788SMarc-André Lureau return 0;
478d0ebd788SMarc-André Lureau
47949ab747fSPaolo Bonzini while (table->name != NULL) {
48049ab747fSPaolo Bonzini if (strcmp(table->name, str) == 0) {
48149ab747fSPaolo Bonzini ret = table->value;
48249ab747fSPaolo Bonzini break;
48349ab747fSPaolo Bonzini }
48449ab747fSPaolo Bonzini table++;
48549ab747fSPaolo Bonzini }
48649ab747fSPaolo Bonzini return ret;
48749ab747fSPaolo Bonzini }
48849ab747fSPaolo Bonzini
emulated_realize(CCIDCardState * base,Error ** errp)489cc847bfdSMao Zhongyi static void emulated_realize(CCIDCardState *base, Error **errp)
49049ab747fSPaolo Bonzini {
49135997599SCao jin EmulatedState *card = EMULATED_CCID_CARD(base);
49249ab747fSPaolo Bonzini VCardEmulError ret;
493d18c7117SJim Meyering const EnumTable *ptable;
49449ab747fSPaolo Bonzini
49549ab747fSPaolo Bonzini QSIMPLEQ_INIT(&card->event_list);
49649ab747fSPaolo Bonzini QSIMPLEQ_INIT(&card->guest_apdu_list);
49749ab747fSPaolo Bonzini qemu_mutex_init(&card->event_list_mutex);
49849ab747fSPaolo Bonzini qemu_mutex_init(&card->vreader_mutex);
49949ab747fSPaolo Bonzini qemu_mutex_init(&card->handle_apdu_mutex);
50049ab747fSPaolo Bonzini qemu_cond_init(&card->handle_apdu_cond);
50149ab747fSPaolo Bonzini card->reader = NULL;
50249ab747fSPaolo Bonzini card->quit_apdu_thread = 0;
503cc847bfdSMao Zhongyi if (init_event_notifier(card, errp) < 0) {
5047dea29e4SLi Qiang goto out1;
50549ab747fSPaolo Bonzini }
506ae12e3a6SCole Robinson
507ae12e3a6SCole Robinson card->backend = 0;
508ae12e3a6SCole Robinson if (card->backend_str) {
509ae12e3a6SCole Robinson card->backend = parse_enumeration(card->backend_str,
510ae12e3a6SCole Robinson backend_enum_table, 0);
511ae12e3a6SCole Robinson }
512ae12e3a6SCole Robinson
51349ab747fSPaolo Bonzini if (card->backend == 0) {
514cc847bfdSMao Zhongyi error_setg(errp, "backend must be one of:");
51549ab747fSPaolo Bonzini for (ptable = backend_enum_table; ptable->name != NULL; ++ptable) {
516cc847bfdSMao Zhongyi error_append_hint(errp, "%s\n", ptable->name);
51749ab747fSPaolo Bonzini }
5187dea29e4SLi Qiang goto out2;
51949ab747fSPaolo Bonzini }
52049ab747fSPaolo Bonzini
521*2a8537cfSMichael Tokarev /* TODO: a passthru backend that works on local machine. third card type?*/
52249ab747fSPaolo Bonzini if (card->backend == BACKEND_CERTIFICATES) {
52349ab747fSPaolo Bonzini if (card->cert1 != NULL && card->cert2 != NULL && card->cert3 != NULL) {
52449ab747fSPaolo Bonzini ret = emulated_initialize_vcard_from_certificates(card);
52549ab747fSPaolo Bonzini } else {
526cc847bfdSMao Zhongyi error_setg(errp, "%s: you must provide all three certs for"
527cc847bfdSMao Zhongyi " certificates backend", TYPE_EMULATED_CCID);
5287dea29e4SLi Qiang goto out2;
52949ab747fSPaolo Bonzini }
53049ab747fSPaolo Bonzini } else {
53149ab747fSPaolo Bonzini if (card->backend != BACKEND_NSS_EMULATED) {
532cc847bfdSMao Zhongyi error_setg(errp, "%s: bad backend specified. The options are:%s"
533cc847bfdSMao Zhongyi " (default), %s.", TYPE_EMULATED_CCID,
534cc847bfdSMao Zhongyi BACKEND_NSS_EMULATED_NAME, BACKEND_CERTIFICATES_NAME);
5357dea29e4SLi Qiang goto out2;
53649ab747fSPaolo Bonzini }
53749ab747fSPaolo Bonzini if (card->cert1 != NULL || card->cert2 != NULL || card->cert3 != NULL) {
538cc847bfdSMao Zhongyi error_setg(errp, "%s: unexpected cert parameters to nss emulated "
539cc847bfdSMao Zhongyi "backend", TYPE_EMULATED_CCID);
5407dea29e4SLi Qiang goto out2;
54149ab747fSPaolo Bonzini }
54249ab747fSPaolo Bonzini /* default to mirroring the local hardware readers */
54349ab747fSPaolo Bonzini ret = wrap_vcard_emul_init(NULL);
54449ab747fSPaolo Bonzini }
54549ab747fSPaolo Bonzini if (ret != VCARD_EMUL_OK) {
546cc847bfdSMao Zhongyi error_setg(errp, "%s: failed to initialize vcard", TYPE_EMULATED_CCID);
5477dea29e4SLi Qiang goto out2;
54849ab747fSPaolo Bonzini }
5494900116eSDr. David Alan Gilbert qemu_thread_create(&card->event_thread_id, "ccid/event", event_thread,
5504900116eSDr. David Alan Gilbert card, QEMU_THREAD_JOINABLE);
5514900116eSDr. David Alan Gilbert qemu_thread_create(&card->apdu_thread_id, "ccid/apdu", handle_apdu_thread,
5524900116eSDr. David Alan Gilbert card, QEMU_THREAD_JOINABLE);
5537dea29e4SLi Qiang
5543fd2092fSDaniel P. Berrangé return;
5553fd2092fSDaniel P. Berrangé
5567dea29e4SLi Qiang out2:
5577dea29e4SLi Qiang clean_event_notifier(card);
5587dea29e4SLi Qiang out1:
5597dea29e4SLi Qiang qemu_cond_destroy(&card->handle_apdu_cond);
5607dea29e4SLi Qiang qemu_mutex_destroy(&card->handle_apdu_mutex);
5617dea29e4SLi Qiang qemu_mutex_destroy(&card->vreader_mutex);
5627dea29e4SLi Qiang qemu_mutex_destroy(&card->event_list_mutex);
56349ab747fSPaolo Bonzini }
56449ab747fSPaolo Bonzini
emulated_unrealize(CCIDCardState * base)565b69c3c21SMarkus Armbruster static void emulated_unrealize(CCIDCardState *base)
56649ab747fSPaolo Bonzini {
56735997599SCao jin EmulatedState *card = EMULATED_CCID_CARD(base);
56849ab747fSPaolo Bonzini VEvent *vevent = vevent_new(VEVENT_LAST, NULL, NULL);
56949ab747fSPaolo Bonzini
57049ab747fSPaolo Bonzini vevent_queue_vevent(vevent); /* stop vevent thread */
57149ab747fSPaolo Bonzini qemu_thread_join(&card->event_thread_id);
57249ab747fSPaolo Bonzini
57349ab747fSPaolo Bonzini card->quit_apdu_thread = 1; /* stop handle_apdu thread */
57449ab747fSPaolo Bonzini qemu_cond_signal(&card->handle_apdu_cond);
57549ab747fSPaolo Bonzini qemu_thread_join(&card->apdu_thread_id);
57649ab747fSPaolo Bonzini
577ca1d4102SLi Qiang clean_event_notifier(card);
57849ab747fSPaolo Bonzini /* threads exited, can destroy all condvars/mutexes */
57949ab747fSPaolo Bonzini qemu_cond_destroy(&card->handle_apdu_cond);
58049ab747fSPaolo Bonzini qemu_mutex_destroy(&card->handle_apdu_mutex);
58149ab747fSPaolo Bonzini qemu_mutex_destroy(&card->vreader_mutex);
58249ab747fSPaolo Bonzini qemu_mutex_destroy(&card->event_list_mutex);
58349ab747fSPaolo Bonzini }
58449ab747fSPaolo Bonzini
58549ab747fSPaolo Bonzini static Property emulated_card_properties[] = {
58649ab747fSPaolo Bonzini DEFINE_PROP_STRING("backend", EmulatedState, backend_str),
58749ab747fSPaolo Bonzini DEFINE_PROP_STRING("cert1", EmulatedState, cert1),
58849ab747fSPaolo Bonzini DEFINE_PROP_STRING("cert2", EmulatedState, cert2),
58949ab747fSPaolo Bonzini DEFINE_PROP_STRING("cert3", EmulatedState, cert3),
59049ab747fSPaolo Bonzini DEFINE_PROP_STRING("db", EmulatedState, db),
59149ab747fSPaolo Bonzini DEFINE_PROP_UINT8("debug", EmulatedState, debug, 0),
59249ab747fSPaolo Bonzini DEFINE_PROP_END_OF_LIST(),
59349ab747fSPaolo Bonzini };
59449ab747fSPaolo Bonzini
emulated_class_initfn(ObjectClass * klass,void * data)59549ab747fSPaolo Bonzini static void emulated_class_initfn(ObjectClass *klass, void *data)
59649ab747fSPaolo Bonzini {
59749ab747fSPaolo Bonzini DeviceClass *dc = DEVICE_CLASS(klass);
59849ab747fSPaolo Bonzini CCIDCardClass *cc = CCID_CARD_CLASS(klass);
59949ab747fSPaolo Bonzini
600cc847bfdSMao Zhongyi cc->realize = emulated_realize;
60180ae8654SPhilippe Mathieu-Daudé cc->unrealize = emulated_unrealize;
60249ab747fSPaolo Bonzini cc->get_atr = emulated_get_atr;
60349ab747fSPaolo Bonzini cc->apdu_from_guest = emulated_apdu_from_guest;
604125ee0edSMarcel Apfelbaum set_bit(DEVICE_CATEGORY_INPUT, dc->categories);
60549ab747fSPaolo Bonzini dc->desc = "emulated smartcard";
6064f67d30bSMarc-André Lureau device_class_set_props(dc, emulated_card_properties);
60749ab747fSPaolo Bonzini }
60849ab747fSPaolo Bonzini
60949ab747fSPaolo Bonzini static const TypeInfo emulated_card_info = {
61035997599SCao jin .name = TYPE_EMULATED_CCID,
61149ab747fSPaolo Bonzini .parent = TYPE_CCID_CARD,
61249ab747fSPaolo Bonzini .instance_size = sizeof(EmulatedState),
61349ab747fSPaolo Bonzini .class_init = emulated_class_initfn,
61449ab747fSPaolo Bonzini };
615be4bf77cSGerd Hoffmann module_obj(TYPE_EMULATED_CCID);
61624ce7aa7SJose R. Ziviani module_kconfig(USB);
61749ab747fSPaolo Bonzini
ccid_card_emulated_register_types(void)61849ab747fSPaolo Bonzini static void ccid_card_emulated_register_types(void)
61949ab747fSPaolo Bonzini {
62049ab747fSPaolo Bonzini type_register_static(&emulated_card_info);
62149ab747fSPaolo Bonzini }
62249ab747fSPaolo Bonzini
62349ab747fSPaolo Bonzini type_init(ccid_card_emulated_register_types)
624