version 1.2.9 of documentation

This commit is contained in:
Jeremy Long
2015-03-06 19:43:56 -05:00
parent 641235ed9a
commit bca392355f
1416 changed files with 49885 additions and 32066 deletions

View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2014-12-07
| Generated by Apache Maven Doxia at 2015-03-06
| 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="20141207" />
<meta name="Date-Revision-yyyymmdd" content="20150306" />
<meta http-equiv="Content-Language" content="en" />
<title>dependency-check-maven -
dependency-check:check</title>
@@ -55,7 +55,7 @@
<li class="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.2.7/#" title="">
<a href="../../../../../../target/site/1.2.9/#" title="">
</a>
<span class="divider">/</span>
</li>
@@ -69,9 +69,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-12-07</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-03-06</li>
<li id="projectVersion" class="pull-right">
Version: 1.2.7
Version: 1.2.9
</li>
</ul>
@@ -100,7 +100,7 @@
Configuration</a>
</li>
<li class="nav-header">Project Documentation</li>
<li>
<a href="project-info.html" title="Project Information">
@@ -165,12 +165,12 @@
<p><b>Full name</b>:</p>
<p>org.owasp:dependency-check-maven:1.2.7:check</p>
<p>org.owasp:dependency-check-maven:1.2.9:check</p>
<p><b>Description</b>:</p>
<div>Maven Plugin that checks project dependencies to see if they have
any known published vulnerabilities.</div>
<div>Maven Plugin that checks the project dependencies to see if they
have any known published vulnerabilities.</div>
<p><b>Attributes</b>:</p>
@@ -178,7 +178,7 @@ any known published vulnerabilities.</div>
<li>Requires a Maven project to be executed.</li>
<li>Requires dependency resolution of artifacts in scope: <tt>runtime+system</tt>.</li>
<li>Requires dependency resolution of artifacts in scope: <tt>compile+runtime</tt>.</li>
<li>The goal is thread-safe and supports parallel builds.</li>
@@ -272,7 +272,7 @@ plug-in unless the externalReport is set to true. Default is HTML.<br /><b>Defau
<td><tt>-</tt></td>
<td>Specifies the destination directory for the generated
Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>reportOutputDirectory</tt>.</td>
Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b>User property is</b>: <tt>project.reporting.outputDirectory</tt>.</td>
</tr>
</table>
</div>
@@ -301,7 +301,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td><tt>-</tt></td>
<td>Generate aggregate reports in multi-module projects.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>aggregate</tt>.</td>
<td><b>Deprecated.</b> use the aggregate goal instead<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>aggregate</tt>.</td>
</tr>
<tr class="a">
@@ -328,6 +328,17 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<tr class="a">
<td><b><a href="#centralAnalyzerEnabled">centralAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Whether or not the Central Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>centralAnalyzerEnabled</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#connectionString">connectionString</a></b></td>
<td><tt>String</tt></td>
@@ -337,7 +348,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The database connection string.<br /><b>User property is</b>: <tt>connectionString</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#connectionTimeout">connectionTimeout</a></b></td>
@@ -348,7 +359,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The Connection Timeout.<br /><b>User property is</b>: <tt>connectionTimeout</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#cveUrl12Base">cveUrl12Base</a></b></td>
@@ -359,7 +370,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Base Data Mirror URL for CVE 1.2.<br /><b>User property is</b>: <tt>cveUrl12Base</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#cveUrl12Modified">cveUrl12Modified</a></b></td>
@@ -370,7 +381,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Data Mirror URL for CVE 1.2.<br /><b>User property is</b>: <tt>cveUrl12Modified</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#cveUrl20Base">cveUrl20Base</a></b></td>
@@ -381,7 +392,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Data Mirror URL for CVE 2.0.<br /><b>User property is</b>: <tt>cveUrl20Base</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#cveUrl20Modified">cveUrl20Modified</a></b></td>
@@ -392,7 +403,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Data Mirror URL for CVE 2.0.<br /><b>User property is</b>: <tt>cveUrl20Modified</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#dataDirectory">dataDirectory</a></b></td>
@@ -403,7 +414,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The data directory, hold DC SQL DB.<br /><b>User property is</b>: <tt>dataDirectory</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#databaseDriverName">databaseDriverName</a></b></td>
@@ -414,7 +425,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The database driver name. An example would be org.h2.Driver.<br /><b>User property is</b>: <tt>databaseDriverName</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#databaseDriverPath">databaseDriverPath</a></b></td>
@@ -425,7 +436,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The path to the database driver if it is not on the class path.<br /><b>User property is</b>: <tt>databaseDriverPath</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#databasePassword">databasePassword</a></b></td>
@@ -436,7 +447,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The password to use when connecting to the database.<br /><b>User property is</b>: <tt>databasePassword</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#databaseUser">databaseUser</a></b></td>
@@ -447,7 +458,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The database user name.<br /><b>User property is</b>: <tt>databaseUser</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#externalReport">externalReport</a></b></td>
@@ -458,7 +469,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td><b>Deprecated.</b> the internal report is no longer supported<br /><b>User property is</b>: <tt>externalReport</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#jarAnalyzerEnabled">jarAnalyzerEnabled</a></b></td>
@@ -469,7 +480,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Whether or not the Jar Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>jarAnalyzerEnabled</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#logFile">logFile</a></b></td>
@@ -480,7 +491,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The path to the verbose log.<br /><b>User property is</b>: <tt>logFile</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#mavenSettings">mavenSettings</a></b></td>
@@ -491,7 +502,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The Maven settings.<br /><b>Default value is</b>: <tt>${settings}</tt>.<br /><b>User property is</b>: <tt>mavenSettings</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#mavenSettingsProxyId">mavenSettingsProxyId</a></b></td>
@@ -502,7 +513,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The maven settings proxy id.<br /><b>User property is</b>: <tt>mavenSettingsProxyId</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#nexusAnalyzerEnabled">nexusAnalyzerEnabled</a></b></td>
@@ -513,7 +524,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Whether or not the Nexus Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>nexusAnalyzerEnabled</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#nexusUrl">nexusUrl</a></b></td>
@@ -521,10 +532,10 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td><tt>-</tt></td>
<td>Whether or not the Nexus Analyzer is enabled.<br /><b>User property is</b>: <tt>nexusUrl</tt>.</td>
<td>The URL of a Nexus Pro server.<br /><b>User property is</b>: <tt>nexusUrl</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#nexusUsesProxy">nexusUsesProxy</a></b></td>
@@ -535,7 +546,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Whether or not the configured proxy is used to connect to Nexus.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>nexusUsesProxy</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#nuspecAnalyzerEnabled">nuspecAnalyzerEnabled</a></b></td>
@@ -546,7 +557,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Whether or not the .NET Nuspec Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>nuspecAnalyzerEnabled</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#pathToMono">pathToMono</a></b></td>
@@ -557,7 +568,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The path to mono for .NET Assembly analysis on non-windows systems.<br /><b>User property is</b>: <tt>pathToMono</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#proxyUrl">proxyUrl</a></b></td>
@@ -568,7 +579,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td><b>Deprecated.</b> Please use mavenSettings instead<br /><b>User property is</b>: <tt>proxyUrl</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#showSummary">showSummary</a></b></td>
@@ -579,7 +590,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Flag indicating whether or not to show a summary in the output.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>showSummary</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#skipProvidedScope">skipProvidedScope</a></b></td>
@@ -590,7 +601,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Skip Analysis for Provided Scope Dependencies.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>skipProvidedScope</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#skipRuntimeScope">skipRuntimeScope</a></b></td>
@@ -601,7 +612,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Skip Analysis for Runtime Scope Dependencies.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>skipRuntimeScope</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#skipTestScope">skipTestScope</a></b></td>
@@ -612,7 +623,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>Skip Analysis for Test Scope Dependencies.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>skipTestScope</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#suppressionFile">suppressionFile</a></b></td>
@@ -623,7 +634,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<td>The path to the suppression file.<br /><b>User property is</b>: <tt>suppressionFile</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#zipExtensions">zipExtensions</a></b></td>
@@ -642,6 +653,8 @@ to jar, zip, ....<br /><b>User property is</b>: <tt>zipExtensions</tt>.</td>
<p><b><a name="aggregate">aggregate</a>:</b></p>
<div><b>Deprecated.</b> use the aggregate goal instead</div>
<div>Generate aggregate reports in multi-module projects.</div>
<ul>
@@ -695,6 +708,20 @@ is not recommended that this be turned to false. Default is true.</div>
<li><b>User Property</b>: <tt>autoupdate</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="centralAnalyzerEnabled">centralAnalyzerEnabled</a>:</b></p>
<div>Whether or not the Central Analyzer is enabled.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>centralAnalyzerEnabled</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="connectionString">connectionString</a>:</b></p>
@@ -957,7 +984,7 @@ plug-in unless the externalReport is set to true. Default is HTML.</div>
</ul><hr />
<p><b><a name="nexusUrl">nexusUrl</a>:</b></p>
<div>Whether or not the Nexus Analyzer is enabled.</div>
<div>The URL of a Nexus Pro server.</div>
<ul>
@@ -1044,9 +1071,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.</div>
<li><b>Required</b>: <tt>Yes</tt></li>
<li><b>User Property</b>: <tt>reportOutputDirectory</tt></li>
<li><b>Default</b>: <tt>${project.reporting.outputDirectory}</tt></li>
<li><b>User Property</b>: <tt>project.reporting.outputDirectory</tt></li>
</ul><hr />
<p><b><a name="showSummary">showSummary</a>:</b></p>
@@ -1142,7 +1167,7 @@ to jar, zip, ....</div>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p >Copyright &copy; 2013&#x2013;2014
<p >Copyright &copy; 2013&#x2013;2015
<a href="http://www.owasp.org">OWASP</a>.
All rights reserved.