用 usbip 轉發 raspberry pi 的 USB 鍵盤滑鼠給 Arch Linux 的 PC

起因

家裡有個裝了 Arch Linux ARM 的樹莓派3B 閒置著，裝了 Arch Linux ARM 偶爾插上電更新一下， 不過因為效能實在不適合做別的事情於是一直在吃灰。某日和老婆看片的時候，鍵盤滑鼠被長長的 USB 線扯著感覺很難受，於是偶發奇想，能不能利用一下樹莓派的多達 4 個 USB 2.0 埠接滑鼠鍵盤呢， 這樣滑鼠鍵盤就可以跟著樹莓派來回走，不用拖著長長的 USB 線了。

上網搜了一下， Linux 環境有個 usbip 工具正好能做到這個。原理也很直觀， usbip 能把 USB 埠上的資料包裝成 IP 協議通過網路轉發出去，從而兩個網路間相互聯通的電腦就可以遠端轉發 USB 了。 設定好的話，就像是一臺 PC 多了幾個位於樹莓派上的 USB 埠，插上樹莓派的 USB 裝置統統作為 PC 的裝置。

這篇文章假設有一個裝了 Arch Linux 的 PC ，和一個裝了 Arch Linux ARM 的樹莓派， 並且兩者間能通過網路互相訪問到。別的發行版上大概也可以這麼做，只是我沒有試過。 usbip 工具似乎普遍被髮行版打包了，除此之外需要的也只是 Linux 核心提供好的功能而已。

設定 Arch Linux ARM 的樹莓派端

假設樹莓派上面網路已經設定妥當，開機插電就能自動聯網。接下來安裝 usbip 工具：

$ pacman -Syu usbip

接下來需要記錄一下樹莓派的 IP 地址：

$ ip addr
3: wlan0: ......
inet 192.168.0.117/24 brd 192.168.0.255 scope global noprefixroute wlan0
......

接下來，我給 udev 添加了一個規則，當插入 usb 裝置的時候，執行我的指令碼 usbipall.sh 把 usb 裝置通過 usbip 共享出去：

$ cat /etc/udev/rules.d/usbipall.rules
ACTION=="add", SUBSYSTEM=="usb", RUN+="/usr/bin/bash /usr/local/bin/usbipall.sh"

這個 rules 檔案可以在我的 dotfiles 裡面找到 。

然後規則呼叫的 usbipall.sh 我這麼寫的，檔案同樣在我的 dotfiles 裡面 ：

#/bin/sh
(
allusb=$(usbip list -p -l)
for usb in $allusb
do
busid=$(echo $usb | sed "s|#.*||g;s|busid=||g")
if [[ $busid = "1-1.1" ]]
then
# ignoring usb ethernet
continue
fi
echo "$(date -Iseconds): Exporting $busid"
usbip bind --busid=$busid
done
) >>/var/log/usbipall.log 2>&1

這個指令碼做了這樣幾件事。

1. 呼叫usbip list --local 列出本地所有 usb 裝置。

2. 針對每個裝置：

    usbip bind --busid=
   

3. 最後把所有輸出記錄到 /var/log/usbipall.log 日誌裡面

樹莓派這邊設定就完成了。從此之後插入的 usb 裝置就會統統匯出出去。

這裡需要注意一下，啟用了 udev 規則之後，就沒法插鍵盤滑鼠到樹莓派上控制它了……我都是從另一端 ssh 上樹莓派操作的。如果有什麼地方設定錯誤，可能需要把樹莓派的 SD 卡拔下來插到電腦上，刪除掉 rules 檔案……

仔細檢查設定正確了之後，重新載入 udev 規則，或者重啟樹莓派：

# systemctl restart systemd-udevd

這樣樹莓派這邊就設定好了。

設定 Arch Linux 的 PC 端

同樣假設 PC 這邊也已經聯網。接下來同樣安裝 usbip 工具：

$ pacman -Syu usbip

然後我寫了個小指令碼去連結樹莓派端，這個檔案 usbiprpi3.sh 也在我的 dotfiles ：

#/bin/sh
rpi3="192.168.0.117"

modprobe vhci-hcd

allusb=$(usbip list -p -r $rpi3 | cut -d":" -f1 -s | sed 's|^[ \t]*||;/^$/d')
for busid in $allusb
do
if [[ $busid = "1-1.1" ]]
then
# ignoring usb ethernet
continue
fi
echo "Attaching $busid"
usbip attach --remote=$rpi3 --busid=$busid
done

其中指令碼第一行填入上面記錄下來的樹莓派的 IP 地址，接下來指令碼做了這麼幾件事：

 usbip list --remote=
 usbip attach

然後就已經準備妥當，接下來是見證奇蹟的時刻：

$ sleep 10; sudo ./usbiprpi3.sh
Attaching 1-1.4.3
Attaching 1-1.4.1

因為只有一套鍵盤滑鼠，所以先 sleep 個 10 秒，在此期間快速把鍵鼠拔下來插到樹莓派的 USB 口上去。 如果對自己手速沒自信也可以把時間設長一點。然後用 root 許可權執行 usbiprpi3.sh 。

一切正常的話，先能觀測插上樹莓派的鍵盤滑鼠被樹莓派初始化了一下，比如鍵盤燈會亮， 然後這些裝置會被匯出出去，從而鍵盤燈滅掉，然後 10 秒等待結束後他們被遠端接到了 PC 端， 又會被初始化一下，同時 PC 端這邊會有上述 Attaching 的輸出。然後鍵盤滑鼠就能像平常一樣用啦。

使用體驗

因為就是通過 IP 轉發 USB 嘛，所以就和普通地接 USB 的體驗差不多，當然前提是網路環境足夠穩定。 在我家間隔 5 米到無線路由器的環境下，基本感覺不到網路延遲的影響。 通過這種方式聊天上網應該和直接接 USB 裝置完全一樣。本文就是在通過樹莓派轉發的前提下用鍵盤打字寫的。

不過如果網路負載本身就很大的話，可能會一些延遲，比如我開著 OBS 直播打東方的時候，原本就手殘 的我感覺更加手殘了……

試過拿著樹莓派在房間到處走，走到無線訊號覆蓋不到的地方， usbip 會斷掉，PC 上的現象就像是 USB 裝置被拔下來了……所以如果無線網路不穩的話，可能需要對上面指令碼做個迴圈？不過那樣可能會用起來很彆扭吧。

以及，上述操作 usbip 是走 TCP 3240 埠，資料包大概完全沒有加密，所以考慮安全性的話， 最好還是在內網環境使用。不過轉念一想，萬一有別人接上了我匯出出去的 USB ，也就是截獲我的鍵盤， PC 這邊沒法 attach 裝置了，應該馬上會發現吧，似乎對攻擊者也沒有什麼好處？我能控制他的鍵盤了耶~