Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arloor/rust_http_proxy

Last synced: 1 day ago
JSON representation

Host: GitHub
URL: https://github.com/arloor/rust_http_proxy
Owner: arloor
License: apache-2.0
Created: 2023-05-06T06:54:21.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-05-17T07:31:47.000Z (5 months ago)
Last Synced: 2024-05-21T08:19:54.445Z (5 months ago)
Language: Rust
Homepage:
Size: 2.53 MB
Stars: 20
Watchers: 1
Forks: 4
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE

Awesome Lists containing this project

README

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/arloor/rust_http_proxy)

基于 `hyper` 和 `rustls` 的静态资源托管服务器、正向代理、反向代理。

## 功能特性

1. 使用tls来对正向代理流量进行加密（`--over-tls`）。
2. 类Nginx的静态资源托管。支持gzip压缩。支持Accept-Ranges以支持断点续传（备注：暂不支持多range，例如 `Range: bytes=0-100,100-` ）
3. 支持反向代理（ `--reverse-proxy-config-file` ）。
4. 基于Prometheus的可观测，可以监控代理的流量、外链访问等。
5. 采集网卡上行流量，展示在 `/speed` 路径下（读取 `/proc/net/dev` 或基于 `ebpf socket filter` ）
5. 支持多端口，多用户。
6. 每天定时加载tls证书，acme证书过期重新签发时不需要重启服务。
7. 连接空闲（10分钟没有IO）自动关闭。

