Files
DependencyCheck/dependency-check-ant/config-update.html
2016-04-10 07:17:05 -04:00

352 lines
11 KiB
HTML

<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7 at 2016-04-09
| Rendered using Apache Maven Fluido Skin 1.5
-->
<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="20160409" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check-ant &#x2013; Configuration</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.5.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.5.min.js"></script>
<style type="text/css">
#bannerLeft { margin-top:-20px;margin-bottom:5px !important }
</style>
</head>
<body class="topBarDisabled">
<a href="https://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">
<img src="images/dc-ant.svg" alt="OWASP dependency-check-ant"/>
</div>
</div>
<div class="pull-right"> </div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="../../../../../../target/site/1.3.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: 2016-04-09</li>
<li id="projectVersion" class="pull-right">
Version: 1.3.6
</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Getting Started</li>
<li>
<a href="index.html" title="Installation">
<span class="none"></span>
Installation</a>
</li>
<li>
<a href="configuration.html" title="Configuration">
<span class="none"></span>
Configuration</a>
</li>
<li class="nav-header">Project Documentation</li>
<li>
<a href="project-info.html" title="Project Information">
<span class="icon-chevron-right"></span>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
<span class="icon-chevron-right"></span>
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="https://github.com/jeremylong/DependencyCheck.git/dependency-check-ant" 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="http://maven.apache.org/" 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="span10" >
<h1>Configuration</h1>
<p>The dependency-check-update task downloads and updates the local copy of the NVD. There are several reasons that one may want to use this task; primarily, creating an update that will be run only once a day or once every few days (but not greater then 7 days) and then use the <tt>autoUpdate=&quot;false&quot;</tt> setting on individual dependency-check scans. See <a class="externalLink" href="https://jeremylong.github.io/DependencyCheck/data/index.html">Internet Access Required</a> for more information on why this task would be used.</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">&lt;target name=&quot;dependency-check-update&quot; description=&quot;Dependency-Check Update&quot;&gt;
&lt;dependency-check-update /&gt;
&lt;/target&gt;
</pre></div></div>
<div class="section">
<h2><a name="Configuration:_dependency-check-update_Task"></a>Configuration: dependency-check-update Task</h2>
<p>The following properties can be set on the dependency-check task.</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>proxyServer </td>
<td>The Proxy Server. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td>proxyPort </td>
<td>The Proxy Port. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td>proxyUsername </td>
<td>Defines the proxy user name. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td>proxyPassword </td>
<td>Defines the proxy password. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td>connectionTimeout </td>
<td>The URL Connection Timeout. </td>
<td>&#160;</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="https://nvd.nist.gov/download/nvdcve-Modified.xml.gz">https://nvd.nist.gov/download/nvdcve-Modified.xml.gz</a></td>
</tr>
<tr class="a">
<td>cveUrl20Modified </td>
<td>URL for the modified CVE 2.0. </td>
<td><a class="externalLink" href="https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-Modified.xml.gz">https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-Modified.xml.gz</a></td>
</tr>
<tr class="b">
<td>cveUrl12Base </td>
<td>Base URL for each year&#x2019;s CVE 1.2, the %d will be replaced with the year. </td>
<td><a class="externalLink" href="https://nvd.nist.gov/download/nvdcve-%d.xml.gz">https://nvd.nist.gov/download/nvdcve-%d.xml.gz</a></td>
</tr>
<tr class="a">
<td>cveUrl20Base </td>
<td>Base URL for each year&#x2019;s CVE 2.0, the %d will be replaced with the year. </td>
<td><a class="externalLink" href="https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml.gz">https://nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml.gz</a></td>
</tr>
<tr class="b">
<td>dataDirectory </td>
<td>Data directory that is used to store the local copy of the NVD. This should generally not be changed. </td>
<td>data</td>
</tr>
<tr class="a">
<td>databaseDriverName </td>
<td>The name of the database driver. Example: org.h2.Driver. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<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>&#160;</td>
</tr>
<tr class="a">
<td>connectionString </td>
<td>The connection string used to connect to the database. </td>
<td>&#160;</td>
</tr>
<tr class="b">
<td>databaseUser </td>
<td>The username used when connecting to the database. </td>
<td>&#160;</td>
</tr>
<tr class="a">
<td>databasePassword </td>
<td>The password used when connecting to the database. </td>
<td>&#160;</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright &copy; 2012&#x2013;2016
<a href="http://www.owasp.org">OWASP</a>.
All rights reserved.
</p>
</div>
</div>
</footer>
</body>
</html>