Once dependency-check-ant has been installed the defined tasks can be used.
To configure the dependency-check task you can add it to a target and include a file based resource collection such as a FileSet, DirSet, or FileList that includes the project’s dependencies.
<target name="dependency-check" description="Dependency-Check Analysis">
<dependency-check projectname="Hello World"
reportoutputdirectory="${basedir}"
reportformat="ALL">
<fileset dir="lib">
<include name="**/*.jar"/>
</fileset>
</dependency-check>
</target>
The following properties can be set on the dependency-check task.
| 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 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 |
| failOnError | Whether the build should fail if there is an error executing the dependency-check analysis | true |
| projectName | The name of the project being scanned. | Dependency-Check |
| reportFormat | The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. | HTML |
| reportOutputDirectory | The location to write the report(s). Note, this is not used if generating the report as part of a mvn site build | ‘target’ |
| suppressionFile | The file path to the XML suppression file - used to suppress false positives | |
| hintsFile | The file path to the XML hints file - used to resolve false negatives | |
| proxyServer | The Proxy Server; see the proxy configuration page for more information. | |
| proxyPort | The Proxy Port. | |
| proxyUsername | Defines the proxy user name. | |
| proxyPassword | Defines the proxy password. | |
| connectionTimeout | The URL Connection Timeout. | |
| enableExperimental | Enable the experimental analyzers. If not enabled the experimental analyzers (see below) will not be loaded or used. | false |
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 the Jar Analyzer will be used. | true |
| centralAnalyzerEnabled | Sets whether the Central Analyzer will be used. Disabling this analyzer is not recommended as it could lead to false negatives (e.g. libraries that have vulnerabilities may not be reported correctly). 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. 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 web service endpoint (example http://domain.enterprise/nexus/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 experimental Node.js 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. |
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. | http://nvd.nist.gov/download/nvdcve-modified.xml |
| cveUrl20Modified | URL for the modified CVE 2.0. | http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml |
| cveUrl12Base | Base URL for each year’s CVE 1.2, the %d will be replaced with the year. | http://nvd.nist.gov/download/nvdcve-%d.xml |
| cveUrl20Base | Base URL for each year’s CVE 2.0, the %d will be replaced with the year. | http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml |
| dataDirectory | Data directory that is used to store the local copy of the NVD. This should generally not be changed. | data |
| 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. | |
| databaseUser | The username used when connecting to the database. | |
| databasePassword | The password used when connecting to the database. |