Fork me on GitHub

Goals

Goal Description
aggregate Runs dependency-check against the child projects and aggregates the results into a single report. Warning: if the aggregate goal is used within the site reporting a blank report will likely be present for any goal beyond site:site (i.e. site:stage or site:deploy will likely result in blank reports being staged or deployed); however, site:site will work. See issue #325 for more information.
check Runs dependency-check against the project and generates a report.
update-only Updates the local cache of the NVD data from NIST.
purge Deletes the local copy of the NVD. This is used to force a refresh of the data.

Configuration

The following properties can be set on the dependency-check-maven plugin.

Property Description Default Value
autoUpdate Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. true
cveValidForHours Sets the number of hours to wait before checking for new updates from the NVD. 4
failBuildOnCVSS Specifies if the build should be failed if a CVSS score equal to or above a specified level is identified. The default is 11 which means since the CVSS scores are 0-10, by default the build will never fail. 11
failBuildOnAnyVulnerability Specific that if any vulnerability is identified, the build will fail. false
failOnError Whether the build should fail if there is an error executing the dependency-check analysis. true
format The report format to be generated (HTML, XML, CSV, JSON, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. HTML
name The name of the report in the site. dependency-check or dependency-check:aggregate
outputDirectory The location to write the report(s). Note, this is not used if generating the report as part of a mvn site build. ‘target’
scanSet An optional collection of filesets that specify additional files and/or directories to analyze as part of the scan. If not specified, defaults to standard Maven conventions. src/main/resources, src/main/filters, src/main/webapp
skip Skips the dependency-check analysis. false
skipProvidedScope Skip analysis for artifacts with Provided Scope. false
skipRuntimeScope Skip analysis for artifacts with Runtime Scope. false
skipSystemScope Skip analysis for artifacts with System Scope. false
skipTestScope Skip analysis for artifacts with Test Scope. true
skipArtifactType A regular expression used to filter/skip artifact types.  
suppressionFiles The file paths to the XML suppression files - used to suppress false positives.  
hintsFile The file path to the XML hints file - used to resolve false negatives.  
enableExperimental Enable the experimental analyzers. If not enabled the experimental analyzers (see below) will not be loaded or used. false
enableRetired Enable the retired analyzers. If not enabled the retired analyzers (see below) will not be loaded or used. false

Analyzer Configuration

The following properties are used to configure the various file type analyzers. These properties can be used to turn off specific analyzers if it is not needed. Note, that specific analyzers will automatically disable themselves if no file types that they support are detected - so specifically disabling them may not be needed.

Property Description Default Value
archiveAnalyzerEnabled Sets whether the Archive Analyzer will be used. true
zipExtensions A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed.  
jarAnalyzer Sets whether Jar Analyzer will be used. true
centralAnalyzerEnabled Sets whether Central Analyzer will be used. If this analyzer is being disabled there is a good chance you also want to disable the Nexus Analyzer (see below). true
nexusAnalyzerEnabled Sets whether Nexus Analyzer will be used (requires Nexus Pro). This analyzer is superceded by the Central Analyzer; however, you can configure this to run against a Nexus Pro installation. true
nexusUrl Defines the Nexus Server’s web service end point (example http://domain.enterprise/service/local/). If not set the Nexus Analyzer will be disabled.  
nexusUsesProxy Whether or not the defined proxy should be used when connecting to Nexus. true
pyDistributionAnalyzerEnabled Sets whether the experimental Python Distribution Analyzer will be used. true
pyPackageAnalyzerEnabled Sets whether the experimental Python Package Analyzer will be used. true
rubygemsAnalyzerEnabled Sets whether the experimental Ruby Gemspec Analyzer will be used. true
opensslAnalyzerEnabled Sets whether the openssl Analyzer should be used. true
cmakeAnalyzerEnabled Sets whether the experimental CMake Analyzer should be used. true
autoconfAnalyzerEnabled Sets whether the experimental autoconf Analyzer should be used. true
composerAnalyzerEnabled Sets whether the experimental PHP Composer Lock File Analyzer should be used. true
nodeAnalyzerEnabled Sets whether the retired Node.js Analyzer should be used. true
nspAnalyzerEnabled Sets whether the NSP Analyzer should be used. true
nuspecAnalyzerEnabled Sets whether the .NET Nuget Nuspec Analyzer will be used. true
cocoapodsAnalyzerEnabled Sets whether the experimental Cocoapods Analyzer should be used. true
bundleAuditAnalyzerEnabled Sets whether the experimental Bundle Audit Analyzer should be used. true
bundleAuditPath Sets the path to the bundle audit executable; only used if bundle audit analyzer is enabled and experimental analyzers are enabled.  
swiftPackageManagerAnalyzerEnabled Sets whether the experimental Switft Package Analyzer should be used. true
assemblyAnalyzerEnabled Sets whether the .NET Assembly Analyzer should be used. true
pathToMono The path to Mono for .NET assembly analysis on non-windows systems.  

Advanced Configuration

The following properties can be configured in the plugin. However, they are less frequently changed. One exception may be the cvedUrl properties, which can be used to host a mirror of the NVD within an enterprise environment.

Property Description Default Value
cveUrl12Modified URL for the modified CVE 1.2. https://nvd.nist.gov/download/nvdcve-Modified.xml.gz
cveUrl20Modified URL for the modified CVE 2.0. https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-Modified.xml.gz
cveUrl12Base Base URL for each year’s CVE 1.2, the %d will be replaced with the year. https://nvd.nist.gov/download/nvdcve-%d.xml.gz
cveUrl20Base Base URL for each year’s CVE 2.0, the %d will be replaced with the year. https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml.gz
connectionTimeout Sets the URL Connection Timeout used when downloading external data.  
dataDirectory Sets the data directory to hold SQL CVEs contents. This should generally not be changed.  
databaseDriverName The name of the database driver. Example: org.h2.Driver.  
databaseDriverPath The path to the database driver JAR file; only used if the driver is not in the class path.  
connectionString The connection string used to connect to the database.  
serverId The id of a server defined in the settings.xml; this can be used to encrypt the database password. See password encryption for more information.  
databaseUser The username used when connecting to the database.  
databasePassword The password used when connecting to the database.  
metaFileName Sets the name of the file to use for storing the metadata about the project. dependency-check.ser

Proxy Configuration

Use Maven’s settings to configure a proxy server. Please see the dependency-check proxy configuration page for additional problem solving techniques. If multiple proxies are configured in the Maven settings file you must tell dependency-check which proxy to use with the following property:

Property Description Default Value
mavenSettingsProxyId The id for the proxy, configured via settings.xml, that dependency-check should use.