fourth

Crates.iofourth
lib.rsfourth
version0.1.5
sourcesrc
created_at2021-10-21 09:07:29.206342
updated_at2021-12-30 14:09:10.812768
descriptionSimple and fast layer 4 proxy in Rust
homepagehttps://github.com/KernelErr/fourth
repositoryhttps://github.com/KernelErr/fourth
max_upload_size
id468385
size101,203
Rui Li (KernelErr)

documentation

README

Fourth

这一波在第四层。

CI

English

积极开发中,0.1版本迭代可能较快

Fourth是一个Rust实现的Layer 4代理,用于监听指定端口TCP/KCP流量,并根据规则转发到指定目标(目前只支持TCP)。

功能

  • 监听指定端口代理到本地或远端指定端口
  • 监听指定端口,通过TLS ClientHello消息中的SNI进行分流
  • 支持KCP入站(警告:未测试)

安装方法

为了确保获得您架构下的最佳性能,请考虑自行编译,首选需要确保您拥有Rust工具链

$ cd fourth
$ cargo build --release

将在target/release/fourth生成二进制文件,您也可以使用cargo install --path . 来安装二进制文件。

或者您也可以使用Cargo直接安装:

$ cargo install fourth

或者您也可以直接从Release中下载二进制文件。

配置

Fourth使用yaml格式的配置文件,默认情况下会读取/etc/fourth/config.yaml,您也可以设置自定义路径到环境变量FOURTH_CONFIG,如下是一个最小有效配置:

version: 1
log: info

servers:
  proxy_server:
    listen:
      - "127.0.0.1:8081"
    default: remote

upstream:
  remote: "tcp://www.remote.example.com:8082" # proxy to remote address

内置两个的upstream:ban(立即中断连接)、echo(返回读到的数据)。更详细的配置可以参考示例配置

注意:[::]会默认同时绑定IPv4和IPv6。

性能测试

在4C2G的服务器上测试:

使用Fourth代理到Nginx(直连QPS 120000): ~70000req/s (测试命令:wrk -t200 -c1000 -d120s --latency http://proxy-server:8081

使用Fourth代理到本地iperf3:8Gbps

io_uring?

尽管经过了很多尝试,我们发现目前一些Rust下面的io_uring实现存在问题,我们使用的io_uring库实现尽管在吞吐量上可以做到单线程20Gbps(相比之下Tokio仅有8Gbps),但在QPS上存在性能损失较大的问题。因此在有成熟的io_uring实现之前,我们仍然选择epoll。之后我们会持续关注相关进展。

可能以后会为Linux高内核版本的用户提供可选的io_uring加速。

感谢

协议

Fourth以Apache-2.0协议开源。

Commit count: 19

cargo fmt