编写教程

Autumn

1600字约5分钟

2024-11-17

插件市场：

插件模板

git clone https://github.com/Autumn-27/ScopeSentry-Plugin-Template.git

插件模板中提供了AssetHandle模块和SubdomainScan模块的demo

https://github.com/Autumn-27/ScopeSentry-Plugin-Template/tree/main/plugin/AssetHandle

https://github.com/Autumn-27/ScopeSentry-Plugin-Template/tree/main/plugin/SubdomainScan

系统模块

插件系统将整个流程分为了13个模块

"TargetHandler",
"SubdomainScan",
"SubdomainSecurity",
"AssetMapping",
"PortScanPreparation",
"PortScan",
"PortFingerprint",
"AssetHandle",
"URLScan",
"URLSecurity",
"WebCrawler",
"DirScan",
"VulnerabilityScan",

插件文件

导入插件需要两个文件

info.json

info.json

{
  "help":"无需参数/No parameters",
  "parameter":"",
  "name":"SubdomainScanDemo",
  "module": "SubdomainScan",
  "version":"v1.0",
  "introduction":"子域名扫描模块demo/Demo of SubdomainScan module"
}

help：参数提示信息
parameter：参数
name：插件名称
module：模块（模块需要准确）
version：版本
introduction：插件的简介

plugin.go

plugin.go （插件源码）

package plugin

func GetName() string {
	return ""
}

func Install() error {
	return nil
}

func Check() error {
	return nil
}

func Uninstall() error {
	return nil
}

func Execute(input interface{}, op options.PluginOption) (interface{}, error) {
	return nil, nil
}

插件编码要求

包名需要为plugin
需要提供5个方法，其中GetName的返回值需要和info.json一致
- GetName
- Install
- Check
- Uninstall
- Execute
系统加载插件时会执行Install()、Check()方法，卸载时会执行Uninstall()方法
Execute方法为实际执行的函数。

Execute方法

Execute方法的参数为input interface{}和 op options.PluginOption

PluginOption的定义在

https://github.com/Autumn-27/ScopeSentry-Plugin-Template/blob/main/internal/options/plugin.go

input参数为输入

type PluginOption struct {
	Name       string
	Module     string
	Parameter  string
	PluginId   string
	ResultFunc func(interface{})
	Custom     interface{}
	TaskId     string
	TaskName   string
	Log        func(msg string, tp ...string)
	Ctx        context.Context
}

Name 为插件名称

Module 为插件所属模块

Parameter 为插件参数

在创建插件时，填写参数信息可以使用{}来引用字典和端口

{dict.subdomain.default} 这个参数会替换为字典中subdomain类别的default名称的文件id

和

{port.top1000} 这个参数会替换为端口的top1000

参数解析参考（调用工具类的ParseArgs方法）:

args, err := utils.Tools.ParseArgs(parameter, "cdncheck", "screenshot")
  if err != nil {
  } else {
    for key, value := range args {
      if value != "" {
        switch key {
        case "cdncheck":
          cdncheck = value
        case "screenshot":
          if value == "true" {
            screenshot = true
          }
        default:
          continue
        }
      }
    }
  }

PluginId 插件id

ResultFunc 插件结果回调函数

比较特殊的是AssetHandle、PortScanPreparation、PortFingerprint模块，input输入为引用，直接修改input就是对结果的修改。

其余模块在获取到结果之后调用op.ResultFunc回调函数来返回结果

Custom 自定义的参数，未来用来拓展

TaskId 任务id 可以利用任务id来进行全局的去重

TaskName 任务名称

Log 日志打印函数

op.Log("test") // info类型日志

op.Log("test", "e") // error类型日志

op.Log("test", "d") // debug类型日志

op.Log("test", "w") // warning类型日志

插件可以调用的内置方法

目前由于插件系统的限制，无法调用第三方的库，所以在系统中内置了一些方法，可供调用，具体如下：

