SploitScan 项目使用教程

SploitScan 项目使用教程

SploitScan SploitScan is a sophisticated cybersecurity utility designed to provide detailed information on vulnerabilities and associated exploits. 项目地址: https://gitcode.com/gh_mirrors/sp/SploitScan

1. 项目目录结构及介绍

SploitScan 项目目录结构如下：

SploitScan/
├── .github/
│   └── workflows/
├── docs/
├── sploitscan/
├── .gitignore
├── CHANGELOG.md
├── Dockerfile
├── LICENSE
├── README.md
├── pyproject.toml
├── requirements.txt
└── sploitscan.py

• .github/workflows/: 存放 GitHub Actions 工作流文件，用于自动化项目的某些流程，如代码测试、构建等。
• docs/: 存放项目文档。
• sploitscan/: 可能是存放项目相关文件的目录，但具体内容未在示例中给出。
• .gitignore: 指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录项目历史版本的更新和变化。
• Dockerfile: 用于创建 Docker 容器的配置文件。
• LICENSE: 项目使用的开源许可证文件。
• README.md: 项目描述文件，包含了项目的基本信息和如何使用项目。
• pyproject.toml: Python 项目配置文件，用于定义项目信息和依赖。
• requirements.txt: 项目所需的 Python 包依赖列表。
• sploitscan.py: 项目的启动和执行文件。

2. 项目的启动文件介绍

项目的启动文件是 sploitscan.py，它包含了项目的入口点。以下是启动文件的基本使用方式：

$ python sploitscan.py [-h] [-e {json,csv,html}] [-t {nessus,nexpose,openvas,docker}] [--ai {openai,google,grok,deepseek}] [-k KEYWORDS [KEYWORDS ...]] [-local] [-f] [-m METHODS] [-i IMPORT_FILE] [-c CONFIG] [-d] [cve_ids ...]

这个脚本可以通过不同的参数来进行配置和使用，例如：

• -h: 显示帮助信息。
• -e {json,csv,html}: 指定导出结果的格式。
• -t {nessus,nexpose,openvas,docker}: 指定导入文件的类型。
• --ai {openai,google,grok,deepseek}: 选择风险评估的 AI 提供商。
• -k KEYWORDS [KEYWORDS ...]: 根据关键字搜索 CVE。
• -local: 下载本地 CVE 列表数据库。
• -f: 启用快速模式。
• -m METHODS: 指定要运行的方法。
• -i IMPORT_FILE: 指定导入文件的路径。
• -c CONFIG: 指定配置文件的路径。
• -d: 启用调试输出。
• cve_ids: 指定 CVE ID。

3. 项目的配置文件介绍

项目的配置文件是 config.json，它用于存储项目运行时所需的各种配置信息，如 API 密钥等。配置文件的默认查找路径为：

• 当前工作目录
• ~/.sploitscan/config.json
• ~/.config/sploitscan/config.json
• ~/Library/Application Support/sploitscan/config.json (macOS)
• %APPDATA%/sploitscan/config.json (Windows)
• /etc/sploitscan/config.json

配置文件的内容如下：

{
  "vulncheck_api_key": "",
  "openai_api_key": "",
  "google_api_key": "",
  "grok_api_key": "",
  "deepseek_api_key": ""
}

在这个配置文件中，可以设置不同的 API 密钥，这些密钥可能在项目运行时用于访问外部服务或 API。每个密钥字段都是一个字符串，需要用户根据实际情况填写。

SploitScan SploitScan is a sophisticated cybersecurity utility designed to provide detailed information on vulnerabilities and associated exploits. 项目地址: https://gitcode.com/gh_mirrors/sp/SploitScan