Skip to content

基于Rust的正向代理、反向代理和静态资源托管。 forward proxy、reverse proxy and static file serving

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE.BSD-2-Clause
Notifications You must be signed in to change notification settings

arloor/rust_http_proxy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open in GitHub Codespaces

基于 hyperaxumrustls静态资源托管服务器正向代理反向代理API server

功能特性

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

提及的参数详见命令行参数

安装说明

linux amd64 可执行文件

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,永远是最新版,可放心使用

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

ebpf 版本安装

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

或者

docker run --rm -it --privileged --net host --pid host docker.io/arloor/rust_http_proxy:bpf_static -p 7788

命令行参数

$ 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 <LOG_DIR>
          [default: /tmp]
      --log-file <LOG_FILE>
          [default: proxy.log]
  -p, --port <PORT>
          可以多次指定来实现多端口
           [default: 3128]
  -c, --cert <CERT>
          [default: cert.pem]
  -k, --key <KEY>
          [default: privkey.pem]
  -u, --users <USER>
          默认为空,表示不鉴权。
          格式为 'username:password'
          可以多次指定来实现多用户
  -w, --web-content-path <WEB_CONTENT_PATH>
          [default: /usr/share/nginx/html]
  -r, --referer-keywords-to-self <REFERER>
          Http Referer请求头处理
          1. 图片资源的防盗链:针对png/jpeg/jpg等文件的请求,要求Request的Referer header要么为空,要么包含配置的值
          2. 外链访问监控:如果Referer不包含配置的值,并且访问html资源时,Prometheus counter req_from_out++,用于外链访问监控
          可以多次指定,也可以不指定
      --never-ask-for-auth
          if enable, never send '407 Proxy Authentication Required' to client。
          当作为正向代理使用时建议开启,否则有被嗅探的风险。
      --prohibit-serving
          禁止所有静态文件托管,为了避免被嗅探
      --allow-serving-network <CIDR>
          允许访问静态文件托管的网段,格式为CIDR,例如: 192.168.1.0/24, 10.0.0.0/8
          可以多次指定来允许多个网段
          如设置了prohibit_serving,则此参数无效
          如未设置任何网段,且未设置prohibit_serving,则允许所有IP访问静态文件
  -o, --over-tls
          if enable, proxy server will listen on https
      --reverse-proxy-config-file <FILE_PATH>
          反向代理配置文件
      --enable-github-proxy
          是否开启github proxy
      --append-upstream-url <https://example.com>
          便捷反向代理配置
          例如:--append-upstream-url=https://cdnjs.cloudflare.com
          则访问 https://your_domain/https://cdnjs.cloudflare.com 会被代理到 https://cdnjs.cloudflare.com
  -h, --help
          Print help

SSL 配置

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

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 以上版本):

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

反向代理配置

[[YOUR_DOMAIN]]
location = "/" # 默认为 /

[YOUR_DOMAIN.upstream]
url_base = "https://www.baidu.com"
version = "H1" # 可以填H1、H2、AUTO,默认为AUTO
headers = [
    ["Host", "${host}"],
] # 可选,覆盖发送给上游服务器的请求头

如果 YOUR_DOMAINdefault_host 则对所有的域名生效。

upstream 配置说明

  • url_base: 上游服务器的基础 URL
  • version: HTTP 版本,可选值为 H1H2AUTO,默认为 AUTO
  • headers: 可选参数,用于覆盖发送给上游服务器的请求头。 支持变量 ${host},分别表示原请求的Host。

例子 1: Github Proxy

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

启动参数中增加 --enable-github-proxy,相当于以下配置:

[[default_host]]
location = "/https://gist.githubusercontent.com"

[default_host.upstream]
url_base = "https://gist.githubusercontent.com"

[[default_host]]
location = "/https://gist.github.com"

[default_host.upstream]
url_base = "https://gist.github.com"

[[default_host]]
location = "/https://github.com"

[default_host.upstream]
url_base = "https://github.com"

[[default_host]]
location = "/https://objects.githubusercontent.com"

[default_host.upstream]
url_base = "https://objects.githubusercontent.com"

[[default_host]]
location = "/https://raw.githubusercontent.com"

[default_host.upstream]
url_base = "https://raw.githubusercontent.com"

[[default_host]]
location = "/https://release-assets.githubusercontent.com"
[default_host.upstream]
url_base = "https://release-assets.githubusercontent.com"

例子 2: 反向代理https://cdnjs.cloudflare.com

启动参数中增加 --append-upstream-url=https://cdnjs.cloudflare.com,相当于以下配置:

[[default_host]]
location = "/https://cdnjs.cloudflare.com"

[default_host.upstream]
url_base = "https://cdnjs.cloudflare.com"

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

[[default_host]]
location = "/v1/chat/completions"

[default_host.upstream]
url_base = "https://models.inference.ai.azure.com/chat/completions"

例子 4: Host 头覆盖 - 当上游服务器需要特定的 Host 头时

[["api.example.com"]]
location = "/api/"

["api.example.com".upstream]
url_base = "http://internal-service:8080"
headers = [
    ["Host", "api.internal.com:8080"],
]  # 覆盖Host头为api.internal.com

[["cdn.example.com"]]
location = "/assets/"

["cdn.example.com".upstream]
url_base = "https://storage.cloud.com"
headers = [
    ["Host", "myapp.storage.com"],
]  # 覆盖Host头为myapp.storage.com

可观测

Prometheus Exporter

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

# 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来创建 Grafana 大盘,效果如下

alt text alt text

Linux 运行时的网速监控

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

客户端

Cargo Features

bpf

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

cargo build --features bpf

需要安装 libbpf-rs 所需的依赖:

ubuntu 22.04 安装:

apt-get install -y libbpf-dev bpftool cmake zlib1g-dev libelf-dev pkg-config clang autoconf autopoint flex bison gawk make

centos stream 9 安装:

yum install -y libbpf zlib-devel elfutils-libelf-devel pkgconf-pkg-config clang bpftool cmake autoconf gettext flex bison gawk make

jemalloc

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

cargo build --features jemalloc

aws_lc_rs

aws_lc_rsringrustls 的两个加密后端。本项目默认使用 ring 作为加密后端,也可选择aws_lc_rs作为加密后端。aws_lc_rs 相比 ring 主要有两点优势:

  1. rustls 的 benchmark 测试中,aws_lc_rs 的性能要优于 ring
  2. 支持美国联邦政府针对加密提出的fips 要求

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

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

激活方式:

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 请求已验证去除以上特征。

代理服务器收到的消息:

Nginx 收到的消息:

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

容器测试

cargo clean
cargo build -r --features bpf_vendored
podman build . -f Dockerfile.test -t test --net host
podman run --rm -it --privileged --net host --pid host test

About

基于Rust的正向代理、反向代理和静态资源托管。 forward proxy、reverse proxy and static file serving

Topics

Resources

License

Unknown, Unknown licenses found

Licenses found

Unknown
LICENSE
Unknown
LICENSE.BSD-2-Clause

Stars

Watchers

Forks

Contributors 2

  •  
  •