diff --git a/README.md b/README.md index 37db16b..aa087da 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ gost - GO Simple Tunnel -==== +====== ### GO语言实现的安全隧道 -#### 特性 +特性 +------ * 可同时监听多端口 * 可设置转发代理,支持多级转发(转发链) * 兼容标准http(s)/socks5代理协议 @@ -17,9 +18,9 @@ Google讨论组: https://groups.google.com/d/forum/go-gost 在gost中,gost与其他代理服务都被看作是代理节点,gost可以自己处理请求,或者将请求转发给任意一个或多个代理节点。 -#### 参数说明 - -##### -L和-F参数格式 +参数说明 +------ +#### -L和-F参数格式 ```bash [scheme://][user:pass@host]:port ``` @@ -39,7 +40,7 @@ protocol: 代理协议类型(http, socks5, shadowsocks), transport: 数据传输 > ss - 作为shadowsocks服务,ss://aes-256-cfb:123456@:8080 -##### 开启日志 +#### 开启日志 > -logtostderr : 输出到控制台 @@ -48,9 +49,9 @@ protocol: 代理协议类型(http, socks5, shadowsocks), transport: 数据传输 > -log_dir=. : 输出到目录 -#### 使用方法 - -##### 不设置转发代理 +使用方法 +------ +#### 不设置转发代理 @@ -69,7 +70,7 @@ gost -L=admin:123456@localhost:8080 gost -L=http+tls://:443 -L=socks://:1080 -L=ss://aes-128-cfb:123456@:8338 ``` -##### 设置转发代理 +#### 设置转发代理 ```bash @@ -81,7 +82,7 @@ gost -L=:8080 -F=192.168.1.1:8081 gost -L=:8080 -F=http://admin:123456@192.168.1.1:8081 ``` -##### 设置多级转发代理(转发链) +#### 设置多级转发代理(转发链) ```bash @@ -89,53 +90,68 @@ gost -L=:8080 -F=http+tls://192.168.1.1:443 -F=socks+ws://192.168.1.2:1080 -F=ss ``` gost按照-F设置顺序通过转发链将请求最终转发给a.b.c.d:NNNN处理,每一个转发代理可以是任意http(s)/socks5/shadowsocks类型代理。 -##### 加密机制 +加密机制 +------ +#### HTTP +对于http可以使用tls加密整个通讯过程,即https代理: -对于http或socks5都可以使用tls加密整个通讯过程: - -http: +服务端: ```bash -gost -L=http+tls://:8080 +gost -L=http+tls://:443 +``` +客户端: +```bash +gost -L=:8080 -F=http+tls://server_ip:443 ``` -socks5: +#### SOCKS5 +gost支持标准socks5协议的no-auth(0x00)和user/pass(0x02)方法,并在此基础上扩展了两个:tls(0x80)和tls-auth(0x82),用于数据加密。 + +服务端: ```bash -gost -L=socks+tls://:8080 +gost -L=socks://:1080 +``` +客户端: +```bash +gost -L=:8080 -F=socks://server_ip:1080 ``` -gost针对socks5额外提供了协商的tls传输方法,与上面的不同之处在于socks5最开始的方法选择(method selection)过程是非加密的。 -如果连接方是gost则后续的通讯使用tls加密,否则使用标准socks5进行通讯(未加密)。 +如果两端都是gost(如上)则数据传输会被加密(使用tls或tls-auth方法),否则使用标准socks5进行通讯(no-auth或user/pass方法)。 -也就是说如果连接方也是gost,使用以下方法: +#### shadowsocks +gost对shadowsocks的支持是基于[shadowsocks-go](https://github.com/shadowsocks/shadowsocks-go)库。 +服务端: ```bash -gost -L=socks://:8080 +gost -L=ss://aes-128-cfb:123456@:8338 +``` +客户端: +```bash +gost -L=:8080 -F=ss://aes-128-cfb:123456@server_ip:8338 ``` -数据也会被加密传输,这时就不需要使用socks+tls(数据会被双重加密传输)模式了。 +gost内置了tls证书,如果需要使用其他tls证书,在gost目录放置key.pem(公钥)和cert.pem(私钥)两个文件即可。 -gost内置了tls证书,如果需要使用其他的tls证书,在gost目录放置key.pem(公钥)和cert.pem(私钥)两个文件即可。 - -#### SOCKS5 UDP数据处理 - -##### 不设置转发代理 +SOCKS5 UDP数据处理 +------ +#### 不设置转发代理 gost作为标准socks5代理处理UDP数据 -##### 设置转发代理 +#### 设置转发代理 -##### 设置多个转发代理(转发链) +#### 设置多个转发代理(转发链) -当设置转发代理时,gost会使用UDP-Over-TCP方式转发UDP数据。proxy1 - proxyN可以为任意http/socks5类型代理。 - -##### 限制条件 +当设置转发代理时,gost会使用UDP-Over-TCP方式转发UDP数据。proxy1 - proxyN可以为任意http(s)/socks5/shadowsocks类型代理。 +限制条件 +------ 转发链中的http代理必须支持CONNECT方法。 如果要转发socks5的BIND和UDP请求,转发链的末端(最后一个-F参数)必须是gost socks5类型代理。