ScopeSentry

https://www.scope-sentry.top/guide/
Admin
ScopeSentry is a comprehensive security scanning platform that provides asset reconnaissance,...
Tokens:7,105
Snippets:103
Trust Score:4.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Web/Server Component from Source

Source: https://www.scope-sentry.top/guide/Distributed

Clone the ScopeSentry repository, install dependencies, create a config.yaml file with database connection details, and run the main Python script.

```bash
git clone https://github.com/Autumn-27/ScopeSentry.git
cd ScopeSentry
pip install -r requirements.txt
```

```yaml
logs:
  total_logs: 1000
mongodb:
  mongodb_database: ScopeSentry
  ip: 127.0.0.1
  password: ""
  port: 27017
  username: admin
redis:
  ip: 127.0.0.1
  password: ""
  port: '6379'
system:
  timezone: Asia/Shanghai
```

```bash
python3 main.py
```

--------------------------------

### ScopeSentry Configuration File Example

Source: https://www.scope-sentry.top/guide/install

Example configuration file for ScopeSentry when running from source. Modify MongoDB and Redis connection details as needed.

```yaml
logs:
  total_logs: 1000
mongodb:
  database_name: ScopeSentry
  ip: 127.0.0.1
  password: QckSdkg5CKvtxfec
  port: 27017
  username: root
redis:
  ip: 127.0.0.1
  password: ScopeSentry
  port: '6379'
system:
  timezone: Asia/Shanghai
```

--------------------------------

### Clone and Start Redis with Docker Compose

Source: https://www.scope-sentry.top/guide/Distributed

Clone the ScopeSentry-Scan repository, navigate to the build directory, and start Redis using Docker Compose. Remember to configure the REDIS_PASSWORD in the .env file.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 修改 .env文件中的REDIS_PASSWORD
docker-compose -f redis-docker-compose.yml up -d
```

--------------------------------

### Clone and Start MongoDB with Docker Compose

Source: https://www.scope-sentry.top/guide/Distributed

Clone the ScopeSentry-Scan repository, navigate to the build directory, and start MongoDB using Docker Compose. Ensure you configure MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD in the .env file.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 修改 .env文件中的MONGO_INITDB_ROOT_USERNAME、MONGO_INITDB_ROOT_PASSWORD
docker-compose -f mongodb-docker-compose.yml up -d
```

--------------------------------

### Install Web/Server Component with Docker Compose

Source: https://www.scope-sentry.top/guide/Distributed

Clone the ScopeSentry-Scan repository, navigate to the build directory, and deploy the web/server component using Docker Compose. Configure MongoDB and Redis connection details in the .env file.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 修改 .env文件中的mongodb、redis账号密码以及地址端口
docker-compose -f server-docker-compose.yml up -d
```

--------------------------------

### Install ScopeSentry Dependencies from Source

Source: https://www.scope-sentry.top/guide/install

Install Python dependencies for ScopeSentry from source. This is required before configuring and running the application from source code.

```bash
git clone https://github.com/Autumn-27/ScopeSentry.git
cd ScopeSentry
pip install -r requirements.txt
```

--------------------------------

### Run ScopeSentry from Source

Source: https://www.scope-sentry.top/guide/install

Execute the main Python script to run ScopeSentry after installing dependencies and configuring the application.

```bash
python3 main.py
```

--------------------------------

### Install Scan Component with Docker Compose

Source: https://www.scope-sentry.top/guide/Distributed

Clone the ScopeSentry-Scan repository, navigate to the build directory, and deploy the scan component using Docker Compose. Configure MongoDB and Redis connection details in the .env file and ensure NodeName is unique.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 编辑 .env文件中Mongdb、Redis的连接信息，NodeName为节点名称，每个节点名称请保持唯一性（如果为空会随机生成，可在web界面更改名称）。
docker-compose -f scan-docker-compose.yml up -d
```

--------------------------------

### DingTalk Notification Configuration

Source: https://www.scope-sentry.top/guide/system-config

Example of a DingTalk notification message format. Replace '*msg*' with your actual message content.

```json
{"at":{"atUserIds":["014728255240768602"],"isAtAll":false},"text":{"content":"ScoSen*msg*"},"msgtype":"text"}
```

--------------------------------

### 插件plugin.go文件结构

Source: https://www.scope-sentry.top/guide/2ixl876k

插件的Go源码文件，需要实现特定的方法。GetName的返回值必须与info.json中的name字段一致。

```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
}
```

--------------------------------

### PluginOption结构体定义

Source: https://www.scope-sentry.top/guide/2ixl876k

Execute方法接收的op参数的结构体定义，包含了插件执行所需的各种配置和回调函数。

```go
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
}
```

--------------------------------

### Deploy Web/Server Component with Docker Compose

