# rustproxy

**Repository Path**: wangjw520/rustproxy

## Basic Information

- **Project Name**: rustproxy
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-03
- **Last Updated**: 2024-07-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rustproxy

[![crates.io](https://img.shields.io/crates/v/rustproxy.svg)](https://crates.io/crates/rustproxy)
[![rustc 1.70.0](https://img.shields.io/badge/rust-1.70%2B-orange.svg)](https://img.shields.io/badge/rust-1.70%2B-orange.svg)
[![Released API docs](https://docs.rs/rustproxy/badge.svg)](https://docs.rs/rustproxy)

`rustproxy`已用`Rust`实现`http/https`代理, `socks5`代理, 反向代理, 负载均衡, 静态文件服务器，`websocket`代理，四层TCP/UDP转发，内网穿透等

## 📦 安装 & 🏃 使用

### 安装

```bash
cargo install rustproxy
```

OR

```bash
git clone https://gitee.com/wangjw520/rustproxy.git
cd rustproxy
cargo install --path .
```

```docker
docker pull dreamwhat/rustproxy
docker run -p 8090:8090 --name proxy_bash dreamwhat/rustproxy /bin/./rustproxy proxy -b 0.0.0.0:8090
```

### 使用

默认端口为8090端口，默认监听地址为127.0.0.1

```bash
# 直接通用默认参数
rustproxy proxy

# 设置账号密码
rustproxy proxy -b 0.0.0.0:8090 --user rustproxy --pass rustproxy

# 其它指令
rustproxy --help

#配置文件版启动
rustproxy config -c config/client.toml
```

##### 启动二级代理

1. 在本地启动代理

```bash
rustproxy proxy -b 127.0.0.1:8090 -S 127.0.0.1:8091 --ts
```

或者

```bash
rustproxy config -c config/client.toml
```

配置文件如下:

```toml
[proxy]
# 连接服务端地址
#server = "127.0.0.1:8091"
bind_addr = "0.0.0.0:8090"
flag = "http https socks5"
# 连接服务端是否加密
ts = true
two_way_tls = true
# username = "rustproxy"
# password = "rustproxy"

# 内网映射配置的数组

  #将localhost的域名转发到本地的127.0.0.1:8080
[[proxy.mappings]]
name = "web"
mode = "http"
local_addr = "127.0.0.1:8080"
domain = "localhost"

headers = [
  "proxy x-forward-for {client_ip}",
  "proxy + from $url",
  "+ last-modified 'from proxy'",
  "- etag",
]

#将tcp的流量无条件转到127.0.0.1:8080
[[proxy.mappings]]
name = "tcp"
mode = "tcp"
local_addr = "127.0.0.1:8080"
domain = ""
```

因为纯转发，所以在当前节点设置账号密码没有意义`-S`表示连接到的二级代理地址，**有该参数则表示是中转代理，否则是末端代理。**```--ts```表示连接父级代理的时候需要用加密的方式链接

2. 在远程启动代理

```bash
rustproxy proxy --user proxy --pass proxy -b 0.0.0.0:8091 --tc
```

或者

```bash
rustproxy config -c config/server.toml
```

配置文件如下:

```toml
[proxy]
#绑定的ip地址
bind_addr = "127.0.0.1:8091"

#代理支持的功能，1为http，2为https，4为socks5
# flag = "7"
username = "rustproxy"
password = "rustproxy"

#内网映射http绑定地址
map_http_bind = "127.0.0.1:8001"
#内网映射tcp绑定地址
map_tcp_bind = "127.0.0.1:8002"
#内网映射https绑定地址
map_https_bind = "127.0.0.1:8003"
#内网映射的公钥证书，为空则是默认证书
# map_cert = 
#内网映射的私钥证书，为空则是默认证书
# map_key =
# 双向认证
two_way_tls = true
#接收客户端是为是加密客户端
tc = true
#当前服务模式，server为服务端，client为客户端
mode = "server"
```

```--tc```表示接收子级代理的时候需要用加密的方式链接，可以```--cert```指定证书的公钥，```--key```指定证书的私钥，```--domain```指定证书的域名，如果不指定，则默认用自带的证书参数

> 至此通过代理访问的，我们已经没有办法得到真正的请求地址，只能得到代理发起的请求

### 代理间的认证

> 目前提供了两种认证双式, ```two_way_tls```开启客户端的证书认证信息, 另一种服务端配置了```username```和```password```即需要客户端配置相同的用户密码才能启用认证信息, 两种方式可叠加使用或者单独使用。
> 配置添加如下:

```yaml
proxy:
  two_way_tls: true
  username: rustproxy
  password: rustproxy
```

# 🚥 路线图

### socks5

- [X]  IPV6 支持
- [X]  `SOCKS5` 验证方式
  - [X]  `NOAUTH`
  - [X]  `USERPASS`
- [X]  `SOCKS5` Commands
  - [X]  `CONNECT`
  - [X]  `UDP ASSOCIATE`

### http/https

- [X]  IPV6 支持

### 内网穿透

- [X]  Http 支持
- [X]  Https 支持
- [X]  Tcp 支持

### 反向代理

- [X]  静态文件服务器
- [X]  被动健康检查
- [X]  主动健康检查
- [X]  配置热加载
- [X]  负载均衡
- [X]  四层TCP负载
- [X]  四层UDP负载
- [X]  流量控制
- [X]  websocket转发

### 基础能力

- [X]  日志

#### 扩展能力

- [X]  请求限速(limit_req)
- [X]  修改 HTTP 请求 Header
- [X]  支持 HTTP2 的内网穿透
- [X]  控制微端
- [X]  try_paths
- [X]  tcp转websocket
- [X]  websocket转tcp

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=tickbh/rustproxy&type=Date)](https://star-history.com/#tickbh/rustproxy&Date)