提及的参数详见[命令行参数](#命令行参数)

## 安装说明

### linux amd64 可执行文件

```shell
curl -SLf https://us.arloor.dev/https://github.com/arloor/rust_http_proxy/releases/download/latest/rust_http_proxy -o /tmp/rust_http_proxy
install /tmp/rust_http_proxy /usr/bin/rust_http_proxy
/usr/bin/rust_http_proxy -p 7788
```

### Docker 安装

> 通过Github Action自动更新release，永远是最新版，可放心使用

```shell
docker run --rm -it --net host docker.io/arloor/rust_http_proxy -p 7788
```

### ebpf版本安装

> 注意：ebpf版本并没有什么新特性，只是为了学习下新技术的自嗨。

```bash
curl -SLf https://us.arloor.dev/https://github.com/arloor/rust_http_proxy/releases/download/bpf/rust_http_proxy -o /tmp/rust_http_proxy
install /tmp/rust_http_proxy /usr/bin/rust_http_proxy
/usr/bin/rust_http_proxy -p 7788
```

或者

```bash
docker run --rm -it --privileged --net host docker.io/arloor/rust_http_proxy:bpf -p 7788
```

## 命令行参数

```shell
$ rust_http_proxy --help
A HTTP proxy server based on Hyper and Rustls, which features TLS proxy and static file serving

Usage: rust_http_proxy [OPTIONS]

Options:
--log-dir
[default: /tmp]
--log-file
[default: proxy.log]
-p, --port
可以多次指定来实现多端口
[default: 3128]
-c, --cert
[default: cert.pem]
-k, --key
[default: privkey.pem]
-u, --users
默认为空，表示不鉴权。
格式为 'username:password'
可以多次指定来实现多用户
[default: ]
-w, --web-content-path
[default: /usr/share/nginx/html]
-r, --referer
Http Referer请求头处理
1. 图片资源的防盗链：针对png/jpeg/jpg等文件的请求，要求Request的Referer header要么为空，要么配置的值
2. 外链访问监控：如果Referer不包含配置的值，并且访问html资源时，Prometheus counter req_from_out++，用于外链访问监控
[default: ]
--never-ask-for-auth
if enable, never send '407 Proxy Authentication Required' to client。
不建议开启，否则有被嗅探的风险

-o, --over-tls
if enable, proxy server will listen on https
--hostname
[default: unknown]
--reverse-proxy-config-file
反向代理配置文件
-h, --help
Print help
```

### SSL配置

其中，tls证书(`--cert`)和pem格式的私钥(`--key`)可以通过openssl命令一键生成：

```bash
openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout /usr/share/rust_http_proxy/privkey.pem -out /usr/share/rust_http_proxy/cert.pem -days 3650 -subj "/C=cn/ST=hl/L=sd/O=op/OU=as/CN=example.com"
```

如需签名证书，请购买tls证书或免费解决方案（acme.sh等）

测试TLS Proxy可以使用curl （7.52.0以上版本）:

```bash
curl https://ip.im/info -U "username:password" -x https://localhost:7788 --proxy-insecure
```

### 反向代理配置

```yaml
YOUR_DOMAIN:
- location: / # 默认为 /
upstream:
scheme_and_authority: https://www.baidu.com # 末尾不包含 /
replacement: / # 默认为 /
version: AUTO # 可以填H1、H2、AUTO，默认为AUTO
```

> 如果 `YOUR_DOMAIN` 填 `default_host` 则对所有的域名生效

#### 例子1: Github Proxy

在github原始url前加上`https://YOUR_DOMAIN`，以便在国内访问raw.githubusercontent.com和github.com

```bash
curl https://YOUR_DOMAIN/https://raw.githubusercontent.com/arloor/iptablesUtils/master/natcfg.sh
```

配置文件如下：

```yaml
default_host:
- location: /https://github.com
upstream:
scheme_and_authority: https://github.com
replacement:
- location: /github-production-release
upstream:
scheme_and_authority: https://objects.githubusercontent.com
replacement: /github-production-release
- location: /https://raw.githubusercontent.com
upstream:
scheme_and_authority: https://raw.githubusercontent.com
replacement:
```

#### 例子2: 改写Github Models的url为openai api的url格式

```yaml
default_host:
- location: /v1/chat/completions
upstream:
scheme_and_authority: https://models.inference.ai.azure.com
replacement: /chat/completions
```

## 可观测

### Prometheus Exporter

提供了Prometheus的Exporter。如果设置了`--users`参数，则需要在header中设置authorization，否则会返回`401 UNAUTHORIZED`。

```text
# HELP req_from_out Number of HTTP requests received.
# TYPE req_from_out counter
req_from_out_total{referer="all",path="all"} 4
# HELP proxy_traffic num proxy_traffic.
# TYPE proxy_traffic counter
# EOF
```

可以使用[此Grafana大盘Template](https://grafana.com/grafana/dashboards/20185-rust-http-proxy/)来创建Grafana大盘，效果如下

![alt text](grafana-template1.png)
![alt text](grafana-template2.png)

### Linux运行时的网速监控

在linux运行时，会监控网卡网速，并展示在 `/net` 。

![](speed.png)

## 客户端

- Clash系列
- [clash-verge-rev](https://github.com/clash-verge-rev/clash-verge-rev)
- [ClashMetaForAndroid](https://github.com/MetaCubeX/ClashMetaForAndroid)
- [mihomo(clash-meta)](https://github.com/MetaCubeX/mihomo/tree/Meta)
- 自研玩具
- Rust：[sslocal(fork shadowsocks-rust)](https://github.com/arloor/shadowsocks-rust)
- Golang：[forward](https://github.com/arloor/forward)
- Java: [connect](https://github.com/arloor/connect)

## Cargo Features

### bpf

使用ebpf来统计网卡出流量，仅在 `x86_64-unknown-linux-gnu` 上测试过。激活方式:

```bash
cargo build --features bpf
```

需要安装 `libbpf-rs` 所需的依赖：

**ubuntu 22.04 安装：**

```bash
apt-get install -y libbpf-dev libz-dev libelf-dev pkg-config clang bpftool
```

**centos stream 9 安装：**

```bash
yum install -y libbpf zlib-devel elfutils-libelf-devel pkgconf-pkg-config clang bpftool
```

### jemalloc

拥有更高的并发分配能力和减少内存碎片，不过会buffer更多的内存，因此top中RES数值会有上升。激活方式：

```bash
cargo build --features jemalloc
```

### aws_lc_rs

`aws_lc_rs` 和 `ring` 是 `rustls` 的两个加密后端。本项目默认使用 `ring` 作为加密后端，也可选择[aws_lc_rs](https://crates.io/crates/aws-lc-rs)作为加密后端。`aws_lc_rs` 相比ring主要有两点优势:

1. 在[rustls的benchmark测试](https://github.com/aochagavia/rustls-bench-results)中，`aws_lc_rs` 的性能要优于 `ring` 。
2. 支持美国联邦政府针对加密提出的[fips要求](https://csrc.nist.gov/pubs/fips/140-2/upd2/final)。

不过，使用 `aws_lc_rs` 会增加一些编译难度，需要额外做以下操作：

| 依赖的包 | 是否必须 |安装方式 |
| --- | --- | --- |
| `cmake` | 必须 | `apt-get install cmake` |

激活方式：

```bash
cargo build --no-default-features --features aws_lc_rs
```

## 高匿实现

代理服务器收到的http请求有一些特征，如果代理服务器不能正确处理，则会暴露自己是一个代理。高匿代理就是能去除这些特征的代理。具体特征有三个：

- 代理服务器收到的request line中有完整url，即包含schema、host。而正常http请求的url只包含路径
- 代理服务器收到http header中有Proxy-Connection请求头，需要去掉
- 代理服务器收到http header中有Proxy-Authentication请求头，需要去掉

本代理能去除以上特征。下面是使用tcpdump测试的结果，分别展示代理服务器收到的http请求和nginx web服务器收到的http请求已验证去除以上特征。

代理服务器收到的消息：

![](traffic_at_proxy.png)

Nginx收到的消息：

![](traffic_at_nginx.png)

可以看到请求URL和`Proxy-Connection`都被正确处理了。