f8ead215d8
build-windows / build-hello-agent-x64 (push) Successful in 5m41s
A single-binary, Flutter-free remote-support agent that speaks the stock
RustDesk wire protocol. Designed for one-line MDM deployment against a
self-hosted rustdesk-server: a supporter using the unmodified rustdesk.exe
client connects, the controlled-side user gets a native Win32 approval
prompt, click Yes / No.
CLI surface
hello-agent.exe --install # register + start service
hello-agent.exe --uninstall # stop, delete, clean up
hello-agent.exe --config <BLOB> # admin-UI deploy string
hello-agent.exe --install --config <BLOB> # MDM one-liner
--config accepts both forms emitted by the rustdesk-server admin UI: the
reversed-base64 deploy string and the host=,key=,api=,relay= filename
form. Decoded via the upstream custom_server module, persisted via
hbb_common::config::Config::set_option.
Architecture
--service runs as a Session 0 LocalSystem service. It polls
WTSGetActiveConsoleSessionId and (re)spawns hello-agent.exe --server
into the active console session via librustdesk::platform::run_as_user,
handling the Session 0 → user-session token impersonation.
--server is the worker. It boots three concurrent components:
1. cm_popup: an IPC listener on the rustdesk `_cm` named pipe
2. librustdesk::start_server(true, false): the upstream protocol
stack — rendezvous mediator, NAT punch, IPC server, screen
capture, login validation, hbbs_http heartbeat / sysinfo sync
3. (implicit) ApproveMode::Click is pinned in config, so every
incoming connection routes through cm_popup
The popup mechanism reuses an existing upstream contract without any
patches to the protocol code: when a peer connects with no password,
Connection::start in the upstream code calls try_start_cm_ipc, which
ipc::connect-s the `_cm` pipe before falling back to spawning a Flutter
CM child. Since cm_popup is up first, step 1 succeeds; we read the
Data::Login{authorized:false} frame, show MessageBoxTimeoutW (Yes/No,
60s, top-most, system-modal), and reply Data::Authorize or Data::Close.
Source tree
src/main.rs CLI dispatcher + run_server() composition
src/cli.rs hand-rolled argv parser + unit tests
src/service.rs windows-service install/uninstall/dispatcher
src/config_import.rs --config blob decoding + persistence
src/cm_popup.rs _cm IPC listener + Win32 approval dialog
Vendoring
The upstream RustDesk crate is vendored under vendor/rustdesk/ — full
workspace including libs/{hbb_common, scrap, enigo, clipboard,
virtual_display, remote_printer}. This makes the build self-contained
(no submodules, no sibling-repo checkout in CI) and gives us freedom to
fork in a different direction later. Excluded from the vendor: .git,
target/, flutter/, appimage/, flatpak/, fastlane/, docs/, examples/,
ci/, build.py, Dockerfile, upstream README/CLAUDE/AGENTS/GEMINI.
One local divergence vs. upstream: vendor/rustdesk/src/lib.rs flips
`mod custom_server` → `pub mod custom_server` so config_import.rs can
call get_custom_server_from_string without going through the
ui_interface shim. Documented in README.md → "Re-syncing the vendored
copy".
CI
.gitea/workflows/build-windows.yml builds on a self-hosted Windows
runner with Rust 1.75, LLVM 15.0.6 (libclang for bindgen via libvpx-sys),
and a vcpkg cache. The vendored vcpkg.json drives x64-windows-static
deps. The workflow stages the resulting hello-agent.exe into
SignOutput\, reports authenticode signing status (warns on unsigned),
and uploads as artifact. ~15 min full build, faster on incremental.
Out of scope for this commit: Linux/macOS builds, code signing, MSI
packaging, coexistence with stock rustdesk on the same box (currently
shares the RustDesk APP_NAME and config dir).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
131 lines
2.6 KiB
Bash
Executable File
131 lines
2.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# This script is derived from https://github.com/neutrinolabs/xrdp/sesman/startwm.sh.
|
|
|
|
#
|
|
# This script is an example. You might need to edit this script
|
|
# depending on your distro if it doesn't work for you.
|
|
#
|
|
# Uncomment the following line for debug:
|
|
# exec xterm
|
|
|
|
|
|
# Execution sequence for interactive login shell - pseudocode
|
|
#
|
|
# IF /etc/profile is readable THEN
|
|
# execute ~/.bash_profile
|
|
# END IF
|
|
# IF ~/.bash_profile is readable THEN
|
|
# execute ~/.bash_profile
|
|
# ELSE
|
|
# IF ~/.bash_login is readable THEN
|
|
# execute ~/.bash_login
|
|
# ELSE
|
|
# IF ~/.profile is readable THEN
|
|
# execute ~/.profile
|
|
# END IF
|
|
# END IF
|
|
# END IF
|
|
pre_start()
|
|
{
|
|
if [ -r /etc/profile ]; then
|
|
. /etc/profile
|
|
fi
|
|
if [ -r ~/.bash_profile ]; then
|
|
. ~/.bash_profile
|
|
else
|
|
if [ -r ~/.bash_login ]; then
|
|
. ~/.bash_login
|
|
else
|
|
if [ -r ~/.profile ]; then
|
|
. ~/.profile
|
|
fi
|
|
fi
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
# When loging out from the interactive shell, the execution sequence is:
|
|
#
|
|
# IF ~/.bash_logout exists THEN
|
|
# execute ~/.bash_logout
|
|
# END IF
|
|
post_start()
|
|
{
|
|
if [ -r ~/.bash_logout ]; then
|
|
. ~/.bash_logout
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
#start the window manager
|
|
wm_start()
|
|
{
|
|
if [ -r /etc/default/locale ]; then
|
|
. /etc/default/locale
|
|
export LANG LANGUAGE
|
|
fi
|
|
|
|
# debian
|
|
if [ -r /etc/X11/Xsession ]; then
|
|
pre_start
|
|
. /etc/X11/Xsession
|
|
post_start
|
|
exit 0
|
|
fi
|
|
|
|
# alpine
|
|
# Don't use /etc/X11/xinit/Xsession - it doesn't work
|
|
if [ -f /etc/alpine-release ]; then
|
|
if [ -f /etc/X11/xinit/xinitrc ]; then
|
|
pre_start
|
|
/etc/X11/xinit/xinitrc
|
|
post_start
|
|
else
|
|
echo "** xinit package isn't installed" >&2
|
|
exit 1
|
|
fi
|
|
fi
|
|
|
|
# el
|
|
if [ -r /etc/X11/xinit/Xsession ]; then
|
|
pre_start
|
|
. /etc/X11/xinit/Xsession
|
|
post_start
|
|
exit 0
|
|
fi
|
|
|
|
# suse
|
|
if [ -r /etc/X11/xdm/Xsession ]; then
|
|
# since the following script run a user login shell,
|
|
# do not execute the pseudo login shell scripts
|
|
. /etc/X11/xdm/Xsession
|
|
exit 0
|
|
elif [ -r /usr/etc/X11/xdm/Xsession ]; then
|
|
. /usr/etc/X11/xdm/Xsession
|
|
exit 0
|
|
fi
|
|
|
|
pre_start
|
|
xterm
|
|
post_start
|
|
}
|
|
|
|
#. /etc/environment
|
|
#export PATH=$PATH
|
|
#export LANG=$LANG
|
|
|
|
# change PATH to be what your environment needs usually what is in
|
|
# /etc/environment
|
|
#PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games"
|
|
#export PATH=$PATH
|
|
|
|
# for PATH and LANG from /etc/environment
|
|
# pam will auto process the environment file if /etc/pam.d/xrdp-sesman
|
|
# includes
|
|
# auth required pam_env.so readenv=1
|
|
|
|
wm_start
|
|
|
|
exit 1
|