Files
usb-server/driver/windows/usbshare.h
T
duffyduckandClaude Opus 5 9ed473a965 Fix HID transfers, harden the tunnel, add E2E crypto and direct peers
The HID failure came down to the endpoint type map being indexed by
endpoint number without the direction bit. A composite device can have
endpoint 1 as both interrupt IN (0x81) and bulk OUT (0x01); the last one
read won, so interrupt URBs were submitted as bulk and the kernel rejected
them. The device attached and stayed silent.

Endpoint data now comes from the raw descriptors read from /dev/bus/usb
rather than sysfs, which only ever exposes the active alternate setting —
a webcam's isochronous endpoints are invisible there because they only
exist after SET_INTERFACE. Two sysfs parsing bugs fell out of that too:
the numeric endpoint attributes are hex without a prefix (wMaxPacketSize
"0040" was read as 40, not 64), and bInterval was never read at all.

Reliability: three places could freeze the whole process. The share path
fed io.Pipe from the WebSocket read loop, so one slow USB transfer stalled
every tunnel and the keepalives with them. The relay wrote to client
sockets while holding the hub lock, so one peer that stopped reading
blocked routing and registration for everyone. Control transfers ran
inline in the protocol loop behind a 5s timeout. Also fixed: a use-after-
free where a discarded URB's memory could be collected while the kernel
still owned it, a reap loop that spun at 100% CPU on ioctl errors, a
missing attach timeout, a double close(done) panic, and Hash[:8] in the
relay's log line, which let a client with a short hash take the server
down.

Adds mode "both", so one client can offer and consume devices at once.
The tunnel and client-left callbacks became multicast for it: as plain
fields the second manager to register silently unhooked the first.

Tunnel traffic is now AES-256-GCM end to end, on the relay path as well
as directly. The key is derived from the three tokens, not from the group
hash — the relay is told the hash, so a key derived from it would protect
nothing from the one party in the middle. Group IDs are unchanged, so
existing setups keep working; only clients configured without the tokens
drop to unencrypted, relay-only operation.

Peers now try to connect directly, with the relay supplying the public
address neither side can determine for itself. Candidates are raced
because an unreachable address hangs until timeout rather than refusing.
Falling back to the relay is not an error.

Platform reach: cross-compiled targets for ARM, MIPS and RISC-V (the
Linux client needed no code changes — usbdevfs is not architecture
specific), multi-arch Docker images, an Android bridge that accepts
devices over SCM_RIGHTS because apps cannot open /dev/bus/usb, and macOS
builds via system_profiler enumeration.

Adds a Windows KMDF filter driver under driver/windows with its Go side.
UNTESTED: it has never been compiled or run, needs the WDK to build and
an EV certificate to distribute. Treat it as a starting point.

Adds "usb-client diag": says per machine whether sharing and using are
possible, what stands in the way, and what fixes it. Reports can be
uploaded to a relay to get them off machines that are awkward to copy
from.

96 tests, all green under -race. Builds for linux, windows and darwin on
amd64 and arm64.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-11 22:02:04 +02:00

99 lines
2.8 KiB
C

/*
* usbshare - internal declarations
*/
#pragma once
#include <ntddk.h>
#include <wdf.h>
#include <usb.h>
#include <usbdlib.h>
#include <wdfusb.h>
#include "public.h"
#define USBSHARE_POOL_TAG 'hsBU'
/*
* Per-device context.
*
* One instance per filtered device. Claimed and ClaimOwner together decide
* whether the class driver's requests are passed down or swallowed.
*/
typedef struct _DEVICE_CONTEXT {
/* The device we are filtering, as a USB target. */
WDFUSBDEVICE UsbDevice;
/* The interface whose pipes we use. Only the first is handled today. */
WDFUSBINTERFACE UsbInterface;
/*
* Pipe handles indexed by endpoint address (0x00-0xFF).
*
* Indexing by full address rather than endpoint number matters: a device
* can have endpoint 1 as both interrupt IN (0x81) and bulk OUT (0x01),
* and conflating them submits transfers of the wrong type.
*/
WDFUSBPIPE Pipes[256];
/*
* Non-zero while user mode holds the device. Guarded by ClaimLock; read
* on the request path, so it must stay cheap.
*/
BOOLEAN Claimed;
/*
* The file object that claimed it. Used to release automatically when
* that handle closes, including when its process dies.
*/
WDFFILEOBJECT ClaimOwner;
WDFSPINLOCK ClaimLock;
/* Outstanding user mode transfers, so cancellation can find them. */
WDFCOLLECTION PendingTransfers;
WDFSPINLOCK PendingLock;
/* Cached descriptor blob, built once on first request. */
PUCHAR Descriptors;
ULONG DescriptorsLength;
/* Device info reported on claim. */
USBSHARE_DEVICE_INFO Info;
} DEVICE_CONTEXT, *PDEVICE_CONTEXT;
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(DEVICE_CONTEXT, GetDeviceContext)
/*
* Per-request context, kept so a cancel can locate the WDFREQUEST that
* belongs to a transfer ID.
*/
typedef struct _REQUEST_CONTEXT {
ULONG64 TransferId;
WDFMEMORY UrbMemory;
PURB Urb;
/* Bytes of payload the caller expects back, for IN transfers. */
ULONG ExpectedLength;
} REQUEST_CONTEXT, *PREQUEST_CONTEXT;
WDF_DECLARE_CONTEXT_TYPE_WITH_NAME(REQUEST_CONTEXT, GetRequestContext)
/* driver.c */
DRIVER_INITIALIZE DriverEntry;
EVT_WDF_DRIVER_DEVICE_ADD UsbShareEvtDeviceAdd;
EVT_WDF_DEVICE_PREPARE_HARDWARE UsbShareEvtDevicePrepareHardware;
EVT_WDF_DEVICE_FILE_CREATE UsbShareEvtDeviceFileCreate;
EVT_WDF_FILE_CLOSE UsbShareEvtFileClose;
/* queue.c */
EVT_WDF_IO_QUEUE_IO_DEVICE_CONTROL UsbShareEvtIoDeviceControl;
/* filter.c */
EVT_WDF_IO_QUEUE_IO_DEFAULT UsbShareEvtIoDefault;
EVT_WDF_IO_QUEUE_IO_INTERNAL_DEVICE_CONTROL UsbShareEvtIoInternalDeviceControl;
/* Helpers shared between translation units. */
NTSTATUS UsbShareBuildDescriptorBlob(_In_ PDEVICE_CONTEXT Context);
BOOLEAN UsbShareIsClaimed(_In_ PDEVICE_CONTEXT Context);
VOID UsbShareReleaseClaim(_In_ PDEVICE_CONTEXT Context, _In_opt_ WDFFILEOBJECT Owner);