基于gfwlist的多种代理软件配置文件生成工具,支持自定义规则,目前可生成的格式有pac, dnsmasq, wingy。
# 安装或更新
$ pip install -U genpac
# 或从github安装更新开发版本
$ pip install -U https://github.com/JinnLynn/genpac/archive/dev.zip
# 卸载
$ pip uninstall genpac
注意: 如果安装后,执行时出现无法找到命令的错误,可能是因为genpac
命令没有被安装到系统路径,如Ububtu 16.04且通过apt-get安装的pip的环境下,genpac
执行入口文件被安装到了~/.local/bin
,遇到这种情况,将~/.local/bin
添加到系统路径,或卸载重新使用sudo安装,都可以解决问题。
genpac [-v] [-h] [--init [PATH]] [--format {pac,dnsmasq,wingy}]
[--gfwlist-url URL] [--gfwlist-proxy PROXY]
[--gfwlist-local FILE] [--gfwlist-update-local]
[--gfwlist-disabled] [--gfwlist-decoded-save FILE]
[--user-rule RULE] [--user-rule-from FILE]
[--template FILE] [-o FILE] [-c FILE]
[--pac-proxy PROXY] [--pac-precise] [--pac-compress]
[--dnsmasq-dns DNS] [--dnsmasq-ipset IPSET]
[--wingy-adapter-opts OPTS] [--wingy-rule-adapter-id ID]
获取gfwlist生成多种格式的翻墙工具配置文件, 支持自定义规则
optional arguments:
-v, --version 版本信息
-h, --help 帮助信息
--init [PATH] 初始化配置和用户规则文件
通用参数:
--format {pac,dnsmasq,wingy}
生成格式, 只有指定了格式, 相应格式的参数才作用
--gfwlist-url URL gfwlist网址,无此参数或URL为空则使用默认地址, URL为-则不在线获取
--gfwlist-proxy PROXY
获取gfwlist时的代理, 如果可正常访问gfwlist地址, 则无必要使用该选项
格式为 "代理类型 [用户名:密码]@地址:端口" 其中用户名和密码可选, 如:
SOCKS5 127.0.0.1:8080
SOCKS5 username:[email protected]:8080
--gfwlist-local FILE 本地gfwlist文件地址, 当在线地址获取失败时使用
--gfwlist-update-local
当在线gfwlist成功获取且--gfwlist-local参数存在时, 更新gfwlist-local内容
--gfwlist-disabled 禁用gfwlist
--gfwlist-decoded-save FILE
保存解码后的gfwlist, 仅用于测试
--user-rule RULE 自定义规则, 允许重复使用或在单个参数中使用`,`分割多个规则,如:
--user-rule="@@sina.com" --user-rule="||youtube.com"
--user-rule="@@sina.com,||youtube.com"
--user-rule-from FILE
从文件中读取自定义规则, 使用方法如--user-rule
-o FILE, --output FILE
输出到文件, 无此参数或FILE为-, 则输出到stdout
-c FILE, --config-from FILE
从文件中读取配置信息
--template FILE 自定义模板文件
PAC:
通过代理自动配置文件(PAC)系统或浏览器可自动选择合适的代理服务器
--pac-proxy PROXY 代理地址, 如 SOCKS5 127.0.0.1:8080; SOCKS 127.0.0.1:8080
--pac-precise 精确匹配模式
--pac-compress 压缩输出
-p PROXY, --proxy PROXY
已弃用参数, 等同于--pac-proxy, 后续版本将删除, 避免使用
-P, --precise 已弃用参数, 等同于--pac-precise, 后续版本将删除, 避免使用
-z, --compress 已弃用参数, 等同于--pac-compress, 后续版本将删除, 避免使用
DNSMASQ:
Dnsmasq配合iptables ipset可实现基于域名的自动直连或代理
--dnsmasq-dns DNS 生成规则域名查询使用的DNS服务器,格式: HOST#PORT
默认: 127.0.0.1#53
--dnsmasq-ipset IPSET
转发使用的ipset名称, 默认: GFWLIST
WINGY:
Wingy是iOS下基于NEKit的代理App
--wingy-adapter-opts OPTS
adapter选项, 选项间使用`,`分割, 多个adapter使用`;`分割, 如:
id:ap1,type:http,host:127.0.0.1,port:8080;id:ap2,type:socks5,host:127.0.0.1,port:3128
--wingy-rule-adapter-id ID
生成规则使用的adapter ID
支持通过 --config-from
参数读入配置信息,配置文件书写方法可参考sample/config.ini
支持通过 --user-rule
自定义单个规则或 --user-rule-from
读入自定义规则文件,这两个参数均可重复使用。
自定义规则文件可参考sample/user-rules.txt
自定义规则的语法与gfwlist相同,使用AdBlock Plus过滤规则( https://adblockplus.org/en/filters ),简述如下:
- 通配符支持,如
*.example.com/*
实际书写时可省略*
为.example.com/
- 正则表达式支持,以
\
开始和结束,如\[\w]+:\/\/example.com\\
- 例外规则
@@
,如@@*.example.com/*
满足@@
后规则的地址不使用代理 - 匹配地址开始和结尾
|
,如|https://example.com
、example.com|
分别表示以https://example.com
开始和以example.com
结束的地址 ||
标记,如||example.com
则https://example.com https://example.com ftp:https://example.com
等地址均满足条件- 注释
!
如! Comment
配置自定义规则时需谨慎,尽量避免与gfwlist产生冲突,或将一些本不需要代理的网址添加到代理列表
规则优先级从高到底为: user-rule > user-rule-from > gfwlist
-
PAC格式中,参数
--pac-precise
的精确匹配模式的作用是什么?1.4.0之后生成的PAC文件默认只对域名进行匹配,如规则
.ftchinese.com/channel/video
处理后为ftchinese.com
,所有在ftchinese.com
下的网址都将通过匹配,在这种模式下可以减少PAC文件尺寸,并在一定程度上提高效率,推荐使用,但如果你依然想用原有的规则进行精确的网址匹配判断,则使用参数--pac-precise
或在配置文件中设置pac-precise=true
即可。 -
出现
fetch gfwlist fail.
错误gfwlist是在线获取,某些情况下可能被和谐或其它原因导致获取失败,可以通过以下几种方法解决该问题:
- 使用
--gfwlist-proxy
参数,通过代理获取gfwlist - 通过其它方式下载到本地,再通过
--gfwlist-local
加载 - 使用参数
--gfwlist-url=-
不进行在线获取,这种情况下你只能使用自定义规则
- 使用
-
gfwlist获取代理使用失败
- 检查--gfwlist-proxy参数或配置gfwlist-proxy值是格式否符合
TYPE HOST:POST
,如SOCKS5 127.0.0.1:1080、PROXY 127.0.0.1:8080
- OSX Linux如果存在http_proxy、https_proxy环境变量,代理可能无法正常使用
- 检查--gfwlist-proxy参数或配置gfwlist-proxy值是格式否符合
-
genpac命令未找到
见前文安装章节的注意事项。
# 从gfwlist生成代理信息为SOCKS5 127.0.0.1:1080的PAC文件
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080"
# 从~/config.ini读取配置生成
genpac --config-from=~/config.ini
# PAC格式 压缩
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --pac-compress
# PAC格式 精确匹配模式
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --pac-precise
# PAC格式 自定义规则
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" "SOCKS5 127.0.0.1:1080" --user-rule="||example.com" --user-rule-from=~/user-rule.txt
genpac --config-from=~/config.ini --pac-proxy="SOCKS5 127.0.0.1:1080" --user-rule="||example.com" --user-rule-from=~/user-rule.txt
# PAC格式 多个自定义规则文件
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --user-rule="||example.com" --user-rule="||example2.com" --user-rule-from=~/user-rule.txt,~/user-rule2.txt
# PAC格式 使用HTTP代理127.0.0.1:8080获取在线gfwlist文件
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --gfwlist-proxy="PROXY 127.0.0.1:8080"
# PAC格式 如果在线gfwlist获取失败使用本地文件,如果在线gfwlist获取成功更新本地gfwlist文件
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --gfwlist-local=~/gfwlist.txt --update-gfwlist-local
# PAC格式 忽略gfwlist,仅使用自定义规则
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --gfwlist-disabled --user-rule-from=~/user-rule.txt
genpac --format=pac --pac-proxy="SOCKS5 127.0.0.1:1080" --gfwlist-url=- --user-rule-from=~/user-rule.txt
# DNSMASQ WINGY格式同样可以使用上述PAC格式中关于gfwlist和自定义规则的参数
# DNSMASQ格式
genpac --format=dnsmasq --dnsmasq-dns="127.0.0.1#53" --dnsmasq-ipset="ipset-name"
# WINGY格式 使用默认模板生成
genpac --format=wingy --wingy-opts="id:do-ss,type:ss,host:192.168.100.1,port:8888,method:bf-cfb,password:test" --wingy-rule-adapter-id=do-ss
# WINGY格式 使用自定义模板
genpac --format=wingy --template=/sample/wingy-tpl.yaml