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.
For instructions on the use of the Jenkins plugin please see the OWASP Dependency-Check Plugin page.
$ ./bin/dependency-check.sh -h $ ./bin/dependency-check.sh --project Testing --out . --scan [path to jar files to be scanned]
> 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]
More detailed instructions can be found on the dependency-check-maven github pages.
The plugin can be configured using the following:
<project> <build> <plugins> ... <plugin> <groupId>org.owasp</groupId> <artifactId>dependency-check-maven</artifactId> <executions> <execution> <goals> <goal>check</goal> </goals> </execution> </executions> </plugin> ... </plugins> ... </build> ... </project>
For instructions on the use of the Ant Task, please see the dependency-check-ant github page.
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 email@example.com:jeremylong/DependencyCheck.git
$ 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
> 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 'DependencyCheck-Report.html' into your favorite browser.
In the following example it is assumed that the source to be checked is in the actual directory. A persistent data directory and a persistent report directory is used so that the container can be destroyed after running it to make sure that you use the newst version, always.
First, you checkout the Dockerfile and build the project:
mkdir dependency-check-build && cd dependency-check-build wget https://raw.githubusercontent.com/jeremylong/DependencyCheck/master/Dockerfile docker build -t dependency-check .
Afterwards, you can use the dependency-check localy like this:
# After the first run, feel free to change the owner of the directories to the owner of the creted files and the permissions to 744 DATA_DIRECTORY=$HOME/OWASP-Dependency-Check/data REPORT_DIRECTORY=/$HOME/OWASP-Dependency-Check/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 docker run --rm \ --volume $(pwd):/src \ --volume $DATA_DIRECTORY:/usr/share/dependency-check/data \ --volume $REPORT_DIRECTORY:/report \ --name dependency-check \ dependency-check \ --suppression "/src/security/dependency-check-suppression.xml"\ --format "ALL" \ --project "My OWASP Dependency Check Projekt"
Archive: google group
Copyright & License
Dependency-Check is Copyright (c) 2012-2016 Jeremy Long. All Rights Reserved.
Permission to modify and redistribute is granted under the terms of the Apache 2.0 license. See the LICENSE.txt file for the full license.
Dependency-Check makes use of several other open source libraries. Please see the NOTICE.txt file for more information.