github-mirrors/DependencyCheck
1
0
Fork 0
mirror of https://github.com/ysoftdevs/DependencyCheck.git synced 2026-03-28 03:51:33 +01:00
Code Issues Packages Projects Releases Wiki Activity

version 1.1.4 of the projects documentation

Browse Source
This commit is contained in:
Jeremy Long
2014-03-29 10:02:40 -04:00
parent a64a31923a
commit 99d2502581
975 changed files with 36859 additions and 28147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

225
dependency-check-maven/check-mojo.html
View File

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2014-03-10
| Generated by Apache Maven Doxia at 2014-03-29
| 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="20140310" />
<meta name="Date-Revision-yyyymmdd" content="20140329" />
<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.1.3/#" title="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.1.4/#" title="">
</a>
<span class="divider">/</span>
</li>
@@ -69,9 +69,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-03-10</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-03-29</li>
<li id="projectVersion" class="pull-right">
Version: 1.1.3
Version: 1.1.4
</li>
</ul>
@@ -165,7 +165,7 @@
<p><b>Full name</b>:</p>
<p>org.owasp:dependency-check-maven:1.1.3:check</p>
<p>org.owasp:dependency-check-maven:1.1.4:check</p>
<p><b>Description</b>:</p>
@@ -260,7 +260,7 @@ plugin unless the externalReport is set to true. Default is HTML.<br /><b>Defaul
<td><tt>-</tt></td>
<td>The output directory.<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
<td>The output directory. This generally maps to &quot;target&quot;.<br /><b>Default value is</b>: <tt>${project.build.directory}</tt>.<br /></td>
</tr>
<tr class="a">
@@ -272,7 +272,7 @@ plugin unless the externalReport is set to true. Default is HTML.<br /><b>Defaul
<td><tt>-</tt></td>
<td>Specifies the destination directory for the generated
Dependency-Check report.<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>Default value is</b>: <tt>${project.reporting.outputDirectory}</tt>.<br /><b>User property is</b>: <tt>reportOutputDirectory</tt>.</td>
</tr>
</table>
</div>
@@ -295,6 +295,28 @@ Dependency-Check report.<br /><b>Default value is</b>: <tt>${project.reporting.o
<tr class="b">
<td><b><a href="#archiveAnalyzerEnabled">archiveAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Whether or not the Archive Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>archiveAnalyzerEnabled</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#assemblyAnalyzerEnabled">assemblyAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<td>Whether or not the .NET Assembly Analyzer is enabled.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>assemblyAnalyzerEnabled</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#connectionString">connectionString</a></b></td>
<td><tt>String</tt></td>
@@ -428,6 +450,17 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
<tr class="b">
<td><b><a href="#jarAnalyzerEnabled">jarAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<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="a">
<td><b><a href="#logFile">logFile</a></b></td>
<td><tt>String</tt></td>
@@ -437,8 +470,30 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
<td>The path to the verbose log.<br /><b>User property is</b>: <tt>logfile</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#mavenSettings">mavenSettings</a></b></td>
<td><tt>Settings</tt></td>
<td><tt>-</tt></td>
<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="a">
<td><b><a href="#mavenSettingsProxyId">mavenSettingsProxyId</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The maven settings proxy id.<br /><b>User property is</b>: <tt>mavenSettingsProxyId</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#name">name</a></b></td>
<td><tt>String</tt></td>
@@ -449,7 +504,7 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>User property is</b>: <tt>name</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#nexusAnalyzerEnabled">nexusAnalyzerEnabled</a></b></td>
@@ -460,7 +515,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<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="a">
<tr class="b">
<td><b><a href="#nexusUrl">nexusUrl</a></b></td>
@@ -471,7 +526,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td>Whether or not the Nexus Analyzer is enabled.<br /><b>User property is</b>: <tt>nexusUrl</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#nexusUsesProxy">nexusUsesProxy</a></b></td>
@@ -482,6 +537,17 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<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">
<td><b><a href="#nuspecAnalyzerEnabled">nuspecAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>-</tt></td>
<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">
<td><b><a href="#pathToMono">pathToMono</a></b></td>
@@ -501,7 +567,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td><tt>-</tt></td>
<td>The Proxy password.<br /><b>User property is</b>: <tt>proxyPassword</tt>.</td>
<td><b>Deprecated.</b> Please use mavenSettings instead<br /><b>User property is</b>: <tt>proxyPassword</tt>.</td>
</tr>
<tr class="a">
@@ -512,7 +578,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td><tt>-</tt></td>
<td>The Proxy Port.<br /><b>User property is</b>: <tt>proxyPort</tt>.</td>
<td><b>Deprecated.</b> Please use mavenSettings instead<br /><b>User property is</b>: <tt>proxyPort</tt>.</td>
</tr>
<tr class="b">
@@ -523,7 +589,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td><tt>-</tt></td>
<td>The Proxy URL.<br /><b>User property is</b>: <tt>proxyUrl</tt>.</td>
<td><b>Deprecated.</b> Please use mavenSettings instead<br /><b>User property is</b>: <tt>proxyUrl</tt>.</td>
</tr>
<tr class="a">
@@ -534,22 +600,11 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td><tt>-</tt></td>
<td>The Proxy username.<br /><b>User property is</b>: <tt>proxyUsername</tt>.</td>
<td><b>Deprecated.</b> Please use mavenSettings instead<br /><b>User property is</b>: <tt>proxyUsername</tt>.</td>
</tr>
<tr class="b">
<td><b><a href="#reportName">reportName</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The name of the site report destination.<br /><b>Default value is</b>: <tt>dependency-check-report</tt>.<br /><b>User property is</b>: <tt>report-name</tt>.</td>
</tr>
<tr class="a">
<td><b><a href="#showSummary">showSummary</a></b></td>
<td><tt>boolean</tt></td>
@@ -559,7 +614,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<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>
@@ -570,7 +625,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td>Skip Analisys 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>
@@ -581,7 +636,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td>Skip Analisys 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>
@@ -592,7 +647,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td>Skip Analisys 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>
@@ -603,7 +658,7 @@ Reports page.<br /><b>Default value is</b>: <tt>Dependency-Check</tt>.<br /><b>U
<td>The Connection Timeout.<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>
@@ -620,6 +675,34 @@ to jar, zip, ....<br /><b>User property is</b>: <tt>zipExtensions</tt>.</td>
<div class="section">
<h3>Parameter Details<a name="Parameter_Details"></a></h3>
<p><b><a name="archiveAnalyzerEnabled">archiveAnalyzerEnabled</a>:</b></p>
<div>Whether or not the Archive 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>archiveAnalyzerEnabled</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="assemblyAnalyzerEnabled">assemblyAnalyzerEnabled</a>:</b></p>
<div>Whether or not the .NET Assembly 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>assemblyAnalyzerEnabled</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="autoUpdate">autoUpdate</a>:</b></p>
<div>Sets whether auto-updating of the NVD CVE/CPE data is enabled. It
@@ -828,6 +911,20 @@ plugin unless the externalReport is set to true. Default is HTML.</div>
<li><b>Default</b>: <tt>HTML</tt></li>
</ul><hr />
<p><b><a name="jarAnalyzerEnabled">jarAnalyzerEnabled</a>:</b></p>
<div>Whether or not the Jar 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>jarAnalyzerEnabled</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="logFile">logFile</a>:</b></p>
<div>The path to the verbose log.</div>
@@ -840,6 +937,32 @@ plugin unless the externalReport is set to true. Default is HTML.</div>
<li><b>User Property</b>: <tt>logfile</tt></li>
</ul><hr />
<p><b><a name="mavenSettings">mavenSettings</a>:</b></p>
<div>The maven settings.</div>
<ul>
<li><b>Type</b>: <tt>org.apache.maven.settings.Settings</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>mavenSettings</tt></li>
<li><b>Default</b>: <tt>${settings}</tt></li>
</ul><hr />
<p><b><a name="mavenSettingsProxyId">mavenSettingsProxyId</a>:</b></p>
<div>The maven settings proxy id.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>mavenSettingsProxyId</tt></li>
</ul><hr />
<p><b><a name="name">name</a>:</b></p>
<div>The name of the report to be displayed in the Maven Generated
@@ -893,11 +1016,25 @@ Reports page.</div>
<li><b>User Property</b>: <tt>nexusUsesProxy</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="nuspecAnalyzerEnabled">nuspecAnalyzerEnabled</a>:</b></p>
<div>Whether or not the .NET Nuspec 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>nuspecAnalyzerEnabled</tt></li>
<li><b>Default</b>: <tt>true</tt></li>
</ul><hr />
<p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
<div>The output directory.</div>
<div>The output directory. This generally maps to &quot;target&quot;.</div>
<ul>
@@ -921,6 +1058,8 @@ Reports page.</div>
</ul><hr />
<p><b><a name="proxyPassword">proxyPassword</a>:</b></p>
<div><b>Deprecated.</b> Please use mavenSettings instead</div>
<div>The Proxy password.</div>
<ul>
@@ -933,6 +1072,8 @@ Reports page.</div>
</ul><hr />
<p><b><a name="proxyPort">proxyPort</a>:</b></p>
<div><b>Deprecated.</b> Please use mavenSettings instead</div>
<div>The Proxy Port.</div>
<ul>
@@ -945,6 +1086,8 @@ Reports page.</div>
</ul><hr />
<p><b><a name="proxyUrl">proxyUrl</a>:</b></p>
<div><b>Deprecated.</b> Please use mavenSettings instead</div>
<div>The Proxy URL.</div>
<ul>
@@ -957,6 +1100,8 @@ Reports page.</div>
</ul><hr />
<p><b><a name="proxyUsername">proxyUsername</a>:</b></p>
<div><b>Deprecated.</b> Please use mavenSettings instead</div>
<div>The Proxy username.</div>
<ul>
@@ -967,24 +1112,10 @@ Reports page.</div>
<li><b>User Property</b>: <tt>proxyUsername</tt></li>
</ul><hr />
<p><b><a name="reportName">reportName</a>:</b></p>
<div>The name of the site report destination.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>report-name</tt></li>
<li><b>Default</b>: <tt>dependency-check-report</tt></li>
</ul><hr />
<p><b><a name="reportOutputDirectory">reportOutputDirectory</a>:</b></p>
<div>Specifies the destination directory for the generated
Dependency-Check report.</div>
Dependency-Check report. This generally maps to &quot;target/site&quot;.</div>
<ul>