code format

README.md

@@ -1,18 +1,18 @@
-# SS/SSR 透明代理脚本
+# SS/SSR/Socks5 全局代理
 ## 脚本简介
-ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客户端的代理功能。目前实现的模式有 global（全局代理模式）、gfwlist（黑名单模式）、chnroute（白名单模式，绕过大陆地址段），考虑到部分用户没有支持 UDP-Relay 的 SS/SSR 节点，所以代理模式又分为 tcp&udp 和 tcponly 两类。Linux 系统下实现透明代理有两种思路：一是利用 iptables 进行重定向（DNAT），二是利用 tun 虚拟网卡进行代理（路由）；因此代理模式又分为 tproxy、tun2socks 两大类，所以一共存在 12 种代理模式（下文中的“本机”指运行 ss-tproxy 的主机）：
+ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客户端的代理功能，当然也支持 Socks5 协议的全局代理配置（如 SSH 代理隧道）。目前实现的模式有 global（全局代理模式）、gfwlist（黑名单模式）、chnroute（白名单模式，绕过大陆地址段），考虑到部分用户没有支持 UDP-Relay 的 SS/SSR 节点，所以代理模式又分为 tcp&udp 和 tcponly 两类。Linux 系统下实现透明代理有两种思路：一是利用 iptables 进行重定向（DNAT），二是利用 tun 虚拟网卡进行代理（路由）；因此代理模式又分为 tproxy、tun2socks 两大类，所以一共存在 12 种代理模式（下文中的“本机”指运行 ss-tproxy 的主机）：
 - `tproxy_global`：代理 TCP/UDP（本机 UDP 除外），iptables/global 模式
 - `tproxy_global_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），iptables/global 模式
 - `tproxy_gfwlist`：代理 TCP/UDP（本机 UDP 除外），iptables/gfwlist 模式
 - `tproxy_gfwlist_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），iptables/gfwlist 模式
 - `tproxy_chnroute`：代理 TCP/UDP（本机 UDP 除外），iptables/chnroute 模式
 - `tproxy_chnroute_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），iptables/chnroute 模式
-- `tun2socks_global`：代理 TCP/UDP（包括本机 UDP），route/global 模式
-- `tun2socks_global_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），route/global 模式
-- `tun2socks_gfwlist`：代理 TCP/UDP（包括本机 UDP），route/gfwlist 模式
-- `tun2socks_gfwlist_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），route/gfwlist 模式
-- `tun2socks_chnroute`：代理 TCP/UDP（包括本机 UDP），route/chnroute 模式
-- `tun2socks_chnroute_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），route/chnroute 模式
+- `tun2socks_global`：代理 TCP/UDP（包括本机 UDP），tun2socks/global 模式
+- `tun2socks_global_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），tun2socks/global 模式
+- `tun2socks_gfwlist`：代理 TCP/UDP（包括本机 UDP），tun2socks/gfwlist 模式
+- `tun2socks_gfwlist_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），tun2socks/gfwlist 模式
+- `tun2socks_chnroute`：代理 TCP/UDP（包括本机 UDP），tun2socks/chnroute 模式
+- `tun2socks_chnroute_tcp`：仅代理 TCP（DNS 使用 TCP 方式查询），tun2socks/chnroute 模式
 
 ## 脚本依赖
 - [ss-tproxy 脚本相关依赖的安装参考](https://www.zfl9.com/ss-redir.html#%E5%AE%89%E8%A3%85%E4%BE%9D%E8%B5%96)
@@ -29,8 +29,8 @@ ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客
 - `tun2socks_gfwlist_tcp`: ss/ssr(版本不限), haveged, tun2socks, iproute2, ipset, perl, dnsmasq, dnsforwarder
 - `tun2socks_chnroute_tcp`: ss/ssr(版本不限), haveged, tun2socks, iproute2, ipset, chinadns, dnsforwarder
 - haveged 依赖项是可选的，主要用于防止系统的熵过低，从而导致 ss-redir、ss-tunnel、ss-local 启动失败等问题
-- `*gfwlist*` 模式更新列表时依赖 curl、base64；`*chnroute*` 模式更新列表时依赖 curl；建议都安装（反正迟早要装）
-- `*gfwlist*` 模式中的 perl 其实可以使用 sed 替代，但由于更新 gfwlist 列表依赖 perl5 v5.10.0+，所以直接使用了 perl
+- `*gfwlist*` 模式更新列表时依赖 curl、base64；`*chnroute*` 模式更新列表时依赖 curl；建议都安装，以备不时之需
+- `*gfwlist*` 模式中的 perl 其实可以使用 sed 替代，但由于更新 gfwlist 列表依赖 perl5 v5.10.0+，所以直接用了 perl
 
 ## 端口占用
 - 请确保相关端口未被其它进程占用，如果有请自行解决
@@ -48,10 +48,8 @@ ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客
 - `tun2socks_chnroute_tcp`: dnsforwarder=60053, chinadns=65353, dnsforwarder=53
 
 ## 脚本用法
-**获取**
-- `git clone https://github.com/zfl9/ss-tproxy.git --single-branch`
-
 **安装**
+- `git clone https://github.com/zfl9/ss-tproxy.git --single-branch`
 - `cd ss-tproxy`
 - `cp -af ss-tproxy /usr/local/bin`
 - `chmod 0755 /usr/local/bin/ss-tproxy`
@@ -69,7 +67,7 @@ ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客
 - `ss-tproxy.conf`：配置文件
 - `ss-tproxy.service`：服务文件
 - `gfwlist.txt`：gfwlist 域名文件，不可配置
-- `gfwlist.ext`：gfwlsit 黑名单文件，允许配置
+- `gfwlist.ext`：gfwlsit 黑名单文件，可配置
 - `chnroute.set`：chnroute for ipset，不可配置
 - `chnroute.txt`：chnroute for chinadns，不可配置
 
@@ -78,14 +76,14 @@ ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客
 - 默认模式为 `tproxy_chnroute`，这也是 v1 版本中的模式，根据自己的需要更改
 - 如果使用 `tproxy*` 模式，则修改 `ss/ssr 配置` 段中的相关 SS/SSR 服务器信息
 - 如果使用 `tun2socks*` 模式，则修改 `socks5 配置` 段中的相关 socks5 代理信息
-- `dns_remote` 为解析国外域名的 DNS 服务器，默认为 Google DNS，根据自己的需要修改
-- `dns_direct` 为解析国内域名的 DNS 服务器，默认为 114、119 DNS，根据自己的需要修改
+- `dns_remote` 指定远程 DNS 服务器（走代理），默认为 Google DNS，根据需要修改
+- `dns_direct` 指定直连 DNS 服务器（走直连），默认为 114/119 DNS，根据需要修改
 - `iptables_intranet` 指定要代理的内网网段，允许多个，默认为 192.168/16，根据需要修改
 - 如果你的内网网段不是“标准”网段（详见文件注释），请注意修改 `iptables_intranet_nonstd`
-- 关于 gfwlist 黑名单，如果需要，请编辑 `/etc/tproxy/gfwlist.ext`，根据注释添加相应的条目
+- 如果需要配置 gfwlist 黑名单，请编辑 `/etc/tproxy/gfwlist.ext`，修改后重启 ss-tproxy 生效
 
 **自启**（Systemd）
-- `cp -af ss-tproxy.service /etc/systemd/system`
+- `mv -f ss-tproxy.service /etc/systemd/system`
 - `systemctl daemon-reload`
 - `systemctl enable ss-tproxy.service`
 
@@ -94,7 +92,7 @@ ss-tproxy 脚本运行于 Linux 系统，用于实现类似 Windows SS/SSR 客
 - `chmod +x /etc/rc.d/rc.local`
 - `echo '/usr/local/bin/ss-tproxy start' >>/etc/rc.d/rc.local`
 
-如果 ss-tproxy 主机使用 PPPoE 拨号上网（或其它耗时比较长的方式），那么配置自启后，可能导致 ss-tproxy 在网络还未完全准备好的情况下先运行。此时如果 ss-tproxy.conf 中的 socks5_remote、server_addr 为域名形式，那么就会导致 ss-tproxy 启动失败（甚至会卡一段时间，因为它一直在尝试解析这些域名，直到超时为止）。要恢复正常的代理，只能在启动完成后手动进行 `ss-tproxy restart`。如果你想避免这种 bug 的发生，请尽量将 ss-tproxy.conf 中的 socks5_remote、server_addr 替换为 IP 地址形式，或者将这些域名添加到 ss-tproxy 主机的 /etc/hosts 文件，如果你和我一样使用的 ArchLinux，那么最好的解决方式就是利用 netctl 的 hook 钩子启动 ss-tproxy（比如在拨号成功后再启动 ss-tproxy），具体的配置可参考 [Arch 官方文档](https://wiki.archlinux.org/index.php/netctl#Using_hooks)。
+如果 ss-tproxy 主机使用 PPPoE 拨号上网（或其它耗时比较长的方式），那么配置自启后，可能导致 ss-tproxy 在网络还未完全准备好的情况下先运行。此时如果 ss-tproxy.conf 中的 socks5_remote、server_addr 为域名形式，那么就会导致 ss-tproxy 启动失败（甚至会卡一段时间，因为它一直在尝试解析这些域名，直到超时为止）。要恢复正常的代理，只能在启动完成后手动进行 `ss-tproxy restart`。如果你想避免这种 bug 的发生，请尽量将 ss-tproxy.conf 中的 socks5_remote、server_addr 替换为 IP 地址形式，或者将这些域名添加到 ss-tproxy 主机的 /etc/hosts 文件，如果你和我一样使用的 ArchLinux，那么最好的解决方式就是利用 netctl 的 hook 启动 ss-tproxy（如拨号成功后再启动 ss-tproxy），具体配置可参考 [Arch 官方文档](https://wiki.archlinux.org/index.php/netctl#Using_hooks)。
 
 **用法**
 - `ss-tproxy help`：查看帮助

ss-tproxy

@@ -615,8 +615,8 @@ tproxy_global*|tproxy_chnroute*)
 
     if [[ "$mode" != *tcp ]]; then
         iptables -t mangle -F PREROUTING
-    	iptables -t mangle -F SS-UDP &>/dev/null
-    	iptables -t mangle -X SS-UDP &>/dev/null
+        iptables -t mangle -F SS-UDP &>/dev/null
+        iptables -t mangle -X SS-UDP &>/dev/null
 
         iptables -t mangle -N SS-UDP
         iptables -t mangle -A SS-UDP -d 0/8 -j RETURN
@@ -667,8 +667,8 @@ tproxy_gfwlist*)
 
     if [[ "$mode" != *tcp ]]; then
         iptables -t mangle -F PREROUTING
-    	iptables -t mangle -F SS-UDP &>/dev/null
-    	iptables -t mangle -X SS-UDP &>/dev/null
+        iptables -t mangle -F SS-UDP &>/dev/null
+        iptables -t mangle -X SS-UDP &>/dev/null
 
         iptables -t mangle -N SS-UDP
         iptables -t mangle -A SS-UDP -p udp -m set --match-set gfwlist dst -j TPROXY --tproxy-mark $iptables_pbr_fwmark --on-ip 127.0.0.1 --on-port 60080
@@ -818,7 +818,7 @@ function start {
 function stop {
     dns_normal
 
-    iptables -t nat -F OUTPUT            
+    iptables -t nat -F OUTPUT
     iptables -t nat -F PREROUTING
     iptables -t nat -F POSTROUTING
     iptables -t nat -F SS-TCP &>/dev/null