开源项目 VCR 使用教程

开源项目 VCR 使用教程

vcr Vulnerability Compliance Report Tool used to parse Nessus files into html reports created by SynerComm, Inc. 项目地址: https://gitcode.com/gh_mirrors/vcr/vcr

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

VCR（Vulnerability Compliance Report Tool）项目的目录结构如下：

vcr/
├── LICENSE
├── Parse-Nessus.ps1
├── Parse-Nessus.pssproj
├── README.md
├── template-cisbenchmark/
│   ├── templateByVuln.html
│   ├── templateDashboard.html
│   └── templateFindings.html
└── template-networkscan/
    ├── templateByVuln.html
    ├── templateDashboard.html
    └── templateFindings.html

目录结构介绍

• LICENSE: 项目的许可证文件，采用 GPL-2.0 许可证。
• Parse-Nessus.ps1: 项目的主要脚本文件，用于解析 Nessus 文件并生成 HTML 报告。
• Parse-Nessus.pssproj: 项目的 PowerShell 项目文件。
• README.md: 项目的说明文件，包含项目的基本介绍和使用说明。
• template-cisbenchmark/: 用于 CIS Benchmark 扫描的模板文件夹。
  • templateByVuln.html: 漏洞报告模板文件。
  • templateDashboard.html: 主页面模板文件。
  • templateFindings.html: 单个 IP 的发现报告模板文件。
• template-networkscan/: 用于基本网络扫描的模板文件夹。
  • templateByVuln.html: 漏洞报告模板文件。
  • templateDashboard.html: 主页面模板文件。
  • templateFindings.html: 单个 IP 的发现报告模板文件。

2. 项目的启动文件介绍

项目的启动文件是 Parse-Nessus.ps1，这是一个 PowerShell 脚本文件。该脚本的主要功能是解析 Nessus 文件并生成 HTML 报告。

启动文件介绍

• Parse-Nessus.ps1: 该脚本接收多个参数，包括 Nessus 文件路径、客户名称、模板路径等。脚本会根据这些参数生成相应的 HTML 报告。

使用示例

PS C:\VCR> .\Parse-Nessus.ps1 -NessusFilePath "C:\vcr\acme.nessus" -CustomerName "Acme Corporation"

3. 项目的配置文件介绍

项目中没有明确的配置文件，但可以通过修改模板文件夹中的 HTML 模板文件来自定义报告的外观和内容。

配置文件介绍

• template-cisbenchmark/ 和 template-networkscan/: 这两个文件夹中包含了用于生成报告的 HTML 模板文件。用户可以根据需要修改这些模板文件，以定制报告的样式和内容。

自定义模板

1. 替换 Logo: 可以将 /images/logo.jpg 文件替换为自定义的 Logo。
2. 修改组织名称: 在 templateByVuln.html、templateDashboard.html 和 templateFindings.html 文件中，使用查找替换功能将“SynerComm”替换为自定义的组织名称。

通过以上步骤，用户可以轻松地定制 VCR 生成的报告，以满足特定的需求。

vcr Vulnerability Compliance Report Tool used to parse Nessus files into html reports created by SynerComm, Inc. 项目地址: https://gitcode.com/gh_mirrors/vcr/vcr