usb-ccid (v5)
cover usb-ccid (v5)
This patchset adds three new devices, usb-ccid, ccid-card-passthru and ccid-card-emulated, providing a CCID bus, a simple passthru protocol implementing card requiring a client, and a standalone emulated card.
v4->v5 changes:
* rebased to latest
* remove static debug in card devices
* fix --enable-smartcard to link
* stall instead of assert when exceeding BULK_OUT_DATA_SIZE
* make ccid_reserve_recv_buf for too large len discard message, not exit
* make ccid_reserve_recv_buf return void*
* fix typo
* remove commented code in VMState
v3->v4:
* remove ccid field in CCIDBus
* remove static debug in bus
* add back docs
v2->v3:
* split into bus (usb-ccid.c, uses ccid.h) and card (ccid-card-passthru.c).
* removed documentation (being revised).
v1->v2:
* all QSIMPLEQ turned into fixed sized rings
* all allocated buffers turned into fixed size buffers
* added migration support
* added a message to tell client qemu has migrated to ip:port
* for lack of monitor commands ip:port are 0:0, which causes the updated vscclient to connect to one port higher on the same host. will add monitor commands in a separate patch. tested with current setup.
Alon Levy (4):
usb-ccid: add CCID bus
ccid: add passthru card device
add ccid-card-emulated device (v2)
ccid: add docs
Makefile.objs | 1 + configure | 33 ++ docs/ccid.txt | 133 +++++ hw/ccid-card-emulated.c | 495 +++++++++++++++++ hw/ccid-card-passthru.c | 278 ++++++++++ hw/ccid.h | 34 ++ hw/usb-ccid.c | 1342 +++++++++++++++++++++++++++++++++++++++++++++++ hw/vscard_common.h | 130 +++++ 8 files changed, 2446 insertions(+), 0 deletions(-) create mode 100644 docs/ccid.txt create mode 100644 hw/ccid-card-emulated.c create mode 100644 hw/ccid-card-passthru.c create mode 100644 hw/ccid.h create mode 100644 hw/usb-ccid.c create mode 100644 hw/vscard_common.h
Signature · 1 line
1.7.3.2
PATCH 1/4 usb-ccid: add CCID bus
A CCID device is a smart card reader. It is a USB device, defined at [1]. This patch introduces the usb-ccid device that is a ccid bus. Next patches will introduce two card types to use it, a passthru card and an emulated card.
[1] http://www.usb.org/developers/devclass_docs/DWG_Smart-Card_CCID_Rev110.
--- Makefile.objs | 1 + configure | 12 + hw/ccid.h | 34 ++ hw/usb-ccid.c | 1342 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 1389 insertions(+), 0 deletions(-) create mode 100644 hw/ccid.h create mode 100644 hw/usb-ccid.c
Makefile.objs +1 -0
@@ -182,6 +182,7 @@ hw-obj-$(CONFIG_FDC) += fdc.o hw-obj-$(CONFIG_ACPI) += acpi.o acpi_piix4.o hw-obj-$(CONFIG_APM) += pm_smbus.o apm.o hw-obj-$(CONFIG_DMA) += dma.o +hw-obj-$(CONFIG_SMARTCARD) += usb-ccid.o # PPC devices hw-obj-$(CONFIG_OPENPIC) += openpic.o
configure +12 -0
@@ -332,6 +332,7 @@ zero_malloc="" trace_backend="nop" trace_file="trace" spice="" +smartcard="no" # OS specific if check_define __linux__ ; then
@@ -739,6 +740,10 @@ for opt do ;; --enable-vhost-net) vhost_net="yes" ;; + --disable-smartcard) smartcard="no" + ;; + --enable-smartcard) smartcard="yes" + ;; --*dir) ;; *) echo "ERROR: unknown option $opt"; show_help="yes"
@@ -934,6 +939,8 @@ echo " --trace-file=NAME Full PATH,NAME of file to store traces" echo " Default:trace-<pid>" echo " --disable-spice disable spice" echo " --enable-spice enable spice" +echo " --disable-smartcard disable smartcard support" +echo " --enable-smartcard enable smartcard support" echo "" echo "NOTE: The object files are built at the place where configure is launched" exit 1
@@ -2338,6 +2345,7 @@ echo "vhost-net support $vhost_net" echo "Trace backend $trace_backend" echo "Trace output file $trace_file-<pid>" echo "spice support $spice" +echo "smartcard support $smartcard" if test $sdl_too_old = "yes"; then echo "-> Your SDL version is too old - please upgrade to have SDL support"
@@ -2601,6 +2609,10 @@ if test "$spice" = "yes" ; then echo "CONFIG_SPICE=y" >> $config_host_mak fi +if test "$smartcard" = "yes" ; then + echo "CONFIG_SMARTCARD=y" >> $config_host_mak +fi + # XXX: suppress that if [ "$bsd" = "yes" ] ; then echo "CONFIG_BSD=y" >> $config_host_mak
hw/ccid.h new file +34 -0
@@ -0,0 +1,34 @@ +#ifndef __CCID_H__ +#define __CCID_H__ + +#include "qdev.h" + +typedef struct CCIDCardState CCIDCardState ; +typedef struct CCIDCardInfo CCIDCardInfo ; + +struct CCIDCardState { +DeviceState qdev; +}; + +struct CCIDCardInfo { +DeviceInfo qdev; +void (*print)(Monitor *mon,CCIDCardState *card,int indent); +const uint8_t *(*get_atr)(CCIDCardState *card,uint32_t *len); +void (*apdu_from_guest)(CCIDCardState *card,const uint8_t *apdu,uint32_t len); +int (*exitfn)(CCIDCardState *card); +int (*initfn)(CCIDCardState *card); +}; + +void ccid_card_send_apdu_to_guest (CCIDCardState *card,uint8_t * apdu,uint32_t len); +void ccid_card_card_removed (CCIDCardState *card); +void ccid_card_card_inserted (CCIDCardState *card); +void ccid_card_card_error (CCIDCardState *card,uint64_t error); +void ccid_card_qdev_register (CCIDCardInfo *card); + +/* support guest visible insertion/removal of ccid devices based on actual +* devices connected/removed. Called by card implementation (passthru, local) */ +int ccid_card_ccid_attach (CCIDCardState *card); +void ccid_card_ccid_detach (CCIDCardState *card); + +#endif // __CCID_H__ +
hw/usb-ccid.c new file +1342 -0
1,342 lines not on this page · raw message
Signature · 1 line
1.7.3.2
PATCH 2/4 ccid: add passthru card device
In reply to Alon LevyFor the client side utility vscclient, see libcac_card:
libcac_card http://cgit.freedesktop.org/~alon/cac_card (temporary home) written by Robert Relyea <[email protected]>
--- Makefile.objs | 2 +- hw/ccid-card-passthru.c | 278 +++++++++++++++++++++++++++++++++++++++++++++++ hw/vscard_common.h | 130 ++++++++++++++++++++++ 3 files changed, 409 insertions(+), 1 deletions(-) create mode 100644 hw/ccid-card-passthru.c create mode 100644 hw/vscard_common.h
Makefile.objs +1 -1
@@ -182,7 +182,7 @@ hw-obj-$(CONFIG_FDC) += fdc.o hw-obj-$(CONFIG_ACPI) += acpi.o acpi_piix4.o hw-obj-$(CONFIG_APM) += pm_smbus.o apm.o hw-obj-$(CONFIG_DMA) += dma.o -hw-obj-$(CONFIG_SMARTCARD) += usb-ccid.o +hw-obj-$(CONFIG_SMARTCARD) += usb-ccid.o ccid-card-passthru.o # PPC devices hw-obj-$(CONFIG_OPENPIC) += openpic.o
hw/ccid-card-passthru.c new file +278 -0
278 lines not on this page · raw message
hw/vscard_common.h new file +130 -0
130 lines not on this page · raw message
Signature · 1 line
1.7.3.2
PATCH 3/4 add ccid-card-emulated device (v2)
In reply to Alon Levychanges from v1:
remove stale comments, use only c-style comments bugfix, forgot to set recv_len
change reader name to 'Virtual Reader'
--- Makefile.objs | 2 +- configure | 21 ++ hw/ccid-card-emulated.c | 495 +++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 517 insertions(+), 1 deletions(-) create mode 100644 hw/ccid-card-emulated.c
Makefile.objs +1 -1
@@ -182,7 +182,7 @@ hw-obj-$(CONFIG_FDC) += fdc.o hw-obj-$(CONFIG_ACPI) += acpi.o acpi_piix4.o hw-obj-$(CONFIG_APM) += pm_smbus.o apm.o hw-obj-$(CONFIG_DMA) += dma.o -hw-obj-$(CONFIG_SMARTCARD) += usb-ccid.o ccid-card-passthru.o +hw-obj-$(CONFIG_SMARTCARD) += usb-ccid.o ccid-card-passthru.o ccid-card-emulated.o # PPC devices hw-obj-$(CONFIG_OPENPIC) += openpic.o
configure +21 -0
@@ -2130,6 +2130,27 @@ EOF fi fi +# check for libcaccard for smartcard support +if test "$smartcard" != "no" ; then + cat > $TMPC << EOF +#include <vscard_common.h> +int main() { return 0; } +EOF + smartcard_cflags=$($pkgconfig --cflags cac_card cac_card 2>/dev/null) + smartcard_libs=$($pkgconfig --libs cac_card cac_card 2>/dev/null) + if $pkgconfig --atleast-version=0.0.1 cac_card &&\ + compile_prog "$smartcard_cflags" "$smartcard_libs" ; then + smartcard="yes" + libs_softmmu="$smartcard_libs $libs_softmmu" + QEMU_CFLAGS="$QEMU_CFLAGS $smartcard_cflags" + else + if test "smartcard" = "yes" ; then + feature_not_found "smartcard" + fi + smartcard="no" + fi +fi + ########################################## ##########################################
hw/ccid-card-emulated.c new file +495 -0
495 lines not on this page · raw message
Signature · 1 line
1.7.3.2
PATCH 4/4 ccid: add docs
In reply to Alon Levy--- docs/ccid.txt | 133 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 133 insertions(+), 0 deletions(-) create mode 100644 docs/ccid.txt
docs/ccid.txt new file +133 -0
@@ -0,0 +1,133 @@ +Qemu CCID Device Documentation. + +Contents +1. USB CCID device +2. Building +3. Using ccid-card-emulated with hardware +4. Using ccid-card-emulated with certificates +5. Using ccid-card-passthru with client side hardware +6. Using ccid-card-passthru with client side certificates +7. Passthrough protocol scenario +8. libcaccard + +1. USB CCID device + +The USB CCID device is a USB device implementing the CCID specification, which +lets one connect smart card readers that implement the same spec. For more +information see the specification: + + Universal Serial Bus + Device Class: Smart Card + CCID + Specification for + Integrated Circuit(s) Cards Interface Devices + Revision 1.1 + April 22rd, 2005 + +Smartcard are used for authentication, single sign on, decryption in +public/private schemes and digital signatures. A smartcard reader on the client +cannot be used on a guest with simple usb passthrough since it will then not be +available on the client, possibly locking the computer when it is "removed". On +the other hand this device can let you use the smartcard on both the client and +the guest machine. It is also possible to have a completely virtual smart card +reader and smart card (i.e. not backed by a physical device) using this device. + +2. Building + +prerequisites: + libcaccard + +At the moment there are no binary or source releases, so it has to be retrieved +from source control: + + git clone git://anongit.freedesktop.org/~alon/cac_card + +fedora: + yum install nss-devel +ubuntu: + apt-get install libnss3-dev + (not tested on ubuntu) + +build cac_card: + cd cac_card + ./configure && make && sudo make install + +qemu: + ./configure --enable-smartcard && make + +Note that if you install to a non default prefix you need to set +PKG_CONFIG_PATH to compile qemu successfully. + +3. Using ccid-card-emulated with hardware + +Assuming you have a working smartcard on the host with the current +user, using NSS, qemu acts as another NSS client using ccid-card-emulated: + + qemu -usb -device usb-ccid -device ccid-card-emualated + +4. Using ccid-card-emulated with certificates + +You must create the certificates. This is a one time process. We use NSS certificates: + + certutil -d /etc/pki/nssdb -x -t "CT,CT,CT" -S -s "CN=cert1" -n cert1 + +Note: you must have exactly three certificates. + +Assuming the current user can access the certificates (use certutil -L to verify), +you can use the emulated card type with the certificates backend: + + qemu -usb -device usb-ccid -device ccid-card-emulated,backend=certificates,cert1=cert1,cert2=cert2,cert3=cert3 + +5. Using ccid-card-passthru with client side hardware + +on the host specify the ccid-card-passthru device with a suitable chardev: + + qemu -chardev socket,server,host=0.0.0.0,port=2001,id=ccid,nowait -usb -device usb-ccid -device ccid-card-passthru,chardev=ccid + +on the client run vscclient, built when you built the libcaccard library: + vscclient <qemu-host> 2001 + +6. Using ccid-card-passthru with client side certificates + +Run qemu as per #5, and run vscclient as follows: +(Note: vscclient command line interface is in a state of change) + + ./vscclient -e "db=\"/etc/pki/nssdb\" use_hw=no soft=(,Test,CAC,,cert1,cert2,cert3)" <qemu-host> 2001 + +7. Passthrough protocol scenario + +This is a typical interchange of messages when using the passthru card device. +usb-ccid is a usb device. It defaults to an unattached usb device on startup. +usb-ccid expects a chardev and expects the protocol defined in cac_card/vscard_common.h to be passed over that. +A typical interchange is: + +client event | vscclient | passthru | usb-ccid | guest event +---------------------------------------------------------------------------------------------- + | VSC_Init | | | + | VSC_ReaderAdd | | attach | + | | | | sees new usb device. +card inserted | | | | + | VSC_ATR | | | + | | | | guest operation, APDU transfer via CCID + | | VSC_APDU | | + | VSC_APDU | | | +client<->physical | | | | +card APDU exchange| | | | + [APDU<->APDU repeats several times] +card removed | | | | + | VSC_CardRemove | | | +kill/quit | | | | + vscclient | | | | + | VSC_ReaderRemove | | detach | + | | | | usb device removed. + + +8. libcaccard + +ccid-card-passthru and vscclient use libcaccard as the card emulator. +libcaccard implements a completely virtual CAC (DoD standard for smart cards) +compliant card and uses NSS to actually retrive certificates and do any +encryption using the backend (real reader + card or file backed certificates). + +For documentation of cac_card see README in libcac_card package. +
Signature · 1 line
1.7.3.2
NACK self. Forgot the statics.
Quoted 58 lines · Alon Levy
This patchset adds three new devices, usb-ccid, ccid-card-passthru and ccid-card-emulated, providing a CCID bus, a simple passthru protocol implementing card requiring a client, and a standalone emulated card.
v4->v5changes:
* rebased to latest
* remove static debug in card devices
* fix --enable-smartcard to link
* stall instead of assert when exceedingBULK_OUT_DATA_SIZE
* makeccid_reserve_recv_buffor too large len discard message, not exit
* makeccid_reserve_recv_bufreturn void*
* fix typo
* remove commented code in VMState
v3->v4:
* remove ccid field in CCIDBus
* remove static debug in bus
* add back docs
v2->v3:
* split into bus (usb-ccid.c, usesccid.h) and card (ccid-card-passthru.c).
* removed documentation (being revised).
v1->v2:
* all QSIMPLEQ turned into fixed sized rings
* all allocated buffers turned into fixed size buffers
* added migration support
* added a message to tell client qemu has migrated to ip:port
* for lack of monitor commands ip:port are 0:0, which causes the updated vscclient to connect to one port higher on the same host. will add monitor commands in a separate patch. tested with current setup.Alon Levy (4):
usb-ccid: add CCID bus
ccid: add passthru card device
add ccid-card-emulated device (v2)
ccid: add docsMakefile.objs | 1 + configure | 33 ++ docs/ccid.txt | 133 +++++ hw/ccid-card-emulated.c | 495 +++++++++++++++++ hw/ccid-card-passthru.c | 278 ++++++++++ hw/ccid.h | 34 ++ hw/usb-ccid.c | 1342 +++++++++++++++++++++++++++++++++++++++++++++++ hw/vscard_common.h | 130 +++++ 8 files changed, 2446 insertions(+), 0 deletions(-) create mode 100644 docs/ccid.txt create mode 100644 hw/ccid-card-emulated.c create mode 100644 hw/ccid-card-passthru.c create mode 100644 hw/ccid.h create mode 100644 hw/usb-ccid.c create mode 100644 hw/vscard_common.hSignature · 1 line
1.7.3.2