8000 GitHub - yangchaoliuyang/frp-mini: frp-mini 是frp的精简版实现,使用 Rust 编写。内存仅占用6M,保留核心代理功能,支持 TCP、TCP-Mux 和 QUIC 传输协议,额外增加 IP 白名单访问控制。 · GitHub
[go: up one dir, main page]

Skip to content
yangchaoliuyangPublic

About

frp-mini 是frp的精简版实现,使用 Rust 编写。内存仅占用6M,保留核心代理功能,支持 TCP、TCP-Mux 和 QUIC 传输协议,额外增加 IP 白名单访问控制。

Resources

Stars

3 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

frp-mini

frp-mini 是frp的精简版实现,使用 Rust 编写。内存仅占用6M,保留核心代理功能,支持 TCP、TCP-Mux 和 QUIC 传输协议,额外增加 IP 白名单访问控制。

特性

  • TCP 代理 — 标准的 TCP 端口转发
  • TCPMux 代理 — 基于 HTTP CONNECT 的虚拟主机路由,按 CONNECT 目标域名路由到不同后端
  • HTTP 代理 — 基于 Host header 的虚拟主机路由,按域名路由到不同后端
  • UDP 代理 — UDP 端口转发(通过 workConn pipe 模型)
  • HTTPS 代理 — 基于 SNI 的虚拟主机路由,支持通配符域名和子域名
  • STCP 代理 — Secret TCP 代理,通过 visitor 建立安全 TCP 连接
  • SUDP 代理 — Secret UDP 代理,通过 visitor 建立安全 UDP 连接
  • 多种传输协议 — TCP、TCP-Mux(yamux 多路复用)、QUIC
  • IP 白名单 — 限制代理访问来源,Web 面板支持动态添加
  • Web 管理面板 — 实时监控会话、代理状态、流量统计、访问日志
  • 连接池 — 可配置的工作连接池,降低代理延迟
  • 认证 — Token 认证机制

快速开始

构建

cargo build --release

构建产物位于 target/release/ 目录下的 frpc 和 frps。

服务端

./frps -c frps.toml

打开浏览器访问 http://<服务器IP>:7500 进入 Web 管理面板。

客户端

./frpc -c frpc.toml

跨平台构建(requires cargo-zigbuild)

# aarch64 Linux
cargo zigbuild --release --target aarch64-unknown-linux-musl

# x86_64 Linux
cargo zigbuild --release --target x86_64-unknown-linux-musl

配置说明

服务端配置 frps.toml

# 监听地址和端口
bindAddr = "0.0.0.0"
bindPort = 6000

# QUIC 协议监听端口(不设置则禁用)
quicBindPort = 6001

# HTTPS 虚拟主机端口(用于 https 类型代理)
vhostHTTPSPort = 7002

# HTTP 虚拟主机端口(用于 http 类型代理)
vhostHTTPPort = 7003

# TCPMux HTTP Connect 端口(用于 tcpmux 类型代理)
tcpmuxHttpConnectPort = 13000

# 子域名主机
subDomainHost = "example.com"

# 客户端最大代理数量(0 表示不限制)
maxPortsPerClient = 0

# 用户连接获取工作连接的超时时间(秒)
userConnTimeout = 10

# Web 管理面板
webServer.addr = "0.0.0.0"
webServer.port = 7500
webServer.user = "admin"
webServer.password = "admin"

# 认证
auth.method = "token"
auth.token = "your-secret-token"

# 传输层
transport.tcpMux = false
transport.maxPoolCount = 5
transport.heartbeatTimeout = 90

# IP 白名单(逗号分隔,空表示允许所有)
allow_ips = "192.168.1.0,127.0.0.1"

客户端配置 frpc.toml

# 用户标识
user = "my-client"

# 服务端地址
serverAddr = "127.0.0.1"
serverPort = 6000

# 认证
auth.method = "token"
auth.token = "your-secret-token"

# 传输层
transport.protocol = "tcp"
transport.tcpMux = false
transport.poolCount = 5

# TCP 代理
[[proxies]]
name = "web"
type = "tcp"
localIP = "127.0.0.1"
localPort = 80
remotePort = 7000

