duffyduckandClaude Opus 5
9ed473a965
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>
101 lines
3.1 KiB
Go
101 lines
3.1 KiB
Go
//go:build linux
|
|
|
|
package usbip
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/duffy/usb-server/internal/usb"
|
|
)
|
|
|
|
func newTestServer(eps map[uint8]usb.Endpoint) *Server {
|
|
dev := &usb.Device{
|
|
BusID: "1-1",
|
|
Endpoints: eps,
|
|
}
|
|
s := NewServer(dev)
|
|
s.buildEndpointTypeMap()
|
|
return s
|
|
}
|
|
|
|
// The composite case that broke HID: endpoint number 1 exists as bulk OUT
|
|
// (0x01) and interrupt IN (0x81). Both must keep their own transfer type.
|
|
func TestGetURBTypeSeparatesDirections(t *testing.T) {
|
|
s := newTestServer(map[uint8]usb.Endpoint{
|
|
0x01: {Address: 0x01, TransferType: usb.TransferTypeBulk},
|
|
0x81: {Address: 0x81, TransferType: usb.TransferTypeInterrupt, Interval: 10},
|
|
0x82: {Address: 0x82, TransferType: usb.TransferTypeIsochronous, Interval: 1},
|
|
})
|
|
|
|
tests := []struct {
|
|
name string
|
|
epAddr uint8
|
|
interval uint32
|
|
packets int32
|
|
want uint8
|
|
}{
|
|
{"bulk OUT endpoint 1", 0x01, 0, 0, usbdevfsTypeBulk},
|
|
{"interrupt IN endpoint 1", 0x81, 10, 0, usbdevfsTypeInterrupt},
|
|
{"isochronous IN endpoint 2", 0x82, 1, 8, usbdevfsTypeISO},
|
|
{"control endpoint 0", 0x00, 0, 0, usbdevfsTypeControl},
|
|
{"control endpoint 0 IN", 0x80, 0, 0, usbdevfsTypeControl},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
got := s.getURBType(tt.epAddr, tt.interval, tt.packets)
|
|
if got != tt.want {
|
|
t.Errorf("getURBType(0x%02x, interval=%d, packets=%d) = %s, want %s",
|
|
tt.epAddr, tt.interval, tt.packets, urbTypeName[got], urbTypeName[tt.want])
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// An endpoint missing from the descriptor map must not default to bulk when
|
|
// the request carries an interval: only periodic transfers have one, and
|
|
// submitting an interrupt endpoint's URB as bulk is what the kernel rejects.
|
|
func TestGetURBTypeFallsBackOnInterval(t *testing.T) {
|
|
s := newTestServer(nil)
|
|
|
|
if got := s.getURBType(0x83, 8, 0); got != usbdevfsTypeInterrupt {
|
|
t.Errorf("unknown endpoint with interval=8: got %s, want INT", urbTypeName[got])
|
|
}
|
|
if got := s.getURBType(0x02, 0, 0); got != usbdevfsTypeBulk {
|
|
t.Errorf("unknown endpoint with interval=0: got %s, want BULK", urbTypeName[got])
|
|
}
|
|
}
|
|
|
|
// NumberOfPackets is authoritative for isochronous transfers: a webcam only
|
|
// activates its ISO endpoints after SET_INTERFACE, so the descriptor map may
|
|
// still describe the alternate-setting-0 view when the request arrives.
|
|
func TestGetURBTypeISOWinsOverMap(t *testing.T) {
|
|
s := newTestServer(map[uint8]usb.Endpoint{
|
|
0x81: {Address: 0x81, TransferType: usb.TransferTypeBulk},
|
|
})
|
|
|
|
if got := s.getURBType(0x81, 1, 16); got != usbdevfsTypeISO {
|
|
t.Errorf("packets=16 should force ISO, got %s", urbTypeName[got])
|
|
}
|
|
}
|
|
|
|
func TestBuildEndpointTypeMapFallsBackToInterfaces(t *testing.T) {
|
|
dev := &usb.Device{
|
|
BusID: "1-1",
|
|
Interfaces: []usb.Interface{{
|
|
Number: 0,
|
|
Class: 0x03,
|
|
Endpoints: []usb.Endpoint{
|
|
{Address: 0x81, TransferType: usb.TransferTypeInterrupt, Interval: 10},
|
|
},
|
|
}},
|
|
}
|
|
|
|
s := NewServer(dev)
|
|
s.buildEndpointTypeMap()
|
|
|
|
if got := s.getURBType(0x81, 10, 0); got != usbdevfsTypeInterrupt {
|
|
t.Errorf("sysfs fallback lost the interrupt type: got %s", urbTypeName[got])
|
|
}
|
|
}
|