Files
DependencyCheck/dependency-check-ant/configuration.html
2013-11-16 13:44:16 -05:00

307 lines
9.4 KiB
HTML

<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2013-11-16
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<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="20131116" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check-ant - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.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.0.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.0.5/#" title="">
</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../index.html" title="dependency-check">
dependency-check</a>
</li>
<li class="divider ">/</li>
<li class=""></li>
<li id="publishDate" class="pull-right">Last Published: 2013-11-16</li> <li class="divider pull-right">|</li>
<li id="projectVersion" class="pull-right">Version: 1.0.5</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 class="divider" />
<div id="poweredBy">
<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>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.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&#x2019;s dependencies.</p>
<div class="source">
<pre>&lt;target name=&quot;dependency-check&quot; description=&quot;Dependency-Check Analysis&quot;&gt;
&lt;dependency-check applicationname=&quot;Hello World&quot;
reportoutputdirectory=&quot;${basedir}&quot;
reportformat=&quot;ALL&quot;&gt;
&lt;fileset dir=&quot;lib&quot;&gt;
&lt;include name=&quot;**/*.jar&quot;/&gt;
&lt;/fileset&gt;
&lt;/dependency-check&gt;
&lt;/target&gt;
</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>
</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>
</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>
</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>
</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>
</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. The default value is true. </td>
<td>Optional</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 &#x2018;dependency-check-data&#x2019;, 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>
</tr>
<tr class="b">
<td>LogFile </td>
<td>The file path to write verbose logging information. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>ProxyUrl </td>
<td>Defines the proxy used to connect to the Internet. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td>ProxyPort </td>
<td>Defines the port for the proxy. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>ProxyUsername </td>
<td>Defines the proxy user name. </td>
<td>Optional</td>
</tr>
<tr class="b">
<td>ProxyPassword </td>
<td>Defines the proxy password. </td>
<td>Optional</td>
</tr>
<tr class="a">
<td>ConnectionTimeout </td>
<td>The connection timeout used when downloading data files from the Internet. </td>
<td>Optional</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2012-2013
<a href="http://www.owasp.org">OWASP</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>