organize repo: tor source under tor-src/, portable data layout, start-tor.exe launcher

Author: Delta-Kronecker

.github/workflows/build.yml

@@ -75,53 +75,57 @@ jobs:
       - name: Configure
         shell: msys2 {0}
         run: |
-          cd "$GITHUB_WORKSPACE"
+          cd "$GITHUB_WORKSPACE/tor-src"
           chmod +x configure
           ./configure --host=x86_64-w64-mingw32 \
             --disable-asciidoc --disable-man --disable-html-docs
 
       - name: Build
         shell: msys2 {0}
         run: |
-          cd "$GITHUB_WORKSPACE"
+          cd "$GITHUB_WORKSPACE/tor-src"
           make -j$(nproc) 2>&1 | tee build-win.log
           exit ${PIPESTATUS[0]}
 
       - name: Smoke test
         shell: msys2 {0}
         run: |
-          cd "$GITHUB_WORKSPACE"
+          cd "$GITHUB_WORKSPACE/tor-src"
           ./src/app/tor.exe --version
 
       - name: Stage tor + runtime DLLs + geoip
         shell: msys2 {0}
         run: |
-          cd "$GITHUB_WORKSPACE"
-          mkdir -p dist/scripts dist/data
-          cp src/app/tor.exe dist/
-          cp "$MINGW_PREFIX"/bin/libevent*.dll "$MINGW_PREFIX"/bin/libssl-3-x64.dll "$MINGW_PREFIX"/bin/libcrypto-3-x64.dll "$MINGW_PREFIX"/bin/zlib1.dll dist/ 2>/dev/null || true
-          cp src/config/geoip src/config/geoip6 dist/
+          cd "$GITHUB_WORKSPACE/tor-src"
+          mkdir -p ../dist/data/scripts
+          cp src/app/tor.exe ../dist/data/
+          cp "$MINGW_PREFIX"/bin/libevent*.dll "$MINGW_PREFIX"/bin/libssl-3-x64.dll "$MINGW_PREFIX"/bin/libcrypto-3-x64.dll "$MINGW_PREFIX"/bin/zlib1.dll ../dist/data/ 2>/dev/null || true
+          cp src/config/geoip src/config/geoip6 ../dist/data/
 
       - name: Download transports
         uses: actions/download-artifact@v4
         with:
           name: transports-win64
           path: transports/
 
-      - name: Merge transports into dist
+      - name: Merge transports into dist/data
         shell: pwsh
         run: |
-          Copy-Item "transports\*.exe" -Destination "dist\" -Force
-          Get-ChildItem "dist" | Select-Object Name, Length
+          Copy-Item "transports\*.exe" -Destination "dist\data\" -Force
+          Get-ChildItem "dist" -Recurse -File | Select-Object FullName, Length
 
-      - name: Copy portable config, scripts, README, start.bat
+      - name: Copy portable config, scripts, README
         shell: pwsh
         run: |
