Skip to content

Snishaper Core

dongle edited this page Oct 25, 2026 · 6 revisions

中文 | English

Snishaper-Core 核心库

snishaper-core(Go module:github.com/SnishaperTeam/snishaper-core,AGPL-3.0)是从 SniShaper 抽取的核心代理库。SniShaper 应用通过 go.mod 直接依赖它,仓库内不再内置核心代理代码。

包一览

包 说明
proxy ProxyServer(HTTP + SOCKS5 混合端口)、RuleManager(规则引擎,v0.7.0 起规则分有效状态/上游备份两个文件,用户差量按需求差,提供 GetRulesLayerInfo / RevertSiteGroupToUpstream / RevertUpstreamConfigToUpstream)、AutoRouter、MITM、上游拨号
subscription Clash 订阅解析、节点存储与协议出站(vmess / vless / trojan / shadowsocks / hysteria / tuic / wireguard 等,mihomo 适配器,v0.2.0 起)
dohresolver DoH 多节点故障切换解析
cfpool Cloudflare 优选 IP 池
netiface 物理网卡选择与出站绑定
tlsfrag TLS ClientHello 分片(TLS-RF)
gfwlist GFWList 域名后缀匹配(仅本地缓存文件,无网络更新)
certmanager CA 生成、MITM 证书签发、系统信任安装
singtun 基于 sing-tun 的 TUN 数据面
config 跨包共享配置类型(CertVerifyConfig 等)
log Logger 接口与 Nop / Std / Func 适配器

设计约定

  • 零全局可变状态:无 init()、无包级可变状态、不读环境变量、不调 os.Exit,可多实例、可并发嵌入。
  • 注入式行为:日志经 log.Logger 注入(默认 Nop,SniShaper 应用注入 Std);调试开关(对应原 SNISHAPER_ROUTER_DEBUG=1)经 proxy.WithRouterDebug 注入。
  • 产品身份经 config.Brand 注入:proxy、dohresolver、subscription 等包均接受品牌选项;零值回落到 config.DefaultProductName(SniShaper)。库内不写死产品名——包括订阅下载的 User-Agent(clash-verge/v2.0 <产品名>)。嵌入方不是 SniShaper 时应显式传入自己的名字。
  • 配置语义兼容:规则与设置 JSON 的格式和语义与 SniShaper 应用侧保持一致。

同时开发 SniShaper 与 snishaper-core

发布依赖走 go.mod(当前 v0.7.0)。要同时修改两个仓库,在 SniShaper 的 go.mod 临时加一行本地 replace:

replace github.com/SnishaperTeam/snishaper-core => ../snishaper-core

改完删掉 replace 再提交。库的完整文档见其仓库的 README 与 docs/DESIGN.md,最小嵌入示例见 examples/basic。

Clone this wiki locally