Installation¶

Die Software des Projektes USB/IP ist stark vom jeweils benutzen Kernel abhängig, und daher ist ihre Installation etwas komplizierter als von anderen Paketen gewohnt.

Die grundsätzliche Unterstützung für die Funktionalität USB-über-TCP/IP ist bei Kernel von Ubuntu in ladbaren Modulen enthalten und daher bei einem gepflegten System bereits enthalten – darum muss man sich selber nicht kümmern.

Man benötigt zusätzlich für Server und Client das Dienstprogramm usbip und für den Server zusätzlich den DAEMON usbipd. Diese Programme sind enthalten in einem Paket mit dem Namensmuster linux-tools-*, dessen genauer Name davon abhängt, über welches Paket man die Updates für den konkret im System eingesetzten Kernel bezieht. Den für das eigene System gültigen Paketnamen kann man im Terminal^[3][2] so ermitteln:

1. Abfrage des für Update des Kernels benutzen Pakets:

   apt list 'linux-image-*' --installed 

   Beispielausgabe:

   linux-image-6.5.0-28-generic/jammy-updates,jammy-security,now 6.5.0-28.29~22.04.1 amd64  [Installiert,automatisch]
   linux-image-6.5.0-35-generic/jammy-updates,jammy-security,now 6.5.0-35.35~22.04.1 amd64  [Installiert,automatisch]
   linux-image-generic-hwe-22.04/jammy-updates,jammy-security,now 6.5.0.35.35~22.04.1 amd64  [Installiert,automatisch]

2. Man streicht aus dieser Liste alle Pakete mit einer konkreten Kernelversion im Namen, dann sollte nur noch ein Paket verbleiben, im Beispiel:

   linux-image-generic-hwe-22.04/jammy-updates,jammy-security,now 6.5.0.35.35~22.04.1 amd64  [Installiert,automatisch]

3. In diesem Namen ersetzt man image (vielleicht auch: image-unsigned) durch tools, dies ist das zu installierende Paket.

Bevor man dieses Paket installiert, kann man noch das für USB/IP optionale Paket hwdata installieren, was aber standardmäßig schon installiert sein sollte. Dieses optionale Paket übersetzt einige USB-IDs in Klartext.

Installiert werden muss das richtige Paket mit dem Namensmuster linux-tools-*generic*^[1], darin sind die Sternchen systemspezifisch zu ersetzen. Wenn man keinen Kernel des Typs generic, sondern des Typs lowlatency benutzt, so ist auch dieser Namensteil zu ändern.

• hwdata (optional)

• linux-tools-*generic*

Befehl zum Installieren der Pakete:

sudo apt-get install hwdata linux-tools-*generic* 

Oder mit apturl installieren, Link: apt://hwdata,linux-tools-*generic*

Diese Prozedur installiert das zum aus Sicht des eigenen Systems aktuellen Kernels passende Paket linux-tools* und sorgt auch dafür, dass dies auch für alle zukünftigen im Rahmen regulärer Updates installierten Kernel zutrifft. Man muss diese Prozedur also nur einmal ausführen. Man erhält aber nicht die passenden Pakete für ältere Kernel.

sudo apt-get remove --purge usbip* libusbip* 

Konfiguration¶

USB/IP unterscheidet die Rollen Server und Client:

• Der Server stellt eines oder mehrere seiner direkt an ihm angeschlossenen USB-Geräte zur Verfügung und exportiert diese über das Netzwerk.

• Der Client greift über das Netzwerk aus den Server zu und importiert eines oder mehrere Geräte in seine eigene Konfiguration. Diese virtuellen Geräte können genau wie direkt angeschlossene reale Geräte mit einem Treiber initialisiert und dann am Client benutzt werden. In der Regel geschieht die Initialisierung automatisch.

Beachte aber: Ein vom Server exportiertes Gerät kann nicht mehr lokal benutzt werden und ein über das Netzwerk verfügbares Gerät kann maximal von einem Client zeitgleich belegt werden.

sudo modprobe usbip-host 