-          Copy-Item "configs\torrc.iran" "dist\torrc" -Force
-          Copy-Item "scripts\launcher.ps1" "dist\scripts\" -Force
-          Copy-Item "scripts\fetch-bridges.ps1" "dist\scripts\" -Force
-          if (Test-Path "README-iran.md") { Copy-Item "README-iran.md" "dist\" -Force }
-          if (Test-Path "start.bat") { Copy-Item "start.bat" "dist\" -Force }
+          Copy-Item "configs\torrc.iran" "dist\data\torrc" -Force
+          Copy-Item "scripts\launcher.ps1" "dist\data\scripts\" -Force
+          Copy-Item "scripts\fetch-bridges.ps1" "dist\data\scripts\" -Force
+          Copy-Item "README.md" "dist\data\README.md" -Force
+
+      - name: Compile start-tor.exe
+        shell: pwsh
+        run: |
+          & "scripts\build-start-tor.ps1" -OutFile "dist\start-tor.exe"
 
       - name: Upload single release artifact
         uses: actions/upload-artifact@v4
@@ -134,4 +138,4 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: build-log-win
-          path: build-win.log
+          path: tor-src/build-win.log

.gitignore

@@ -6,3 +6,6 @@
 
 # tor runtime data (kept next to the packaged tor.exe, never in the repo)
 data/
+
+# locally compiled launcher (CI builds it into the artifact)
+/scripts/start-tor.exe

README-iran.md

@@ -1,73 +1,46 @@
-Tor protects your privacy on the internet by hiding the connection between
-your Internet address and the services you use. We believe Tor is reasonably
-secure, but please ensure you read the instructions and configure it properly.
+# Tor Portable for Iran
 
-## Build
-
-To build Tor from source:
-
-```
-./configure
-make
-make install
-```
+Single-folder, portable Tor client for Iranian networks. Built in CI from the
+official tor 0.4.9.11 sources plus pluggable transports (obfs4, snowflake,
+webtunnel). No installation and no `%APPDATA%` — every file and all runtime
+state stays inside one folder, so you can copy or move it anywhere.
 
-To build Tor from a just-cloned git repository:
+## Layout
 
 ```
-./autogen.sh
-./configure
-make
-make install
+start-tor.exe          double-click to start Tor and set the system proxy
+data\                  everything else lives here
+  tor.exe              + DLLs, geoip, geoip6, transports (obfs4/snowflake/webtunnel)
+  torrc                portable config (relative paths; sits next to tor.exe)
+  scripts\             launcher.ps1 (new identity / stop) + fetch-bridges.ps1
+  data\                runtime state (cached consensus, keys, tor.log)
 ```
 
-## Releases
-
-The tarballs, checksums and signatures can be found here: https://dist.torproject.org
-
-- Checksum: `<tarball-name>.sha256sum`
-- Signatures: `<tarball-name>.sha256sum.asc`
-
-### Schedule
-
-You can find our release schedule here:
-
-- https://gitlab.torproject.org/tpo/core/team/-/wikis/NetworkTeam/CoreTorReleases
-
-### Keys that CAN sign a release
+## Usage
 
-The following keys are the maintainers of this repository. One or many of
-these keys can sign the releases, do NOT expect them all:
+1. Download the `tor-win64-portable` artifact from GitHub Actions and unzip.
+2. Double-click `start-tor.exe`.
+3. Tor bootstraps (direct by default). On 100% the system proxy is enabled
+   (HTTP 127.0.0.1:8118, SOCKS5 127.0.0.1:9050, DNS 127.0.0.1:53530).
+   Press Enter to stop Tor and restore the proxy.
 
-- Alexander Færøy:
-    [514102454D0A87DB0767A1EBBE6A0531C18A9179](https://keys.openpgp.org/vks/v1/by-fingerprint/1C1BC007A9F607AA8152C040BEA7B180B1491921)
-- David Goulet:
-    [B74417EDDF22AC9F9E90F49142E86A2A11F48D36](https://keys.openpgp.org/vks/v1/by-fingerprint/B74417EDDF22AC9F9E90F49142E86A2A11F48D36)
-- Nick Mathewson:
-    [2133BC600AB133E1D826D173FE43009C4607B1FB](https://keys.openpgp.org/vks/v1/by-fingerprint/2133BC600AB133E1D826D173FE43009C4607B1FB)
+## If Tor is blocked
 
-## Development
+Run `data\scripts\fetch-bridges.ps1` to fetch fresh bridges (it rewrites
+`data\torrc`), then start again.
 
-See our hacking documentation in [doc/HACKING/](./doc/HACKING).
+## Advanced
 
-## Resources
-
-Home page:
-
-- https://www.torproject.org/
-
-Download new versions:
-
-- https://www.torproject.org/download/tor
-
-How to verify Tor source:
-
-- https://support.torproject.org/little-t-tor/
-
-Documentation and Frequently Asked Questions:
+```
+data\scripts\launcher.ps1 -NewCircuit   request a new identity
+data\scripts\launcher.ps1 -Stop         stop Tor and restore the proxy
+```
 
-- https://support.torproject.org/
+## Build
 
-How to run a Tor relay:
+`.github/workflows/build.yml` builds tor + transports on every push and
+publishes the `tor-win64-portable` artifact.
 
-- https://community.torproject.org/relay/ 
+- `tor-src\` — unmodified official tor 0.4.9.11 source
+- `configs\torrc.iran` — the portable config template (becomes `data\torrc`)
+- `scripts\start-tor.cs` — source of `start-tor.exe` (compiled with `build-start-tor.ps1`)

README.md

@@ -0,0 +1,22 @@
+<#
+.SYNOPSIS
+  Compile scripts\start-tor.cs into start-tor.exe using the .NET Framework csc.
+
+.PARAMETER OutFile
+  Output path for start-tor.exe (default: scripts\start-tor.exe)
+#>
+param(
+    [string]$OutFile = (Join-Path $PSScriptRoot "start-tor.exe")
+)
+
+$candidates = @(
+    (Join-Path $env:WINDIR "Microsoft.NET\Framework64\v4.0.30319\csc.exe"),
+    (Join-Path $env:WINDIR "Microsoft.NET\Framework\v4.0.30319\csc.exe")
+)
+$csc = $candidates | Where-Object { Test-Path $_ } | Select-Object -First 1
+if (-not $csc) { Write-Host "[x] csc.exe ('.NET Framework 4.x') not found."; exit 1 }
+
+$src = Join-Path $PSScriptRoot "start-tor.cs"
+& $csc -nologo -optimize+ -target:exe -out:$OutFile $src
+if ($LASTEXITCODE -ne 0) { Write-Host "[x] compile failed ($LASTEXITCODE)"; exit $LASTEXITCODE }
+Write-Host "[ok] built $OutFile"

scripts/build-start-tor.ps1

@@ -145,4 +145,4 @@ if ($all.Count -gt 0) {
     Write-Host "  3. Paste them into:  $TorrcPath  (add 'Bridge ' before each)"
 }
 if ($failed.Count) { Write-Host "No bridges for: $($failed -join ', ')" }
-Write-Host "Run tor.exe (or start.bat / launcher.ps1) to connect."
+Write-Host "Run start-tor.exe (or data\scripts\launcher.ps1) to connect."

scripts/fetch-bridges.ps1

@@ -4,12 +4,13 @@
   system proxy (HTTP 127.0.0.1:8118) on success.
 
 .DESCRIPTION
-  Layout (fully portable, all files together):
+  Layout (fully portable, all files together under data\):
     folder\
-      tor.exe + DLLs + webtunnel.exe + obfs4proxy.exe + snowflake-client.exe
-      torrc                 <- complete config (direct by default, or with
-                                bridges after running fetch-bridges.ps1)
-      data\                 <- created next to tor.exe: tor.log, bridges.txt
+      start-tor.exe
+      data\
+        tor.exe + DLLs + transports + torrc + geoip + geoip6
+        scripts\           <- this script + fetch-bridges.ps1
+        data\              <- runtime state: tor.log, cached-*, keys
 
   There is NO runtime config generation: torrc already sits next to tor.exe.
   This launcher just starts tor, waits for 100% bootstrap and sets the system