mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-01-15 16:23:37 +01:00
537 lines
15 KiB
HTML
537 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
| Generated by Apache Maven Doxia at 2014-11-16
|
|
| Rendered using Apache Maven Fluido Skin 1.3.1
|
|
-->
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="Date-Revision-yyyymmdd" content="20141116" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
<title>dependency-check-maven - Configuration</title>
|
|
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
|
|
<link rel="stylesheet" href="./css/site.css" />
|
|
<link rel="stylesheet" href="./css/print.css" media="print" />
|
|
|
|
|
|
<script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
|
|
|
|
|
|
|
|
<style type="text/css">#bannerLeft { margin-top:50px !important }</style>
|
|
|
|
</head>
|
|
<body class="topBarDisabled">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://github.com/jeremylong/DependencyCheck">
|
|
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
|
|
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
|
|
alt="Fork me on GitHub">
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="container-fluid">
|
|
<div id="banner">
|
|
<div class="pull-left">
|
|
<div id="bannerLeft">
|
|
<h2>dependency-check-maven</h2>
|
|
</div>
|
|
</div>
|
|
<div class="pull-right"> </div>
|
|
<div class="clear"><hr/></div>
|
|
</div>
|
|
|
|
<div id="breadcrumbs">
|
|
<ul class="breadcrumb">
|
|
|
|
|
|
<li class="">
|
|
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.2.6/#" title="">
|
|
</a>
|
|
<span class="divider">/</span>
|
|
</li>
|
|
<li class="">
|
|
<a href="../index.html" title="dependency-check">
|
|
dependency-check</a>
|
|
<span class="divider">/</span>
|
|
</li>
|
|
<li class="active ">Configuration</li>
|
|
|
|
|
|
|
|
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-11-16</li>
|
|
<li id="projectVersion" class="pull-right">
|
|
Version: 1.2.6
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<div class="row-fluid">
|
|
<div id="leftColumn" class="span3">
|
|
<div class="well sidebar-nav">
|
|
|
|
|
|
<ul class="nav nav-list">
|
|
<li class="nav-header">Getting Started</li>
|
|
|
|
<li>
|
|
|
|
<a href="usage.html" title="Usage">
|
|
<i class="none"></i>
|
|
Usage</a>
|
|
</li>
|
|
|
|
<li class="active">
|
|
|
|
<a href="#"><i class="none"></i>Configuration</a>
|
|
</li>
|
|
<li class="nav-header">Project Documentation</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-info.html" title="Project Information">
|
|
<i class="icon-chevron-right"></i>
|
|
Project Information</a>
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<a href="project-reports.html" title="Project Reports">
|
|
<i class="icon-chevron-right"></i>
|
|
Project Reports</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<div id="poweredBy">
|
|
|
|
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
|
|
|
|
|
|
<div class="g-plusone" data-href="http://maven.apache.org" data-size="tall" ></div>
|
|
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
|
|
|
|
|
|
<div id="twitter">
|
|
|
|
<a href="https://twitter.com/ctxt" class="twitter-follow-button" data-show-count="true" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ctxt</a>
|
|
<script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
<div class="clear"></div>
|
|
<a href="./" title="Maven" class="builtBy">
|
|
<img class="builtBy" alt="built with maven" src="http://jeremylong.github.io/DependencyCheck/images/logos/maven-feather.png" />
|
|
</a>
|
|
<a href="http://www.jetbrains.com/idea/" title="IntelliJ" class="builtBy">
|
|
<img class="builtBy" alt="developed using" src="http://jeremylong.github.io/DependencyCheck/images/logos/logo_intellij_idea.png" width="170px" />
|
|
</a>
|
|
<a href="http://www.cloudbees.com/" title="Cloudbees" class="builtBy">
|
|
<img class="builtBy" alt="built on cloudbees" src="http://jeremylong.github.io/DependencyCheck/images/logos/Button-Built-on-CB-1.png" />
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div id="bodyColumn" class="span9" >
|
|
|
|
<h1>Configuration</h1>
|
|
<p>The following properties can be set on the dependency-check-maven plugin.</p>
|
|
|
|
<table border="0" class="table table-striped">
|
|
<thead>
|
|
|
|
<tr class="a">
|
|
|
|
<th>Property </th>
|
|
|
|
<th>Description </th>
|
|
|
|
<th>Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="b">
|
|
|
|
<td>aggregate </td>
|
|
|
|
<td>Sets whether report aggregation will be performed for multi-module site reports. This option only affects the report generation when configured within the reporting section. </td>
|
|
|
|
<td>false</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>autoUpdate </td>
|
|
|
|
<td>Sets whether auto-updating of the NVD CVE/CPE data is enabled. It is not recommended that this be turned to false. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>outputDirectory </td>
|
|
|
|
<td>The location to write the report(s). Note, this is not used if generating the report as part of a <tt>mvn site</tt> build </td>
|
|
|
|
<td>‘target’</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>failBuildOnCVSS </td>
|
|
|
|
<td>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. </td>
|
|
|
|
<td>11</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>format </td>
|
|
|
|
<td>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. </td>
|
|
|
|
<td>HTML</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>logFile </td>
|
|
|
|
<td>The file path to write verbose logging information. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>suppressionFile </td>
|
|
|
|
<td>The file path to the XML suppression file - used to suppress <a href="../suppression.html">false positives</a> </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>skipTestScope </td>
|
|
|
|
<td>Should be skip analysis for artifacts with Test Scope </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>skipProvidedScope </td>
|
|
|
|
<td>Should be skip analysis for artifacts with Provided Scope </td>
|
|
|
|
<td>false</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>skipRuntimeScope </td>
|
|
|
|
<td>Should be skip analysis for artifacts with Runtime Scope </td>
|
|
|
|
<td>false</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h1>Analyzer Configuration</h1>
|
|
<p>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.</p>
|
|
|
|
<table border="0" class="table table-striped">
|
|
<thead>
|
|
|
|
<tr class="a">
|
|
|
|
<th>Property </th>
|
|
|
|
<th>Description </th>
|
|
|
|
<th>Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="b">
|
|
|
|
<td>archiveAnalyzerEnabled </td>
|
|
|
|
<td>Sets whether the Archive Analyzer will be used. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>zipExtensions </td>
|
|
|
|
<td>A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>jarAnalyzer </td>
|
|
|
|
<td>Sets whether Jar Analyzer will be used. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>nexusAnalyzerEnabled </td>
|
|
|
|
<td>Sets whether Nexus Analyzer will be used. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>nexusUrl </td>
|
|
|
|
<td>Defines the Nexus Pro Server URL. If not set the Nexus Analyzer will be disabled. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>nexusUsesProxy </td>
|
|
|
|
<td>Whether or not the defined proxy should be used when connecting to Nexus. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>nuspecAnalyzerEnabled </td>
|
|
|
|
<td>Sets whether or not the .NET Nuget Nuspec Analyzer will be used. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>assemblyAnalyzerEnabled </td>
|
|
|
|
<td>Sets whether or not the .NET Assembly Analyzer should be used. </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>pathToMono </td>
|
|
|
|
<td>The path to Mono for .NET assembly analysis on non-windows systems. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h1>Advanced Configuration</h1>
|
|
<p>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.</p>
|
|
|
|
<table border="0" class="table table-striped">
|
|
<thead>
|
|
|
|
<tr class="a">
|
|
|
|
<th>Property </th>
|
|
|
|
<th>Description </th>
|
|
|
|
<th>Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="b">
|
|
|
|
<td>cveUrl12Modified </td>
|
|
|
|
<td>URL for the modified CVE 1.2. </td>
|
|
|
|
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-modified.xml">http://nvd.nist.gov/download/nvdcve-modified.xml</a></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>cveUrl20Modified </td>
|
|
|
|
<td>URL for the modified CVE 2.0. </td>
|
|
|
|
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml</a></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>cveUrl12Base </td>
|
|
|
|
<td>Base URL for each year’s CVE 1.2, the %d will be replaced with the year. </td>
|
|
|
|
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-%d.xml">http://nvd.nist.gov/download/nvdcve-%d.xml</a></td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>cveUrl20Base </td>
|
|
|
|
<td>Base URL for each year’s CVE 2.0, the %d will be replaced with the year. </td>
|
|
|
|
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml</a></td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>connectionTimeout </td>
|
|
|
|
<td>Sets the URL Connection Timeout used when downloading external data. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>dataDirectory </td>
|
|
|
|
<td>Sets the data directory to hold SQL CVEs contents. This should generally not be changed. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>databaseDriverName </td>
|
|
|
|
<td>The name of the database driver. Example: org.h2.Driver. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>databaseDriverPath </td>
|
|
|
|
<td>The path to the database driver JAR file; only used if the driver is not in the class path. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>connectionString </td>
|
|
|
|
<td>The connection string used to connect to the database. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>databaseUser </td>
|
|
|
|
<td>The username used when connecting to the database. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>databasePassword </td>
|
|
|
|
<td>The password used when connecting to the database. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>metaFileName </td>
|
|
|
|
<td>Sets the name of the file to use for storing the metadata about the project. </td>
|
|
|
|
<td>dependency-check.ser</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h1>Proxy Configuration</h1>
|
|
<p>Use <a class="externalLink" href="https://maven.apache.org/settings.html#Proxies">Maven’s settings</a> to configure a proxy server. If multiple proxies are configured in the Maven settings file you must tell dependency-check which proxy to use with the following property:</p>
|
|
|
|
<table border="0" class="table table-striped">
|
|
<thead>
|
|
|
|
<tr class="a">
|
|
|
|
<th>Property </th>
|
|
|
|
<th>Description </th>
|
|
|
|
<th>Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="b">
|
|
|
|
<td>mavenSettingsProxyId </td>
|
|
|
|
<td>The id for the proxy, configured via settings.xml, that dependency-check should use. </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<footer>
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
<p >Copyright © 2013–2014
|
|
<a href="http://www.owasp.org">OWASP</a>.
|
|
All rights reserved.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|