Files
aevolution/docs/engineering/CLIENT_PACKAGING.md
T
dingoandClaude Opus 5.5 6262c778c7 Add M9.8e reproducible Windows client package
Static-runtime client-package preset with /Brepro and a build identity printed by
evo-client --version (ADR-0086). tools/client packages an explicit allowlist with
licence texts from the verified sources, BUILD-INFO and SHA256SUMS into a
deterministic ZIP, refusing credentials, profile paths and non-system imports;
verification runs the extracted client without Visual Studio, and a self-test
proves each guard. Publication via Gitea Actions waits for a Windows runner.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-02 16:48:12 -04:00

46 lines
2.3 KiB
Markdown

# Windows client package (M9.8e)
Decision: [ADR-0086](../adr/0086-windows-client-package.md). Windows development host
only; requires Visual Studio 2022 C++ tools and prepared SDL, Dear ImGui and Mbed TLS
sources (`cmake -P tools/prepare-sdl3.cmake`, `prepare-imgui.cmake`,
`prepare-mbedtls.cmake`).
## Build a package
```powershell
powershell -NoProfile -ExecutionPolicy Bypass -File tools\client\package-windows.ps1
```
It refuses uncommitted tracked changes (`-AllowDirty` packages them with a `-dirty`
identity), configures `client-package` with `EVO_BUILD_IDENTITY=g<12 hex>`, builds,
runs the client/network CTest suite, stages the allowlisted files and writes
`build/packages/evo-client-windows-x64-<identity>.zip` and `.zip.sha256`. The staged
folder stays next to the ZIP. `-Clean` deletes `build/client-package` first; the
build log is `build/client-package.log` (+ `.err`).
Package content (exact): `evo-client.exe`, `SDL3.dll`, `README.txt`,
`BUILD-INFO.txt`, `THIRD-PARTY-NOTICES.txt`, `SHA256SUMS.txt` and `LICENSES/`
(SDL3, its HIDAPI, yuv2rgb, stb_image and Khronos notices, Apache-2.0, Mbed TLS,
Dear ImGui with fonts and stb notices). The tester README template is
`tools/client/README-package.txt`; the notice index is
`tools/client/THIRD-PARTY-NOTICES.txt`. No credentials, grant bundles, CA files or
settings are ever packaged; dev CA and grants are issued to testers separately.
## Verify a package
```powershell
powershell -NoProfile -ExecutionPolicy Bypass -File tools\client\verify-windows-package.ps1 -Zip build\packages\<name>.zip [-Interactive]
powershell -NoProfile -ExecutionPolicy Bypass -File tools\client\package-selftest.ps1 -Staged build\packages\<name> -DynamicRuntimeImage build\client-network\evo-client.exe
```
Verification works without Visual Studio (copy `tools/client` with the ZIP): digest,
exact content and SHA256SUMS, PE imports limited to system DLLs plus `SDL3.dll`,
credential and profile-path scan, then the extracted client runs with only the
Windows system directories on PATH. `-Interactive` opens a real window for 3 s.
The self-test proves each guard refuses its defect.
## Not yet covered
- Gitea Actions publication: needs a Windows runner (none registered).
- A clean Windows VM run and hardware/DPI qualification: M9.8g.
- Code signing: none; Windows SmartScreen may warn on first run.