4623a7f031
All checks were successful
Build Multi-Platform Binaries / build (push) Successful in 11m9s
343 lines
11 KiB
Markdown
343 lines
11 KiB
Markdown
# GoTunnel
|
||
|
||
[](https://go.dev/)
|
||
[](LICENSE)
|
||
|
||
一个轻量级、高性能的内网穿透工具，采用服务端集中化管理模式，支持 TLS 加密通信。
|
||
|
||
## 项目简介
|
||
|
||
GoTunnel 是一个类似 frp 的内网穿透解决方案，核心特点是**服务端集中管理配置**和**零配置 TLS 加密**。客户端只需提供认证信息即可自动获取映射规则，无需在客户端维护复杂配置。
|
||
|
||
### 与 frp 的主要区别
|
||
|
||
| 特性 | GoTunnel | frp |
|
||
|------|----------|-----|
|
||
| 配置管理 | 服务端集中管理 | 客户端各自配置 |
|
||
| TLS 证书 | 自动生成，零配置 | 需手动配置 |
|
||
| 管理界面 | 内置 Web 控制台 | 需额外部署 Dashboard |
|
||
| 客户端部署 | 仅需 3 个参数 | 需配置文件 |
|
||
|
||
### 架构设计
|
||
|
||
```
|
||
┌──────────────┐ ┌──────────────────────┐
|
||
│ Client │ Control Channel │ Server │
|
||
│ │ ◄────────────────►│ │
|
||
│ ┌────────┐ │ (Yamux Mux) │ ┌────────────────┐ │
|
||
│ │ Agent │ │ │ │ Control Manager│ │
|
||
│ └────────┘ │ │ └────────────────┘ │
|
||
│ │ │ │ │ │
|
||
│ ▼ │ Data Streams │ ▼ │
|
||
│ ┌────────┐ │ ◄────────────────►│ ┌────────────────┐ │
|
||
│ │ Proxy │ │ │ │ Proxy Listener │ │
|
||
│ └────────┘ │ │ │ :8080,:9090 │ │
|
||
│ │ │ │ └────────────────┘ │
|
||
│ ▼ │ │ ▲ │
|
||
│ ┌────────┐ │ │ │ │
|
||
│ │Local:80│ │ │ External Users │
|
||
│ └────────┘ │ │ │
|
||
└──────────────┘ └──────────────────────┘
|
||
```
|
||
|
||
## 功能特性
|
||
|
||
### 核心功能
|
||
|
||
- **服务端集中管理** - 所有客户端的映射规则由服务端统一配置，客户端零配置
|
||
- **多路复用** - 基于 Yamux 实现控制通道与数据通道分离，高效复用单一 TCP 连接
|
||
- **多客户端支持** - 支持多个客户端同时连接，每个客户端独立的映射规则
|
||
- **端口冲突检测** - 自动检测系统端口占用和客户端间端口冲突
|
||
- **SOCKS5/HTTP 代理** - 支持通过客户端网络访问任意网站
|
||
|
||
### 安全性
|
||
|
||
- **TLS 加密** - 默认启用 TLS 加密，证书自动生成，零配置
|
||
- **Token 认证** - 基于 Token 的身份验证机制
|
||
- **客户端白名单** - 仅配置的客户端 ID 可以连接
|
||
|
||
### 可靠性
|
||
|
||
- **心跳检测** - 可配置的心跳间隔和超时时间，及时发现断线
|
||
- **断线重连** - 客户端自动重连机制，网络恢复后自动恢复服务
|
||
- **优雅关闭** - 客户端断开时自动释放端口资源
|
||
|
||
### Web 管理
|
||
|
||
- **Web 控制台** - 内置 Web 管理界面，可视化管理客户端和规则
|
||
- **实时状态** - 查看客户端在线状态
|
||
- **动态配置** - 在线添加/修改客户端规则
|
||
|
||
## 快速开始
|
||
|
||
### 安装
|
||
|
||
**从源码编译：**
|
||
|
||
```bash
|
||
git clone https://github.com/your-repo/gotunnel.git
|
||
cd gotunnel
|
||
go build -o server ./cmd/server
|
||
go build -o client ./cmd/client
|
||
```
|
||
|
||
**下载预编译二进制：**
|
||
|
||
从 Releases 页面下载对应平台的二进制文件。
|
||
|
||
### 服务端启动
|
||
|
||
```bash
|
||
# 零配置启动（自动生成 Token，启用 TLS 和 Web 控制台）
|
||
./server
|
||
|
||
# 或指定配置文件
|
||
./server -c server.yaml
|
||
```
|
||
|
||
首次启动会自动：
|
||
- 生成随机 Token（打印在日志中）
|
||
- 启用 TLS 加密（证书在内存中自动生成）
|
||
- 启动 Web 控制台（默认 http://localhost:7500）
|
||
- 创建 SQLite 数据库存储客户端配置
|
||
|
||
### 客户端启动
|
||
|
||
```bash
|
||
./client -s <服务器IP>:7000 -t <Token> -id <客户端ID>
|
||
```
|
||
|
||
**参数说明：**
|
||
|
||
| 参数 | 说明 | 必填 |
|
||
|------|------|------|
|
||
| `-s` | 服务器地址 (ip:port) | 是 |
|
||
| `-t` | 认证 Token | 是 |
|
||
| `-id` | 客户端 ID（需与服务端配置匹配） | 否（自动生成） |
|
||
| `-no-tls` | 禁用 TLS 加密 | 否 |
|
||
|
||
## 配置系统
|
||
|
||
服务端使用 YAML 配置文件 + SQLite 数据库管理。YAML 配置服务端参数，SQLite 存储客户端规则。
|
||
|
||
### 配置文件示例
|
||
|
||
```yaml
|
||
# server.yaml
|
||
server:
|
||
bind_addr: "0.0.0.0" # 监听地址
|
||
bind_port: 7000 # 监听端口
|
||
token: "your-secret-token" # 认证 Token（不配置则自动生成）
|
||
heartbeat_sec: 30 # 心跳间隔（秒）
|
||
heartbeat_timeout: 90 # 心跳超时（秒）
|
||
db_path: "gotunnel.db" # 数据库路径
|
||
tls_disabled: false # 是否禁用 TLS（默认启用）
|
||
|
||
web:
|
||
enabled: true # 启用 Web 控制台
|
||
bind_addr: "0.0.0.0"
|
||
bind_port: 7500
|
||
username: "admin" # 可选，设置后启用认证
|
||
password: "password"
|
||
```
|
||
|
||
### 配置参数说明
|
||
|
||
**Server 配置：**
|
||
|
||
| 参数 | 类型 | 默认值 | 说明 |
|
||
|------|------|--------|------|
|
||
| `bind_addr` | string | 0.0.0.0 | 服务端监听地址 |
|
||
| `bind_port` | int | 7000 | 服务端监听端口 |
|
||
| `token` | string | 自动生成 | 客户端认证 Token |
|
||
| `heartbeat_sec` | int | 30 | 心跳发送间隔（秒） |
|
||
| `heartbeat_timeout` | int | 90 | 心跳超时时间（秒） |
|
||
| `db_path` | string | gotunnel.db | SQLite 数据库路径 |
|
||
| `tls_disabled` | bool | false | 是否禁用 TLS |
|
||
|
||
**Web 配置：**
|
||
|
||
| 参数 | 类型 | 默认值 | 说明 |
|
||
|------|------|--------|------|
|
||
| `enabled` | bool | true | 是否启用 Web 控制台 |
|
||
| `bind_addr` | string | 0.0.0.0 | Web 监听地址 |
|
||
| `bind_port` | int | 7500 | Web 监听端口 |
|
||
| `username` | string | - | 认证用户名（可选） |
|
||
| `password` | string | - | 认证密码（可选） |
|
||
|
||
## 代理规则类型
|
||
|
||
通过 Web 控制台配置客户端规则时，支持以下类型：
|
||
|
||
### 内置类型
|
||
|
||
| 类型 | 说明 | 示例用途 |
|
||
|------|------|----------|
|
||
| `tcp` | TCP 端口转发（默认） | SSH、MySQL、Web 服务 |
|
||
| `udp` | UDP 端口转发 | DNS、游戏服务器、VoIP |
|
||
| `http` | HTTP 代理 | 通过客户端网络访问 HTTP/HTTPS |
|
||
| `https` | HTTPS 代理 | 同 HTTP，支持 CONNECT 方法 |
|
||
|
||
### 插件类型
|
||
|
||
| 类型 | 说明 | 示例用途 |
|
||
|------|------|----------|
|
||
| `socks5` | SOCKS5 代理（官方插件） | 通过客户端网络访问任意地址 |
|
||
|
||
**规则配置示例（通过 Web API）：**
|
||
|
||
```json
|
||
{
|
||
"id": "client-a",
|
||
"rules": [
|
||
{"name": "web", "type": "tcp", "local_ip": "127.0.0.1", "local_port": 80, "remote_port": 8080},
|
||
{"name": "dns", "type": "udp", "local_ip": "127.0.0.1", "local_port": 53, "remote_port": 5353},
|
||
{"name": "socks5-proxy", "type": "socks5", "remote_port": 1080},
|
||
{"name": "http-proxy", "type": "http", "remote_port": 8888}
|
||
]
|
||
}
|
||
```
|
||
|
||
## 项目结构
|
||
|
||
```
|
||
GoTunnel/
|
||
├── cmd/
|
||
│ ├── server/main.go # 服务端入口
|
||
│ └── client/main.go # 客户端入口
|
||
├── internal/
|
||
│ ├── server/
|
||
│ │ ├── tunnel/ # 隧道服务
|
||
│ │ ├── config/ # 配置管理
|
||
│ │ ├── db/ # 数据库存储
|
||
│ │ ├── app/ # Web 服务
|
||
│ │ ├── router/ # API 路由
|
||
│ │ └── plugin/ # 服务端插件管理
|
||
│ └── client/
|
||
│ ├── tunnel/ # 客户端隧道
|
||
│ └── plugin/ # 客户端插件管理和缓存
|
||
├── pkg/
|
||
│ ├── protocol/ # 通信协议
|
||
│ ├── crypto/ # TLS 加密
|
||
│ ├── proxy/ # 代理服务器
|
||
│ ├── relay/ # 数据转发
|
||
│ ├── utils/ # 工具函数
|
||
│ └── plugin/ # 插件系统核心
|
||
│ ├── builtin/ # 内置插件 (socks5)
|
||
│ ├── wasm/ # WASM 运行时 (wazero)
|
||
│ └── store/ # 插件持久化 (SQLite)
|
||
├── web/ # Vue 3 前端
|
||
└── go.mod
|
||
```
|
||
|
||
## 插件系统
|
||
|
||
GoTunnel 支持基于 WASM 的插件系统，可扩展代理协议支持。
|
||
|
||
### 架构设计
|
||
|
||
- **内置类型**: tcp, udp, http, https 直接在 tunnel 代码中处理，无需插件
|
||
- **官方插件**: SOCKS5 作为官方插件提供
|
||
- **WASM 插件**: 自定义插件可通过 wazero 运行时动态加载
|
||
- **混合分发**: 内置插件离线可用；WASM 插件可从服务端下载
|
||
|
||
### 开发自定义插件
|
||
|
||
插件需实现 `ProxyHandler` 接口：
|
||
|
||
```go
|
||
type ProxyHandler interface {
|
||
Metadata() PluginMetadata
|
||
Init(config map[string]string) error
|
||
HandleConn(conn net.Conn, dialer Dialer) error
|
||
Close() error
|
||
}
|
||
```
|
||
|
||
参考实现：`pkg/plugin/builtin/socks5.go`
|
||
|
||
## Web API
|
||
|
||
Web 控制台提供 RESTful API 用于管理客户端和配置。
|
||
|
||
### 客户端管理
|
||
|
||
```bash
|
||
# 获取所有客户端
|
||
GET /api/clients
|
||
|
||
# 添加客户端
|
||
POST /api/clients
|
||
Content-Type: application/json
|
||
{"id": "client-a", "rules": [...]}
|
||
|
||
# 获取单个客户端
|
||
GET /api/client/{id}
|
||
|
||
# 更新客户端规则
|
||
PUT /api/client/{id}
|
||
Content-Type: application/json
|
||
{"rules": [...]}
|
||
|
||
# 删除客户端
|
||
DELETE /api/client/{id}
|
||
```
|
||
|
||
### 服务状态
|
||
|
||
```bash
|
||
# 获取服务状态
|
||
GET /api/status
|
||
|
||
# 获取配置
|
||
GET /api/config
|
||
|
||
# 重载配置
|
||
POST /api/config/reload
|
||
```
|
||
|
||
## 使用场景
|
||
|
||
### 场景一：暴露内网 Web 服务
|
||
|
||
```bash
|
||
# 服务端配置客户端规则（通过 Web 控制台或 API）
|
||
curl -X POST http://server:7500/api/clients \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"id":"home","rules":[{"name":"web","type":"tcp","local_ip":"127.0.0.1","local_port":80,"remote_port":8080}]}'
|
||
|
||
# 客户端连接
|
||
./client -s server:7000 -t <token> -id home
|
||
|
||
# 访问：http://server:8080 -> 内网 127.0.0.1:80
|
||
```
|
||
|
||
### 场景二：SOCKS5 代理访问内网
|
||
|
||
```bash
|
||
# 配置 SOCKS5 代理规则
|
||
{"name":"proxy","type":"socks5","remote_port":1080}
|
||
|
||
# 使用代理
|
||
curl --socks5 server:1080 http://internal-service/
|
||
```
|
||
|
||
## 常见问题
|
||
|
||
**Q: 客户端连接失败，提示 "client not configured"**
|
||
|
||
A: 需要先在服务端 Web 控制台添加对应的客户端 ID。
|
||
|
||
**Q: 如何禁用 TLS？**
|
||
|
||
A: 服务端配置 `tls_disabled: true`，客户端使用 `-no-tls` 参数。
|
||
|
||
**Q: 端口被占用怎么办？**
|
||
|
||
A: 服务端会自动检测端口冲突，请检查日志并更换端口。
|
||
|
||
## 许可证
|
||
|
||
本项目采用 [MIT License](LICENSE) 开源许可证。
|
||
|