From 30aa7cbf8e56c196d3d4624e679a6ce8df881b0f Mon Sep 17 00:00:00 2001 From: loyalsoldier <10487845+Loyalsoldier@users.noreply.github.com> Date: Wed, 10 Mar 2021 10:44:12 +0800 Subject: [PATCH] Chore: refine README --- README.md | 274 ++++++++++++++++++++---------------------------------- 1 file changed, 103 insertions(+), 171 deletions(-) diff --git a/README.md b/README.md index 3b35ecc6d..3b7686e2a 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,52 @@ -# Trojan-Go +# Trojan-Go [![Go Report Card](https://goreportcard.com/badge/github.com/p4gefau1t/trojan-go)](https://goreportcard.com/report/github.com/p4gefau1t/trojan-go) [![HitCounts](http://hits.dwyl.io/p4gefau1t/trojan-go.svg)](http://hits.dwyl.io/p4gefau1t/trojan-go) [![Downloads](https://img.shields.io/github/downloads/p4gefau1t/trojan-go/total?label=downloads&logo=github&style=flat-square)](https://img.shields.io/github/downloads/p4gefau1t/trojan-go/total?label=downloads&logo=github&style=flat-square) -[![License](https://img.shields.io/github/license/p4gefau1t/trojan-go)](https://img.shields.io/github/license/p4gefau1t/trojan-go) -[![Downloads](https://img.shields.io/github/downloads/p4gefau1t/trojan-go/total?label=downloads&logo=github&style=flat-square)](https://img.shields.io/github/downloads/p4gefau1t/trojan-go/total?label=downloads&logo=github&style=flat-square) -[![HitCounts](http://hits.dwyl.io/p4gefau1t/trojan-go.svg)](http://hits.dwyl.io/p4gefau1t/trojan-go) -[![Release](https://img.shields.io/github/v/release/p4gefau1t/trojan-go?include_prereleases)](https://img.shields.io/github/v/release/p4gefau1t/trojan-go?include_prereleases) -[![Release Date](https://img.shields.io/github/release-date-pre/p4gefau1t/trojan-go)](https://img.shields.io/github/release-date-pre/p4gefau1t/trojan-go) -[![Docker Image](https://images.microbadger.com/badges/image/p4gefau1t/trojan-go.svg)](https://hub.docker.com/r/p4gefau1t/trojan-go) +使用 Go 实现的完整 Trojan 代理，兼容原版 Trojan 协议及配置文件格式。安全、高效、轻巧、易用。 -[![Commit](https://img.shields.io/github/last-commit/p4gefau1t/trojan-go)](https://img.shields.io/github/last-commit/p4gefau1t/trojan-go) -[![Commit Activity](https://img.shields.io/github/commit-activity/m/p4gefau1t/trojan-go)](https://img.shields.io/github/commit-activity/m/p4gefau1t/trojan-go) -[![Go Report Card](https://goreportcard.com/badge/github.com/p4gefau1t/trojan-go)](https://goreportcard.com/report/github.com/p4gefau1t/trojan-go) -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/p4gefau1t/trojan-go/pulls) +Trojan-Go 支持[多路复用](#多路复用)提升并发性能；使用[路由模块](#路由模块)实现国内外分流；支持 [CDN 流量中转](#Websocket)(基于 WebSocket over TLS)；支持使用 AEAD 对 Trojan 流量进行[二次加密](#aead-加密)(基于 Shadowsocks AEAD)；支持可插拔的[传输层插件](#传输层插件)，允许替换 TLS，使用其他加密隧道传输 Trojan 协议流量。 -使用Go实现的完整Trojan代理，与Trojan协议以及Trojan版本的配置文件格式兼容。安全，高效，轻巧，易用。 +预编译二进制可执行文件可在 [Release 页面](https://github.com/p4gefau1t/trojan-go/releases)下载。解压后即可直接运行，无其他组件依赖。 -支持使用[多路复用](#多路复用)提升并发性能，使用[路由模块](#路由模块)实现国内直连。 +如遇到配置和使用问题、发现 bug，或是有更好的想法，欢迎加入 [Telegram 交流反馈群](https://t.me/trojan_go_chat)。 -支持[CDN流量中转](#Websocket)(基于WebSocket over TLS/SSL)。 +## 简介 -支持使用AEAD对Trojan流量[二次加密](#AEAD)(基于Shadowsocks AEAD) +**完整介绍和配置教程，参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。** -支持可插拔的[传输层插件](#传输层插件)，允许替换TLS，使用其他加密隧道传输Trojan协议流量。 +Trojan-Go 兼容原版 Trojan 的绝大多数功能，包括但不限于： -预编译的版本可在[Release 页面](https://github.com/p4gefau1t/trojan-go/releases)下载。直接运行解压得到的执行文件即可，无其他组件依赖。 +- TLS 隧道传输 +- UDP 代理 +- 透明代理 (NAT 模式，iptables 设置参考[这里](https://github.com/shadowsocks/shadowsocks-libev/tree/v3.3.1#transparent-proxy)) +- 对抗 GFW 被动检测 / 主动检测的机制 +- MySQL 数据持久化方案 +- MySQL 用户权限认证 +- 用户流量统计和配额限制 -如果你遇到配置和使用方面的问题，发现了软件Bug，或是有更好的想法，欢迎加入Trojan-Go的[Telegram交流反馈群](https://t.me/trojan_go_chat)。 +同时，Trojan-Go 还扩展实现了更多高效易用的功能特性： -## **下面的说明为简单介绍，完整配置教程和配置介绍参见[Trojan-Go文档](https://p4gefau1t.github.io/trojan-go)。** - -Trojan-Go支持并且兼容原版Trojan的绝大多数功能，包括但不限于： - -- TLS/SSL隧道传输 - -- 透明代理 (NAT模式，iptables设置参见[这里](https://github.com/shadowsocks/shadowsocks-libev/tree/v3.3.1#transparent-proxy)) - -- UDP代理 - -- 对抗GFW被动/主动检测的机制 - -- MySQL数据库支持 - -- 流量统计，用户流量配额限制 - -- 从数据库中的用户列表进行认证 - -同时，Trojan-Go还扩展了更多高效易用的功能特性： - -- 简易模式，快速部署使用 - -- Socks5/HTTP代理自动适配 - -- 基于tproxy的透明代理(TCP/UDP) - -- 多平台和多操作系统支持，无特殊依赖 - -- 基于多路复用(smux)降低延迟，提升并发性能 - -- 自定义路由模块，可实现国内直连/广告屏蔽等功能 - -- Websocket传输支持，用于实现CDN流量中转(基于WebSocket over TLS/SSL)和对抗GFW中间人攻击 - -- TLS指纹伪造，绕过GFW针对TLS Client Hello的特征识别 - -- 基于gRPC的API支持，支持动态用户管理和流量速度限制等 - -- 可插拔传输层，可将TLS替换为其他协议或明文传输。同时有完整的Shadowsocks混淆插件支持 - -- 支持对人类更友好的YAML配置文件格式 +- 便于快速部署的「简易模式」 +- Socks5 / HTTP 代理自动适配 +- 基于 TProxy 的透明代理（TCP / UDP） +- 全平台支持，无特殊依赖 +- 基于多路复用（smux）降低延迟，提升并发性能 +- 自定义路由模块，可实现国内外分流 / 广告屏蔽等功能 +- Websocket 传输支持，以实现 CDN 流量中转（基于 WebSocket over TLS）和对抗 GFW 中间人攻击 +- TLS 指纹伪造，以对抗 GFW 针对 TLS Client Hello 的特征识别 +- 基于 gRPC 的 API 支持，以实现用户管理和速度限制等 +- 可插拔传输层，可将 TLS 替换为其他协议或明文传输，同时有完整的 Shadowsocks 混淆插件支持 +- 支持对用户更友好的 YAML 配置文件格式 ## 图形界面客户端 -Trojan-Go服务端可以兼容所有原Trojan客户端，如Igniter，ShadowRocket等。 - -下面是支持Trojan-Go扩展特性（Websocket/Mux等）的客户端。 - -[Trojan-Qt5](https://github.com/Trojan-Qt5/Trojan-Qt5/)，跨平台客户端，支持Windows/macOS/Linux，使用Trojan-Go核心，支持所有Trojan-Go扩展特性。 - -[Qv2ray](https://github.com/Qv2ray/Qv2ray)，跨平台客户端，支持Windows/macOS/Linux，使用Trojan-Go核心，支持所有Trojan-Go扩展特性。 +Trojan-Go 服务端兼容所有原 Trojan 客户端，如 Igniter、ShadowRocket 等。以下是支持 Trojan-Go 扩展特性（Websocket / Mux 等）的客户端： -[Igniter-Go](https://github.com/p4gefau1t/trojan-go-android)，安卓客户端，Fork自Igniter，将Igniter核心替换为Trojan-Go并做了一定修改，支持所有Trojan-Go扩展特性。 +- [Trojan-Qt5](https://github.com/Trojan-Qt5/Trojan-Qt5/)：跨平台客户端，支持 Windows / macOS / Linux，使用 Trojan-Go 核心，支持所有 Trojan-Go 扩展特性。 +- [Qv2ray](https://github.com/Qv2ray/Qv2ray)：跨平台客户端，支持 Windows / macOS / Linux，使用 Trojan-Go 核心，支持所有 Trojan-Go 扩展特性。 +- [Igniter-Go](https://github.com/p4gefau1t/trojan-go-android)：Android 客户端，Fork 自 Igniter，将 Igniter 核心替换为 Trojan-Go 并做了一定修改，支持所有 Trojan-Go 扩展特性。 ## 使用方法 -1. 快速启动服务器和客户端（简易模式） +1. 快速启动服务端和客户端（简易模式） - 服务端 @@ -96,19 +60,19 @@ Trojan-Go服务端可以兼容所有原Trojan客户端，如Igniter，ShadowRock ./trojan-go -client -remote example.com:443 -local 127.0.0.1:1080 -password your_password ``` -2. 使用配置文件启动客户端/服务端/透明代理/中继（一般模式） +2. 使用配置文件启动客户端 / 服务端 / 透明代理 / 中继（一般模式） ```shell ./trojan-go -config config.json ``` -3. 使用URL启动客户端（格式参见文档） +3. 使用 URL 启动客户端（格式参见文档） ```shell ./trojan-go -url 'trojan-go://password@cloudflare.com/?type=ws&path=%2Fpath&host=your-site.com' - ```` + ``` -4. 使用Docker部署 +4. 使用 Docker 部署 ```shell docker run \ @@ -119,7 +83,7 @@ Trojan-Go服务端可以兼容所有原Trojan客户端，如Igniter，ShadowRock p4gefau1t/trojan-go ``` - 或者 + 或者 ```shell docker run \ @@ -131,74 +95,60 @@ Trojan-Go服务端可以兼容所有原Trojan客户端，如Igniter，ShadowRock /path/in/container/config.json ``` - 镜像的latest标签对应master分支，nightly标签对应dev分支。 - ## 特性 -一般情况下，Trojan-Go和Trojan是互相兼容的。但是一旦使用下面介绍的扩展特性（如多路复用，Websocket等），则无法与之兼容。 +一般情况下，Trojan-Go 和 Trojan 是互相兼容的，但一旦使用下面介绍的扩展特性（如多路复用、Websocket 等），则无法兼容。 ### 移植性 -运行Trojan-Go的可执行文件不依赖其他组件。 - -可以将编译得到的单个可执行文件在目标机器上直接执行而不需要考虑依赖的问题。同时，你可以很方便地编译（或者交叉编译）它，然后在你的服务器，PC，树莓派，甚至路由器上部署。可以方便地使用build tag删减各模块，以缩小可执行文件体积。 +编译得到的 Trojan-Go 单个可执行文件不依赖其他组件。同时，你可以很方便地编译（或交叉编译） Trojan-Go，然后在你的服务器、PC、树莓派，甚至路由器上部署；可以方便地使用 build tag 删减模块，以缩小可执行文件体积。 -例如，交叉编译一个在mips处理器，linux操作系统上运行的，只有客户端功能的Trojan-Go，只需执行下面的命令即可 +例如，交叉编译一个可在 mips 处理器、Linux 操作系统上运行的、只有客户端功能的 Trojan-Go，只需执行下面的命令，得到的可执行文件可以直接在目标平台运行： ```shell CGO_ENABLE=0 GOOS=linux GOARCH=mips go build -tags "client" -trimpath -ldflags "-s -w -buildid=" ``` -得到的可执行文件可以直接在目标平台运行。 - -完整的tag说明参见[Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 +完整的 tag 说明参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 ### 易用 -配置文件格式与Trojan兼容，但做了大幅简化，未指定的字段会被赋给一个默认值。你可以更方便地部署你的服务器和客户端。下面是一个简单的例子，完整的配置文件可以参见[这里](https://p4gefau1t.github.io/trojan-go)。 - -服务器配置文件 +配置文件格式与原版 Trojan 兼容，但做了大幅简化，未指定的字段会被赋予默认值，由此可以更方便地部署服务端和客户端。以下是一个简单例子，完整的配置文件可以参见[这里](https://p4gefau1t.github.io/trojan-go)。 -server.json +服务端配置文件 `server.json`： ```json { - "run_type": "server", - "local_addr": "0.0.0.0", - "local_port": 443, - "remote_addr": "127.0.0.1", - "remote_port": 80, - "password": [ - "your_awesome_password" - ], - "ssl": { - "cert": "your_cert.crt", - "key": "your_key.key", - "sni": "www.your-awesome-domain-name.com" - } + "run_type": "server", + "local_addr": "0.0.0.0", + "local_port": 443, + "remote_addr": "127.0.0.1", + "remote_port": 80, + "password": ["your_awesome_password"], + "ssl": { + "cert": "your_cert.crt", + "key": "your_key.key", + "sni": "www.your-awesome-domain-name.com" + } } ``` -客户端配置文件 - -client.json +客户端配置文件 `client.json`： ```json { - "run_type": "client", - "local_addr": "127.0.0.1", - "local_port": 1080, - "remote_addr": "www.your-awesome-domain-name.com", - "remote_port": 443, - "password": [ - "your_awesome_password" - ] + "run_type": "client", + "local_addr": "127.0.0.1", + "local_port": 1080, + "remote_addr": "www.your-awesome-domain-name.com", + "remote_port": 443, + "password": ["your_awesome_password"] } ``` -可以使用更简明易读的YAML语法进行配置，下面是一个客户端的例子，与上面的client.json等价 +可以使用更简明易读的 YAML 语法进行配置。以下是一个客户端的例子，与上面的 `client.json` 等价： -client.yaml +客户端配置文件 `client.yaml`： ```yaml run-type: client @@ -210,16 +160,13 @@ password: - your_awesome_password ``` - - ### WebSocket -Trojan-Go支持使用TLS+Websocket承载Trojan协议，使得利用CDN进行流量中转成为可能。 +Trojan-Go 支持使用 TLS + Websocket 承载 Trojan 协议，使得利用 CDN 进行流量中转成为可能。 -服务器和客户端配置文件中同时添加```websocket```选项即可启用Websocket支持，例如 +服务端和客户端配置文件中同时添加 `websocket` 选项即可启用 Websocket 支持，例如 ```json -... "websocket": { "enabled": true, "path": "/your-websocket-path", @@ -227,53 +174,41 @@ Trojan-Go支持使用TLS+Websocket承载Trojan协议，使得利用CDN进行流 } ``` -完整的选项说明参见[Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 - -可以省略```hostname```, 但是服务器和客户端的```path```必须一致。服务器开启Websocket支持后可以同时支持Websocket和一般Trojan流量，未配置Websocket选项的客户端依然可以正常使用。 +完整的选项说明参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 -由于Trojan并不支持Websocket，因此，虽然开启了Websocket支持的Trojan-Go服务端可以兼容所有客户端，但是如果要使用Websocket承载流量，请确保双方都使用Trojan-Go。 +可以省略 `hostname`, 但服务端和客户端的 `path` 必须一致。服务端开启 Websocket 支持后，可以同时支持 Websocket 和一般 Trojan 流量。未配置 Websocket 选项的客户端依然可以正常使用。 - +由于 Trojan 并不支持 Websocket，因此，虽然开启了 Websocket 支持的 Trojan-Go 服务端可以兼容所有客户端，但如果要使用 Websocket 承载流量，请确保双方都使用 Trojan-Go。 ### 多路复用 -在很差的网络条件下，一次TLS握手可能会花费很多时间。 +在很差的网络条件下，一次 TLS 握手可能会花费很多时间。Trojan-Go 支持多路复用（基于 [smux](https://github.com/xtaci/smux)），通过一条 TLS 隧道连接承载多条 TCP 连接的方式，减少 TCP 和 TLS 握手带来的延迟，以期提升高并发情景下的性能。 -Trojan-Go支持多路复用(基于[smux](https://github.com/xtaci/smux))。通过一个TLS隧道连接承载多个TCP连接的方式，减少TCP和TLS握手带来的延迟，以期提升高并发情景下的性能。 +> 启用多路复用并不能提高测速得到的链路速度，但能降低延迟、提升大量并发请求时的网络体验，例如浏览含有大量图片的网页等。 -启用多路复用并不会增加你测速得到的链路速度，但会降低延迟，提升大量并发请求时的网络体验，例如浏览含有大量图片的网页等。 - -你可以通过设置客户端的mux选项"enabled"字段启用它。如下 +你可以通过设置客户端的 `mux` 选项 `enabled` 字段启用它： ```json -... "mux": { "enabled": true } ``` -完整的选项说明参见[Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 - -你只需要设置客户端的配置文件即可，服务端会自动检测是否启用多路复用并提供支持。 - - +只需开启客户端 mux 配置即可，服务端会自动检测是否启用多路复用并提供支持。完整的选项说明参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 ### 路由模块 -Trojan-Go的客户端内建一个简单实用的路由模块用以方便实现国内直连等自定义路由功能。 +Trojan-Go 客户端内建一个简单实用的路由模块，以方便实现国内直连、海外代理等自定义路由功能。 -路由策略有三种 +路由策略有三种： -- Proxy 代理。将请求通过TLS隧道进行代理，由trojan服务器和目的地址进行连接。 +- `Proxy` 代理：将请求通过 TLS 隧道进行代理，由 Trojan 服务端与目的地址进行连接。 +- `Bypass` 绕过：直接使用本地设备与目的地址进行连接。 +- `Block` 封锁：不发送请求，直接关闭连接。 -- Bypass 绕过。直接在本地和目的地址进行连接。 - -- Block 封锁。不代理请求，直接关闭连接。 - -要激活模块，在你的配置文件中添加router选项，并且设置enabled为true，例如 +要激活路由模块，请在配置文件中添加 `router` 选项，并设置 `enabled` 字段为 `true`： ```json -... "router": { "enabled": true, "bypass": [ @@ -291,36 +226,30 @@ Trojan-Go的客户端内建一个简单实用的路由模块用以方便实现 } ``` -完整的选项说明参见[Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 - - +完整的选项说明参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 -### AEAD加密 +### AEAD 加密 -Trojan-Go允许对Trojan协议基于Shadowsocks AEAD进行加密，以保证Websocket传输流量无法被不可信的CDN识别和审查。下面是一个例子 +Trojan-Go 支持基于 Shadowsocks AEAD 对 Trojan 协议流量进行二次加密，以保证 Websocket 传输流量无法被不可信的 CDN 识别和审查： ```json -... "shadowsocks": { "enabled": true, "password": "my-password" } ``` -如果需要开启，服务端和客户端必须同时开启并保证密码一致。 - - +如需开启，服务端和客户端必须同时开启并保证密码一致。 ### 传输层插件 -Trojan-Go支持可插拔的传输层插件，并支持Shadowsocks [SIP003](https://shadowsocks.org/en/spec/Plugin.html)标准的混淆插件。下面是使用v2ray-plugin的一个例子： +Trojan-Go 支持可插拔的传输层插件，并支持 Shadowsocks [SIP003](https://shadowsocks.org/en/wiki/Plugin.html) 标准的混淆插件。下面是使用 `v2ray-plugin` 的一个例子： -**此配置并不安全，仅用作演示** +> **此配置并不安全，仅作为演示** 服务端配置： ```json -... "transport_plugin": { "enabled": true, "type": "shadowsocks", @@ -332,7 +261,6 @@ Trojan-Go支持可插拔的传输层插件，并支持Shadowsocks [SIP003](https 客户端配置： ```json -... "transport_plugin": { "enabled": true, "type": "shadowsocks", @@ -341,13 +269,13 @@ Trojan-Go支持可插拔的传输层插件，并支持Shadowsocks [SIP003](https } ``` -完整的选项说明参见[Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 +完整的选项说明参见 [Trojan-Go 文档](https://p4gefau1t.github.io/trojan-go)。 ## 构建 -确保你的Go版本 >= 1.14，推荐使用snap安装Go保持与上游同步。 +> 请确保 Go 版本 >= 1.14 -下面的命令使用```make```进行编译 +使用 `make` 进行编译： ```shell git clone https://github.com/p4gefau1t/trojan-go.git @@ -356,35 +284,39 @@ make make install #安装systemd服务等，可选 ``` -你也可以使用Go自行编译和安装 +或者使用 Go 自行编译： ```shell go build -tags "full" ``` -Go支持通过设置环境变量进行交叉编译，例如 +Go 支持通过设置环境变量进行交叉编译，例如： + +编译适用于 64 位 Windows 操作系统的可执行文件： ```shell CGO_ENABLE=0 GOOS=windows GOARCH=amd64 go build -tags "full" ``` -以及 +编译适用于 Apple Silicon 的可执行文件： ```shell -CGO_ENABLE=0 GOOS=linux GOARCH=arm go build -tags "full" +CGO_ENABLE=0 GOOS=macos GOARCH=arm64 go build -tags "full" ``` -## 致谢 +编译适用于 64 位 Linux 操作系统的可执行文件： -[trojan](https://github.com/trojan-gfw/trojan) - -[v2ray](https://github.com/v2ray/) - -[smux](https://github.com/xtaci/smux) +```shell +CGO_ENABLE=0 GOOS=linux GOARCH=amd64 go build -tags "full" +``` -[go-tproxy](https://github.com/LiamHaworth/go-tproxy) +## 致谢 -[utls](https://github.com/refraction-networking/utls) +- [Trojan](https://github.com/trojan-gfw/trojan) +- [V2Fly](https://github.com/v2fly) +- [utls](https://github.com/refraction-networking/utls) +- [smux](https://github.com/xtaci/smux) +- [go-tproxy](https://github.com/LiamHaworth/go-tproxy) ## Stargazers over time