OWASP BenchmarkJava 项目使用教程

2024-09-27 01:59:58作者：殷蕙予

OWASP Benchmark is a test suite designed to verify the speed and accuracy of software vulnerability detection tools. A fully runnable web app written in Java, it supports analysis by Static (SAST), Dynamic (DAST), and Runtime (IAST) tools that support Java. The idea is that since it is fully runnable and all the vulnerabilities are actually exploitable, it’s a fair test for any kind of vulnerability detection tool. For more details on this project, please see the OWASP Benchmark Project home page.

项目地址：https://gitcode.com/gh_mirrors/be/BenchmarkJava

1. 项目目录结构及介绍

BenchmarkJava/
├── github/workflows/
├── mvn/
├── VMs/
├── data/
├── results/
├── scorecard/
├── scripts/
├── src/
├── tools/
├── .gitattributes
├── .gitignore
├── keystore
├── travis.yml
├── DevStyleHtml.prefs
├── DevStyleXml.prefs
├── LICENSE
├── OWASP Benchmark.URL
├── README.md
├── createAnonScorecards.sh
├── createScorecards.bat
├── createScorecards.sh
├── expectedresults-1.2.csv
├── pom.xml
├── runBenchmark.bat
├── runBenchmark.sh
├── runCrawler.bat
├── runCrawler.sh
├── runRemoteAccessibleBenchmark.bat
└── runRemoteAccessibleBenchmark.sh

目录结构说明

github/workflows/: 包含GitHub Actions的工作流配置文件。
mvn/: 包含Maven相关的配置和脚本。
VMs/: 虚拟机相关的配置和脚本。
data/: 项目运行时生成的数据文件。
results/: 项目运行结果的存储目录。
scorecard/: 包含评分卡相关的文件。
scripts/: 包含项目运行所需的脚本文件。
src/: 项目的源代码目录。
tools/: 包含项目使用的工具和插件。
.gitattributes: Git属性配置文件。
.gitignore: Git忽略文件配置。
keystore: 密钥存储文件。
travis.yml: Travis CI配置文件。
DevStyleHtml.prefs: 开发风格HTML配置文件。
DevStyleXml.prefs: 开发风格XML配置文件。
LICENSE: 项目许可证文件。
OWASP Benchmark.URL: OWASP Benchmark项目的URL文件。
README.md: 项目说明文档。
createAnonScorecards.sh: 创建匿名评分卡的脚本。
createScorecards.bat: 创建评分卡的批处理脚本。
createScorecards.sh: 创建评分卡的Shell脚本。
expectedresults-1.2.csv: 预期结果的CSV文件。
pom.xml: Maven项目配置文件。
runBenchmark.bat: 运行Benchmark的批处理脚本。
runBenchmark.sh: 运行Benchmark的Shell脚本。
runCrawler.bat: 运行爬虫的批处理脚本。
runCrawler.sh: 运行爬虫的Shell脚本。
runRemoteAccessibleBenchmark.bat: 运行远程可访问Benchmark的批处理脚本。
runRemoteAccessibleBenchmark.sh: 运行远程可访问Benchmark的Shell脚本。

2. 项目启动文件介绍

启动文件

runBenchmark.bat: 用于Windows系统的批处理脚本，启动Benchmark项目。
runBenchmark.sh: 用于Linux/Unix系统的Shell脚本，启动Benchmark项目。

使用方法

在Windows系统中，打开命令提示符，导航到项目根目录，然后运行：

runBenchmark.bat

在Linux/Unix系统中，打开终端，导航到项目根目录，然后运行：

./runBenchmark.sh

3. 项目配置文件介绍

主要配置文件

pom.xml: Maven项目配置文件，定义了项目的依赖、插件、构建配置等。
travis.yml: Travis CI配置文件，定义了持续集成的工作流程。
keystore: 密钥存储文件，用于安全相关的配置。

配置文件说明

pom.xml:
- dependencies: 定义了项目所需的依赖库。
- plugins: 定义了项目使用的Maven插件。
- build: 定义了项目的构建配置。
travis.yml:
- language: 定义了项目使用的编程语言。
- script: 定义了Travis CI运行时的脚本命令。
- before_install: 定义了安装前的准备工作。
- install: 定义了安装依赖的命令。
keystore:
- 用于存储密钥和证书，确保项目的安全性。