reza/tcproxy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Reza Behzadan 2025-02-20 14:58:37 -05:00
parent 8d3113f3fb
commit eecbaee9be
1 changed files with 17 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,34 +1,30 @@
# TCProxy
**TCProxy** is a lightweight TCP proxy designed to forward HTTPS and HTTP traffic while enforcing an IP-based whitelist. It inspects incoming connections, determines if they are HTTPS or HTTP, and forwards them accordingly to the appropriate backend server.
**TCProxy** is a lightweight and efficient TCP proxy that forwards HTTPS and HTTP traffic transparently based on SNI and host headers. Originally developed to bypass internet censorship, it enables seamless access to blocked websites when combined with a custom DNS resolver.
### Features:
- **SNI-based Routing**: Extracts the Server Name Indication (SNI) from HTTPS requests and forwards them to the correct backend.
- **IP Whitelisting**: Allows only approved IP addresses to connect, dynamically reloading the whitelist file on changes.
- **Seamless HTTP/HTTPS Handling**: Differentiates between HTTP and HTTPS connections and routes them accordingly.
- **Concurrency Support**: Uses goroutines and wait groups for efficient connection handling.
- **Customizable Binding**: Supports binding to a custom address and port via command-line flags.
- **Lightweight & Self-Contained**: Written in Go with no external dependencies apart from the standard library.
- **Transparent HTTPS/HTTP Forwarding**: Routes traffic based on SNI (for HTTPS) and Host headers (for HTTP) without requiring client-side configuration.
- **Censorship Bypass**: Designed to work with a DNS server that redirects blocked domains to a proxy server.
- **IP Whitelisting**: Restricts access to authorized users, with dynamic whitelist updates.
- **Minimal Overhead**: Lightweight Go implementation with efficient concurrency handling.
- **Customizable Binding**: Allows specifying the listening address and port.
### How It Works:
1. A **custom DNS resolver** is deployed inside a censored region to redirect domains to an external VPS.
2. The **VPS runs TCProxy**, which inspects and forwards traffic to the requested destination.
3. **iptables** is used to transparently redirect all traffic on ports `80` and `443` to `tcproxy`.
### Usage:
```
tcproxy -b <bind-address>
```
Or with default options:
```
tcproxy
```
### Command-line Options:
- `-b, --bind`: Set the address to bind (default: `localhost:8443`).
- `-v, --version`: Display the version.
- `-h, --help`: Show usage instructions.
### Example:
```sh
tcproxy -b "0.0.0.0:8443"
```
This starts TCProxy, listening on all interfaces at port 8443.
### Command-line Options:
- `-b, --bind`: Set the address to bind (default: `localhost:8443`).
- `-v, --version`: Display the version.
- `-h, --help`: Show usage instructions.
### Requirements:
- Go 1.16+
- A `whitelist.txt` file for IP-based filtering.
@ -39,6 +35,7 @@ Build from source:
git clone https://git.behzadan.com/reza/tcproxy.git
cd tcproxy
make
sudo make install
```
### Acknowledgements