Files
usb-server/internal/client/tunnel.go
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

131 lines
3.4 KiB
Go

package client
import (
"fmt"
"log"
"github.com/duffy/usb-server/internal/crypto"
)
// tunnelCodec seals and opens tunnel payloads.
//
// It sits above the transport so that a tunnel is protected the same way
// whether its frames travel directly or through the relay. A nil codec passes
// data through unchanged, which is what a client configured with only a group
// hash — and therefore unable to derive the key — falls back to.
type tunnelCodec struct {
sealer *crypto.Sealer
opener *crypto.Opener
}
// newTunnelCodec builds a codec for one end of a tunnel.
// send is the direction this end transmits in; it receives on the other.
func newTunnelCodec(secret *crypto.TunnelSecret, tunnelID string, send crypto.Direction) (*tunnelCodec, error) {
if secret == nil {
return nil, nil // unencrypted, by configuration
}
key, err := secret.TunnelKey(tunnelID)
if err != nil {
return nil, err
}
recv := crypto.DirShareToUse
if send == crypto.DirShareToUse {
recv = crypto.DirUseToShare
}
sealer, err := crypto.NewSealer(key, send)
if err != nil {
return nil, err
}
opener, err := crypto.NewOpener(key, recv)
if err != nil {
return nil, err
}
return &tunnelCodec{sealer: sealer, opener: opener}, nil
}
// encode prepares a payload for transmission.
func (c *tunnelCodec) encode(payload []byte) ([]byte, error) {
if c == nil {
return payload, nil
}
return c.sealer.Seal(payload)
}
// decode recovers a received payload.
func (c *tunnelCodec) decode(frame []byte) ([]byte, error) {
if c == nil {
return frame, nil
}
return c.opener.Open(frame)
}
// encrypted reports whether this codec actually protects anything.
func (c *tunnelCodec) encrypted() bool { return c != nil }
// tunnelSender delivers one encoded frame to the peer.
type tunnelSender func(frame []byte) error
// relaySender routes frames through the relay, tagged with the tunnel ID.
func relaySender(c *Client, tunnelID string) tunnelSender {
return func(frame []byte) error {
return c.SendTunnelData(tunnelID, frame)
}
}
// directSender routes frames over an established direct connection.
func directSender(conn *directConn) tunnelSender {
return func(frame []byte) error {
return conn.WriteFrame(frame)
}
}
// send encodes a payload and hands it to the transport.
func send(codec *tunnelCodec, sender tunnelSender, payload []byte) error {
frame, err := codec.encode(payload)
if err != nil {
return fmt.Errorf("encoding tunnel frame: %w", err)
}
return sender(frame)
}
// receiveLoop reads frames from a direct connection, decodes them and hands
// each payload to deliver. It returns when the connection ends, when the
// tunnel is torn down, or on the first frame that fails to authenticate.
func receiveLoop(conn *directConn, codec *tunnelCodec, deliver func([]byte) error, done <-chan struct{}, label string) {
for {
select {
case <-done:
return
default:
}
frame, err := conn.ReadFrame()
if err != nil {
select {
case <-done:
default:
log.Printf("[direct] %s: read ended: %v", label, err)
}
return
}
payload, err := codec.decode(frame)
if err != nil {
// A frame that fails to authenticate means the stream is either
// corrupt or being tampered with. Either way this tunnel cannot
// be trusted to carry USB traffic any further.
log.Printf("[direct] %s: dropping connection: %v", label, err)
return
}
if err := deliver(payload); err != nil {
log.Printf("[direct] %s: delivery failed: %v", label, err)
return
}
}
}