You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-11Lines changed: 14 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,14 @@
1
1
# Reverse-SOXY
2
2
3
-
A minimal, encrypted SOCKS5 tunnel for securely forwarding traffic between a **Proxy** and an **Agent**. Uses AES-CTR + HMAC to authenticate and encrypt the tunnel, plus SOCKS5 on the Proxy side.
3
+
A minimal, encrypted SOCKS5 tunnel for securely forwarding traffic between a **Proxy** and an **Agent** (optionally using a **Relay** server). Uses AES-CTR + HMAC to authenticate and encrypt the tunnel, plus SOCKS5 on the Proxy side.
4
4
5
5
## Features
6
6
7
7
-**Proxy mode**: exposes a local SOCKS5 endpoint and listens for agent connections on a tunnel port.
8
8
-**Agent mode**: dials into the proxy over a secure, authenticated, AES-CTR tunnel.
9
+
-**Relay mode**: starts a relay server. Useful when the Proxy cannot expose a public port.
10
+
-**Proxy via Relay**: registers a Proxy behind NAT with the Relay, then starts the SOCKS5 front-end.
11
+
-**Agent via Relay**: dials into the Relay on behalf of the Agent, establishing a secure tunnel via the relay.
9
12
- Graceful shutdown (SIGINT/SIGTERM) and automatic reconnect/backoff.
10
13
- Simple YAML configuration override.
11
14
- Zero external dependencies beyond the Go standard library and `gopkg.in/yaml.v3`.
@@ -30,6 +33,16 @@ Starts the SOCKS5 proxy front-end and listens for agent connections.
30
33
--secret mySharedSecret
31
34
```
32
35
36
+
### Agent mode
37
+
38
+
Dials into the proxy over the encrypted tunnel.
39
+
40
+
```bash
41
+
./reverse-soxy \
42
+
--tunnel-addr proxy.host:9000 \
43
+
--secret mySharedSecret
44
+
```
45
+
33
46
### Relay mode
34
47
35
48
Starts a public relay server on a VPS. Useful when the Proxy cannot expose a public port.
@@ -64,16 +77,6 @@ Dials into the Relay on behalf of the Agent, establishing a secure tunnel via th
0 commit comments