docs: 更新文档
Some checks failed
Python application test / build (pull_request) Failing after 12s

This commit is contained in:
dqy 2024-04-30 21:39:12 +08:00
parent 7557f11672
commit 6131de5ed1
3 changed files with 12 additions and 8 deletions

View File

@ -42,7 +42,8 @@ python backdoor_detection.py ./src -o ./output/report.pdf
**主要组件**: **主要组件**:
- `load_vulnerable_packages(filename)`: 从给定的文件中加载包含漏洞的包信息。 - `parse_html`: 爬取网站收集的漏洞依赖信息。
- `trans_vulnerable_packages(content)`: 将漏洞版本中的集合形式转换为大于小于的格式。
- `load_requirements(filename)`: 从项目的 `requirements.txt` 文件中加载依赖信息。 - `load_requirements(filename)`: 从项目的 `requirements.txt` 文件中加载依赖信息。
- `output_results(filename, results, format_type)`: 根据指定格式输出检测结果。 - `output_results(filename, results, format_type)`: 根据指定格式输出检测结果。
- `check_vulnerabilities(requirements, vulnerabilities, output_file)`: 核心功能,对比依赖与漏洞信息并生成报告。 - `check_vulnerabilities(requirements, vulnerabilities, output_file)`: 核心功能,对比依赖与漏洞信息并生成报告。
@ -50,7 +51,6 @@ python backdoor_detection.py ./src -o ./output/report.pdf
**输入**: **输入**:
- 依赖漏洞文件路径。
- 项目 `requirements.txt` 文件路径。 - 项目 `requirements.txt` 文件路径。
- 输出文件路径和格式(通过命令行参数指定)。 - 输出文件路径和格式(通过命令行参数指定)。
@ -67,7 +67,7 @@ python backdoor_detection.py ./src -o ./output/report.pdf
**使用示例**: **使用示例**:
```bash ```bash
python requirements_detection.py vulnerabilities_data.txt requirements.txt -o ./output/report.md python requirements_detection.py ./requirements.txt -o ./output/report.md
``` ```
--- ---

View File

@ -40,7 +40,13 @@
- **主要应用**读取漏洞数据文件和依赖文件输出结果报告到文本、Markdown、HTML 或 PDF 文件。 - **主要应用**读取漏洞数据文件和依赖文件输出结果报告到文本、Markdown、HTML 或 PDF 文件。
## 7. 代码和风险分析 ## 7. 爬虫
利用`python``BeautifulSoup`制作爬虫快速收集整理信息
- **主要应用**:通过爬虫收集漏洞依赖信息并进行汇总,用于判断依赖是否存在漏洞版本。
## 8. 代码和风险分析
项目中实现了基本的静态代码分析功能,用于识别和报告潜在的安全风险函数调用,如 `system``exec` 等。 项目中实现了基本的静态代码分析功能,用于识别和报告潜在的安全风险函数调用,如 `system``exec` 等。

View File

@ -26,20 +26,18 @@ pip install packaging reportlab
**命令格式** **命令格式**
```bash ```bash
python requirements_detection.py <vulnerabilities_file> <requirements_file> -o <output_file> python requirements_detection.py <requirements_file> -o <output_file>
``` ```
**参数说明** **参数说明**
- `<vulnerabilities_file>`: 包含漏洞信息的文件路径。
- `<requirements_file>`: 项目的 `requirements.txt` 文件路径。 - `<requirements_file>`: 项目的 `requirements.txt` 文件路径。
- `<output_file>`: 指定输出结果的文件路径和格式,支持的格式有 `.txt`, `.md`, `.html`, `.pdf` - `<output_file>`: 指定输出结果的文件路径和格式,支持的格式有 `.txt`, `.md`, `.html`, `.pdf`
**示例** **示例**
```bash ```bash
python requirements_detection.py vulnerabilities_data.txt requirements.txt -o output/report.md python requirements_detection.py requirements.txt -o output/report.md
``` ```
## 运行静态代码后门检测脚本 ## 运行静态代码后门检测脚本