mike
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>
122 lines
4.1 KiB
YAML
122 lines
4.1 KiB
YAML
# AppVeyor configuration template for Rust using rustup for Rust installation
|
|
# https://github.com/starkat99/appveyor-rust
|
|
|
|
## Operating System (VM environment) ##
|
|
|
|
# Rust needs at least Visual Studio 2013 AppVeyor OS for MSVC targets.
|
|
os: Visual Studio 2015
|
|
|
|
## Build Matrix ##
|
|
|
|
# This configuration will setup a build for each channel & target combination (12 windows
|
|
# combinations in all).
|
|
#
|
|
# There are 3 channels: stable, beta, and nightly.
|
|
#
|
|
# Alternatively, the full version may be specified for the channel to build using that specific
|
|
# version (e.g. channel: 1.5.0)
|
|
#
|
|
# The values for target are the set of windows Rust build targets. Each value is of the form
|
|
#
|
|
# ARCH-pc-windows-TOOLCHAIN
|
|
#
|
|
# Where ARCH is the target architecture, either x86_64 or i686, and TOOLCHAIN is the linker
|
|
# toolchain to use, either msvc or gnu. See https://www.rust-lang.org/downloads.html#win-foot for
|
|
# a description of the toolchain differences.
|
|
# See https://github.com/rust-lang-nursery/rustup.rs/#toolchain-specification for description of
|
|
# toolchains and host triples.
|
|
#
|
|
# Comment out channel/target combos you do not wish to build in CI.
|
|
#
|
|
# You may use the `cargoflags` and `RUSTFLAGS` variables to set additional flags for cargo commands
|
|
# and rustc, respectively. For instance, you can uncomment the cargoflags lines in the nightly
|
|
# channels to enable unstable features when building for nightly. Or you could add additional
|
|
# matrix entries to test different combinations of features.
|
|
environment:
|
|
matrix:
|
|
|
|
### MSVC Toolchains ###
|
|
|
|
# Stable 64-bit MSVC
|
|
- channel: stable
|
|
target: x86_64-pc-windows-msvc
|
|
# Stable 32-bit MSVC
|
|
- channel: stable
|
|
target: i686-pc-windows-msvc
|
|
# Beta 64-bit MSVC
|
|
- channel: beta
|
|
target: x86_64-pc-windows-msvc
|
|
# Beta 32-bit MSVC
|
|
- channel: beta
|
|
target: i686-pc-windows-msvc
|
|
# Nightly 64-bit MSVC
|
|
- channel: nightly
|
|
target: x86_64-pc-windows-msvc
|
|
#cargoflags: --features "unstable"
|
|
# Nightly 32-bit MSVC
|
|
- channel: nightly
|
|
target: i686-pc-windows-msvc
|
|
#cargoflags: --features "unstable"
|
|
|
|
### GNU Toolchains ###
|
|
|
|
# Stable 64-bit GNU
|
|
- channel: stable
|
|
target: x86_64-pc-windows-gnu
|
|
# Stable 32-bit GNU
|
|
- channel: stable
|
|
target: i686-pc-windows-gnu
|
|
# Beta 64-bit GNU
|
|
- channel: beta
|
|
target: x86_64-pc-windows-gnu
|
|
# Beta 32-bit GNU
|
|
- channel: beta
|
|
target: i686-pc-windows-gnu
|
|
# Nightly 64-bit GNU
|
|
- channel: nightly
|
|
target: x86_64-pc-windows-gnu
|
|
#cargoflags: --features "unstable"
|
|
# Nightly 32-bit GNU
|
|
- channel: nightly
|
|
target: i686-pc-windows-gnu
|
|
#cargoflags: --features "unstable"
|
|
|
|
### Allowed failures ###
|
|
|
|
# See AppVeyor documentation for specific details. In short, place any channel or targets you wish
|
|
# to allow build failures on (usually nightly at least is a wise choice). This will prevent a build
|
|
# or test failure in the matching channels/targets from failing the entire build.
|
|
matrix:
|
|
allow_failures:
|
|
- channel: nightly
|
|
|
|
# If you only care about stable channel build failures, uncomment the following line:
|
|
#- channel: beta
|
|
|
|
## Install Script ##
|
|
|
|
# This is the most important part of the AppVeyor configuration. This installs the version of Rust
|
|
# specified by the 'channel' and 'target' environment variables from the build matrix. This uses
|
|
# rustup to install Rust.
|
|
#
|
|
# For simple configurations, instead of using the build matrix, you can simply set the
|
|
# default-toolchain and default-host manually here.
|
|
install:
|
|
- appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
|
|
- rustup-init -yv --default-toolchain %channel% --default-host %target%
|
|
- set PATH=%PATH%;%USERPROFILE%\.cargo\bin
|
|
- rustc -vV
|
|
- cargo -vV
|
|
|
|
## Build Script ##
|
|
|
|
# 'cargo test' takes care of building for us, so disable AppVeyor's build stage. This prevents
|
|
# the "directory does not contain a project or solution file" error.
|
|
build: false
|
|
|
|
# Uses 'cargo test' to run tests and build. Alternatively, the project may call compiled programs
|
|
#directly or perform other testing commands. Rust will automatically be placed in the PATH
|
|
# environment variable.
|
|
test_script:
|
|
- cargo test --verbose %cargoflags%
|