layer4-proxy/README.md

85 lines
2.4 KiB
Markdown
Raw Normal View History

2021-10-21 08:43:59 +00:00
# Fourth
> 这一波在第四层。
2021-10-25 14:29:02 +00:00
[![](https://img.shields.io/crates/v/fourth)](https://crates.io/crates/fourth) [![CI](https://img.shields.io/github/workflow/status/kernelerr/fourth/Rust)](https://github.com/KernelErr/fourth/actions/workflows/rust.yml)
2021-10-21 08:43:59 +00:00
[English](/README-EN.md)
2021-10-26 15:58:00 +00:00
**积极开发中0.1版本迭代可能较快**
2021-10-26 13:36:12 +00:00
Fourth是一个Rust实现的Layer 4代理用于监听指定端口TCP/KCP流量并根据规则转发到指定目标目前只支持TCP
2021-10-21 08:43:59 +00:00
## 功能
- 监听指定端口代理到本地或远端指定端口
- 监听指定端口通过TLS ClientHello消息中的SNI进行分流
2021-10-26 15:02:05 +00:00
- 支持KCP入站警告未测试
2021-10-21 08:43:59 +00:00
## 安装方法
为了确保获得您架构下的最佳性能,请考虑自行编译,首选需要确保您拥有[Rust工具链](https://rustup.rs/)。
```bash
$ cd fourth
$ cargo build --release
```
将在`target/release/fourth`生成二进制文件,您也可以使用`cargo install --path . `来安装二进制文件。
2021-10-26 13:40:40 +00:00
或者您也可以使用Cargo直接安装
```bash
$ cargo install fourth
```
2021-10-21 08:43:59 +00:00
## 配置
Fourth使用yaml格式的配置文件默认情况下会读取`/etc/fourth/config.yaml`,如下是一个示例配置。
```yaml
version: 1
log: info
servers:
example_server:
listen:
- "0.0.0.0:443"
- "[::]:443"
2021-10-26 13:36:12 +00:00
tls: true # Enable TLS features like SNI filtering
2021-10-21 08:43:59 +00:00
sni:
proxy.example.com: proxy
www.example.com: nginx
default: ban
2021-10-26 13:36:12 +00:00
proxy_server:
2021-10-21 08:43:59 +00:00
listen:
- "127.0.0.1:8081"
default: remote
2021-10-26 13:36:12 +00:00
kcp_server:
protocol: kcp # default TCP
listen:
- "127.0.0.1:8082"
default: echo
2021-10-21 08:43:59 +00:00
upstream:
nginx: "127.0.0.1:8080"
proxy: "127.0.0.1:1024"
2021-10-26 15:27:03 +00:00
remote: "www.remote.example.com:8082" # proxy to remote address
2021-10-21 08:43:59 +00:00
```
2021-10-25 14:29:02 +00:00
内置两个的upstreamban立即中断连接、echo返回读到的数据
2021-10-21 08:43:59 +00:00
## io_uring?
尽管经过了很多尝试我们发现目前一些Rust下面的io_uring实现存在问题我们使用的io_uring库实现尽管在吞吐量上可以做到单线程20Gbps相比之下Tokio仅有8Gbps但在QPS上存在性能损失较大的问题。因此在有成熟的io_uring实现之前我们仍然选择epoll。之后我们会持续关注相关进展。
可能以后会为Linux高内核版本的用户提供可选的io_uring加速。
2021-10-26 15:02:05 +00:00
## 感谢
- [tokio_kcp](https://github.com/Matrix-Zhang/tokio_kcp)
2021-10-21 08:43:59 +00:00
## 协议
Fourth以Apache-2.0协议开源。