https://github.com/hidden-node/gooserelayvpn-androidclient
GooseRelayVPN Android client: a SOCKS5 VPN with profile-based setup, live logs, and JSON import/export that tunnels raw TCP through Google Apps Script to your VPS exit server (AES-256-GCM, domain-fronted).
https://github.com/hidden-node/gooserelayvpn-androidclient
aes-gcm http-proxy mitm proxy sni socks5 tunnel tunneling vpn vpn-client
Last synced: 18 days ago
JSON representation
GooseRelayVPN Android client: a SOCKS5 VPN with profile-based setup, live logs, and JSON import/export that tunnels raw TCP through Google Apps Script to your VPS exit server (AES-256-GCM, domain-fronted).
- Host: GitHub
- URL: https://github.com/hidden-node/gooserelayvpn-androidclient
- Owner: Hidden-Node
- License: mit
- Created: 2026-04-28T22:33:54.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-02T14:23:19.000Z (about 1 month ago)
- Last Synced: 2026-05-03T17:02:50.713Z (about 1 month ago)
- Topics: aes-gcm, http-proxy, mitm, proxy, sni, socks5, tunnel, tunneling, vpn, vpn-client
- Language: Go
- Homepage:
- Size: 1.28 MB
- Stars: 116
- Watchers: 0
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GooseRelayVPN Android Client
🌐 **[فارسی](README_FA.md)**
Android client for GooseRelayVPN that runs the GooseRelay core through a Go mobile bridge and provides a complete Android UI for VPN lifecycle, profiles, logs, and settings.
- Upstream core project: https://github.com/kianmhz/GooseRelayVPN
- This repository: Android-focused client implementation
## What This App Does
This app creates a local SOCKS5 endpoint on Android and tunnels TCP traffic through the GooseRelay architecture:
1. Local app/browser traffic -> SOCKS5
2. GooseRelay encrypted framing (AES key from your profile)
3. HTTPS path through Google-facing endpoints (Apps Script flow)
4. Your VPS exit server handles outbound target connections
The app wraps this flow in Android `VpnService` so selected/full traffic can be routed through the tunnel.
## Key Features
- Android VPN integration (`VpnService` + tun2socks)
- Profile-based configuration
- JSON import/export for profile config
- Real-time Home status + telemetry cards
- Logs tab for Android/core diagnostics
- Split tunneling and internet sharing controls
## Configuration Model (Profile)
Profile fields are aligned with GooseRelay client config:
```json
{
"debug_timing": false,
"socks_host": "127.0.0.1",
"socks_port": 1080,
"google_host": "216.239.38.120",
"sni": ["www.google.com", "mail.google.com", "accounts.google.com"],
"script_keys": [
"REPLACE_WITH_DEPLOYMENT_ID",
"OPTIONAL_SECOND_DEPLOYMENT_ID"
],
"tunnel_key": "REPLACE_WITH_OUTPUT_OF_scripts_gen-key.sh"
}
```
Notes:
- `script_keys` in UI: one key per line.
- `tunnel_key`: must match server-side key.
- Import/export in app uses JSON.
## Upstream Setup Flow (Required)
You still need upstream infrastructure prepared first:
1. Prepare VPS and run `goose-server`
2. Deploy `apps_script/Code.gs` and obtain deployment ID(s)
3. Generate key via `scripts/gen-key.sh`
4. Put deployment ID(s) and key into Android profile
5. Connect in app and configure app/browser proxy as needed
For full infra details, use upstream docs:
- https://github.com/kianmhz/GooseRelayVPN
## Android Build (Local)
Requirements:
- Android Studio
- JDK 17
- Go 1.22+
- Android SDK / NDK
Build AAR (Go mobile bridge):
```bash
bash android/build_go_mobile.sh
```
Build debug APK:
```bash
cd android
./gradlew :app:assembleDebug
```
## Release / CI
Workflows in this repo:
- `.github/workflows/android-ci.yml`
- `.github/workflows/release-manual.yml`
- `.github/workflows/release.yml`
Manual signed release requires secrets:
- `ANDROID_KEYSTORE_BASE64`
- `ANDROID_KEYSTORE_PASSWORD`
- `ANDROID_KEY_ALIAS`
- `ANDROID_KEY_PASSWORD`
## Troubleshooting
- If reconnect fails with SOCKS port busy:
- Disconnect, wait a few seconds, reconnect.
- Ensure no other app uses the same SOCKS port.
- If connection stays in preparing state:
- Verify `script_keys` and `tunnel_key`.
- Check Logs tab for core errors.
- If no traffic flows:
- Verify VPN permission granted.
- Verify split tunnel app selection.
## Credits
1. Main project:
- https://github.com/kianmhz/GooseRelayVPN
2. Project that inspired the main project idea:
- https://github.com/masterking32/MasterHttpRelayVPN