github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-05-08 08:04:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation v1.3.1

Browse Source
This commit is contained in:
Jeremy Long
2015-09-20 07:41:29 -04:00
parent 4fd8873223
commit 191c5fae56
1456 changed files with 125936 additions and 63077 deletions
Download Patch File Download Diff File Expand all files Collapse all files

178
dependency-check-ant/configuration.html
View File

@@ -1,21 +1,21 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2015-08-04
| Rendered using Apache Maven Fluido Skin 1.3.1
| Generated by Apache Maven Doxia at 2015-09-20
| 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="20150804" />
<meta name="Date-Revision-yyyymmdd" content="20150920" />
<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" />
<title>dependency-check-ant &#x2013; Configuration</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.3.1.min.js"></script>
<script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
@@ -29,7 +29,7 @@
<a href="http://github.com/jeremylong/DependencyCheck">
<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">
@@ -54,7 +54,7 @@
<li class="">
<a href="../../../../../../target/site/1.3.0/#" title="">
<a href="../../../../../../target/site/1.3.1/#" title="">
</a>
<span class="divider">/</span>
</li>
@@ -67,9 +67,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-08-04</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-09-20</li>
<li id="projectVersion" class="pull-right">
Version: 1.3.0
Version: 1.3.1
</li>
</ul>
@@ -77,7 +77,7 @@
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
@@ -87,34 +87,27 @@
<li>
<a href="installation.html" title="Installation">
<i class="none"></i>
<span class="none"></span>
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>
<a href="#"><span class="none"></span>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>
<span class="icon-chevron-right"></span>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
<i class="icon-chevron-right"></i>
<span class="icon-chevron-right"></span>
Project Reports</a>
</li>
</ul>
@@ -157,14 +150,24 @@
</div>
<div id="bodyColumn" class="span9" >
<div id="bodyColumn" class="span10" >
<h1>Configuration</h1>
<p>Once dependency-check-ant has been <a href="index.html">installed</a> the defined tasks can be used.</p>
<ul>
<li>dependency-check - the primary task used to check the project dependencies. Configuration options are below.</li>
<li>dependency-check-purge - deletes the local copy of the NVD; this should rarely be used (if ever). See the <a href="config-purge.html">purge configuration</a> for more information.</li>
<li>dependency-check-update - downloads and updates the local copy of the NVD. See the <a href="config-update.html">update configuration</a> for more information.</li>
</ul>
<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;
<div class="source"><pre class="prettyprint linenums">&lt;target name=&quot;dependency-check&quot; description=&quot;Dependency-Check Analysis&quot;&gt;
&lt;dependency-check projectname=&quot;Hello World&quot;
reportoutputdirectory=&quot;${basedir}&quot;
reportformat=&quot;ALL&quot;&gt;
@@ -173,9 +176,10 @@
&lt;/fileset&gt;
&lt;/dependency-check&gt;
&lt;/target&gt;
</pre></div>
<h1>Configuration</h1>
<p>The following properties can be set on the dependency-check-maven plugin.</p>
</pre></div></div>
<div class="section">
<h2><a name="Configuration:_dependency-check_Task"></a>Configuration: dependency-check Task</h2>
<p>The following properties can be set on the dependency-check-update task.</p>
<table border="0" class="table table-striped">
<thead>
@@ -202,24 +206,15 @@
<tr class="a">
<td>updateOnly </td>
<td>projectName </td>
<td>If set to true only the update phase of dependency-check will be executed; no scan will be executed and no report will be generated. </td>
<td>The name of the project being scanned. </td>
<td>false</td>
<td>Dependency-Check</td>
</tr>
<tr class="b">
<td>externalReport </td>
<td>When using as a Site plugin this parameter sets whether or not the external report format should be used. </td>
<td>false</td>
</tr>
<tr class="a">
<td>reportOutputDirectory </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>
@@ -227,7 +222,7 @@
<td>&#x2018;target&#x2019;</td>
</tr>
<tr class="b">
<tr class="a">
<td>failBuildOnCVSS </td>
@@ -236,7 +231,7 @@
<td>11</td>
</tr>
<tr class="a">
<tr class="b">
<td>reportFormat </td>
@@ -245,7 +240,7 @@
<td>HTML</td>
</tr>
<tr class="b">
<tr class="a">
<td>suppressionFile </td>
@@ -254,7 +249,7 @@
<td>&#160;</td>
</tr>
<tr class="a">
<tr class="b">
<td>proxyServer </td>
@@ -263,7 +258,7 @@
<td>&#160;</td>
</tr>
<tr class="b">
<tr class="a">
<td>proxyPort </td>
@@ -272,7 +267,7 @@
<td>&#160;</td>
</tr>
<tr class="a">
<tr class="b">
<td>proxyUsername </td>
@@ -281,7 +276,7 @@
<td>&#160;</td>
</tr>
<tr class="b">
<tr class="a">
<td>proxyPassword </td>
@@ -290,7 +285,7 @@
<td>&#160;</td>
</tr>
<tr class="a">
<tr class="b">
<td>connectionTimeout </td>
@@ -382,6 +377,78 @@
<tr class="a">
<td>pyDistributionAnalyzerEnabled </td>
<td>Sets whether the Python Distribution Analyzer will be used. </td>
<td>true</td>
</tr>
<tr class="b">
<td>pyPackageAnalyzerEnabled </td>
<td>Sets whether the Python Package Analyzer will be used. </td>
<td>true</td>
</tr>
<tr class="a">
<td>rubygemsAnalyzerEnabled </td>
<td>Sets whether the Ruby Gemspec Analyzer will be used. </td>
<td>true</td>
</tr>
<tr class="b">
<td>opensslAnalyzerEnabled </td>
<td>Sets whether or not the openssl Analyzer should be used. </td>
<td>true</td>
</tr>
<tr class="a">
<td>cmakeAnalyzerEnabled </td>
<td>Sets whether or not the CMake Analyzer should be used. </td>
<td>true</td>
</tr>
<tr class="b">
<td>autoconfAnalyzerEnabled </td>
<td>Sets whether or not the autoconf Analyzer should be used. </td>
<td>true</td>
</tr>
<tr class="a">
<td>composerAnalyzerEnabled </td>
<td>Sets whether or not the PHP Composer Lock File Analyzer should be used. </td>
<td>true</td>
</tr>
<tr class="b">
<td>nodeAnalyzerEnabled </td>
<td>Sets whether or not the Node.js Analyzer should be used. </td>
<td>true</td>
</tr>
<tr class="a">
<td>nuspecAnalyzerEnabled </td>
<td>Sets whether or not the .NET Nuget Nuspec Analyzer will be used. </td>
@@ -465,9 +532,9 @@
<td>dataDirectory </td>
<td>Data directory to hold SQL CVEs contents. This should generally not be changed. </td>
<td>Data directory that is used to store the local copy of the NVD. This should generally not be changed. </td>
<td>&#160;</td>
<td>data</td>
</tr>
<tr class="a">
@@ -515,7 +582,7 @@
<td>&#160;</td>
</tr>
</tbody>
</table>
</table></div>
</div>
</div>
</div>
@@ -525,15 +592,14 @@
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright &copy; 2012&#x2013;2015
<p >Copyright &copy; 2012&#x2013;2015
<a href="http://www.owasp.org">OWASP</a>.
All rights reserved.
</p>
</div>
</div>
</div>
</footer>
</body>