Introduce CanoKey QEMU
v4 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.
---
v1 -> v2:
* Use trace events instead of printf to log canokey.c function call
* Update debug instructions (trace, pcap) in CanoKey doc
* Drop commit about legacy -usbdevice usage
v2 -> v3:
* Fix code style in commit hw/usb/canokey: Add trace events
* Move docs/canokey.txt to docs/system/devices/canokey.rst
v3 -> v4:
* Refactor canokey.c into single thread version. This version is much easier to understand and review
* Add more comments
* Add links to canokey.rst in usb.rst
* Update MAINTAINERS canokey docs file
Hongren (Zenithal) Zheng (6):
hw/usb: Add CanoKey Implementation
hw/usb/canokey: Add trace events
meson: Add CanoKey
docs: Add CanoKey documentation docs/system/devices/usb: Add CanoKey to USB devices examples
MAINTAINERS: add myself as CanoKey maintainer
MAINTAINERS | 8 + docs/system/device-emulation.rst | 1 + docs/system/devices/canokey.rst | 158 ++++++++++++++++ docs/system/devices/usb.rst | 4 + hw/usb/Kconfig | 5 + hw/usb/canokey.c | 311 +++++++++++++++++++++++++++++++ hw/usb/canokey.h | 69 +++++++ hw/usb/meson.build | 3 + hw/usb/trace-events | 16 ++ meson.build | 6 + meson_options.txt | 2 + scripts/meson-buildoptions.sh | 3 + 12 files changed, 586 insertions(+) create mode 100644 docs/system/devices/canokey.rst create mode 100644 hw/usb/canokey.c create mode 100644 hw/usb/canokey.h
Signature · 1 line
2.34.1
PATCH v4 1/6 hw/usb: Add CanoKey Implementation
This 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 | 298 +++++++++++++++++++++++++++++++++++++++++++++++ hw/usb/canokey.h | 69 +++++++++++ 2 files changed, 367 insertions(+) create mode 100644 hw/usb/canokey.c create mode 100644 hw/usb/canokey.h
hw/usb/canokey.c new file +298 -0
@@ -0,0 +1,298 @@ +/* +* CanoKey QEMU device implementation. +* +* Copyright (c) 2021-2022 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 "qapi/error.h" +#include "hw/usb.h" +#include "hw/qdev-properties.h" +#include "desc.h" +#include "canokey.h" + +#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, +}; + + +/* +* libcanokey-qemu.so side functions +* All functions are called from canokey_emu_device_loop +*/ +int canokey_emu_stall_ep (void *base,uint8_t ep) +{ +CanoKeyState *key = base; +uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ + key->ep_in_size[ep_in] =0 ; + key->ep_in_state[ep_in] =CANOKEY_EP_IN_STALL ; +return 0 ; +} + +int canokey_emu_set_address (void *base,uint8_t 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) +{ +CanoKeyState *key = base; + 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) +{ +CanoKeyState *key = base; +uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ +memcpy (key->ep_in[ep_in] + key->ep_in_size[ep_in], + pbuf, size); + key->ep_in_size[ep_in] += size; + key->ep_in_state[ep_in] =CANOKEY_EP_IN_READY ; +/* +* ready for more data in device loop +* +* Note: this is a quirk for CanoKey CTAPHID +* because it calls multiple emu_transmit in one device_loop +* but w/o data_in it would stuck in device_loop +* This has no side effect for CCID as it is strictly +* OUT then IN transfer +* However it has side effect for Control transfer +*/ +if (ep_in !=0 ) { +canokey_emu_data_in (ep_in); + } +return 0 ; +} + +uint32_t canokey_emu_get_rx_data_size (void *base,uint8_t ep) +{ +CanoKeyState *key = base; +return key->ep_out_size[ep]; +} + +/* +* QEMU side functions +*/ +static void canokey_handle_reset (USBDevice *dev) +{ +CanoKeyState *key =CANOKEY (dev); +for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { + key->ep_in_state[i] =CANOKEY_EP_IN_WAIT ; + key->ep_in_pos[i] =0 ; + key->ep_in_size[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) +{ +CanoKeyState *key =CANOKEY (dev); + +canokey_emu_setup (request, value, index, length); + +uint32_t dir_in = request & DeviceRequest; +if (!dir_in) { +/* OUT */ +if (key->ep_out[0 ] !=NULL ) { +memcpy (key->ep_out[0 ], data, length); + } +canokey_emu_data_out (p->ep->nr, data); + } + +canokey_emu_device_loop (); + +/* IN */ +switch (key->ep_in_state[0 ]) { +case CANOKEY_EP_IN_WAIT : + p->status =USB_RET_NAK ; +break ; +case CANOKEY_EP_IN_STALL : + p->status =USB_RET_STALL ; +break ; +case CANOKEY_EP_IN_READY : +memcpy (data, key->ep_in[0 ], key->ep_in_size[0 ]); + p->actual_length = key->ep_in_size[0 ]; +/* reset state */ + key->ep_in_state[0 ] =CANOKEY_EP_IN_WAIT ; + key->ep_in_size[0 ] =0 ; + key->ep_in_pos[0 ] =0 ; +break ; + } +} + +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; +uint32_t out_pos; +uint32_t out_len; +switch (p->pid) { +case USB_TOKEN_OUT : +usb_packet_copy (p, key->ep_out_buffer[ep_out], p->iov.size); + out_pos =0 ; +while (out_pos != p->iov.size) { +/* +* key->ep_out[ep_out] set by prepare_receive +* to be a buffer inside libcanokey-qemu.so +* key->ep_out_size[ep_out] set by prepare_receive +* to be the buffer length +*/ + out_len =MIN (p->iov.size - out_pos, key->ep_out_size[ep_out]); +memcpy (key->ep_out[ep_out], + key->ep_out_buffer[ep_out] + out_pos, out_len); + out_pos += out_len; +/* update ep_out_size to actual len */ + key->ep_out_size[ep_out] = out_len; +canokey_emu_data_out (ep_out,NULL ); + } +break ; +case USB_TOKEN_IN : +if (key->ep_in_pos[ep_in] ==0 ) {/* first time IN */ +canokey_emu_data_in (ep_in); +canokey_emu_device_loop ();/* may call transmit multiple times */ + } +switch (key->ep_in_state[ep_in]) { +case CANOKEY_EP_IN_WAIT : +/* NAK for early INTR IN */ + p->status =USB_RET_NAK ; +break ; +case CANOKEY_EP_IN_STALL : + p->status =USB_RET_STALL ; +break ; +case CANOKEY_EP_IN_READY : +/* submit part of ep_in buffer to USBPacket */ + 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; +/* reset state if all data submitted */ +if (key->ep_in_pos[ep_in] == key->ep_in_size[ep_in]) { + key->ep_in_state[ep_in] =CANOKEY_EP_IN_WAIT ; + key->ep_in_size[ep_in] =0 ; + key->ep_in_pos[ep_in] =0 ; + } +break ; + } +break ; +default : + p->status =USB_RET_STALL ; +break ; + } +} + +static void canokey_realize (USBDevice *base,Error **errp) +{ +CanoKeyState *key =CANOKEY (base); + +if (key->file ==NULL ) { +error_setg (errp,"You must provide file=/path/to/canokey-file" ); +return ; + } + +usb_desc_init (base); + +for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { + key->ep_in_state[i] =CANOKEY_EP_IN_WAIT ; + key->ep_in_size[i] =0 ; + 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 ; + } +} + +static void canokey_unrealize (USBDevice *base) +{ +} + +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 +69 -0
69 lines not on this page · raw message
Signature · 1 line
2.34.1
PATCH v4 2/6 hw/usb/canokey: Add trace events
In reply to Hongren (Zenithal) Zheng--- hw/usb/canokey.c | 13 +++++++++++++ hw/usb/trace-events | 16 ++++++++++++++++ 2 files changed, 29 insertions(+)
hw/usb/canokey.c +13 -0
@@ -14,6 +14,7 @@#include "qapi/error.h" #include "hw/usb.h" #include "hw/qdev-properties.h" +#include "trace.h" #include "desc.h" #include "canokey.h"
@@ -65,6 +66,7 @@ static const USBDesc desc_canokey = {*/ int canokey_emu_stall_ep (void *base,uint8_t ep) { +trace_canokey_emu_stall_ep (ep);CanoKeyState *key = base;uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ key->ep_in_size[ep_in] =0 ;
@@ -74,6 +76,7 @@ int canokey_emu_stall_ep(void *base, uint8_t ep)int canokey_emu_set_address (void *base,uint8_t addr) { +trace_canokey_emu_set_address (addr);CanoKeyState *key = base; key->dev.addr = addr;return 0 ;
@@ -82,6 +85,7 @@ int canokey_emu_set_address(void *base, uint8_t addr)int canokey_emu_prepare_receive (void *base,uint8_t ep,uint8_t *pbuf,uint16_t size) { +trace_canokey_emu_prepare_receive (ep, size);CanoKeyState *key = base; key->ep_out[ep] = pbuf; key->ep_out_size[ep] = size;
@@ -91,6 +95,7 @@ int canokey_emu_prepare_receive(int canokey_emu_transmit (void *base,uint8_t ep,const uint8_t *pbuf,uint16_t size) { +trace_canokey_emu_transmit (ep, size);CanoKeyState *key = base;uint8_t ep_in =CANOKEY_EP_IN (ep);/* INTR IN has ep 129 */ memcpy(key->ep_in[ep_in] + key->ep_in_size[ep_in],
@@ -124,6 +129,7 @@ uint32_t canokey_emu_get_rx_data_size(void *base, uint8_t ep)*/ static void canokey_handle_reset (USBDevice *dev) { +trace_canokey_handle_reset ();CanoKeyState *key =CANOKEY (dev);for (int i =0 ; i !=CANOKEY_EP_NUM ; ++i) { key->ep_in_state[i] =CANOKEY_EP_IN_WAIT ;
@@ -136,6 +142,7 @@ static void canokey_handle_reset(USBDevice *dev)static void canokey_handle_control (USBDevice *dev,USBPacket *p,int request,int value,int index,int length,uint8_t *data) { +trace_canokey_handle_control_setup (request, value, index, length);CanoKeyState *key =CANOKEY (dev);canokey_emu_setup (request, value, index, length);
@@ -143,6 +150,7 @@ static void canokey_handle_control(USBDevice *dev, USBPacket *p,uint32_t dir_in = request & DeviceRequest;if (!dir_in) {/* OUT */ +trace_canokey_handle_control_out ();if (key->ep_out[0 ] !=NULL ) {memcpy (key->ep_out[0 ], data, length); }
@@ -162,6 +170,7 @@ static void canokey_handle_control(USBDevice *dev, USBPacket *p,case CANOKEY_EP_IN_READY :memcpy (data, key->ep_in[0 ], key->ep_in_size[0 ]); p->actual_length = key->ep_in_size[0 ]; +trace_canokey_handle_control_in (p->actual_length);/* reset state */ key->ep_in_state[0 ] =CANOKEY_EP_IN_WAIT ; key->ep_in_size[0 ] =0 ;
@@ -181,6 +190,7 @@ static void canokey_handle_data(USBDevice *dev, USBPacket *p)uint32_t out_len;switch (p->pid) {case USB_TOKEN_OUT : +trace_canokey_handle_data_out (ep_out, p->iov.size);usb_packet_copy (p, key->ep_out_buffer[ep_out], p->iov.size); out_pos =0 ;while (out_pos != p->iov.size) {
@@ -225,6 +235,7 @@ static void canokey_handle_data(USBDevice *dev, USBPacket *p) key->ep_in_size[ep_in] =0 ; key->ep_in_pos[ep_in] =0 ; } +trace_canokey_handle_data_in (ep_in, in_len);break ; }break ;
@@ -236,6 +247,7 @@ static void canokey_handle_data(USBDevice *dev, USBPacket *p)static void canokey_realize (USBDevice *base,Error **errp) { +trace_canokey_realize ();CanoKeyState *key =CANOKEY (base);if (key->file ==NULL ) {
@@ -259,6 +271,7 @@ static void canokey_realize(USBDevice *base, Error **errp)static void canokey_unrealize (USBDevice *base) { +trace_canokey_unrealize (); }static Property canokey_properties[] = {
hw/usb/trace-events +16 -0
@@ -345,3 +345,19 @@ usb_serial_set_baud(int bus, int addr, int baud) "dev %d:%u baud rate %d" usb_serial_set_data(int bus, int addr, int parity, int data, int stop) "dev %d:%u parity %c, data bits %d, stop bits %d" usb_serial_set_flow_control(int bus, int addr, int index) "dev %d:%u flow control %d" usb_serial_set_xonxoff(int bus, int addr, uint8_t xon, uint8_t xoff) "dev %d:%u xon 0x%x xoff 0x%x" + +# canokey.c +canokey_emu_stall_ep(uint8_t ep) "ep %d" +canokey_emu_set_address(uint8_t addr) "addr %d" +canokey_emu_prepare_receive(uint8_t ep, uint16_t size) "ep %d size %d" +canokey_emu_transmit(uint8_t ep, uint16_t size) "ep %d size %d" +canokey_thread_start(void) +canokey_thread_stop(void) +canokey_handle_reset(void) +canokey_handle_control_setup(int request, int value, int index, int length) "request 0x%04X value 0x%04X index 0x%04X length 0x%04X" +canokey_handle_control_out(void) +canokey_handle_control_in(int actual_len) "len %d" +canokey_handle_data_out(uint8_t ep_out, uint32_t out_len) "ep %d len %d" +canokey_handle_data_in(uint8_t ep_in, uint32_t in_len) "ep %d len %d" +canokey_realize(void) +canokey_unrealize(void)
Signature · 1 line
2.34.1
PATCH v4 3/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
@@ -1194,6 +1194,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
@@ -29,6 +29,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'
@@ -116,6 +117,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.1
PATCH v4 4/6 docs: Add CanoKey documentation
In reply to Hongren (Zenithal) Zheng--- docs/system/device-emulation.rst | 1 + docs/system/devices/canokey.rst | 158 +++++++++++++++++++++++++++++++ 2 files changed, 159 insertions(+) create mode 100644 docs/system/devices/canokey.rst
docs/system/device-emulation.rst +1 -0
@@ -90,3 +90,4 @@ Emulated Devices devices/vhost-user.rst devices/virtio-pmem.rst devices/vhost-user-rng.rst + devices/canokey.rst
docs/system/devices/canokey.rst new file +158 -0
158 lines not on this page · raw message
Signature · 1 line
2.34.1
PATCH v4 5/6 docs/system/devices/usb: Add CanoKey to USB devices examples
In reply to Hongren (Zenithal) Zheng--- docs/system/devices/usb.rst | 4 ++++ 1 file changed, 4 insertions(+)
docs/system/devices/usb.rst +4 -0
@@ -199,6 +199,10 @@ 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. + For more information, see :ref:`canokey`. + Physical port addressing ^^^^^^^^^^^^^^^^^^^^^^^^
Signature · 1 line
2.34.1
PATCH v4 6/6 MAINTAINERS: add myself as CanoKey maintainer
In reply to Hongren (Zenithal) Zheng--- MAINTAINERS | 8 ++++++++ 1 file changed, 8 insertions(+)
MAINTAINERS +8 -0
@@ -2376,6 +2376,14 @@ F: hw/intc/s390_flic*.c F: include/hw/s390x/s390_flic.h L: [email protected] +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/system/devices/canokey.rst + Subsystems ---------- Overall Audio backends
Signature · 1 line
2.34.1
Hi,
Is there any further feedback on this patch set.
Regards,
Zenithal
Quoted 3 lines · Hongren (Zenithal) Zheng
Hi,
Is there any further feedback on this patch set.
Sorry for the looong delay, I'm rather busy with edk2.
Tried to queue up this, noticed it breaks the build in case the canokey library is not installed.
I'd suggest to run the patch series through the qemu gitlab CI before sending out v5.
take care,
Gerd
Quoted 6 lines · Gerd Hoffmann
Quoted 3 lines · Hongren (Zenithal) Zheng
Hi,
Is there any further feedback on this patch set.
Sorry for the looong delay, I'm rather busy with edk2.
Fully understandable. There is also delay on my side, sorry for that too.
Quoted 3 lines
Tried to queue up this, noticed it breaks the build in case the canokey library is not installed.
Yes, this is my fault. I forgot to put softmmu_ss.add(canokey) inside a if canokey.found() conditional check.
I've fixed it with
https://gitlab.com/ZenithalHourlyRate/qemu/-/commit/5d8604c70abefc8146dbb4f7836f3215bc9df966
which will be contained in v5.
Quoted 3 lines
I'd suggest to run the patch series through the qemu gitlab CI before sending out v5.
I have gone through qemu gitlab CI and the result is in
https://gitlab.com/ZenithalHourlyRate/qemu/-/pipelines/497317417
Except check-dco and check-patch (I only generate Signed-off-by line when git format-patch), other failed checks are "allowed to fail" and I've checked the log, these failures are about Debian RISC-V packages instead of qemu itself.
Is this appropriate for sending out v5?
By the way, we are planning to separate libcanokey-qemu.so from canokey-core to a dedicated repo at
https://github.com/canokeys/canokey-qemu
(not done yet), which would result in changes in documentation. I will contain these changes in v5 once we are done.
Quoted 4 lines
take care,
Gerd
Regards,
Hongren
Hi,
Quoted 9 lines
Quoted 2 lines
I'd suggest to run the patch series through the qemu gitlab CI before sending out v5.
I have gone through qemu gitlab CI and the result is in
https://gitlab.com/ZenithalHourlyRate/qemu/-/pipelines/497317417
Except check-dco and check-patch (I only generate Signed-off-by line whengit format-patch), other failed checks are "allowed to fail" and I've checked the log, these failures are about Debian RISC-V packages instead of qemu itself.
Sounds fine. The risc-v bits seem to be in progress still, I have failures with them too.
Quoted 7 lines
Is this appropriate for sending out v5?
By the way, we are planning to separate libcanokey-qemu.so from canokey-core to a dedicated repo at
https://github.com/canokeys/canokey-qemu
(not done yet), which would result in changes in documentation. I will contain these changes in v5 once we are done.
If you want split the library it makes sense to do that (and test in CI) before sending out v5.
No need to hurry right now, qemu is in freeze for the 7.0 release so it can be merged only after the tree re-opens for 7.1 development (roughly one month from now).
take care,
Gerd