# UDP 代理
[[proxies]]
name = "dns"
type = "udp"
localIP = "8.8.8.8"
localPort = 53
remotePort = 7004

# TCPMux 代理(HTTP CONNECT 路由)
[[proxies]]
name = "tcpmux-web"
type = "tcpmux"
subdomain = "tcpmux-web"
localIP = "127.0.0.1"
localPort = 80

# HTTP 代理(Host header 路由)
[[proxies]]
name = "http-web"
type = "http"
subdomain = "http-web"
localIP = "127.0.0.1"
localPort = 80

# HTTPS 代理(SNI 路由)

[[proxies]]
name = "https-web"
type = "https"
customDomains = ["web.example.com"]
plugin.type = "https2http"
plugin.localAddr = "127.0.0.1:80"
plugin.crtPath = "server.crt"
plugin.keyPath = "server.key"

# STCP 代理(不绑定真实端口,通过 visitor 访问)
[[proxies]]
name = "stcp-test"
type = "stcp"
localIP = "127.0.0.1"
localPort = 80
sk = "your-secret-key"

# SUDP 代理(不绑定真实端口,通过 visitor 访问)
[[proxies]]
name = "sudp-test"
type = "sudp"
localIP = "127.0.0.1"
localPort = 53
sk = "your-secret-key"

Visitor 客户端配置 frpc_visitor.toml

# 用户标识
user = "visitor"

# 服务端地址
serverAddr = "127.0.0.1"
serverPort = 6000

# 认证
auth.method = "token"
auth.token = "your-secret-token"

# 传输层
transport.protocol = "tcp"
transport.poolCount = 3

# Visitor 列表
[[visitors]]
name = "stcp-test-visitor"
type = "stcp"
serverName = "stcp-test"
serverUser = "my-client"
sk = "your-secret-key"
bindAddr = "127.0.0.1"
bindPort = 9001

[[visitors]]
name = "sudp-test-visitor"
type = "sudp"
serverName = "sudp-test"
serverUser = "my-client"
sk = "your-secret-key"
bindAddr = "127.0.0.1"
bindPort = 9002

代理类型

TCP 代理

标准的 TCP 端口转发。用户访问 服务端IP:remotePort,流量转发到 localIP:localPort。

TCPMux 代理

基于 HTTP CONNECT 的虚拟主机路由。服务端在 tcpmuxHTTPConnectPort 监听,解析 CONNECT 请求的目标域名,将流量路由到对应代理。支持:

  • 自定义域名 — customDomains = ["a.example.com", "b.example.com"]
  • 子域名 — subdomain = "test" → test.{subDomainHost}
  • 通配符域名 — customDomains = ["*.example.com"]

使用浏览器或 curl,配置 HTTP 代理为 tcpmuxHTTPConnectPort,即可通过 CONNECT 隧道访问后端服务。

HTTP 代理

基于 Host header 的虚拟主机路由。服务端在 vhostHTTPPort 监听,解析 HTTP 请求的 Host header,将流量路由到对应代理。支持:

  • 自定义域名 — customDomains = ["a.example.com", "b.example.com"]
  • 子域名 — subdomain = "test" → test.{subDomainHost}
  • 通配符域名 — customDomains = ["*.example.com"]

HTTPS 代理

基于 SNI 的虚拟主机路由。服务端在 vhostHTTPSPort 监听,根据 TLS ClientHello 中的 SNI 将流量路由到对应代理。支持:

  • 自定义域名 — customDomains = ["a.example.com", "b.example.com"]
  • 子域名 — subdomain = "test" → test.{subDomainHost}
  • 通配符域名 — customDomains = ["*.example.com"]

客户端使用 https2http 插件进行 TLS 终止,将原始 HTTPS 流量转为 HTTP 请求转发到本地服务。

STCP 代理(Secret TCP)

不绑定真实端口,通过 visitor 建立安全 TCP 连接。只有持有相同密钥的 visitor 才能访问目标服务。

  • frpc(服务端) — 注册 STCP 代理,绑定 sk(密钥)
  • frpc_visitor(客户端) — 绑定本地端口,用户连接后通过 visitor TCP → frps → frpc → 本地服务

