mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-02-24 19:35:16 +01:00
documentation v1.3.2
This commit is contained in:
Jeremy Long
604
dependency-check-gradle/configuration-update.html
Normal file
604
dependency-check-gradle/configuration-update.html
Normal file
@@ -0,0 +1,604 @@
|
||||
<!DOCTYPE html>
|
||||
<!--
|
||||
| Generated by Apache Maven Doxia at 2015-11-28
|
||||
| Rendered using Apache Maven Fluido Skin 1.4
|
||||
-->
|
||||
<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="20151128" />
|
||||
<meta http-equiv="Content-Language" content="en" />
|
||||
<title>dependency-check – Tasks</title>
|
||||
<link rel="stylesheet" href="../css/apache-maven-fluido-1.4.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.4.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.svg" alt="OWASP dependency-check"/>
|
||||
</div>
|
||||
</div>
|
||||
<div class="pull-right"> </div>
|
||||
<div class="clear"><hr/></div>
|
||||
</div>
|
||||
|
||||
<div id="breadcrumbs">
|
||||
<ul class="breadcrumb">
|
||||
|
||||
|
||||
<li class="">
|
||||
<a href="../#" title="">
|
||||
</a>
|
||||
<span class="divider">/</span>
|
||||
</li>
|
||||
<li class="active ">Tasks</li>
|
||||
|
||||
|
||||
|
||||
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-11-28</li>
|
||||
<li id="projectVersion" class="pull-right">
|
||||
Version: 1.3.2
|
||||
</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">OWASP dependency-check</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../index.html" title="General">
|
||||
<span class="icon-chevron-down"></span>
|
||||
General</a>
|
||||
<ul class="nav nav-list">
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/internals.html" title="How it Works">
|
||||
<span class="none"></span>
|
||||
How it Works</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/thereport.html" title="Reading the Report">
|
||||
<span class="none"></span>
|
||||
Reading the Report</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/suppression.html" title="False Positives">
|
||||
<span class="none"></span>
|
||||
False Positives</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../data/index.html" title="Internet Access Required">
|
||||
<span class="icon-chevron-right"></span>
|
||||
Internet Access Required</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../related.html" title="Related Work">
|
||||
<span class="none"></span>
|
||||
Related Work</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/dependency-check.pptx" title="Project Presentation (pptx)">
|
||||
<span class="none"></span>
|
||||
Project Presentation (pptx)</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/dependency-check.pdf" title="Project Presentation (pdf)">
|
||||
<span class="none"></span>
|
||||
Project Presentation (pdf)</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/SampleReport.html" title="Sample Report">
|
||||
<span class="none"></span>
|
||||
Sample Report</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../general/scan_iso.html" title="How to Scan an ISO Image">
|
||||
<span class="none"></span>
|
||||
How to Scan an ISO Image</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../analyzers/index.html" title="File Type Analyzers">
|
||||
<span class="icon-chevron-right"></span>
|
||||
File Type Analyzers</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../modules.html" title="Modules">
|
||||
<span class="icon-chevron-down"></span>
|
||||
Modules</a>
|
||||
<ul class="nav nav-list">
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-cli/index.html" title="CLI">
|
||||
<span class="none"></span>
|
||||
CLI</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-ant/index.html" title="Ant Task">
|
||||
<span class="none"></span>
|
||||
Ant Task</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-maven/index.html" title="Maven Plugin">
|
||||
<span class="none"></span>
|
||||
Maven Plugin</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-gradle/index.html" title="Gradle Plugin">
|
||||
<span class="icon-chevron-down"></span>
|
||||
Gradle Plugin</a>
|
||||
<ul class="nav nav-list">
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-gradle/configuration.html" title="dependencyCheck">
|
||||
<span class="none"></span>
|
||||
dependencyCheck</a>
|
||||
</li>
|
||||
|
||||
<li class="active">
|
||||
|
||||
<a href="#"><span class="none"></span>dependencyCheckUpdate</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-gradle/configuration-purge.html" title="dependencyCheckPurge">
|
||||
<span class="none"></span>
|
||||
dependencyCheckPurge</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-jenkins/index.html" title="Jenkins Plugin">
|
||||
<span class="none"></span>
|
||||
Jenkins Plugin</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-core/index.html" title="Core">
|
||||
<span class="none"></span>
|
||||
Core</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="../dependency-check-utils/index.html" title="Utils">
|
||||
<span class="none"></span>
|
||||
Utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
</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" 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>Tasks</h1>
|
||||
|
||||
<table border="0" class="table table-striped">
|
||||
<thead>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<th>Task </th>
|
||||
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td><a href="configuration.html">dependencyCheck</a> </td>
|
||||
|
||||
<td>Runs dependency-check against the project and generates a report.</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>dependencyCheckUpdate </td>
|
||||
|
||||
<td>Updates the local cache of the NVD data from NIST.</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td><a href="configuration-purge.html">dependencyCheckPurge</a> </td>
|
||||
|
||||
<td>Deletes the local copy of the NVD. This is used to force a refresh of the data.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1>Configuration: dependencyCheckUpdate</h1>
|
||||
<p>The following properties can be configured for the dependencyCheckUpdate 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>cveValidForHours </td>
|
||||
|
||||
<td>Sets the number of hours to wait before checking for new updates from the NVD. </td>
|
||||
|
||||
<td>4</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section">
|
||||
<div class="section">
|
||||
<div class="section">
|
||||
<h4><a name="Example"></a>Example</h4>
|
||||
|
||||
<div class="source">
|
||||
<div class="source"><pre class="prettyprint linenums">dependencyCheckUpdate {
|
||||
cveValidForHours=1
|
||||
}
|
||||
</pre></div></div></div></div>
|
||||
<div class="section">
|
||||
<h3><a name="Proxy_Configuration"></a>Proxy Configuration</h3>
|
||||
|
||||
<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>server </td>
|
||||
|
||||
<td>The proxy server. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>port </td>
|
||||
|
||||
<td>The proxy port. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>username </td>
|
||||
|
||||
<td>Defines the proxy user name. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>password </td>
|
||||
|
||||
<td>Defines the proxy password. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>connectionTimeout </td>
|
||||
|
||||
<td>The URL Connection Timeout. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section">
|
||||
<h4><a name="Example"></a>Example</h4>
|
||||
|
||||
<div class="source">
|
||||
<div class="source"><pre class="prettyprint linenums">dependencyCheckUpdate {
|
||||
proxy {
|
||||
server=some.proxy.server
|
||||
port=8989
|
||||
}
|
||||
}
|
||||
</pre></div></div></div></div>
|
||||
<div class="section">
|
||||
<h3><a name="Advanced_Configuration"></a>Advanced Configuration</h3>
|
||||
<p>The following properties can be configured in the dependencyCheck task. 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. Note, if ANY of the cve configuration group are set - they should all be set to ensure things work as expected.</p>
|
||||
|
||||
<table border="0" class="table table-striped">
|
||||
<thead>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<th>Config Group </th>
|
||||
|
||||
<th>Property </th>
|
||||
|
||||
<th>Description </th>
|
||||
|
||||
<th>Default Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>cve </td>
|
||||
|
||||
<td>url12Modified </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>cve </td>
|
||||
|
||||
<td>url20Modified </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>cve </td>
|
||||
|
||||
<td>url12Base </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="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>cve </td>
|
||||
|
||||
<td>url20Base </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="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>data </td>
|
||||
|
||||
<td>directory </td>
|
||||
|
||||
<td>Sets the data directory to hold SQL CVEs contents. This should generally not be changed. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>data </td>
|
||||
|
||||
<td>driver </td>
|
||||
|
||||
<td>The name of the database driver. Example: org.h2.Driver. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>data </td>
|
||||
|
||||
<td>driverPath </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="a">
|
||||
|
||||
<td>data </td>
|
||||
|
||||
<td>connectionString </td>
|
||||
|
||||
<td>The connection string used to connect to the database. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>data </td>
|
||||
|
||||
<td>username </td>
|
||||
|
||||
<td>The username used when connecting to the database. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>data </td>
|
||||
|
||||
<td>password </td>
|
||||
|
||||
<td>The password used when connecting to the database. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div class="section">
|
||||
<h4><a name="Example"></a>Example</h4>
|
||||
|
||||
<div class="source">
|
||||
<div class="source"><pre class="prettyprint linenums">dependencyCheckUpdate {
|
||||
data {
|
||||
directory='d:/nvd'
|
||||
}
|
||||
}
|
||||
</pre></div></div></div></div></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<footer>
|
||||
<div class="container-fluid">
|
||||
<div class="row-fluid">
|
||||
<p >Copyright © 2012–2015
|
||||
<a href="http://www.owasp.org">OWASP</a>.
|
||||
All rights reserved.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user