2023-11-13 14:33:28 +00:00
|
|
|
# sys-usb
|
|
|
|
|
|
|
|
|
|
PCI handler of USB devices in Qubes OS.
|
|
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
|
|
|
|
* [Description](#description)
|
|
|
|
|
* [Installation](#installation)
|
2024-01-10 11:50:02 +00:00
|
|
|
* [Access control](#access-control)
|
2023-11-13 14:33:28 +00:00
|
|
|
* [Usage](#usage)
|
|
|
|
|
* [Credits](#credits)
|
|
|
|
|
|
|
|
|
|
## Description
|
|
|
|
|
|
|
|
|
|
Setup named disposables for USB qubes. During creation, it tries to separate
|
|
|
|
|
the USB controllers to different qubes is possible.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
- Top:
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl top.enable sys-usb
|
|
|
|
|
qubesctl --targets=tpl-sys-usb state.apply
|
|
|
|
|
qubesctl top.disable sys-usb
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- State:
|
|
|
|
|
<!-- pkg:begin:post-install -->
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl state.apply sys-usb.create
|
|
|
|
|
qubesctl --skip-dom0 --targets=tpl-sys-usb state.apply sys-usb.install
|
|
|
|
|
```
|
|
|
|
|
<!-- pkg:end:post-install -->
|
|
|
|
|
|
|
|
|
|
If you use an USB keyboard, also run:
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl state.apply sys-usb.keyboard
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Install the proxy on the client template:
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl --skip-dom0 --targets=tpl-QUBE state.apply sys-usb.install-client-proxy
|
|
|
|
|
```
|
2024-01-09 17:44:50 +00:00
|
|
|
|
2023-11-13 14:33:28 +00:00
|
|
|
If the client requires decrypting a device, install on the client template:
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl --skip-dom0 --targets=tpl-QUBE state.apply sys-usb.install-client-cryptsetup
|
|
|
|
|
```
|
2024-01-09 17:44:50 +00:00
|
|
|
|
2023-11-13 14:33:28 +00:00
|
|
|
If the client requires a FIDO device, install on the client template:
|
|
|
|
|
```sh
|
|
|
|
|
qubesctl --skip-dom0 --targets=tpl-QUBE state.apply sys-usb.install-client-fido
|
|
|
|
|
```
|
2024-01-09 17:44:50 +00:00
|
|
|
And enable the CTAP Proxy service for the client qubes:
|
|
|
|
|
```sh
|
|
|
|
|
qvm-features QUBE service.qubes-ctap-proxy 1
|
|
|
|
|
```
|
2023-11-13 14:33:28 +00:00
|
|
|
|
2024-01-10 11:50:02 +00:00
|
|
|
## Access control
|
|
|
|
|
|
|
|
|
|
No extra services are implemented, consult upstream to learn how to use the
|
|
|
|
|
following services:
|
|
|
|
|
- `qubes.InputMouse`, `qubes.InputKeyboard`, `qubes.InputTablet`;
|
|
|
|
|
- `ctap.GetInfo`, `ctap.ClientPin`, `u2f.Register`, `u2f.Authenticate`,
|
|
|
|
|
`policy.RegisterArgument`.
|
|
|
|
|
|
2023-11-13 14:33:28 +00:00
|
|
|
## Usage
|
|
|
|
|
|
2024-01-12 17:21:35 +00:00
|
|
|
Depending on you system, one or more USB qubes will be created to hold the
|
|
|
|
|
different controllers. The qube names are `disp-sys-usb`, `disp-sys-usb-left`,
|
|
|
|
|
`disp-sys-usb-dock`.
|
|
|
|
|
|
2023-11-13 14:33:28 +00:00
|
|
|
Start a USB qube an connect a device to it. USB PCI devices will appear on
|
|
|
|
|
the system tray icon `qui-devices`. From there, assign it to the intended
|
|
|
|
|
qube.
|
|
|
|
|
|
|
|
|
|
## Credits
|
|
|
|
|
|
|
|
|
|
- [Unman](https://github.com/unman/shaker/blob/main/sys-usb)
|
