OWASP Dependency-Check Pack

In this section:

Introduction

OWASP Dependency-Check is an open-source tool that scans Java and .NET projects and identifies the use of known vulnerable components. You can view the official page for the OWASP Dependency-Check open-source tool here. Parasoft OWASP Dependency-Check Pack reads the results the OWASP Dependency-Check tool and reports vulnerabilities to Parasoft DTP in a standardized format. This enables DTP to present the data in widgets and to provide remediation paths for addressing the vulnerabilities.

Vulnerabilities are reported in DTP as violations of the OWASP Top 10 2021 A6: Vulnerable and Outdated Components guideline. Merging the OWASP Dependency-Check Pack data with code analysis results from Parasoft Jtest or dotTEST enables the full implementation of your OWASP security compliance initiative.

Requirements

Java Runtime 11.
X-Server access (Linux only). The DISPLAY variable must be set, and access control must be disabled for the xhost command (run xhost +). This is required to ensure that overview images in HTML reports display correctly.
OWASP Dependency-Check results in XML format. See the OWASP Dependency-Check documentation for details.
Analysis from OWASP Dependency-Check 11.0.0 is supported.

Deployment

Extract the dependency-check-pack-<VERSION>.zip file distribution to the desired location. Some extractor tools, such as the default Windows extractors, will create a directory for the dependency check pack files. We recommend creating an installation home directory if your tool does not automatically create a directory to hold the extracted files.
Follow the instructions for installing Security Compliance Pack into your DTP environment. This step is not required to run the OWASP Dependency-Check Pack, but it is required for viewing results in DTP.

OWASP Dependency-Check Rule Documentation

For DTP to display the OWASP Dependency-Check rule documentation, the rules shipped with the OWASP Dependency-Check Pack must be copied to the DTP rules directory.

Copy the contents of the <DEPENDENCY_CHECK_INSTALL>/rulesdoc/dependencycheck/ directory to the <DTP_INSTALL>/tomcat/webapps/grs/rulesdoc/ directory.

After copying the rules, documentation associated with OWASP Dependency-Check violations will be available in DTP interfaces, such as the Documentation tab of the Violations Explorer.

End User License Agreement Acceptance

Edit the settings.properties file located in the installation directory and set the following property to accept the Parasoft End User License Agreement (please read the EULA at https://www.parasoft.com/license):

parasoft.eula.accepted=true

Connecting to DTP

The OWASP Dependency-Check Pack is a separate tool and must connect to DTP to send results to your DTP project. Specify the following settings in the settings.properties file located in the installation directory.

dtp.url	Specifies the URL to your DTP server. Remember to include the `https://` protocol; DTP requires `https://` connections from other Parasoft tools.
dtp.user	Specifies the username for DTP authentication.
dtp.password	Specifies the user password for DTP authentication. You can encode your DTP password by running the dependency.sh or dependency.bat with the `-encodepass` parameter. For example: `./dependencycheck.sh -encodepass=<MYPASSWORD>`
dtp.project	Specifies the name of the existing DTP project that you want to link to.
build.id	Specifies the build that the data should be associated with. For accurate results, the build ID should match the build ID configured in your static analysis tool.

Usage

If you have not already done so, execute OWASP Dependency-Check. The results should be output to an XML file. To send these results to Parasoft DTP using OWASP Dependency-Check Pack:

Open a command prompt and navigate to the OWASP Dependency-Check Pack installation directory.
Execute the .BAT or .SH script with specifying the OWASP Dependency-Check results using the -results.file parameter, for example:
```
./dependencycheck.sh -results.file="/Users/admin/Desktop/dependency_check.xml"
```
The -results.file is the only required parameter, but you can pass the following optional parameters:
-parasoft.local.storage.dir: This setting specifies the location for generated log files. The recommended location is ${project.base.dir}/.dependencycheck. For example:
-parasoft.local.storage.dir=.dependencycheck
-settings: By default, the OWASP Dependency-Check Pack will reference the settings.properties file in the installation directory, but you can use this setting to point to alternate configuration files. Example:
-settings=C:\my-team-configs\my-settings.properties

Viewing Results

After executing the OWASP Dependency-Check Pack, results are output in two ways:

As local Parasoft HTML reports. The local HTML report (and XML data that feeds the report) are saved to the <DTP_INSTALL>/reports directory after execution.
Sent to DTP and presented in widgets, reports, and other visualizations. Vulnerabilities are reported in DTP as violations of the OWASP Top 10 2021 A6: Vulnerable and Outdated Components guideline. See OWASP Compliance for details on viewing violations in DTP.

Page tree