![](https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEglo6MalGbIc81QBbz1jqOU8B0085n2UVJCaH9SfhIfxA0MYt1dEFk2-zwiD-qE16LkgxrJgrbgfuRdoyn1PJho_kqKA_0VlMfW9-waWAuhLT9El1w9XQpbyBj_-3MCTMml9gdUmU9k4Ek/s640/DependencyCheck.png) Dependency-Check is a utility that attempts to detect publicly disclosed vulnerabilities contained within project dependencies. It does this by determining if there is a Common Platform Enumeration (CPE) identifier for a given dependency. If found, it will generate a report linking to the associated CVE entries. Documentation and links to production binary releases can be found on the github pages. Additionally, more information about the architecture and ways to extend dependency-check can be found on the wiki. **Current Releases** **Jenkins Plugin** For instructions on the use of the Jenkins plugin please see the OWASP Dependency-Check Plugin page. **Command Line** More detailed instructions can be found on the dependency-check github pages. The latest CLI can be downloaded from bintray's dependency-check page. On *nix $ ./bin/dependency-check.sh -h $ ./bin/dependency-check.sh --project Testing --out . --scan [path to jar files to be scanned] On Windows > .\bin\dependency-check.bat -h > .\bin\dependency-check.bat --project Testing --out . --scan [path to jar files to be scanned] On Mac with Homebrew $ brew update && brew install dependency-check $ dependency-check -h $ dependency-check --project Testing --out . --scan [path to jar files to be scanned] **Maven Plugin** More detailed instructions can be found on the dependency-check-maven github pages. By default, the plugin is tied to the `verify` phase (i.e. `mvn verify`). Alternatively, one can directly invoke the plugin via `mvn org.owasp:dependency-check-maven:check`. The dependency-check plugin can be configured using the following: ... org.owasp dependency-check-maven check ... ... ... **Ant Task** For instructions on the use of the Ant Task, please see the dependency-check-ant github page. **Development Usage** The following instructions outline how to compile and use the current snapshot. While every intention is to maintain a stable snapshot it is recommended that the release versions listed above be used. The repository has some large files due to test resources. The team has tried to cleanup the history as much as possible. However, it is recommended that you perform a shallow clone to save yourself time: git clone --depth 1 some-email@example.com:jeremylong/DependencyCheck.git On *nix $ mvn install $ ./dependency-check-cli/target/release/bin/dependency-check.sh -h $ ./dependency-check-cli/target/release/bin/dependency-check.sh --project Testing --out . --scan ./src/test/resources On Windows > mvn install > .\dependency-check-cli\target\release\bin\dependency-check.bat -h > .\dependency-check-cli\target\release\bin\dependency-check.bat --project Testing --out . --scan ./src/test/resources Then load the resulting 'dependency-check-report.html' into your favorite browser. **Docker** In the following example it is assumed that the source to be checked is in the current working directory. Persistent data and report directories are used, allowing you to destroy the container after running. #!/bin/sh OWASPDC_DIRECTORY=$HOME/OWASP-Dependency-Check DATA_DIRECTORY="$OWASPDC_DIRECTORY/data" REPORT_DIRECTORY="$OWASPDC_DIRECTORY/reports" if [ ! -d "$DATA_DIRECTORY" ]; then echo "Initially creating persistent directories" mkdir -p "$DATA_DIRECTORY" chmod -R 777 "$DATA_DIRECTORY" mkdir -p "$REPORT_DIRECTORY" chmod -R 777 "$REPORT_DIRECTORY" fi # Make sure we are using the latest version docker pull owasp/dependency-check docker run --rm \ --volume $(pwd):/src \ --volume "$DATA_DIRECTORY":/usr/share/dependency-check/data \ --volume "$REPORT_DIRECTORY":/report \ owasp/dependency-check \ --scan /src \ --format "ALL" \ --project "My OWASP Dependency Check Project" # Use suppression like this: (/src == $pwd) # --suppression "/src/security/dependency-check-suppression.xml" **Upgrade Notes** **Upgrading from**1.x.x** to **2.x.x**** Note that when upgrading from version 1.x.x that the following changes will need to be made to your configuration. **Suppression file** In order to support multiple suppression files, the mechanism for configuring suppression files has changed. As such, users that have defined a suppression file in their configuration will need to update. See the examples below: **Ant** Old: New: **Maven** Old: org.owasp dependency-check-maven suppression.xml New: org.owasp dependency-check-maven suppression.xml **Gradle** In addition to the changes to the suppression file, the task `dependencyCheck` has been renamed to `dependencyCheckAnalyze`. Old: buildscript { repositories { mavenLocal() } dependencies { classpath 'org.owasp:dependency-check-gradle:2.0.1-SNAPSHOT' } } apply plugin: 'org.owasp.dependencycheck' dependencyCheck { suppressionFile='path/to/suppression.xml' } check.dependsOn dependencyCheckAnalyze New: buildscript { repositories { mavenLocal() } dependencies { classpath 'org.owasp:dependency-check-gradle:2.0.1-SNAPSHOT' } } apply plugin: 'org.owasp.dependencycheck' dependencyCheck { suppressionFiles = ['path/to/suppression1.xml', 'path/to/suppression2.xml'] } check.dependsOn dependencyCheckAnalyze **Download DependencyCheck**