github.com/Autumn-27/ScopeSentry-Scan/pkg/logger
github.com/Autumn-27/ScopeSentry-Scan/pkg/utils
github.com/Autumn-27/ScopeSentry-Scan/internal/options
github.com/Autumn-27/ScopeSentry-Scan/internal/bigcache
github.com/Autumn-27/ScopeSentry-Scan/internal/config
github.com/Autumn-27/ScopeSentry-Scan/internal/contextmanager
github.com/Autumn-27/ScopeSentry-Scan/internal/global
github.com/Autumn-27/ScopeSentry-Scan/internal/interfaces
github.com/Autumn-27/ScopeSentry-Scan/internal/mongodb
github.com/Autumn-27/ScopeSentry-Scan/internal/notification
github.com/Autumn-27/ScopeSentry-Scan/internal/pool
github.com/Autumn-27/ScopeSentry-Scan/internal/redis
github.com/Autumn-27/ScopeSentry-Scan/internal/results
github.com/Autumn-27/ScopeSentry-Scan/internal/types

上边提到的包下边所有方法都可以调用、

主要会用的有如下 logger：日志包，日志提供了本地打印以及发送到redis的打印方式，具体参考源码

utils：工具包中提供了多种方法，获取当前时间、多种执行命令方式、发送http请求、发送dns请求

bigcache：基于内存的缓存管理，可以利用缓存进行去重

contextmanager：上下文管理器，每个任务都会创建一个上下文，任务的暂停于删除依赖于这个上下文管理，在编写插件时如果需要停止功能，需要利用这个上下文。

global：存储一些全局变量，包括节点名称等信息

mongodb： mongodb连接器

redis： redis连接器

notification：用于发送通知

pool：协程池管理

results：结果处理

types：结构体

各模块的输入输出

TargetHandler

该模块主要是对输入的原始目标进行处理，如: targetparser

该插件会对原始目标进行处理，详情可以看代码的注释。

该模块可以拓展的功能，比如输入的原始数据为"百度"，编写一个新的插件可以对公司名称的原始目标进行处理调用一些api或其他方式来获取该目标的一些域名和其他信息。

input

string

output

string

SubdomainScan

该模块为子域名扫描模块，可以集成任何子域名工具

input

string

output

types.SubdomainResult

SubdomainSecurity

该模块是子域名安全检测，对扫描出来的域名进行检测，结果会存入到SubdoaminTakerResult中

input

types.SubdomainResult

output

types.SubTakeResult

PortScanPreparation

该模块主要是在端口扫描前进行一些处理，处理是否需要跳过端口扫描，内置了一个简单的cdn判断，如果是cdn就跳过端口扫描。

该模块的输入是引用，会对DomainSkip直接进行修改

input

*types.DomainSkip

output

对输入直接进行修改

PortScan

该模块主要进行端口存活扫描

input

types.DomainSkip

output

types.PortAlive

PortFingerprint

该模块对存活的端口进行端口的指纹识别,同样是对输入直接进行修改，其中Type属性分为"http"和"other"，其余属性可以参考数据库中的信息。

input

*types.AssetOther

output

对输入直接进行修改

AssetMapping

该模块是对http的资产进行处理

input

types.AssetOther

output

types.AssetHttp

AssetHandle

该模块是对扫描出的资产进行处理，内置的插件是调用web的指纹识别对http资产进行指纹识别，可以拓展对非http端口进行弱口令扫描（目前无内置插件）。在该模块还可以对资产进行打标签。

input

types.AssetOther 或 types.AssetHttp

output

types.AssetOther 或 types.AssetHttp

URLScan

该模块是对http资产进行url发现，同时，如果Execute方法return的第一个参数为[]string url列表，则会一起发往爬虫模块

input

types.AssetHttp

output

types.UrlResult

WebCrawler

该模块是爬虫模块，内置插件是rad爬虫,该模块输入是前边url扫描发现的url

input

[]string

output

types.CrawlerResult

URLSecurity

该模块会对url扫描和爬虫扫描的结果进行处理，如内置插件扫描敏感信息泄露以及将url作为页面监控的目标。

input

types.CrawlerResult 或 types.UrlResult

output

该模块没有固定的输出，如果想要存储在数据库中，需要在Execute方法方法中自行操作

DirScan

目录扫描模块

input

types.AssetHttp

output

types.DirResult

VulnerabilityScan

漏洞扫描模块

input

types.AssetOther 或 types.AssetHttp

output

types.VulnResult