统一的安全扫描工具 Go SDK，提供一致的接口设计。
Chainreactors SDK 为多个安全扫描工具提供统一接口：
- Fingers: Web 指纹识别（HTTP/Socket）
- Neutron: POC/漏洞扫描
- GoGo: 集成指纹识别和 POC 检测的端口扫描
- Spray: HTTP 批量检测和路径爆破
go get github.com/chainreactors/sdkSDK 采用简单的四组件架构：
- Engine（引擎）: 实现具体的扫描逻辑
- Context（上下文）: 携带配置和控制信息
- Task（任务）: 定义扫描目标
- Result（结果）: 返回扫描结果
每个引擎可以独立使用，也可以与其他引擎集成（如 GoGo 同时集成 Fingers 和 Neutron）。
所有引擎支持双重加载模式：
- 本地模式: 从嵌入数据或文件系统加载
- 远程模式: 从 Cyberhub API 加载，支持 sources 过滤
import (
"github.com/chainreactors/sdk/fingers"
)
// 创建并加载引擎
config := fingers.NewConfig()
config.WithCyberhub("http://127.0.0.1:8080", "your_key")
engine, _ := fingers.NewEngine(config)
// 方式一：使用 Match API 直接检测
frameworks, _ := engine.Match(httpResponseBytes)
// 方式二：使用底层 Engine
libEngine := engine.Get()
frameworks, _ = libEngine.DetectContent(httpResponseBytes)import (
"github.com/chainreactors/sdk/neutron"
)
// 创建并加载引擎
config := neutron.NewConfig()
config.WithCyberhub("http://127.0.0.1:8080", "your_key")
engine, _ := neutron.NewEngine(config)
templates := engine.Get() // 自动编译
// 执行 POC
for _, t := range templates {
result, _ := t.Execute("http://target.com", nil)
if result.Matched {
// 处理漏洞
}
}import (
"github.com/chainreactors/sdk/gogo"
"github.com/chainreactors/sdk/fingers"
"github.com/chainreactors/sdk/neutron"
)
// 加载指纹库
fingersEngine, _ := fingers.NewEngine(fingersConfig)
// 加载 POC
neutronEngine, _ := neutron.NewEngine(neutronConfig)
// 创建集成扫描器
gogoConfig := gogo.NewConfig().
WithFingersEngine(fingersEngine).
WithNeutronEngine(neutronEngine)
gogoEngine := gogo.NewEngine(gogoConfig)
gogoEngine.Init()
// 执行扫描
gogoCtx := gogo.NewContext().
SetThreads(1000).
SetVersionLevel(2).
SetExploit("all").
SetDelay(5)
task := gogo.NewScanTask("192.168.1.0/24", "80,443,8080")
resultCh, _ := gogoEngine.Execute(gogoCtx, task)
for result := range resultCh {
// 处理结果
}import (
"github.com/chainreactors/sdk/spray"
)
engine := spray.NewEngine(nil)
engine.Init()
urls := []string{"http://example.com", "http://target.com"}
sprayCtx := spray.NewContext().
SetThreads(100).
SetTimeout(10)
task := spray.NewCheckTask(urls)
resultCh, _ := engine.Execute(sprayCtx, task)
for result := range resultCh {
sprayResult := result.(*spray.Result).SprayResult()
// 处理结果
}config := fingers.NewConfig()
config.WithCyberhub("http://127.0.0.1:8080", "your_key")
config.SetSources("github") // 可选：按来源过滤
config.WithLocalFile("fingers.yaml") // 可选：从导出的 YAML 加载
config.SetTimeout(10 * time.Second)config := neutron.NewConfig()
config.WithCyberhub("http://127.0.0.1:8080", "your_key")
config.SetSources("github") // 可选：按来源过滤
config.WithLocalFile("./pocs") // 可选：本地 POC 目录
config.SetTimeout(10 * time.Second)config := gogo.NewConfig().
WithFingersEngine(fingersEngine).
WithNeutronEngine(neutronEngine)ctx := gogo.NewContext().
SetThreads(1000).
SetVersionLevel(2). // 0-3，数值越高检测越深
SetExploit("all"). // none/all/known
SetDelay(5) // 请求超时时间ctx := spray.NewContext().
SetThreads(100).
SetTimeout(10)examples/ 目录提供了预构建的命令行工具：
# 构建所有工具
cd examples
go build -o fingers/fingers.exe ./fingers/main.go
go build -o neutron/neutron.exe ./neutron/main.go
go build -o gogo/gogo.exe ./gogo/main.go
go build -o spray/spray.exe ./spray/main.go详细使用方法参见 examples/README.md。
sdk/
├── fingers/ # 指纹识别引擎
│ ├── engine.go # 核心引擎实现
│ ├── config.go # 配置
│ ├── types.go # 类型定义
│ ├── additions.go # 扩展方法 (AddFingers, AddFingersFile)
│ ├── init.go # 注册入口
│ └── README.md # 引擎文档
│
├── neutron/ # POC 扫描引擎
│ ├── engine.go # 核心引擎（自动编译）
│ ├── config.go # 配置
│ ├── types.go # 类型定义
│ ├── templates.go # Templates 辅助类型 (Filter, Merge)
│ ├── additions.go # 扩展方法 (AddPocs, AddPocsFile)
│ └── README.md # 引擎文档
│
├── gogo/ # 端口扫描（集成）
│ ├── gogo.go # 支持 Fingers/Neutron 的引擎
│ ├── types.go # 类型定义和配置
│ ├── init.go # 注册入口
│ └── README.md # 引擎文档
│
├── spray/ # HTTP 检测引擎
│ ├── spray.go # 核心引擎实现
│ ├── types.go # 类型定义和配置
│ ├── init.go # 注册入口
│ └── README.md # 引擎文档
│
├── pkg/
│ ├── cyberhub/ # 统一 API 客户端
│ │ ├── client.go # HTTP 客户端（支持 gzip）
│ │ ├── config.go # 客户端配置
│ │ └── types.go # API 类型
│ ├── association/ # 关联索引
│ │ └── index.go # 指纹-POC 关联索引
│ └── interface.go # 核心 SDK 接口
│
└── examples/ # CLI 工具实现
├── fingers/
├── neutron/
├── gogo/
├── spray/
└── README.md
所有引擎都支持从 Cyberhub 加载数据：
- Gzip 压缩处理
- 基于 sources 的过滤
- API Key 认证
Neutron 引擎在加载时自动编译 POC：
- 无需手动编译
- 编译失败的 POC 自动跳过
- ExecuterOptions 从引擎配置生成
GoGo 可以同时集成 Fingers 和 Neutron：
- 模板按指纹、ID、标签建立索引
- 9,444 个 POC 生成 61,267 条索引（多重索引）
SDK 支持两种筛选方式：
使用 ExportFilter 在请求 API 时筛选，减少传输数据量：
import (
"time"
"github.com/chainreactors/sdk/fingers"
"github.com/chainreactors/sdk/neutron"
"github.com/chainreactors/sdk/pkg/cyberhub"
)
// 指纹筛选
filter := cyberhub.NewExportFilter().
WithTags("cms", "framework"). // 按标签筛选
WithSources("github"). // 按来源筛选
WithLimit(100). // 限制数量
WithUpdatedAfter(time.Now().AddDate(0, -1, 0)) // 最近一个月更新的
config := fingers.NewConfig().
WithCyberhub("http://127.0.0.1:8080", "your_key")
config.ExportFilter = filter
engine, _ := fingers.NewEngine(config)
// POC 筛选
pocFilter := cyberhub.NewExportFilter().
WithTags("cve", "rce"). // 按标签筛选
WithSources("nuclei"). // 按来源筛选
WithCreatedAfter(time.Now().AddDate(-1, 0, 0)) // 最近一年创建的
nConfig := neutron.NewConfig().
WithCyberhub("http://127.0.0.1:8080", "your_key")
nConfig.ExportFilter = pocFilter
nEngine, _ := neutron.NewEngine(nConfig)使用 FullFingers.Filter 或 Templates.Filter 对已加载的数据进行二次过滤：
import (
"github.com/chainreactors/sdk/fingers"
"github.com/chainreactors/sdk/neutron"
neutronTemplates "github.com/chainreactors/neutron/templates"
)
// 加载指纹后筛选
fConfig := fingers.NewConfig().WithCyberhub("http://127.0.0.1:8080", "your_key")
fEngine, _ := fingers.NewEngine(fConfig)
// 获取并过滤指纹（按协议筛选）
allFingers := fConfig.FullFingers
httpFingers := allFingers.Filter(func(f *fingers.FullFinger) bool {
return f.Finger != nil && f.Finger.Protocol == "http"
})
// 加载 POC 后筛选
nConfig := neutron.NewConfig().WithCyberhub("http://127.0.0.1:8080", "your_key")
nEngine, _ := neutron.NewEngine(nConfig)
// 使用 Templates.Filter 筛选
allTemplates := (neutron.Templates{}).Merge(nEngine.Get())
// 按严重级别筛选
highSeverity := allTemplates.Filter(func(t *neutronTemplates.Template) bool {
severity := t.Info.Severity
return severity == "critical" || severity == "high"
})
// 按标签筛选
rceTemplates := allTemplates.Filter(func(t *neutronTemplates.Template) bool {
for _, tag := range t.GetTags() {
if tag == "rce" {
return true
}
}
return false
})下面示例演示：Fingers 命中指纹后，使用 neutron.Templates.Filter 从模板集中筛选相关 POC 并执行。
package main
import (
"strings"
"github.com/chainreactors/sdk/fingers"
"github.com/chainreactors/sdk/neutron"
neutronTemplates "github.com/chainreactors/neutron/templates"
)
func main() {
// 1) 指纹识别
fConfig := fingers.NewConfig().WithCyberhub("http://127.0.0.1:8080", "your_key")
fEngine, _ := fingers.NewEngine(fConfig)
// 使用 Match API 直接匹配
frameworks, _ := fEngine.Match([]byte("raw http response"))
// 收集指纹名称
fingerNames := make(map[string]struct{})
for _, frame := range frameworks {
fingerNames[strings.ToLower(frame.Name)] = struct{}{}
}
// 2) 加载 POC 并使用 Filter 筛选
nConfig := neutron.NewConfig().WithCyberhub("http://127.0.0.1:8080", "your_key")
nEngine, _ := neutron.NewEngine(nConfig)
// 使用 Templates.Filter 按指纹/标签筛选
filtered := (neutron.Templates{}).Merge(nEngine.Get()).Filter(func(t *neutronTemplates.Template) bool {
// 按 Fingers 字段匹配
for _, finger := range t.Fingers {
if _, ok := fingerNames[strings.ToLower(finger)]; ok {
return true
}
}
// 按 Tags 匹配
for _, tag := range t.GetTags() {
if _, ok := fingerNames[strings.ToLower(tag)]; ok {
return true
}
}
return false
})
// 3) 执行筛选后的 POC
task := &neutron.ExecuteTask{
Target: "http://target.example",
Templates: filtered.Templates(),
}
resultCh, _ := nEngine.Execute(neutron.NewContext(), task)
for range resultCh {
// consume results
}
}也可以使用 pkg/association 包中的 FingerPOCIndex 进行更高效的关联查询。
引擎支持在运行时动态添加指纹和 POC：
// Fingers: 动态添加指纹
engine.AddFingers(newFingers) // 添加指纹切片
engine.AddFingersFile("./custom.yaml") // 从文件/目录加载
// Neutron: 动态添加 POC
engine.AddPocs(newTemplates) // 添加模板切片
engine.AddPocsFile("./custom-pocs/") // 从文件/目录加载# 运行所有测试
go test ./...
# 运行特定包的测试
go test ./fingers -v
go test ./neutron -v
go test ./gogo -v
go test ./spray -v- 实现
pkg/interface.go中的核心接口 - 创建引擎包，包含
engine.go、config.go、init.go - 在
engine.go的 init 函数中注册 - 在
examples/中添加 CLI 工具
MIT License