mirror of
https://github.com/VallierDev/uu-remote-linux.git
synced 2026-11-16 16:50:41 +01:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
03d2311649 | ||
|
|
5949314e55 | ||
|
|
8389fc4eed |
No files matched your search
@@ -35,6 +35,14 @@ jobs:
|
||||
run: |
|
||||
cargo build --locked --features wayland,portal,engine-plugins --bin uuremote-server
|
||||
test -f target/debug/libuu-wayland.so
|
||||
- name: Debian package installs
|
||||
run: |
|
||||
packaging/deb/build-deb.sh 0.0.0~ci target/debug /tmp/deb
|
||||
dpkg-deb -I /tmp/deb/*.deb | grep -E 'Depends|Recommends'
|
||||
sudo apt-get install -y /tmp/deb/*.deb
|
||||
uuremote-server --help | head -1
|
||||
test -f /usr/lib/uu-remote-linux/libuu-wayland.so
|
||||
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
|
||||
|
||||
test-viewer:
|
||||
runs-on: ubuntu-22.04
|
||||
|
||||
@@ -69,10 +69,20 @@ jobs:
|
||||
cp -r contrib "$name/"
|
||||
tar czf "$name.tar.gz" "$name"
|
||||
sha256sum "$name.tar.gz" > "$name.tar.gz.sha256"
|
||||
- name: Debian package
|
||||
run: |
|
||||
packaging/deb/build-deb.sh "${GITHUB_REF_NAME#v}" target/release .
|
||||
deb=$(ls uu-remote-linux_*.deb)
|
||||
sha256sum "$deb" > "$deb.sha256"
|
||||
sudo apt-get install -y "./$deb"
|
||||
uuremote-server --help | head -1
|
||||
systemd-analyze verify /usr/lib/systemd/user/uuremote-native.service
|
||||
- uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: package-${{ matrix.arch }}
|
||||
path: uu-remote-linux-*.tar.gz*
|
||||
path: |
|
||||
uu-remote-linux-*.tar.gz*
|
||||
uu-remote-linux_*.deb*
|
||||
|
||||
# One publisher, so the matrix legs never race to create the release.
|
||||
release:
|
||||
@@ -90,6 +100,8 @@ jobs:
|
||||
files: |
|
||||
uu-remote-linux-*.tar.gz
|
||||
uu-remote-linux-*.tar.gz.sha256
|
||||
uu-remote-linux_*.deb
|
||||
uu-remote-linux_*.deb.sha256
|
||||
|
||||
# Headless NAS image (docker/), built from the release tarball published by the job above.
|
||||
docker:
|
||||
|
||||
@@ -117,6 +117,7 @@ viewer does not reconnect them automatically.
|
||||
| `UU_AUDIO=0`, `UU_AUDIO_SOURCE` | disable sound / choose the Pulse source (default `@DEFAULT_MONITOR@`) |
|
||||
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
|
||||
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
|
||||
| `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged |
|
||||
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
|
||||
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
|
||||
|
||||
|
||||
Generated
+1
-1
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
||||
|
||||
[[package]]
|
||||
name = "uu-remote-linux"
|
||||
version = "0.2.17"
|
||||
version = "0.2.18"
|
||||
dependencies = [
|
||||
"async-trait",
|
||||
"base64 0.22.1",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "uu-remote-linux"
|
||||
version = "0.2.17"
|
||||
version = "0.2.18"
|
||||
edition = "2021"
|
||||
default-run = "uuremote-server"
|
||||
authors = ["uu-remote-linux contributors"]
|
||||
|
||||
+13
-1
@@ -131,7 +131,18 @@ Switching reuses one video track and pauses input until the new source sends a f
|
||||
|
||||
### 0. Prebuilt release package (recommended, x86_64 / aarch64)
|
||||
|
||||
Download `uu-remote-linux-<version>-x86_64-linux.tar.gz` (ARM64: `aarch64-linux`) from [Releases](../../releases/latest), extract it, then:
|
||||
**Ubuntu / Debian (v0.2.18+)**: download `uu-remote-linux_<version>_amd64.deb` (ARM64: `arm64`), then:
|
||||
|
||||
```sh
|
||||
sudo apt install ./uu-remote-linux_<version>_amd64.deb
|
||||
uuremote-server login # scan the QR code with the UU Remote app
|
||||
systemctl --user enable --now uuremote-native.service # start with the graphical session
|
||||
```
|
||||
|
||||
The deb installs the binaries, plugins, a systemd user unit and menu entries; uinput access stays opt-in (step 5).
|
||||
GNOME and KDE pass the display environment to the unit; on desktops that don't (e.g. Xfce) add `DISPLAY` as in step 4.
|
||||
|
||||
**Other distributions**: download `uu-remote-linux-<version>-x86_64-linux.tar.gz` (ARM64: `aarch64-linux`) from [Releases](../../releases/latest), extract it, then:
|
||||
|
||||
```sh
|
||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||
@@ -322,6 +333,7 @@ Common environment variables:
|
||||
| `UU_ASSIST_ALLOW=1` | Allow remote assistance at start (overrides the saved switch) |
|
||||
| `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
|
||||
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
|
||||
| `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) |
|
||||
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly |
|
||||
|
||||
Host settings such as "lock after remote session" and "mute host" are stored in
|
||||
|
||||
@@ -117,7 +117,18 @@ GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通
|
||||
|
||||
### 0. 直接用 Release 预编译包(推荐,x86_64 / aarch64)
|
||||
|
||||
从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后:
|
||||
**Ubuntu / Debian(v0.2.18 起)**:下载 `uu-remote-linux_<版本>_amd64.deb`(ARM64 选 `arm64`)后:
|
||||
|
||||
```sh
|
||||
sudo apt install ./uu-remote-linux_<版本>_amd64.deb
|
||||
uuremote-server login # 用 UU 远程 App 扫码
|
||||
systemctl --user enable --now uuremote-native.service # 随图形会话启动
|
||||
```
|
||||
|
||||
deb 会安装程序、插件、用户级 systemd 服务和应用菜单图标;uinput 权限不会自动开启(见第 5 步)。
|
||||
GNOME / KDE 会把显示环境自动传给服务;Xfce 等不传的桌面需按第 4 步补 `DISPLAY`。
|
||||
|
||||
**其他发行版**:从 [Releases](../../releases/latest) 下载 `uu-remote-linux-<版本>-x86_64-linux.tar.gz`(ARM64 选 `aarch64-linux`),解压后:
|
||||
|
||||
```sh
|
||||
install -Dm755 uuremote-server ~/.local/bin/uuremote-server
|
||||
@@ -292,6 +303,7 @@ systemctl --user restart uuremote-native.service
|
||||
| `UU_REMOTE_ASSIST=0` | 关闭远程协助(未登录时也不再以访客身份提供协助) |
|
||||
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
|
||||
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
|
||||
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
|
||||
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 |
|
||||
|
||||
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
# Unofficial UU Remote Linux host in a container, for NAS boxes (Synology DSM, etc.) without a desktop.
|
||||
# Headless mode: file transfer, terminal and port mapping; no remote desktop. Uses the published release binary.
|
||||
FROM ubuntu:24.04
|
||||
ARG VERSION=v0.2.17
|
||||
ARG VERSION=v0.2.18
|
||||
LABEL org.opencontainers.image.source="https://github.com/VallierDev/uu-remote-linux" \
|
||||
org.opencontainers.image.description="Unofficial UU Remote Linux host, headless (file transfer, terminal, port mapping)" \
|
||||
org.opencontainers.image.licenses="GPL-3.0"
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
Ubuntu / Debian 安装包(.deb);实验性远程开机辅助。/ Debian packages; experimental Wake-on-LAN helper.
|
||||
|
||||
### 新增 / Added
|
||||
- **`.deb` 安装包**(amd64 / arm64):`sudo apt install ./uu-remote-linux_0.2.18_amd64.deb` 一步装好程序、两个桌面插件、
|
||||
用户级 systemd 服务和应用菜单图标,依赖由 apt 自动安装。之后以桌面用户运行:
|
||||
```sh
|
||||
uuremote-server login
|
||||
systemctl --user enable --now uuremote-native.service
|
||||
```
|
||||
服务随图形会话启动(GNOME / KDE 会自动传入显示环境;Xfce 等需按 README 补 `DISPLAY`)。uinput 权限不会自动开启,规则文件放在
|
||||
`/usr/share/doc/uu-remote-linux/`。安装流程在 CI 的 Ubuntu 22.04 上实测(apt 安装、`--help`、systemd 单元校验);尚未在真实桌面上完整验收。
|
||||
- **远程开机辅助(实验性,默认关闭,`UU_WOL_HELPER=1`)**:仿照官方 Windows 被控端,登录后向网易上报本机局域网信息,
|
||||
收到云端的唤醒请求时向同一局域网发送唤醒包,让这台常开的 Linux(例如 NAS)帮你唤醒同局域网的其他电脑。
|
||||
字段名来自官方程序的日志字符串,**未经端到端验证**;不开启时不上报任何局域网信息,只记录唤醒推送的字段名(不含 MAC/IP)。
|
||||
- Debian packages (amd64/arm64) with the binaries, plugins, a systemd user unit and menu entries; install-tested on Ubuntu 22.04 in CI.
|
||||
Experimental, opt-in Wake-on-LAN helper (`UU_WOL_HELPER=1`) modelled on the official Windows host; not verified end to end.
|
||||
|
||||
### 修复 / Fixed
|
||||
- `uuremote-server doctor` 不再输出带完整路径的插件加载日志(路径可能含用户名)。
|
||||
|
||||
### 下载 / Download
|
||||
`uu-remote-linux_0.2.18_amd64.deb` / `uu-remote-linux_0.2.18_arm64.deb`,或 `uu-remote-linux-v0.2.18-<x86_64|aarch64>-linux.tar.gz`,
|
||||
或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.18`(x86_64)。
|
||||
|
||||
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
|
||||
Executable
+67
@@ -0,0 +1,67 @@
|
||||
#!/bin/sh
|
||||
# Build uu-remote-linux_<version>_<arch>.deb from release binaries.
|
||||
# usage: packaging/deb/build-deb.sh VERSION BIN_DIR OUT_DIR (VERSION without the leading v)
|
||||
set -eu
|
||||
version=$1 bin=$2 out=$3
|
||||
here=$(cd "$(dirname "$0")" && pwd) root=$(cd "$here/../.." && pwd)
|
||||
case $(uname -m) in x86_64) arch=amd64 ;; aarch64) arch=arm64 ;; *) echo "unsupported arch" >&2; exit 1 ;; esac
|
||||
pkg=$(mktemp -d)
|
||||
trap 'rm -rf "$pkg"' EXIT
|
||||
install -Dm755 "$bin/uuremote-server" "$pkg/usr/bin/uuremote-server"
|
||||
[ -f "$bin/uuremote-viewer" ] && install -Dm755 "$bin/uuremote-viewer" "$pkg/usr/bin/uuremote-viewer"
|
||||
for lib in libuu-wayland.so libuu-portal.so; do
|
||||
[ -f "$bin/$lib" ] && install -Dm644 "$bin/$lib" "$pkg/usr/lib/uu-remote-linux/$lib"
|
||||
done
|
||||
install -Dm644 "$here/uuremote-native.service" "$pkg/usr/lib/systemd/user/uuremote-native.service"
|
||||
install -Dm644 "$root/contrib/desktop/uu-remote-linux.desktop" "$pkg/usr/share/applications/uu-remote-linux.desktop"
|
||||
[ -f "$pkg/usr/bin/uuremote-viewer" ] && install -Dm644 "$root/contrib/desktop/uu-remote-linux-viewer.desktop" "$pkg/usr/share/applications/uu-remote-linux-viewer.desktop"
|
||||
install -Dm644 "$root/contrib/desktop/uu-remote-linux.svg" "$pkg/usr/share/icons/hicolor/scalable/apps/uu-remote-linux.svg"
|
||||
install -Dm644 "$root/LICENSE" "$pkg/usr/share/doc/uu-remote-linux/copyright"
|
||||
# uinput access is opt-in: it lets the service inject input into the whole seat.
|
||||
printf '%s\n' 'KERNEL=="uinput", SUBSYSTEM=="misc", OPTIONS+="static_node=uinput", TAG+="uaccess"' \
|
||||
> "$pkg/usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules"
|
||||
size=$(du -sk "$pkg/usr" | cut -f1)
|
||||
# Library dependencies from the binaries themselves (the server hard, the viewer recommended).
|
||||
shlibdeps() {
|
||||
work=$(mktemp -d); mkdir "$work/debian"
|
||||
printf 'Source: uu-remote-linux\n\nPackage: uu-remote-linux\nArchitecture: any\n' > "$work/debian/control"
|
||||
(cd "$work" && dpkg-shlibdeps -O --ignore-missing-info "$1" 2>/dev/null) | sed -n 's/^shlibs:Depends=//p'
|
||||
rm -rf "$work"
|
||||
}
|
||||
depends=$(shlibdeps "$pkg/usr/bin/uuremote-server")
|
||||
recommends=""
|
||||
[ -f "$pkg/usr/bin/uuremote-viewer" ] && recommends=$(shlibdeps "$pkg/usr/bin/uuremote-viewer")
|
||||
[ -n "$depends" ] || { echo "dpkg-shlibdeps produced no dependencies" >&2; exit 1; }
|
||||
mkdir -p "$pkg/DEBIAN"
|
||||
cat > "$pkg/DEBIAN/control" <<CONTROL
|
||||
Package: uu-remote-linux
|
||||
Version: $version
|
||||
Architecture: $arch
|
||||
Maintainer: VallierDev <[email protected]>
|
||||
Installed-Size: $size
|
||||
Depends: $depends, ffmpeg
|
||||
Recommends: ${recommends:+$recommends, }libwayland-client0, libxkbcommon0
|
||||
Suggests: libpipewire-0.3-0, libei1, wl-clipboard
|
||||
Section: net
|
||||
Priority: optional
|
||||
Homepage: https://github.com/VallierDev/uu-remote-linux
|
||||
Description: Unofficial native Linux host for NetEase UU Remote
|
||||
Lets the official NetEase UU Remote clients control this Linux desktop
|
||||
(X11, wlroots Wayland and GNOME/KDE Wayland through runtime plugins).
|
||||
Includes the experimental uuremote-viewer. Not affiliated with NetEase.
|
||||
CONTROL
|
||||
cat > "$pkg/DEBIAN/postinst" <<'POSTINST'
|
||||
#!/bin/sh
|
||||
set -e
|
||||
if [ "$1" = configure ]; then
|
||||
cat <<'MSG'
|
||||
uu-remote-linux installed. As your desktop user (not root):
|
||||
uuremote-server login # scan the QR code with the UU Remote app
|
||||
systemctl --user enable --now uuremote-native.service # start with the graphical session
|
||||
Optional uinput keyboard/mouse (Wayland): see /usr/share/doc/uu-remote-linux/60-uu-remote-linux-uinput.rules
|
||||
MSG
|
||||
fi
|
||||
POSTINST
|
||||
chmod 755 "$pkg/DEBIAN/postinst"
|
||||
mkdir -p "$out"
|
||||
dpkg-deb --build --root-owner-group "$pkg" "$out/uu-remote-linux_${version}_${arch}.deb"
|
||||
@@ -0,0 +1,17 @@
|
||||
# Installed by the uu-remote-linux .deb as a systemd *user* unit; enable it per user:
|
||||
# systemctl --user enable --now uuremote-native.service
|
||||
# GNOME and KDE import DISPLAY / WAYLAND_DISPLAY into the user manager when the graphical session
|
||||
# starts. Desktops that do not (e.g. Xfce) can add a drop-in with Environment=DISPLAY=:0.
|
||||
[Unit]
|
||||
Description=UU Remote Linux host (unofficial)
|
||||
After=graphical-session.target
|
||||
PartOf=graphical-session.target
|
||||
|
||||
[Service]
|
||||
Environment=RUST_LOG=info
|
||||
ExecStart=/usr/bin/uuremote-server
|
||||
Restart=always
|
||||
RestartSec=5
|
||||
|
||||
[Install]
|
||||
WantedBy=graphical-session.target
|
||||
+10
@@ -251,6 +251,16 @@ impl UUAuthClient {
|
||||
Ok((status, value))
|
||||
}
|
||||
|
||||
/// Signed JSON POST to another API host (the signature covers the path only).
|
||||
pub async fn post_json_url(&self, base: &str, path: &str, body: &serde_json::Value) -> Result<(u16, serde_json::Value), String> {
|
||||
let body_str = serde_json::to_string(body).map_err(|e| e.to_string())?;
|
||||
let resp = self.http.post(format!("{base}{path}"))
|
||||
.headers(self.build_headers("POST", path, &body_str)).body(body_str)
|
||||
.send().await.map_err(|e| format!("HTTP post {path} failed: {}", transport_error(&e)))?;
|
||||
let status = resp.status().as_u16();
|
||||
Ok((status, resp.json().await.unwrap_or(serde_json::Value::Null)))
|
||||
}
|
||||
|
||||
/// Guest APIs use requestPlain for empty requests; sign the actual empty body.
|
||||
/// Errors intentionally exclude response text and URL (both can contain secrets).
|
||||
pub async fn assist_post(&self, path: &str, body: Option<&serde_json::Value>) -> Result<(u16, serde_json::Value), String> {
|
||||
|
||||
@@ -41,6 +41,8 @@ async fn command_output(program: &str, args: &[&str]) -> Option<String> {
|
||||
pub async fn run() -> Result<(), String> {
|
||||
use crate::desktop_backend as backend;
|
||||
use crate::engine_plugin::{load, Engine};
|
||||
// Info logs (e.g. plugin paths under the home directory) would bypass the redaction below.
|
||||
log::set_max_level(log::LevelFilter::Warn);
|
||||
println!("uu-remote-linux doctor (safe to paste: no ids, tokens, addresses or file contents)");
|
||||
line("version", format!("v{} {}", env!("CARGO_PKG_VERSION"), std::env::consts::ARCH));
|
||||
line("glibc", glibc());
|
||||
|
||||
+21
@@ -3,6 +3,7 @@
|
||||
|
||||
mod engine_plugin;
|
||||
mod doctor;
|
||||
mod wol;
|
||||
mod desktop_backend;
|
||||
mod desktop_session;
|
||||
mod desktop_power;
|
||||
@@ -649,6 +650,11 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
||||
}
|
||||
SignalingEvent::Connected => {
|
||||
log::info!("Signaling handshake established.");
|
||||
static WOL_REPORTED: std::sync::atomic::AtomicBool = std::sync::atomic::AtomicBool::new(false);
|
||||
if wol::enabled() && assist.as_ref().is_none_or(|s| s.is_account()) && !WOL_REPORTED.swap(true, std::sync::atomic::Ordering::AcqRel) {
|
||||
let client = auth.clone();
|
||||
tokio::spawn(async move { wol::report(&client).await; });
|
||||
}
|
||||
}
|
||||
SignalingEvent::RoomInfoAck(_) => { log::info!("RoomInfo acknowledged by NetEase server"); }
|
||||
SignalingEvent::DeviceInfoChanged(val) => {
|
||||
@@ -658,6 +664,21 @@ async fn serve(mut capture: Arc<ScreenCapture>, input: Arc<InputInjector>, shutd
|
||||
log::debug!("Assist bmsg_push shape: type={:?} keys={:?} data_keys={:?}",
|
||||
val.get("type").and_then(serde_json::Value::as_str), keys(Some(&val)), keys(val.get("data")));
|
||||
}
|
||||
if val.get("type").and_then(serde_json::Value::as_str) == Some("wake_on_lan") {
|
||||
// Key names only: the target carries a MAC and LAN address.
|
||||
let data = val.get("data").unwrap_or(&val);
|
||||
log::info!("wake_on_lan push received: keys={:?} target_keys={:?} helper_enabled={}",
|
||||
data.as_object().map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
|
||||
data.get("target_device").and_then(|t| t.as_object()).map(|o| o.keys().cloned().collect::<Vec<_>>()).unwrap_or_default(),
|
||||
wol::enabled());
|
||||
if wol::enabled() {
|
||||
match wol::handle_push(data) {
|
||||
Ok(sent) => log::info!("WOL helper: magic packet sent ({sent} datagrams)"),
|
||||
Err(error) => log::warn!("WOL helper: {error}"),
|
||||
}
|
||||
}
|
||||
continue;
|
||||
}
|
||||
if val.get("type").and_then(serde_json::Value::as_str) == Some("get_control_mode") {
|
||||
if let Some(s) = assist.as_mut() {
|
||||
match s.control_mode(val.get("data").unwrap_or(&serde_json::Value::Null)).await {
|
||||
|
||||
+123
@@ -0,0 +1,123 @@
|
||||
//! Experimental Wake-on-LAN helper (`UU_WOL_HELPER=1`, off by default).
|
||||
//!
|
||||
//! The official Windows host (GameViewerServer: LoginManager::reportLanInfo, PushMessageHandler::wakeOnLan,
|
||||
//! wake_on_lan.cpp host::send_wol) reports its LAN address to `api-ipv4…/api/v1/device/wake_on_lan/info`
|
||||
//! after sign-in (logged as "mac / ip / subnet_mask", response carries `turn_on_wol`), and on a
|
||||
//! `wake_on_lan` cloud push with a `target_device` {mac, ip, subnet_mask} it sends a magic packet to that
|
||||
//! subnet's broadcast address, waking another PC of the account on the same LAN. The exact request and
|
||||
//! push field names come from the official log strings only; nothing here is verified end to end yet.
|
||||
//! Addresses are sent to NetEase only when the helper is enabled and are never logged.
|
||||
|
||||
use std::net::{Ipv4Addr, SocketAddrV4, UdpSocket};
|
||||
|
||||
pub fn enabled() -> bool { std::env::var("UU_WOL_HELPER").is_ok_and(|v| v == "1") }
|
||||
|
||||
/// `aa:bb:cc:dd:ee:ff` / `aa-bb-…` / `aabbcc…` → 6 bytes.
|
||||
pub fn parse_mac(text: &str) -> Option<[u8; 6]> {
|
||||
let hex: String = text.chars().filter(|c| c.is_ascii_hexdigit()).collect();
|
||||
if hex.len() != 12 || text.chars().any(|c| !(c.is_ascii_hexdigit() || matches!(c, ':' | '-' | '.'))) { return None; }
|
||||
let mut mac = [0u8; 6];
|
||||
for (i, byte) in mac.iter_mut().enumerate() { *byte = u8::from_str_radix(&hex[i * 2..i * 2 + 2], 16).ok()?; }
|
||||
(mac != [0; 6] && mac != [0xff; 6]).then_some(mac)
|
||||
}
|
||||
|
||||
/// Six 0xFF bytes followed by the MAC sixteen times.
|
||||
pub fn magic_packet(mac: [u8; 6]) -> Vec<u8> {
|
||||
let mut packet = vec![0xff; 6];
|
||||
for _ in 0..16 { packet.extend_from_slice(&mac); }
|
||||
packet
|
||||
}
|
||||
|
||||
/// Directed broadcast of `ip`/`mask`, or None when either is missing or invalid.
|
||||
pub fn subnet_broadcast(ip: &str, mask: &str) -> Option<Ipv4Addr> {
|
||||
let (ip, mask): (Ipv4Addr, Ipv4Addr) = (ip.parse().ok()?, mask.parse().ok()?);
|
||||
let mask = u32::from(mask);
|
||||
if mask == 0 || mask.leading_ones() + mask.trailing_zeros() != 32 { return None; }
|
||||
Some(Ipv4Addr::from(u32::from(ip) | !mask))
|
||||
}
|
||||
|
||||
/// Handles a `wake_on_lan` push payload; returns how many datagrams were sent.
|
||||
pub fn handle_push(data: &serde_json::Value) -> Result<usize, String> {
|
||||
let target = data.get("target_device").or_else(|| data.get("data").and_then(|d| d.get("target_device")))
|
||||
.ok_or("wake_on_lan push without target_device")?;
|
||||
let text = |key: &str| target.get(key).and_then(serde_json::Value::as_str).unwrap_or("");
|
||||
let mac = parse_mac(text("mac")).ok_or("wake_on_lan target has no valid mac")?;
|
||||
let packet = magic_packet(mac);
|
||||
let socket = UdpSocket::bind("0.0.0.0:0").map_err(|e| format!("WOL socket: {}", e.kind()))?;
|
||||
socket.set_broadcast(true).map_err(|e| format!("WOL broadcast: {}", e.kind()))?;
|
||||
let mut targets = vec![Ipv4Addr::BROADCAST];
|
||||
if let Some(directed) = subnet_broadcast(text("ip"), text("subnet_mask")) { targets.insert(0, directed); }
|
||||
let mut sent = 0;
|
||||
for address in targets { for port in [9, 7] {
|
||||
if socket.send_to(&packet, SocketAddrV4::new(address, port)).is_ok() { sent += 1; }
|
||||
} }
|
||||
if sent == 0 { return Err("WOL packet could not be sent".into()); }
|
||||
Ok(sent)
|
||||
}
|
||||
|
||||
/// This host's LAN identity on the default IPv4 route: (mac, ip, subnet mask).
|
||||
#[cfg(target_os = "linux")]
|
||||
pub fn lan_info() -> Option<(String, String, String)> {
|
||||
let routes = std::fs::read_to_string("/proc/net/route").ok()?;
|
||||
let iface = routes.lines().skip(1).map(|l| l.split_whitespace().collect::<Vec<_>>())
|
||||
.find(|f| f.len() > 2 && f[1] == "00000000")?.first()?.to_string();
|
||||
let mac = std::fs::read_to_string(format!("/sys/class/net/{iface}/address")).ok()?.trim().to_owned();
|
||||
parse_mac(&mac)?;
|
||||
let mut addrs: *mut libc::ifaddrs = std::ptr::null_mut();
|
||||
if unsafe { libc::getifaddrs(&mut addrs) } != 0 { return None; }
|
||||
let mut result = None;
|
||||
let mut cursor = addrs;
|
||||
while !cursor.is_null() {
|
||||
let entry = unsafe { &*cursor };
|
||||
cursor = entry.ifa_next;
|
||||
if entry.ifa_addr.is_null() || entry.ifa_netmask.is_null() { continue; }
|
||||
let name = unsafe { std::ffi::CStr::from_ptr(entry.ifa_name) }.to_string_lossy();
|
||||
if name != iface.as_str() || i32::from(unsafe { (*entry.ifa_addr).sa_family }) != libc::AF_INET { continue; }
|
||||
let v4 = |p: *mut libc::sockaddr| Ipv4Addr::from(u32::from_be(unsafe { (*(p as *const libc::sockaddr_in)).sin_addr.s_addr }));
|
||||
result = Some((mac.clone(), v4(entry.ifa_addr).to_string(), v4(entry.ifa_netmask).to_string()));
|
||||
break;
|
||||
}
|
||||
unsafe { libc::freeifaddrs(addrs) };
|
||||
result
|
||||
}
|
||||
#[cfg(not(target_os = "linux"))]
|
||||
pub fn lan_info() -> Option<(String, String, String)> { None }
|
||||
|
||||
/// Report this host's LAN identity like the official host after sign-in.
|
||||
pub async fn report(auth: &crate::auth::UUAuthClient) {
|
||||
let Some((mac, ip, subnet_mask)) = lan_info() else { log::warn!("WOL helper: no IPv4 default-route interface"); return; };
|
||||
let body = serde_json::json!({ "mac": mac, "ip": ip, "subnet_mask": subnet_mask });
|
||||
match auth.post_json_url("https://api-ipv4.nrd.nie.163.com", "/api/v1/device/wake_on_lan/info", &body).await {
|
||||
Ok((status, value)) => log::info!("WOL helper: LAN info reported: status={status} code={:?} turn_on_wol={:?}",
|
||||
value.get("code").and_then(serde_json::Value::as_i64),
|
||||
value.get("data").and_then(|d| d.get("turn_on_wol")).or_else(|| value.get("turn_on_wol"))),
|
||||
Err(error) => log::warn!("WOL helper: LAN info report failed: {error}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
#[test]
|
||||
fn mac_parsing_and_packet() {
|
||||
assert_eq!(parse_mac("AA:bb:cc:dd:ee:01"), Some([0xaa, 0xbb, 0xcc, 0xdd, 0xee, 1]));
|
||||
assert_eq!(parse_mac("aa-bb-cc-dd-ee-01"), parse_mac("aabbccddee01"));
|
||||
assert!(parse_mac("aa:bb:cc").is_none() && parse_mac("zz:bb:cc:dd:ee:01").is_none() && parse_mac("00:00:00:00:00:00").is_none());
|
||||
let packet = magic_packet([1, 2, 3, 4, 5, 6]);
|
||||
assert_eq!(packet.len(), 102);
|
||||
assert_eq!(&packet[..6], &[0xff; 6]);
|
||||
assert_eq!(&packet[96..], &[1, 2, 3, 4, 5, 6]);
|
||||
}
|
||||
#[test]
|
||||
fn directed_broadcast() {
|
||||
assert_eq!(subnet_broadcast("192.168.2.29", "255.255.255.0"), Some(Ipv4Addr::new(192, 168, 2, 255)));
|
||||
assert_eq!(subnet_broadcast("10.1.2.3", "255.255.0.0"), Some(Ipv4Addr::new(10, 1, 255, 255)));
|
||||
assert_eq!(subnet_broadcast("10.1.2.3", "255.0.255.0"), None);
|
||||
assert_eq!(subnet_broadcast("", "255.255.255.0"), None);
|
||||
}
|
||||
#[test]
|
||||
fn push_without_target_is_rejected() {
|
||||
assert!(handle_push(&serde_json::json!({})).is_err());
|
||||
assert!(handle_push(&serde_json::json!({"target_device": {"mac": "nope"}})).is_err());
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user