Introduce CanoKey QEMU
PATCH 2/6 meson: Add CanoKey
In reply to Hongren (Zenithal) Zheng--- hw/usb/Kconfig | 5 +++++ hw/usb/meson.build | 3 +++ meson.build | 6 ++++++ meson_options.txt | 2 ++ scripts/meson-buildoptions.sh | 3 +++ 5 files changed, 19 insertions(+)
hw/usb/Kconfig +5 -0
@@ -119,6 +119,11 @@ config USB_U2F default y depends on USB +config USB_CANOKEY + bool + default y + depends on USB + config IMX_USBPHY bool default y
hw/usb/meson.build +3 -0
@@ -63,6 +63,9 @@ if u2f.found() softmmu_ss.add(when: 'CONFIG_USB_U2F', if_true: [u2f, files('u2f-emulated.c')]) endif +# CanoKey +softmmu_ss.add(when: 'CONFIG_USB_CANOKEY', if_true: [canokey, files('canokey.c')]) + # usb redirect if usbredir.found() usbredir_ss = ss.source_set()
meson.build +6 -0
@@ -1181,6 +1181,12 @@ if have_system method: 'pkg-config', kwargs: static_kwargs) endif +canokey = not_found +if have_system + canokey = dependency('canokey-qemu', required: get_option('canokey'), + method: 'pkg-config', + kwargs: static_kwargs) +endif usbredir = not_found if not get_option('usb_redir').auto() or have_system usbredir = dependency('libusbredirparser-0.5', required: get_option('usb_redir'),
meson_options.txt +2 -0
@@ -143,6 +143,8 @@ option('spice_protocol', type : 'feature', value : 'auto', description: 'Spice protocol support') option('u2f', type : 'feature', value : 'auto', description: 'U2F emulation support') +option('canokey', type : 'feature', value : 'auto', + description: 'CanoKey support') option('usb_redir', type : 'feature', value : 'auto', description: 'libusbredir support') option('l2tpv3', type : 'feature', value : 'auto',
scripts/meson-buildoptions.sh +3 -0
@@ -28,6 +28,7 @@ meson_options_help() { printf "%s\n" ' bpf eBPF support' printf "%s\n" ' brlapi brlapi character device driver' printf "%s\n" ' bzip2 bzip2 support for DMG images' + printf "%s\n" ' canokey CanoKey support' printf "%s\n" ' cap-ng cap_ng support' printf "%s\n" ' cocoa Cocoa user interface (macOS only)' printf "%s\n" ' coreaudio CoreAudio sound support'
@@ -115,6 +116,8 @@ _meson_option_parse() { --disable-brlapi) printf "%s" -Dbrlapi=disabled ;; --enable-bzip2) printf "%s" -Dbzip2=enabled ;; --disable-bzip2) printf "%s" -Dbzip2=disabled ;; + --enable-canokey) printf "%s" -Dcanokey=enabled ;; + --disable-canokey) printf "%s" -Dcanokey=disabled ;; --enable-cap-ng) printf "%s" -Dcap_ng=enabled ;; --disable-cap-ng) printf "%s" -Dcap_ng=disabled ;; --enable-capstone) printf "%s" -Dcapstone=enabled ;;
Signature · 1 line
2.34.0
PATCH 3/6 docs: Add CanoKey documentation
In reply to Hongren (Zenithal) Zheng--- docs/canokey.txt | 133 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 133 insertions(+) create mode 100644 docs/canokey.txt
docs/canokey.txt new file +133 -0
@@ -0,0 +1,133 @@ +CanoKey QEMU Documentation. + +Contents +1. CanoKey QEMU +2. Building +3. Using CanoKey QEMU +4. Debuging +5. Limitations +6. References + +1. CanoKey QEMU + +CanoKey[1] is an open-source secure key with supports of + + * U2F / FIDO2 with Ed25519 and HMAC-secret + * OpenPGP Card V3.4 with RSA4096, Ed25519 and more[2] + * PIV (NIST SP 800-73-4) + * HOTP / TOTP + * NDEF + +All these platform-independent code are in canokey-core[3]. + +For different platforms, CanoKey has different implementations, +including both hardware implementions and virtual cards: + + * CanoKey STM32[4] + * CanoKey Pigeon[5] + * (virt-card) CanoKey USB/IP[6] + +In QEMU, yet another CanoKey virt-card is implemented. +CanoKey QEMU exposes itself as a USB device to the guest OS. + +With the same configuration as what would be done for a hardware key, +the guest OS can use all the functionalities of a secure key as if +there was actually an hardware key plugged in. + +CanoKey QEMU provides much convenience for debuging: + + * libcanokey-qemu supports debuging output thus developers can + trace what happens inside a secure key + * CanoKey QEMU supports debuging output, thus it can show USB packets. + +Then for developers: + + * For developers on software with secure key support (e.g. FIDO2, OpenPGP), + they can see what happens inside the secure key + * For secure key developers, USB packets between guest OS and CanoKey + can be easily captured and analysed + +Also as this is a virtual card, it can be easily used in CI for testing +on code coping with secure key. + +2. Building + +libcanokey-qemu is required to use CanoKey QEMU. + + git clone https://github.com/canokeys/canokey-core + mkdir canokey-core/build + pushd canokey-core/build + +If you want to install libcanokey-qemu in a different place, +add -DCMAKE_INSTALL_PREFIX=/path/to/your/place to cmake below. + + cmake .. -DQEMU=ON + make + make install # may need sudo + popd + +Then configuring and building: + + # depending on your env, lib/pkgconfig can be lib64/pkgconfig + export PKG_CONFIG_PATH=/path/to/your/place/lib/pkgconfig:$PKG_CONFIG_PATH + ./configure --enable-canokey && make + +3. Using CanoKey QEMU + +CanoKey QEMU stores all its data on a file of the host specified by the argument +when invoking qemu. + + qemu -usb -device canokey,file=$HOME/.canokey-file + +Note: you should keep this file carefully as it may contain your private key! + +The first time when the file is used, it is created and initialized by CanoKey, +afterwards CanoKey QEMU would just read this file. + +After the guest OS boots, you can check that there is a USB device. + +For example, If the guest OS is an Linux machine. You may invoke lsusb +and find CanoKey QEMU there: + + $ lsusb + Bus 001 Device 002: ID 20a0:42d4 Clay Logic CanoKey + +You may setup the key as guided in https://docs.canokeys.org/ + +The console for the key is at https://console.canokeys.org/ + +4. Debuging + +CanoKey QEMU consists of two parts, libcanokey-qemu.so and canokey.c, the latter +of which resides in QEMU. The former provides core functionality of a secure key +while the latter provides platform-dependent functions: USB packet handling. + +If you want to trace what happens inside the secure key, when compiling +libcanokey-qemu, you should add -DENABLE_DEBUG_OUTPUT=ON in cmake command line: + + cmake .. -DQEMU=ON -DENABLE_DEBUG_OUTPUT=ON + +And if you want to show the USB packet flow, you can uncomment DEBUG_CANOKEY +in hw/usb/canokey.c and compile qemu again. Or even further if you want to +show the USB packet payload, you can uncomment DEBUG_CANOKEY_DATA + +5. Limitations + +Currently libcanokey-qemu.so has dozens of global variables as it was originally +designed for embedded systems. Thus one qemu instance can not have +multiple CanoKey QEMU running, namely you can not + + qemu -usb -device canokey,file=$HOME/.canokey-file\ + -device canokey,file=$HOME/.canokey-file2 + +Also, there is no lock on canokey-file, thus two CanoKey QEMU instance +can not read one canokey-file at the same time. + +6. References + +[1] https://canokeys.org +[2] https://docs.canokeys.org/userguide/openpgp/#supported-algorithm +[3] https://github.com/canokeys/canokey-core +[4] https://github.com/canokeys/canokey-stm32 +[5] https://twitter.com/CanoKeys/status/1473647697744003072 +[6] https://github.com/canokeys/canokey-core#virt-card-usbip
Signature · 1 line
2.34.0
PATCH 1/6 hw/usb: Add CanoKey Implementation
In reply to Hongren (Zenithal) ZhengThis commit added a new emulated device called CanoKey to QEMU.
CanoKey implements platform independent features in canokey-core
https://github.com/canokeys/canokey-core, and leaves the USB implementation to the platform.
In this commit the USB part was implemented in QEMU using QEMU's USB APIs, therefore the emulated CanoKey can communicate with the guest OS using USB.
--- hw/usb/canokey.c | 378 +++++++++++++++++++++++++++++++++++++++++++++++ hw/usb/canokey.h | 60 ++++++++ 2 files changed, 438 insertions(+) create mode 100644 hw/usb/canokey.c create mode 100644 hw/usb/canokey.h
hw/usb/canokey.c new file +378 -0
@@ -0,0 +1,378 @@ +/* +* CanoKey QEMU device implementation. +* +* Copyright (c) Canokeys.org <[email protected]> +* Written by Hongren (Zenithal) Zheng <[email protected]> +* +* This code is licensed under the Apache-2.0. +*/ + +#include "qemu/osdep.h" +#include <canokey-qemu.h> + +#include "qemu/module.h" +#include "qemu/thread.h" +#include "qemu/main-loop.h" +#include "qapi/error.h" +#include "hw/usb.h" +#include "hw/qdev-properties.h" +#include "desc.h" +#include "canokey.h" + +/* #define DEBUG_CANOKEY_DATA 1 */ +/* #define DEBUG_CANOKEY 1 */ + +#ifdef DEBUG_CANOKEY_DATA +#define DPRINTF_DATA (data, len, fmt, ...) \ +do { \ + printf("canokey: payload: " fmt " ", ## __VA_ARGS__); \ + for (int i = 0; i != (len); ++i) { \ + printf("%02X ", (data)[i]); \ + } \ + printf("\n"); \ +} while (0) +#else +#define DPRINTF_DATA (data, len, fmt, ...) do {} while (0) +#endif + +#ifdef DEBUG_CANOKEY +#define DPRINTF (fmt, ...) \ +do { printf("canokey: " fmt "\n", ## __VA_ARGS__); } while (0) +#define BADF (fmt, ...) \ +do { fprintf(stderr, "canokey: error: " fmt "\n", ## __VA_ARGS__); \ + exit(1); } while (0) +#else +#define DPRINTF (fmt, ...) do {} while (0) +#define BADF (fmt, ...) \ +do { fprintf(stderr, "canokey: error: " fmt "\n", ## __VA_ARGS__); } while (0) +#endif + +#define CANOKEY_EP_IN (ep) ((ep) & 0x7F) + +#define CANOKEY_VENDOR_NUM 0x20a0 +#define CANOKEY_PRODUCT_NUM 0x42d2 + +/* +* placeholder, canokey-qemu implements its own usb desc +* Namely we do not use usb_desc_handle_contorl +*/ +enum { +STR_MANUFACTURER =1 , +STR_PRODUCT , +STR_SERIALNUMBER +}; + +static const USBDescStrings desc_strings = { + [STR_MANUFACTURER ] ="canokeys.org" , + [STR_PRODUCT ] ="CanoKey QEMU" , + [STR_SERIALNUMBER ] ="0" +}; + +static const USBDescDevice desc_device_canokey = { + .bcdUSB =0x0 , + .bMaxPacketSize0 =16 , + .bNumConfigurations =0 , + .confs =NULL , +}; + +static const USBDesc desc_canokey = { + .id = { + .idVendor =CANOKEY_VENDOR_NUM , + .idProduct =CANOKEY_PRODUCT_NUM , + .bcdDevice =0x0100 , + .iManufacturer =STR_MANUFACTURER , + .iProduct =STR_PRODUCT , + .iSerialNumber =STR_SERIALNUMBER , + }, + .full = &desc_device_canokey, + .str = desc_strings, +}; + + +/* Implement canokey-qemu functions */ +int canokey_emu_stall_ep (void *base,uint8_t ep) +{ +DPRINTF ("stall ep %d" , ep); +CanoKeyState *key = base; +uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ +qemu_mutex_lock (&key->ep_in_mutex[ep_in]); + key->ep_in_size[ep_in] =0 ; + key->ep_in_status[ep_in] =CANOKEY_EP_IN_STALL ; +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); +return 0 ; +} + +int canokey_emu_set_address (void *base,uint8_t addr) +{ +DPRINTF ("set addr %d" , addr); +CanoKeyState *key = base; + key->dev.addr = addr; +return 0 ; +} + +int canokey_emu_prepare_receive ( +void *base,uint8_t ep,uint8_t *pbuf,uint16_t size) +{ +DPRINTF ("prepare receive on ep %d size %d" , ep, size); +CanoKeyState *key = base; +/* +* No mutex here because it is usually called by +* canokey_emu_data_out (qemu thread), which already has mutex +*/ + key->ep_out[ep] = pbuf; + key->ep_out_size[ep] = size; +return 0 ; +} + +int canokey_emu_transmit ( +void *base,uint8_t ep,const uint8_t *pbuf,uint16_t size) +{ +DPRINTF ("transmit ep %d size %d" , ep, size); +DPRINTF_DATA (pbuf, size,"transmit" ); +CanoKeyState *key = base; +uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ +qemu_mutex_lock (&key->ep_in_mutex[ep_in]); +memcpy (key->ep_in[ep_in], pbuf, size); + key->ep_in_size[ep_in] = size; + key->ep_in_status[ep_in] =CANOKEY_EP_IN_READY ; +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); +return 0 ; +} + +uint32_t canokey_emu_get_rx_data_size (void *base,uint8_t ep) +{ +CanoKeyState *key = base; +DPRINTF ("get rx data size ep %d size %d" , ep, key->ep_out_size[ep]); +return key->ep_out_size[ep]; +} + +static void *canokey_thread (void *arg) +{ +DPRINTF ("thread" ); +CanoKeyState *key = arg; + +while (true) { +/* Wait signal */ +qemu_mutex_lock (&key->key_mutex); +qemu_cond_wait (&key->key_cond, &key->key_mutex); +qemu_mutex_unlock (&key->key_mutex); + +/* Exit thread check */ +if (key->stop_thread) { +DPRINTF ("stop thread" ); + key->stop_thread = false; +break ; + } + +canokey_emu_device_loop (); + } +return NULL ; +} + +static void canokey_handle_reset (USBDevice *dev) +{ +DPRINTF ("reset" ); +CanoKeyState *key =CANOKEY (dev); +for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { + key->ep_in_status[i] =CANOKEY_EP_IN_WAIT ; + key->ep_in_pos[i] =0 ; + } +canokey_emu_reset (); +} + +static void canokey_handle_control (USBDevice *dev,USBPacket *p, +int request,int value,int index,int length,uint8_t *data) +{ +DPRINTF ("contorl SETUP: %04X %04X %04X %04X" , + request, value, index, length); +CanoKeyState *key =CANOKEY (dev); + +canokey_emu_setup (request, value, index, length); +qemu_cond_signal (&key->key_cond); + +uint8_t ep_in =CANOKEY_EP_IN (p->ep->nr); +uint32_t dir_in = request & DeviceRequest; +if (!dir_in) { +/* OUT */ +DPRINTF ("control OUT size %d" , length); +DPRINTF_DATA (data, length,"control OUT" ); +qemu_mutex_lock (&key->key_mutex); +if (key->ep_out[0 ] !=NULL ) { +memcpy (key->ep_out[0 ], data, length); + } +canokey_emu_data_out (p->ep->nr, data); +qemu_cond_signal (&key->key_cond); +qemu_mutex_unlock (&key->key_mutex); + } + +/* IN */ +qemu_mutex_lock (&key->ep_in_mutex[ep_in]); +if (key->ep_in_status[ep_in] ==CANOKEY_EP_IN_WAIT ) { + p->status =USB_RET_NAK ; +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); +return ; + } +if (key->ep_in_status[ep_in] ==CANOKEY_EP_IN_STALL ) { + p->status =USB_RET_STALL ; + } + key->ep_in_status[ep_in] =CANOKEY_EP_IN_WAIT ; +memcpy (data, key->ep_in[ep_in], key->ep_in_size[ep_in]); + p->actual_length = key->ep_in_size[ep_in]; + +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); + +DPRINTF ("control IN: %d" , p->actual_length); +DPRINTF_DATA (data, p->actual_length,"control IN" ); +} + +static void canokey_handle_data (USBDevice *dev,USBPacket *p) +{ +CanoKeyState *key =CANOKEY (dev); + +uint8_t ep_in =CANOKEY_EP_IN (p->ep->nr); +uint8_t ep_out = p->ep->nr; +uint32_t in_len; +switch (p->pid) { +case USB_TOKEN_OUT : +DPRINTF ("data OUT, ep %d" , ep_out); +qemu_mutex_lock (&key->key_mutex); +if (p->iov.size > key->ep_out_size[ep_out]) { +DPRINTF ("data OUT, ep %d overflow! income %d, buffer size %d" , + ep_out, p->iov.size, key->ep_out_size[ep_out]); + p->status =USB_RET_NAK ; +qemu_mutex_unlock (&key->key_mutex); +break ; + } +usb_packet_copy (p, key->ep_out[ep_out], p->iov.size); + key->ep_out_size[ep_out] = p->iov.size; +DPRINTF_DATA (key->ep_out[ep_out], p->iov.size,"data OUT payload" ); +canokey_emu_data_out (ep_out,NULL ); +qemu_cond_signal (&key->key_cond); +qemu_mutex_unlock (&key->key_mutex); +break ; +case USB_TOKEN_IN : +qemu_mutex_lock (&key->ep_in_mutex[ep_in]); +if (key->ep_in_pos[ep_in] ==0 ) { +canokey_emu_data_in (ep_in); +qemu_cond_signal (&key->key_cond); +if (key->ep_in_status[ep_in] ==CANOKEY_EP_IN_WAIT ) { + p->status =USB_RET_NAK ; +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); +break ; + } +DPRINTF ("data IN, ep %d" , ep_in); +DPRINTF_DATA (key->ep_in[ep_in], key->ep_in_size[ep_in], +"data IN payload" ); +if (key->ep_in_status[ep_in] ==CANOKEY_EP_IN_STALL ) { + p->status =USB_RET_STALL ; + } + key->ep_in_status[ep_in] =CANOKEY_EP_IN_WAIT ; + + in_len =MIN (key->ep_in_size[ep_in], p->iov.size); +usb_packet_copy (p, key->ep_in[ep_in], in_len); +if (in_len < key->ep_in_size[ep_in]) { + key->ep_in_pos[ep_in] = in_len; + } + }else { + in_len =MIN (key->ep_in_size[ep_in] - key->ep_in_pos[ep_in], + p->iov.size); +usb_packet_copy (p, + key->ep_in[ep_in] + key->ep_in_pos[ep_in], in_len); + key->ep_in_pos[ep_in] += in_len; +if (key->ep_in_pos[ep_in] == key->ep_in_size[ep_in]) { + key->ep_in_pos[ep_in] =0 ; + } + } +qemu_mutex_unlock (&key->ep_in_mutex[ep_in]); +break ; +default : + p->status =USB_RET_STALL ; +break ; + } +} + +static void canokey_realize (USBDevice *base,Error **errp) +{ +DPRINTF ("realize" ); +CanoKeyState *key =CANOKEY (base); + +if (key->file ==NULL ) { +error_setg (errp,"You must provide file=/path/to/canokey-file" ); +return ; + } + +usb_desc_init (base); + +/* Synchronization */ +qemu_cond_init (&key->key_cond); +qemu_mutex_init (&key->key_mutex); +for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { +qemu_mutex_init (&key->ep_in_mutex[i]); + key->ep_in_status[i] =CANOKEY_EP_IN_WAIT ; + key->ep_in_pos[i] =0 ; + } + +if (canokey_emu_init (key, key->file)) { +error_setg (errp,"canokey can not create or read %s" , key->file); +return ; + } + +/* Thread */ + key->stop_thread = false; +qemu_thread_create (&key->key_thread,"canokey" , canokey_thread, + key,QEMU_THREAD_JOINABLE ); +} + +static void canokey_unrealize (USBDevice *base) +{ +DPRINTF ("unrealize" ); +CanoKeyState *key =CANOKEY (base); + +/* Thread */ + key->stop_thread = true; +qemu_cond_signal (&key->key_cond); +qemu_thread_join (&key->key_thread); + +/* Synchronization */ +qemu_cond_destroy (&key->key_cond); +qemu_mutex_destroy (&key->key_mutex); +for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { +qemu_mutex_destroy (&key->ep_in_mutex[i]); + } +} + +static Property canokey_properties[] = { +DEFINE_PROP_STRING ("file" , CanoKeyState, file), +DEFINE_PROP_END_OF_LIST (), +}; + +static void canokey_class_init (ObjectClass *klass,void *data) +{ +DeviceClass *dc =DEVICE_CLASS (klass); +USBDeviceClass *uc =USB_DEVICE_CLASS (klass); + + uc->product_desc ="CanoKey QEMU" ; + uc->usb_desc = &desc_canokey; + uc->handle_reset = canokey_handle_reset; + uc->handle_control = canokey_handle_control; + uc->handle_data = canokey_handle_data; + uc->handle_attach = usb_desc_attach; + uc->realize = canokey_realize; + uc->unrealize = canokey_unrealize; + dc->desc ="CanoKey QEMU" ; +device_class_set_props (dc, canokey_properties); +} + +static const TypeInfo canokey_info = { + .name =TYPE_CANOKEY , + .parent =TYPE_USB_DEVICE , + .instance_size =sizeof (CanoKeyState), + .class_init = canokey_class_init +}; + +static void canokey_register_types (void ) +{ +type_register_static (&canokey_info); +} + +type_init (canokey_register_types)
hw/usb/canokey.h new file +60 -0
60 lines not on this page · raw message
Signature · 1 line
2.34.0
PATCH 4/6 docs/system/devices/usb: Add CanoKey to USB devices examples
In reply to Hongren (Zenithal) Zheng--- docs/system/devices/usb.rst | 3 +++ 1 file changed, 3 insertions(+)
docs/system/devices/usb.rst +3 -0
@@ -199,6 +199,9 @@ option or the ``device_add`` monitor command. Available devices are: ``u2f-{emulated,passthru}`` Universal Second Factor device +``canokey`` + An Open-source Secure Key implementing FIDO2, OpenPGP, PIV and more. + Physical port addressing ^^^^^^^^^^^^^^^^^^^^^^^^
Signature · 1 line
2.34.0
cover Introduce CanoKey QEMU
- One sentense
With this patch series, QEMU would fully emulate an open-source secure key, CanoKey, with supports of various features listed below:
* U2F / FIDO2 with Ed25519 and HMAC-secret
* OpenPGP Card V3.4 with RSA4096, Ed25519 and more
* PIV (NIST SP 800-73-4)
* HOTP / TOTP
- What's New
Although we have seen multiple emulated devices providing different functionalities for different purposes such as U2F (hw/usb/u2f-emulated.c) and CAC (hw/usb/ccid-card-emulated.c), modern secure key needs more advanced protocols like FIDO2 (WebAuthn, in comparison to U2f) and PIV (in comparison to CAC), which is not implemented previously.
Other features like OpenPGP / TOTP are also not implemented before, at least as an emulated functionality.
- Why get upstreamed
At Canokeys.org, virtual cards on its own are for testing and debugging on the key itself. We have implemented various virt-cards including fido-hid-over-udp and USB/IP on our CI for testing and developer debuging.
As we found emulated U2F and CAC in QEMU mainline, we estimated we could implement such features as well, which is good for testing since now we can emulate the whole key as an USB device, and we implemented it! as presented by this patch series.
The story doesn't end here. As CanoKey QEMU is a fully functional key and it is inside QEMU, we think this emulated device could reach a wider audience other than CanoKey developers: projects using secure key can also benefit from it.
For example, this device can be used in CI for projects using secure key. Bringing up a VM using QEMU with CanoKey QEMU, now we have an environment with secure key, and we can test the correctness of the behavior of the code.
Another example is that as it is fully emulated rather than some hardware, all traces/debug logs can be easily extracted, which is helpful for developpers to debug.
One note though, using CanoKey QEMU as a daily secure key is not recommended as the secret key in the emulated key is not protected by hardware.
- Implementation details
CanoKey implements all these platform independent features in canokey-core
https://github.com/canokeys/canokey-core, and leaves the USB implementation to the platform, thus in this patch series we implemented the USB part in QEMU platform using QEMU's USB APIs, therefore the emulated CanoKey can communicate with the guest OS using USB.
Some note though, CanoKey also has a NFC interface, thus we can implement the NFC part in QEMU and expose CanoKey to the guest as an NFC device. This is left as future work.
In the meanwhile, unlike other emulated device which has a passthrough counterpart, CanoKey QEMU does not provide a passthrough mode as a whole since CanoKey has multiple interfaces which is hard to passthrough. (Left as future work, passthrough via WebUSB interface)
You may try to use u2f-passthru and ccid-card-passthru to pass the U2F and CCID (e.g. OpenPGP, PIV) part of a real (or virtual, referring to USB/IP) CanoKey on the host to the guest.
Hongren (Zenithal) Zheng (6):
hw/usb: Add CanoKey Implementation
meson: Add CanoKey
docs: Add CanoKey documentation docs/system/devices/usb: Add CanoKey to USB devices examples docs/qdev-device-use: Add CanoKey to QDEV devices examples
MAINTAINERS: add myself as CanoKey maintainer
MAINTAINERS | 8 + docs/canokey.txt | 133 ++++++++++++ docs/qdev-device-use.txt | 1 + docs/system/devices/usb.rst | 3 + hw/usb/Kconfig | 5 + hw/usb/canokey.c | 378 ++++++++++++++++++++++++++++++++++ hw/usb/canokey.h | 60 ++++++ hw/usb/meson.build | 3 + meson.build | 6 + meson_options.txt | 2 + scripts/meson-buildoptions.sh | 3 + 11 files changed, 602 insertions(+) create mode 100644 docs/canokey.txt create mode 100644 hw/usb/canokey.c create mode 100644 hw/usb/canokey.h
Signature · 1 line
2.34.0
PATCH 5/6 docs/qdev-device-use: Add CanoKey to QDEV devices examples
--- docs/qdev-device-use.txt | 1 + 1 file changed, 1 insertion(+)
docs/qdev-device-use.txt +1 -0
@@ -342,6 +342,7 @@ The new way is -device DEVNAME,DEV-OPTS... Details depend on DRIVER: * tablet -device usb-tablet * wacom-tablet -device usb-wacom-tablet * u2f -device u2f-{emulated,passthru} +* canokey -device canokey * braille See "Character Devices" Until v2.12.0, we additionally had
Signature · 1 line
2.34.0
PATCH 6/6 MAINTAINERS: add myself as CanoKey maintainer
In reply to Hongren (Zenithal) Zheng--- MAINTAINERS | 8 ++++++++ 1 file changed, 8 insertions(+)
MAINTAINERS +8 -0
@@ -2295,6 +2295,14 @@ F: hw/timer/mips_gictimer.c F: include/hw/intc/mips_gic.h F: include/hw/timer/mips_gictimer.h +CanoKey +M: Hongren (Zenithal) Zheng <[email protected]> +S: Maintained +R: Canokeys.org <[email protected]> +F: hw/usb/canokey.c +F: hw/usb/canokey.h +F: docs/canokey.txt + Subsystems ---------- Overall Audio backends
Signature · 1 line
2.34.0
Re: [PATCH 1/6] hw/usb: Add CanoKey Implementation
In reply to Hongren (Zenithal) ZhengHi,
hw/usb/canokey.c line 40
Quoted 3 lines
hw/usb/canokey.c new file +3
-0+#ifdef DEBUG_CANOKEY +#define DPRINTF (fmt, ...) \ +do { printf("canokey: " fmt "\n", ## __VA_ARGS__); } while (0)
Better use tracepoints instead (see docs/devel/tracing.rst).
hw/usb/canokey.c line 131
Quoted 5 lines
hw/usb/canokey.c new file +5
-0+int canokey_emu_transmit ( +void *base,uint8_t ep,const uint8_t *pbuf,uint16_t size) +{ +DPRINTF ("transmit ep %d size %d" , ep, size); +DPRINTF_DATA (pbuf, size,"transmit" );
Did you know all usb devices have a pcap property for writing out usb packet traces? i.e. use '-device canokey,pcap=test.pcap', then look at the traces using wireshark.
take care,
Gerd
Re: [PATCH 5/6] docs/qdev-device-use: Add CanoKey to QDEV devices examples
In reply to Hongren (Zenithal) ZhengQuoted 10 lines · Hongren (Zenithal) Zheng
Signed-off-by Hongren (Zenithal) Zheng <[email protected]>--- docs/qdev-device-use.txt | 1 + 1 file changed, 1 insertion(+)docs/qdev-device-use.txt +0
-0
docs/qdev-device-use.txt The new way is -device DEVNAME,DEV-OPTS... Details depend on DRIVER: · line 346
Quoted 5 lines
docs/qdev-device-use.txt +1
-0@@ -342,6 +342,7 @@ The new way is -device DEVNAME,DEV-OPTS... Details depend on DRIVER: * tablet -device usb-tablet * wacom-tablet -device usb-wacom-tablet * u2f -device u2f-{emulated,passthru} +* canokey -device canokey * braille See "Character Devices"
Please drop this patch. The list here is only about legacy USB device usage with the "-usbdevice" parameter, but since there never was and never will be a "-usbdevice canokey", there is no need to add an entry here.
Thomas