Source: https://www.scope-sentry.top/guide/install

Deploy the main ScopeSentry web and server components using Docker Compose. Ensure you configure the Redis and MongoDB connection details in the docker-compose.yml file.

```bash
git clone https://github.com/Autumn-27/ScopeSentry.git
cd ScopeSentry
# 编辑docke-compose.yml文件中Redis、MongoDb的IP、端口、账号密码
docker-compose up -d
```

--------------------------------

### Compile and Run Scan Component from Source

Source: https://www.scope-sentry.top/guide/install

Compile and run the ScopeSentry scan component from its source code. This requires Go and libpcap environment. The first run will generate a configuration file to set database connection details.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan
go build -o dist/ScopeSentry ./cmd/ScopeSentry/main.go
cd dist
chmod +x ScopeSentry
./ScopeSentry
#首次运行会生成配置文件，修改配置文件中的数据库地址，重新运行
```

--------------------------------

### Deploy Redis with Docker Compose

Source: https://www.scope-sentry.top/guide/install

Set up a Redis instance using Docker Compose. Remember to change 'yourpassword' in the redis-docker-compose.yml file to your desired password.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 编辑 redis-docker-compose.yml文件中的yourpassword密码
docker-compose -f redis-docker-compose.yml up -d
```

--------------------------------

### 克隆ScopeSentry插件模板

Source: https://www.scope-sentry.top/guide/2ixl876k

使用git clone命令获取ScopeSentry插件开发的官方模板。

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

--------------------------------

### Single-Host Deployment with Docker Compose

Source: https://www.scope-sentry.top/guide/install

Use this command to deploy ScopeSentry on a single machine using Docker Compose. Ensure you modify the .env file for MongoDB and Redis credentials.

```bash
git clone https://github.com/Autumn-27/ScopeSentry.git
cd ScopeSentry
# 修改.env文件中的mongodb、redis账号密码。
docker-compose -f single-host-deployment.yml up -d
```

--------------------------------

### Execute方法参数解析示例

Source: https://www.scope-sentry.top/guide/2ixl876k

演示如何在Execute方法中解析插件参数，并根据参数值设置相应的变量。支持引用字典和端口。

```go
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
        }
      }
    }
  }
```

--------------------------------

### Build and Run ScopeSentry Docker Image Locally

Source: https://www.scope-sentry.top/guide/install

Build a custom ScopeSentry Docker image locally if pulling the official image is slow. After building, you can run the application using Docker Compose.

```bash
git clone https://github.com/Autumn-27/ScopeSentry.git
mv ScopeSentry/dockerfile .
docker build -t autumn27/scopesentry:latest .
cd ScopeSentry
docker-compose up -d
```

--------------------------------

### 日志打印示例

Source: https://www.scope-sentry.top/guide/2ixl876k

使用op.Log函数打印不同级别的日志信息，包括info、error、debug和warning。

```go
op.Log("test") // info类型日志
op.Log("test", "e") // error类型日志
op.Log("test", "d") // debug类型日志
op.Log("test", "w") // warning类型日志
```

--------------------------------

### URL Discovery Module for HTTP Assets

Source: https://www.scope-sentry.top/guide/2ixl876k

This module discovers URLs for HTTP assets. If the 'Execute' method returns a string slice of URLs, they are sent to the crawler module.

```go
types.AssetHttp
```

--------------------------------

### Subdomain Brute-forcing with Ksubdomain

Source: https://www.scope-sentry.top/guide/task

Employs Ksubdomain for stateless subdomain brute-forcing. Dictionary management is handled separately. Refer to the Ksubdomain GitHub repository for more information.

```bash
Ksubdomain
```

--------------------------------

### Deploy Scan Component with Docker Compose

Source: https://www.scope-sentry.top/guide/install

