diff options
| author | Bitflash <admin@bitflash.network> | 2026-08-13 14:39:40 -0300 |
|---|---|---|
| committer | Bitflash <admin@bitflash.network> | 2026-08-13 14:39:40 -0300 |
| commit | 8e21e8ca0b8d50c29376bc2f0a89575baa477213 (patch) | |
| tree | 4590b138ec6fb4848004ffa224273b7b6bb45e38 /docs | |
| parent | 5dec9b16a5b98ed0e24ec7113b867f22be2d0026 (diff) | |
| parent | 03e583395c42124521d09287bef29bf1d1bbe59b (diff) | |
Merge pull request 'release: package Windows builds with managed Tor' (#34) from windows-managed-tor-package into main
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/release-verification.md | 8 | ||||
| -rw-r--r-- | docs/tor.md | 19 |
2 files changed, 27 insertions, 0 deletions
diff --git a/docs/release-verification.md b/docs/release-verification.md index 408bab9..b8eaf5e 100644 --- a/docs/release-verification.md +++ b/docs/release-verification.md | |||
| @@ -81,6 +81,14 @@ Publish, alongside the assets, `SHA256SUMS` and `SHA256SUMS.asc`, and update | |||
| 81 | is ever rotated, announce the new fingerprint clearly and update the embedded | 81 | is ever rotated, announce the new fingerprint clearly and update the embedded |
| 82 | key in `verify-release.sh`. | 82 | key in `verify-release.sh`. |
| 83 | 83 | ||
| 84 | For Windows releases with managed Tor built in, run `make windows-tor`. It | ||
| 85 | creates `Bitflash-*-windows-with-tor.zip` by downloading the Tor Expert Bundle, | ||
| 86 | checking the pinned SHA256 in `scripts/package-windows-tor.sh`, optionally | ||
| 87 | verifying the Tor Project `.asc` signature, and placing `tor/tor.exe` next to | ||
| 88 | `Bitflash.exe`. For release builds, run `TOR_VERIFY_GPG=required make | ||
| 89 | windows-tor` so the signature check is mandatory. Include that zip in | ||
| 90 | `SHA256SUMS` like any other release asset. | ||
| 91 | |||
| 84 | ## Why this matters | 92 | ## Why this matters |
| 85 | 93 | ||
| 86 | `SHA256SUMS` alone protects against a broken download, but not against someone | 94 | `SHA256SUMS` alone protects against a broken download, but not against someone |
diff --git a/docs/tor.md b/docs/tor.md index 1c0f589..a408704 100644 --- a/docs/tor.md +++ b/docs/tor.md | |||
| @@ -53,6 +53,25 @@ Without a value, Bitflash looks for Tor in this order: | |||
| 53 | 2. `tor.exe` or `tor` beside the Bitflash binary; | 53 | 2. `tor.exe` or `tor` beside the Bitflash binary; |
| 54 | 3. `tor.exe` or `tor` on `PATH`. | 54 | 3. `tor.exe` or `tor` on `PATH`. |
| 55 | 55 | ||
| 56 | Windows releases can also be built as `Bitflash-*-windows-with-tor.zip`. That | ||
| 57 | package includes the official Tor Expert Bundle under `tor/`, so the first path | ||
| 58 | above exists immediately after extraction and `bitflash -managedtor` needs no | ||
| 59 | separate Tor install. | ||
| 60 | |||
| 61 | The bundled-Tor package is created by: | ||
| 62 | |||
| 63 | ```bash | ||
| 64 | make windows-tor | ||
| 65 | ``` | ||
| 66 | |||
| 67 | The packaging script verifies a pinned SHA256 for the downloaded Tor Expert | ||
| 68 | Bundle before copying it into the release directory. When `gpg` is available it | ||
| 69 | also verifies the matching `.asc` signature against the pinned Tor Browser | ||
| 70 | Developers signing-key fingerprint. Release builds should use | ||
| 71 | `TOR_VERIFY_GPG=required make windows-tor` to make that second check mandatory. | ||
| 72 | The Tor binary is bundled; the runtime data directory, hidden-service key, and | ||
| 73 | control cookie are still created under the user's Bitflash data directory. | ||
| 74 | |||
| 56 | To point at a specific Tor executable: | 75 | To point at a specific Tor executable: |
| 57 | 76 | ||
| 58 | ```bash | 77 | ```bash |