Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lutfailham96/go-tcp-proxy-tunnel
Fast & clean TCP proxy tunnel written in Go
https://github.com/lutfailham96/go-tcp-proxy-tunnel
Last synced: 9 days ago
JSON representation
Fast & clean TCP proxy tunnel written in Go
- Host: GitHub
- URL: https://github.com/lutfailham96/go-tcp-proxy-tunnel
- Owner: lutfailham96
- License: mit
- Created: 2022-09-22T15:42:23.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T15:31:21.000Z (over 1 year ago)
- Last Synced: 2024-06-20T13:35:09.964Z (5 months ago)
- Language: Go
- Size: 96.7 KB
- Stars: 20
- Watchers: 2
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-tcp-proxy-tunnel
[](https://github.com/lutfailham96/go-tcp-proxy-tunnel/actions/workflows/ci.yml)
[](https://github.com/lutfailham96/go-tcp-proxy-tunnel/blob/master/LICENSE)
[](https://go.dev/)
[](https://pkg.go.dev/github.com/lutfailham96/go-tcp-proxy-tunnel)
[](https://goreportcard.com/report/github.com/lutfailham96/go-tcp-proxy-tunnel)
[](https://codeclimate.com/github/lutfailham96/go-tcp-proxy-tunnel/maintainability)
Fast & clean tcp proxy tunnel written in Go
This project was intended for debugging text-based protocols.
## Install
**Source**
``` sh
$ go get -v github.com/lutfailham96/go-tcp-proxy-tunnel
```
**Build & install to system**
```sh
$ git clone https://github.com/lutfailham96/go-tcp-proxy-tunnel \
&& cd go-tcp-proxy-tunnel \
&& make build \
&& sudo make install
```
## Usage
```
$ go-tcp-proxy-tunnel --help
-bs uint
connection buffer size
-c string
load config from JSON file
-cert string
tls cert pem file
-dsr
disable server host resolve
-ip string
remote TCP payload replacer
-k string
proxy kind [ssh, trojan] (default: ssh) (default "ssh")
-key string
tls key pem file
-l string
local address (default "127.0.0.1:8082")
-lv uint
log level [1-5] (default 3)
-op string
local TCP payload replacer
-r string
remote address (default "127.0.0.1:443")
-s string
server host address
-sni string
SNI hostname
-sv
run on server mode
-tls
enable tls/secure connection
```
### Server example
Accept incoming connection to use as `SSH` tunnel
```shell
$ go-tcp-proxy-tunnel \
-l 127.0.0.1:8082 \
-r 127.0.0.1:22 \
-sv \
-lv 3
Mode : server proxy
Proxy Kind : ssh
Buffer size : 65535
Connection : insecure
go-tcp-proxy-tunnel proxing from 127.0.0.1:8082 to 127.0.0.1:22
```
`nginx` site configuration
```
server {
listen 80;
listen [::]:80;
listen 443 ssl;
listen [::]:443 ssl;
# SSL configuration
ssl_certificate /etc/nginx/ssl/fullchain.pem;
ssl_certificate_key /etc/nginx/ssl/privkey.pem;
server_name my-server;
location / {
proxy_pass http://127.0.0.1:8082;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
include proxy_params;
}
}
```
or run using `go-ws-web-server` binary for simplicity
```shell
$ sudo go-ws-web-server \
-sni localhost
SNI : localhost
Secure TCP listen on : 127.0.0.1:443
TCP listen on : 127.0.0.1:80
```
### Client Example
Use custom payload
```shell
$ go-tcp-proxy-tunnel \
-l 127.0.0.1:9999 \
-r 127.0.0.1:10443 \
-s myserver:443 \
-dsr \
-sni cloudflare.com \
-op "GET ws://[sni] HTTP/1.1[crlf]Host: [host][crlf]Upgrade: websocket[crlf]Connection: keep-alive[crlf][crlf]"
Mode : client proxy
Proxy Kind : ssh
Buffer size : 65535
Connection : insecure
go-tcp-proxy-tunnel proxing from 127.0.0.1:9999 to 127.0.0.1:10443
```
`stunnel` configuration
```
[ws]
client = yes
accept = 127.0.0.1:10443
connect = 104.15.50.5:443
sni = cloudflare.com
cert = /etc/stunnel/ssl/stunnel.pem
```
Tunnel over `SSH` connection
```shell
$ ssh -o "ProxyCommand=ncat --proxy 127.0.0.1:9999 %h %p" -v4ND 1080 my-user@localhost
```
### Client Example (TLS without `stunnel`)
Use custom payload
```shell
$ go-tcp-proxy-tunnel \
-l 127.0.0.1:9999 \
-r 104.15.50.5:443 \
-s myserver:443 \
-dsr \
-tls \
-sni cloudflare.com \
-op "GET ws://[sni] HTTP/1.1[crlf]Host: [host][crlf]Upgrade: websocket[crlf]Connection: keep-alive[crlf][crlf]"
Mode : client proxy
Proxy Kind : ssh
Buffer size : 65535
Connection : secure (TLS)
SNI Host : cloudflare.com
go-tcp-proxy-tunnel proxing from 127.0.0.1:9999 to 104.15.50.5:443
```
Tunnel over `SSH` connection
```shell
$ ssh -o "ProxyCommand=ncat --proxy 127.0.0.1:9999 %h %p" -v4ND 1080 my-user@localhost
```
### Config File Example
**sever**
```json
{
"BufferSize": 65535,
"ServerProxyMode": true,
"ProxyInfo": "server proxy",
"LocalAddress": "127.0.0.1:8082",
"RemoteAddress": "127.0.0.1:22"
}
```
**client**
```json
{
"BufferSize": 65535,
"ServerProxyMode": false,
"ProxyInfo": "client proxy",
"ProxyKind": "ssh",
"LocalAddress": "127.0.0.1:9999",
"RemoteAddress": "127.0.0.1:10443",
"LocalPayload": "GET ws://[sni] HTTP/1.1[crlf]Host: [host][crlf]Connection: keep-alive[crlf]Upgrade: websocket[crlf][crlf]",
"RemotePayload": "HTTP/1.1 200 Connection Established[crlf][crlf]",
"ServerHost": "my-server:443"
"SNIHost": "cloudflare.com",
}
```
**client (TLS)**
```json
{
"BufferSize": 65535,
"ServerProxyMode": false,
"ProxyInfo": "client proxy",
"ProxyKind": "ssh",
"LocalAddress": "127.0.0.1:9999",
"RemoteAddress": "104.15.50.1:443",
"LocalPayload": "GET ws://[sni] HTTP/1.1[crlf]Host: [host][crlf]Connection: keep-alive[crlf]Upgrade: websocket[crlf][crlf]",
"RemotePayload": "HTTP/1.1 200 Connection Established[crlf][crlf]",
"TLSEnabled": true,
"SNIHost": "cloudflare.com",
"ServerHost": "my-server:443"
}
```
Example run `go-tcp-proxy-tunnel` using config file
```shell
$ go-tcp-proxy-tunnel -c config.json
```
### Run via Docker
Pull the images image
```shell
$ docker pull lutfailham/go-tcp-proxy-tunnel:latest
```
**Server Mode**
```shell
Example:
- dropbear host address: 127.0.0.1:442
$ docker run --rm -it \
--name go-tcp-proxy-tunnel \
-e PROXY_DROPBEAR=127.0.0.1:442 \
--net=host \
-p "80:80" \
-p "443:443" \
-p "8082:8082" \
lutfailham/go-tcp-proxy-tunnel:latest-alpine
```
### Log Level
Default log level value `3`, add or pass `-lv` arguments if you want to change the verbosity of logs
| Log Level | Second Header |
|-----------|---------------|
| 1 | `None` |
| 2 | `Critical` |
| 3 | `Info` |
| 4 | `Debug` |
| 5 | `Error` |
### Todo
- Add unit test
- Improve documentation