Deploy the ScopeSentry scan component using Docker Compose. Ensure you configure MongoDB, Redis connection details, and a unique NodeName in the scan-docker-compose.yml file.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 编辑 scan-docker-compose.yml文件中Mongdb、Redis的连接信息，NodeName为节点名称，每个节点名称请保持唯一性（如果为空会随机生成，可在web界面更改名称）。
docker-compose -f scan-docker-compose.yml up -d
```

--------------------------------

### 插件info.json文件结构

Source: https://www.scope-sentry.top/guide/2ixl876k

定义插件的基本信息，包括名称、模块、版本和简介。确保module字段与实际插件模块匹配。

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

--------------------------------

### Asset Handling Module

Source: https://www.scope-sentry.top/guide/2ixl876k

This module processes scanned assets. It includes a built-in plugin for web fingerprinting on HTTP assets and can be extended for non-HTTP port vulnerability scanning. Assets can also be tagged within this module.

```go
types.AssetOther 或 types.AssetHttp
```

--------------------------------

### Asset Mapping Module for HTTP Assets

Source: https://www.scope-sentry.top/guide/2ixl876k

This module processes HTTP assets. It transforms an 'AssetOther' type to 'AssetHttp'.

```go
types.AssetOther
```

--------------------------------

### Port Fingerprinting Module

Source: https://www.scope-sentry.top/guide/2ixl876k

This module performs port fingerprinting on live ports. It modifies the input directly. The 'Type' attribute can be 'http' or 'other'. Other attributes refer to database information.

```go
*types.AssetOther
```

--------------------------------

### URL Discovery with Waybackurls

Source: https://www.scope-sentry.top/guide/task

Leverages waybackurls to discover historical URLs. This is a prerequisite for sensitive information scanning.

```bash
waybackurls
```

--------------------------------

### Crawler Configuration

Source: https://www.scope-sentry.top/guide/task

Configures the crawler, which integrates with URL scanning results. This process can be memory and CPU intensive, so adjust parallel threads based on system configuration. Crawler settings are managed within 'rad'.

```bash
rad
```

--------------------------------

### Subdomain Scanning with Subfinder

Source: https://www.scope-sentry.top/guide/task

Utilizes Subfinder for subdomain enumeration. Refer to the official Subfinder GitHub repository for more details.

```bash
Subfinder
```

--------------------------------

### Deploy MongoDB with Docker Compose

Source: https://www.scope-sentry.top/guide/install

Deploy MongoDB using Docker Compose. You need to edit the mongodb-docker-compose.yml file to set your preferred username and password.

```bash
git clone https://github.com/Autumn-27/ScopeSentry-Scan.git
cd ScopeSentry-Scan/build
# 编辑 mongodb-docker-compose.yml文件中的账号密码
docker-compose -f mongodb-docker-compose.yml up -d
```

--------------------------------

### TargetHandler模块输入输出

Source: https://www.scope-sentry.top/guide/2ixl876k

TargetHandler模块处理原始目标输入，输出处理后的字符串目标。

```plaintext
input
```
string
```

output
```
string
```
```

--------------------------------

### Web Crawler Module

Source: https://www.scope-sentry.top/guide/2ixl876k

This is the crawler module, using the 'rad' crawler as a built-in plugin. The input for this module is the list of URLs discovered by the preceding URL scan.

```go
[]string
```

--------------------------------

### URL Security Processing Module

Source: https://www.scope-sentry.top/guide/2ixl876k

This module processes results from URL scanning and web crawling. Built-in plugins scan for sensitive information leaks and use URLs as targets for page monitoring. There is no fixed output; custom database storage must be implemented in the 'Execute' method.

```go
types.CrawlerResult 或 types.UrlResult
```

--------------------------------

### PortScanPreparation模块输入输出

Source: https://www.scope-sentry.top/guide/2ixl876k

PortScanPreparation模块接收指向DomainSkip的指针作为输入，并直接修改该输入以决定是否跳过端口扫描。

```plaintext
input
```
*types.DomainSkip
```

output
```
对输入直接进行修改
```
```

--------------------------------

### PortScan模块输入输出

Source: https://www.scope-sentry.top/guide/2ixl876k

PortScan模块接收DomainSkip结构体作为输入，执行端口存活扫描并输出结果。

```plaintext
input
```
types.DomainSkip
```

output
```
types.PortAlive
```
```

--------------------------------

### Initialize MongoDB Password via Docker

Source: https://www.scope-sentry.top/guide/Distributed

Use this command to reset the MongoDB user password within a running Docker container. Ensure you have the correct container name and database details.

```bash
docker exec -it scopesentry-mongodb mongosh -u admin -p password --eval 'db = db.getSiblingDB("ScopeSentry"); db.user.updateOne({ "username": "ScopeSentry" }, { $set: { "password": "b0ce71fcbed8a6ca579d52800145119cc7d999dc8651b62dfc1ced9a984e6e64" } })'
```

--------------------------------

### SubdomainScan模块输入输出

Source: https://www.scope-sentry.top/guide/2ixl876k

SubdomainScan模块接收字符串目标作为输入，输出子域名扫描结果。

```plaintext
input
```
string
```

output
```
types.SubdomainResult
```
```

--------------------------------

### 系统模块列表

Source: https://www.scope-sentry.top/guide/2ixl876k

ScopeSentry插件系统划分的13个核心模块，插件需要指定其所属模块。

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

--------------------------------

### SubdomainSecurity模块输入输出

Source: https://www.scope-sentry.top/guide/2ixl876k

SubdomainSecurity模块接收子域名扫描结果作为输入，输出子域名安全检测结果。

```plaintext
input
```
types.SubdomainResult
```

output
```
types.SubTakeResult
```
```
Tokens:
Raw