mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2024-11-25 05:03:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Add u2f device support page to mdbook

Browse source 
BUG=b:326345530
TEST=built mdbook

Change-Id: Iff8aee96b640b954cf9caf58c5618c48e0168b7d
Reviewed-on: https://chromium-review.googlesource.com/c/crosvm/crosvm/+/5320441
Reviewed-by: Daniel Verkamp <dverkamp@chromium.org>
Commit-Queue: Morg <morg@google.com>
This commit is contained in:
Federico 'Morg' Pareschi 2024-02-26 05:04:27 +00:00 committed by crosvm LUCI
parent 846228e595
commit e59edadc4e
2 changed files with 60 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/book/src/SUMMARY.md
View file

@ -26,6 +26,7 @@
- [USB](./devices/usb.md)
- [Wayland](./devices/wayland.md)
- [Video (experimental)](./devices/video.md)
- [Virtual U2F Passthrough](./devices/virtual_u2f.md)
- [Vhost-user](./devices/vhost_user.md)
- [Tracing](./tracing.md)
- [Integration](./integration/index.md)

59
docs/book/src/devices/virtual_u2f.md Normal file
View file

@ -0,0 +1,59 @@
# Virtual U2F Passthrough
crosvm supports sharing a single [u2f](https://en.wikipedia.org/wiki/Universal_2nd_Factor) USB
device between the host and the guest. Unlike with normal [USB](usb.md) devices which require to be
exclusively attached to one VM, it is possible to share a single security key between multiple VMs
and the host in a non-exclusive manner using the `attach_key` command.
A generic hardware security key that supports the fido1/u2f protocol should appear as a
`/dev/hidraw` interface on the host, like this:
```shell
$ lsusb
Bus 004 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 003 Device 018: ID 1050:0407 Yubico.com YubiKey OTP+FIDO+CCID
Bus 003 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
$ ls /dev/hidraw*
/dev/hidraw0 /dev/hidraw1
```
In this example, the physical YubiKey presents both a keyboard interface (`/dev/hidraw0`) and a
u2f-hid interface (`/dev/hidraw1`). Crosvm supports passing the `/dev/hidraw1` interface to the
guest via the `crosvm usb attach_key` command.
First, start crosvm making sure to specify a control socket:
```shell
$ crosvm run -s /run/crosvm.sock ${USUAL_CROSVM_ARGS}
```
Since the virtual u2f device is surfaced as a generic HID device, make sure your guest kernel is
built with support for HID devices. Specifically it needs CONFIG_HID, CONFIG_HIDRAW,
CONFIG_HID_GENERIC, and CONFIG_USB_HID enabled.
Once the VM is launched, attach the security key with the following command on the host:
```shell
$ crosvm usb attach_key /dev/hidraw1 /run/crosvm.sock
ok 1
```
The virtual security key will show up inside the guest as a Google USB device with Product and
Vendor IDs as `18d1:f1d0`:
```shell
$ lsusb
Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 001 Device 002: ID 18d1:f1d0 Google Inc.
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
```
You can verify that the correct hidraw device has been created in the `/dev/` tree:
```shell
$ ls /dev/hidraw*
/dev/hidraw0
```
The device should now be usable as u2f-supported security key both inside the guest and on the host.
It can also be attached to other crosvm instances at the same time too.