mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-01-16 08:36:55 +01:00
504 lines
14 KiB
HTML
504 lines
14 KiB
HTML
<!DOCTYPE html>
|
|
<!--
|
|
| Generated by Apache Maven Doxia at 2014-03-03
|
|
| 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="20140303" />
|
|
<meta http-equiv="Content-Language" content="en" />
|
|
<title>dependency-check-ant - 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-ant</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.1.2/#" 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-03-03</li>
|
|
<li id="projectVersion" class="pull-right">
|
|
Version: 1.1.2
|
|
</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="installation.html" title="Installation">
|
|
<i class="none"></i>
|
|
Installation</a>
|
|
</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="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://maven.apache.org/" 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>To configure the dependency-check task you can add it to a target and include a file based <a class="externalLink" href="http://ant.apache.org/manual/Types/resources.html#collection">resource collection</a> such as a <a class="externalLink" href="http://ant.apache.org/manual/Types/fileset.html">FileSet</a>, <a class="externalLink" href="http://ant.apache.org/manual/Types/dirset.html">DirSet</a>, or <a class="externalLink" href="http://ant.apache.org/manual/Types/filelist.html">FileList</a> that includes the project’s dependencies.</p>
|
|
|
|
<div class="source">
|
|
<pre><target name="dependency-check" description="Dependency-Check Analysis">
|
|
<dependency-check applicationname="Hello World"
|
|
reportoutputdirectory="${basedir}"
|
|
reportformat="ALL">
|
|
|
|
<fileset dir="lib">
|
|
<include name="**/*.jar"/>
|
|
</fileset>
|
|
</dependency-check>
|
|
</target>
|
|
</pre></div>
|
|
<p>The following table lists the configurable properties:</p>
|
|
|
|
<table border="0" class="table table-striped">
|
|
<thead>
|
|
|
|
<tr class="a">
|
|
|
|
<th>Property </th>
|
|
|
|
<th>Description </th>
|
|
|
|
<th>Requirement </th>
|
|
|
|
<th>Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr class="b">
|
|
|
|
<td>applicationName </td>
|
|
|
|
<td>The name of the application to use in the generated report. </td>
|
|
|
|
<td>Required </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>reportFormat </td>
|
|
|
|
<td>The format of the report to be generated. Allowed values are: HTML, XML, VULN, or ALL. The default value is HTML.</td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td>HTML</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>reportOutputDirectory </td>
|
|
|
|
<td>The directory where dependency-check will store data used for analysis. Defaults to the current working directory. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>failBuildOn </td>
|
|
|
|
<td>If set and a CVE is found that is greater then the specified value the build will fail. The default value is 11 which means that the build will not fail. Valid values are 0-11. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td>11</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>autoUpdate </td>
|
|
|
|
<td>If set to false the NVD CVE data is not automatically updated. Setting this to false could result in false negatives. However, this may be required in some environments. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>dataDirectory </td>
|
|
|
|
<td>The directory where dependency-check will store data used for analysis. Defaults to a folder called, called ‘dependency-check-data’, that is in the same directory as the dependency-check-ant jar file was installed in. <i>It is not recommended to change this.</i> </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>logFile </td>
|
|
|
|
<td>The file path to write verbose logging information. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>suppressionFile </td>
|
|
|
|
<td>An XML file conforming to the suppression schema that suppresses findings; this is used to hide <a href="../suppression.html">false positives</a>. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>proxyUrl </td>
|
|
|
|
<td>Defines the proxy used to connect to the Internet. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>proxyPort </td>
|
|
|
|
<td>Defines the port for the proxy. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>proxyUsername </td>
|
|
|
|
<td>Defines the proxy user name. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>proxyPassword </td>
|
|
|
|
<td>Defines the proxy password. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>connectionTimeout </td>
|
|
|
|
<td>The connection timeout used when downloading data files from the Internet. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>nexusAnalyzerEnabled </td>
|
|
|
|
<td>The connection timeout used when downloading data files from the Internet. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>nexusUrl </td>
|
|
|
|
<td>The connection timeout used when downloading data files from the Internet. </td>
|
|
|
|
<td>Optional </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>Optional </td>
|
|
|
|
<td>true</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>databaseDriverName </td>
|
|
|
|
<td>The name of the database driver. Example: org.h2.Driver. </td>
|
|
|
|
<td>Optional </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>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>connectionString </td>
|
|
|
|
<td>The connection string used to connect to the database. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="a">
|
|
|
|
<td>databaseUser </td>
|
|
|
|
<td>The username used when connecting to the database. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td>dcuser</td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>databasePassword </td>
|
|
|
|
<td>The password used when connecting to the database. </td>
|
|
|
|
<td>Optional </td>
|
|
|
|
<td> </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>Optional </td>
|
|
|
|
<td> </td>
|
|
</tr>
|
|
|
|
<tr class="b">
|
|
|
|
<td>cveUrl12Modified </td>
|
|
|
|
<td>URL for the modified CVE 1.2 </td>
|
|
|
|
<td>Optional </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>Optional </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>Optional </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>Optional </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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<footer>
|
|
<div class="container-fluid">
|
|
<div class="row-fluid">
|
|
<p >Copyright © 2012–2014
|
|
<a href="http://www.owasp.org">OWASP</a>.
|
|
All rights reserved.
|
|
|
|
</p>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
</footer>
|
|
</body>
|
|
</html>
|