CVE-Half-Day-Watcher 项目使用教程

CVE-Half-Day-Watcher 项目使用教程

CVE-Half-Day-Watcher 项目地址: https://gitcode.com/gh_mirrors/cv/CVE-Half-Day-Watcher

1. 项目目录结构及介绍

CVE-Half-Day-Watcher/
├── .gitignore
├── LICENSE
├── README.md
├── github_api_request_handler.py
├── requirements.txt
└── scan.py

• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证文件，本项目使用MIT许可证。
• README.md: 项目的介绍文档，包含项目的基本信息、安装步骤和使用说明。
• github_api_request_handler.py: 处理GitHub API请求的模块。
• requirements.txt: 项目依赖的Python包列表。
• scan.py: 项目的启动文件，负责执行CVE扫描和GitHub仓库扫描。

2. 项目启动文件介绍

scan.py

scan.py 是CVE-Half-Day-Watcher项目的主要启动文件，负责执行以下功能：

• NVD扫描模式: 扫描国家漏洞数据库（NVD）中最新发布的CVE，并检查这些CVE是否在GitHub上有相关引用（如提交、拉取请求或问题）。
• 仓库扫描模式: 扫描指定的GitHub仓库，查找可能存在安全漏洞的拉取请求和问题。
• 交互模式: 提供一个交互式菜单，允许用户选择不同的扫描选项。

使用示例

NVD扫描模式

python scan.py --github_token YOUR_GITHUB_TOKEN --mode feed --days 3 --min_stars 150

仓库扫描模式

python scan.py --github_token YOUR_GITHUB_TOKEN --mode repo --repo_full_name YOUR_REPO_NAME

3. 项目配置文件介绍

requirements.txt

requirements.txt 文件列出了项目运行所需的Python包及其版本。在安装项目依赖时，可以使用以下命令：

pip install -r requirements.txt

.gitignore

.gitignore 文件用于指定Git版本控制系统忽略的文件和目录，例如虚拟环境文件、日志文件等。

LICENSE

LICENSE 文件包含了项目的开源许可证信息，本项目使用MIT许可证。

README.md

README.md 文件是项目的介绍文档，包含了项目的基本信息、安装步骤和使用说明。建议在开始使用项目前仔细阅读该文件。

通过以上介绍，您应该对CVE-Half-Day-Watcher项目的目录结构、启动文件和配置文件有了基本的了解。希望这份教程能帮助您顺利使用该项目。

CVE-Half-Day-Watcher 项目地址: https://gitcode.com/gh_mirrors/cv/CVE-Half-Day-Watcher