sudo usbipd --daemon 

echo usbip-host | sudo tee /etc/modules-load.d/USB-over-IP-server.conf 

# /etc/systemd/system/USB-over-IP-server.service
# 2024 – kB @ UbuntuUsers.de

[Unit]
Description	= USB over TCP/IP host daemon %H
Documentation	= https://wiki.ubuntuusers.de/USBIP/
After		= network-online.target
Wants		= network-online.target

[Service]
Type		= simple
Restart		= on-failure
ExecStartPre	= modprobe	usbip-host
ExecStart	= usbipd	--tcp-port 3240
ExecStopPost	= rmmod 	usbip-host
ExecStopPost	= rmmod 	usbip-core

[Install]
WantedBy	= multi-user.target

sudo pkill usbipd 

usbip list --remote 127.0.0.1 

usbip list --remote 192.168.178.42 

Exportable USB devices
======================
 - 192.168.178.42
      1-4.2: SanDisk Corp. : Cruzer Blade (0781:5567)
           : /sys/devices/pci0000:00/0000:00:14.0/usb1/1-4/1-4.2
           : (Defined at Interface level) (00/00/00)
           :  0 - Mass Storage / SCSI / Bulk-Only (08/06/50)

sudo usbip attach --remote 192.168.178.42 --busid 1-4.2 

usbip port 

sudo usbip detach --port 0 

Befehle¶

Sicherheit¶

Ein USB/IP Server verfügt selbst über keine Mechanismen zur Beschränkung von Zugriffen, sondern akzeptiert Verbindungen aus aller Welt. Oft ist dies unerwünscht. Zur Abhilfe sollte man den USB/IP Server hinter einer Firewall betreiben und damit mögliche Zugriffe auf solche aus dem eigenen LAN beschränken. Wenn dieses LAN technisch offenen Zugang für alle bietet (z.B. WLAN), ist natürlich eine Zugangsregulierung und -beschränkung unverzichtbar.

Technische Begrenzungen¶

Die Konfiguration der Ubuntu Kernel sieht einen virtuellen USB-Controller mit maximal 8 Ports vor. Wenn das nicht ausreicht, muss man den Linux Kernel aus dem Quellcode mit einer angepassten Konfiguration selbst übersetzen.

Der Zugriff auf USB-Geräte über das Netzwerk funktioniert zwar grundsätzlich mit jedem USB-Gerät, z.B. auch wie oben gezeigt mit USB-Sticks, jedoch bedeutet dies nicht, dass es immer gut funktioniert. Vielmehr muss man in der Praxis über das Netzwerk stets mit schlechterer Performanz und Zeitverzögerungen rechnen als bei direktem Anschluss des USB-Gerätes, da das USB-Protokoll für Situationen entwickelt wurde, in denen Latenzen vernachlässigbar sind, während bei TCP/IP gegen Latenzen robust sein soll und selbst auch durch Speicherung und Bearbeitung der IP-Pakete in den Netzwerkgeräten unvermeidlich Latenzen erzeugt; dies kann bis zum völligen Versagen führen. Generell sollte man daher bei der Anwendung von USB-über-TCP/IP beachten:

• Die zu übertragene Datenmenge auf ein Minimum reduzieren.

• Eine Übertragungsstrecke mit möglichst wenigen Netzwerkgeräten (Repeater, Switch, Router, Gateway usw.) verwenden.

• Medienwechsel (z.B. Wifi/WLAN ←→ Ethernet) vermeiden.

Dokumentation¶

Die Programme usbip und usbipd haben jeweils eine eigene Manpage:

• man usbip 

• man usbipd 

Die Projektseite enthält einige technische Details, allerdings sind einige Bezeichnungen nicht mehr aktuell.

Links¶

• Projektseite 🇬🇧

• USB/IP for Windows 🇬🇧 – Eine experimentelle USB/IP Implementation für Windows, für den produktiven Betrieb nicht empfohlen.

• USB/IP protocol 🇬🇧 in der Kernel Dokumentation