Add Dynamic USB Passthrough (#60)

* feat: Start work on implementing dynamic USB passthrough

* chore: Minor refactor, and actually call the guest listener setup in usbmanager

* Carry progress over from static passthrough implementation (#31)

* feat: start work on usb passthrough, fix z-index issue with x-menus

* feat: usb passthrough screen functional, implemented parsing to/from docker compose file

* feat: start work on communicating with qemu through qmp, refactor current usb logic

* feat: Finish QMPManager class

* feat: Finished QMP communications

There were also some logical problems like not checking whether the docker was running and calling a function multiple times this commit fixes

* feat: Get rid of edge-cases where the QMP connection init blocked the event loop

* feat: Fix USB hotplugging

* feat: Handle Docker Compose mismatch

co-authored by: @TibixDev

* feat: Prefer passing USB's to QEMU by hostdevice instead of VID/PID

---------

Co-authored-by: TibixDev <tibix@fhs.sh>
Co-authored-by: Tibix <fuloptibi03@gmail.com>

Author: Levev

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "tabWidth": 4,
+  "bracketSameLine": true,
+  "printWidth": 160
+}

package-lock.json

@@ -45,6 +45,7 @@
         "node-fetch": "2",
         "path-browserify": "^1.0.1",
         "turndown": "^7.2.0",
+        "usb": "^2.16.0",
         "vue": "^3.5.13",
         "vue-router": "^4.5.0",
         "vue3-apexcharts": "^1.8.0",

package.json

@@ -19,7 +19,6 @@
         <!-- Updater -->
         <dialog ref="updateDialog">
             <Icon class="text-indigo-400 size-12" icon="mdi:cloud-upload"></Icon>
-
             <template v-if="manualUpdateRequired">
                 <h3 class="mt-2">Manual Guest Server Update Required</h3>
                 <div class="max-w-[60vw]">

src/renderer/App.vue

@@ -2,11 +2,13 @@ const fs: typeof import("fs") = require("fs");
 const path: typeof import("path") = require("path");
 import { type WinApp } from "../../types";
 import { WINBOAT_DIR } from "./constants";
+import { type PTSerializableDeviceInfo } from "./usbmanager";
 
 export type WinboatConfigObj = {
     scale: number;
     smartcardEnabled: boolean
     rdpMonitoringEnabled: boolean
+    passedThroughDevices: PTSerializableDeviceInfo[];
     customApps: WinApp[]
     experimentalFeatures: boolean
 };
@@ -15,21 +17,21 @@ const defaultConfig: WinboatConfigObj = {
     scale: 100,
     smartcardEnabled: false,
     rdpMonitoringEnabled: false,
+    passedThroughDevices: [],
     customApps: [],
     experimentalFeatures: false
 };
 
-let instance: WinboatConfig | null = null;
-
-export class WinboatConfig {
+export class WinboatConfig { 
+    private static instance: WinboatConfig;
     #configPath: string = path.join(WINBOAT_DIR, "winboat.config.json");
     #configData: WinboatConfigObj = { ...defaultConfig };
 
     constructor() {
-        if (instance) return instance;
+        if (WinboatConfig.instance) return WinboatConfig.instance;
         this.#configData = this.readConfig();
         console.log("Reading current config", this.#configData);
-        instance = this;
+        WinboatConfig.instance = this;
     }
 
     get config(): WinboatConfigObj {
@@ -53,6 +55,7 @@ export class WinboatConfig {
     }
 
     writeConfig(): void {
+        console.log("writing data: ", this.#configData);
         fs.writeFileSync(this.#configPath, JSON.stringify(this.#configData, null, 4), "utf-8");
     }
 

src/renderer/lib/config.ts

@@ -55,5 +55,14 @@ export const WINDOWS_LANGUAGES = {
     "🇺🇦 Ukrainian": "Ukrainian"
 }
 
+// Ports
 export const RDP_PORT = 3389;
 export const PORT_MAX = 65535;
+
+// USB
+export const USB_CLASS_IMAGING = 6;
+export const USB_INTERFACE_MTP = 5;
+export const USB_VID_BLACKLIST = [
+    // Linux Foundation VID
+    "1d6b:"
+];

src/renderer/lib/constants.ts

@@ -14,7 +14,7 @@ const execAsync = promisify(exec);
 const logger = createLogger(path.join(WINBOAT_DIR, 'install.log'));
 
 const composeFilePath = path.join(WINBOAT_DIR, 'docker-compose.yml');
-const defaultCompose: ComposeConfig = {
+export const DefaultCompose: ComposeConfig = {
     "name": "winboat",
     "volumes": {
         "data": null
@@ -32,7 +32,8 @@ const defaultCompose: ComposeConfig = {
                 "PASSWORD": "MyWindowsPassword",
                 "HOME": "${HOME}",
                 "LANGUAGE": "English",
-                "ARGUMENTS": "-cpu host,arch_capabilities=off"
+                "HOST_PORTS": "7149",
+                "ARGUMENTS": "-cpu host,arch_capabilities=off \n-qmp tcp:0.0.0.0:7149,server,wait=off\n"
             },
             "cap_add": [
                 "NET_ADMIN"
@@ -41,6 +42,7 @@ const defaultCompose: ComposeConfig = {
             "ports": [
                 "8006:8006", // VNC Web Interface
                 "7148:7148", // Winboat Guest Server API
+                "7149:7149", // QEMU QMP Port
                 "3389:3389/tcp", // RDP
                 "3389:3389/udp" // RDP
             ],
@@ -49,10 +51,11 @@ const defaultCompose: ComposeConfig = {
             "volumes": [
                 "data:/storage",
                 "${HOME}:/shared",
-                "./oem:/oem"
+                "/dev/bus/usb:/dev/bus/usb", // QEMU Synamic USB Passthrough
+                "./oem:/oem",
             ],
             "devices": [
-                "/dev/kvm"
+                "/dev/kvm",
             ]
         }
     }
@@ -115,7 +118,7 @@ export class InstallManager {
         }
 
         // Configure the compose file
-        const composeContent = { ...defaultCompose }
+        const composeContent = { ...DefaultCompose }
 
         composeContent.services.windows.environment.RAM_SIZE = `${this.conf.ramGB}G`;
         composeContent.services.windows.environment.CPU_CORES = `${this.conf.cpuThreads}`;