SUDP 代理(Secret UDP)

不绑定真实端口,通过 visitor 建立安全 UDP 连接。原理同 STCP,但底层使用 UDP 数据包格式。

  • frpc(服务端) — 注册 SUDP 代理,绑定 sk(密钥)
  • frpc_visitor(客户端) — 绑定本地 UDP 端口,dispatcher 循环等待首包 → 60s timeout 后关闭 worker 等待下一轮

传输协议

协议 说明
TCP 每个控制/工作连接使用独立的 TCP 连接
TCP-Mux 基于 yamux 的多路复用,在单个 TCP 连接上复用多个虚拟连接
QUIC 基于 UDP 的 QUIC 协议,自带多路复用和加密

通过 transport.protocol = "tcp" / "quic" 切换协议。设置 transport.tcpMux = true 在 TCP 基础上启用 yamux 多路复用。

IP 白名单

通过 allow_ips 配置逗号分隔的 IP 列表,限制可以访问代理的用户 IP。空值表示允许所有连接。

在 Web 管理面板的 API 中可以通过 POST /api/allow_ip 动态添加 IP,无需重启服务。

白名单检查在以下入口点生效:

  • TCP 代理:用户连接到达代理监听器时
  • HTTPS 代理:vhost Muxer 解析 SNI 之前
  • HTTP 代理:vhost HTTP Muxer 解析 Host 之前
  • TCPMux 代理:vhost TCPMux Muxer 解析 CONNECT 之前

Web 管理面板

启动后访问 http://<服务器IP>:<webServer.port>。

功能:

  • 登录认证(用户名 + 密码,Session 有效期 24 小时)
  • 实时查看在线客户端和代理状态
  • 流量统计(全局 + 按代理)
  • 访问日志(IP 白名单拦截记录)
  • 动态添加 IP 白名单

API:

  • POST /api/login — 登录
  • POST /api/logout — 登出
  • GET /api/status — 会话/代理/流量/日志/白名单
  • GET /api/myip — 获取当前请求的 IP
  • POST /api/allow_ip — 添加 IP 白名单

与 frp 的对齐

frp-mini 忠实于 Go 版本 frp 的源代码,模块和函数命名尽量与 Go 版本对齐:

Go frp 模块 frp-mini 模块
server/service.go server::service
server/control.go server::control
server/proxy/ server::proxy
client/service.go client::service
client/control.go client::control
client/visitor/ client::visitor
pkg/msg/ msg
pkg/net/ conn
libio.Join io::forward_server
pkg/util/vhost/https.go server::vhost
pkg/util/vhost/http.go server::vhost (HTTP Muxer)
pkg/util/tcpmux/httpconnect.go server::vhost (TCPMux Muxer)
pkg/metrics/mem/ server::metrics

技术栈

  • 运行时 — tokio(异步运行时)
  • 网络 — quinn(QUIC)、tokio-yamux(TCP-Mux)
  • TLS — rustls + rcgen(自签名证书生成)
  • Web 框架 — warp(HTTP 服务)
  • 配置 — TOML 格式
  • 插件 — axum + axum-reverse-proxy(HTTPS2HTTP 反向代理)
  • 加密/编码 — data-encoding(Base64,TCPMux Basic auth 解码)

与完整 frp 的差异

frp-mini 是精简版,仅保留核心功能:

功能 frp-mini frp
TCP 代理 ✅ ✅
UDP 代理 ✅ ✅
HTTPS 代理 ✅ ✅
HTTP 代理 ✅ ✅
TCPMux 代理 ✅ ✅
STCP/XTCP 代理 ✅/❌ ✅/✅
SUDP 代理 ✅ ✅
P2P 代理 ❌ ✅
传输加密 ❌ ✅
传输压缩 ❌ ✅
IP 白名单 ✅(扩展) ❌

License

本项目参考 frp 的实现,frp 使用 MIT 协议开源。frp-mini 作为独立实现,遵循 MIT 协议。

About

frp-mini 是frp的精简版实现,使用 Rust 编写。内存仅占用6M,保留核心代理功能,支持 TCP、TCP-Mux 和 QUIC 传输协议,额外增加 IP 白名单访问控制。

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

0