Shhgit 项目使用教程

1. 项目的目录结构及介绍

Shhgit 是一个用于检测 GitHub 上公开代码库中敏感信息的工具。以下是 Shhgit 项目的目录结构及其介绍：

shhgit/
├── config.yaml
├── main.go
├── README.md
├── ...
└── vendor/

• config.yaml: 项目的配置文件，用于设置扫描速率、搜索模式和输出格式等。
• main.go: 项目的启动文件，包含了 Shhgit 的主要逻辑。
• README.md: 项目的说明文档，包含了项目的简介、安装方法和使用示例。
• vendor/: 存放项目依赖的第三方库。

2. 项目的启动文件介绍

Shhgit 的启动文件是 main.go。该文件包含了 Shhgit 的主要逻辑，负责初始化配置、启动扫描任务以及处理扫描结果。以下是 main.go 文件的主要功能模块：

• 初始化配置: 读取 config.yaml 文件中的配置信息，并根据配置初始化扫描任务。
• 启动扫描任务: 根据配置的扫描速率和搜索模式，持续监控 GitHub 上的公开代码库，检测敏感信息。
• 处理扫描结果: 将检测到的敏感信息输出到指定位置，并根据配置发送通知。

3. 项目的配置文件介绍

Shhgit 的配置文件是 config.yaml。该文件用于配置扫描速率、搜索模式和输出格式等。以下是 config.yaml 文件的主要配置项：

scan:
  rate: 60  # 扫描速率，单位为秒
exclude:
  - org/repo  # 排除特定的仓库或文件路径
search:
  patterns:
    - regex: '(i)(access|api|auth|key|pass|secret)_'  # 自定义搜索模式
output:
  format: "shhgit_output.json"  # 输出格式
  overwrite: false  # 是否覆盖输出文件

• scan.rate: 设置扫描速率，即两次扫描之间的时间间隔。
• exclude: 排除特定的仓库或文件路径，避免不必要的扫描。
• search.patterns: 自定义搜索模式，用于检测敏感信息。
• output: 配置输出格式和是否覆盖输出文件。

通过修改 config.yaml 文件，用户可以根据自己的需求定制 Shhgit 的扫描行为。