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

version 1.2.5 of the documentation

Browse Source
This commit is contained in:
Jeremy Long
2014-09-17 05:43:14 -04:00
parent c9a8bb3969
commit b31c4d94c4
988 changed files with 22559 additions and 19785 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia at 2014-08-05
| Generated by Apache Maven Doxia at 2014-09-16
| 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="20140805" />
<meta name="Date-Revision-yyyymmdd" content="20140916" />
<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.4/#" title="">
<a href="../../../../../../../../../../../../c:/Users/jeremy/Documents/NetBeansProjects/DependencyCheck/target/site/1.2.5/#" title="">
</a>
<span class="divider">/</span>
</li>
@@ -69,9 +69,9 @@
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-08-05</li>
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2014-09-16</li>
<li id="projectVersion" class="pull-right">
Version: 1.2.4
Version: 1.2.5
</li>
</ul>
@@ -107,7 +107,7 @@
<i class="icon-chevron-right"></i>
Project Information</a>
</li>
<li>
<a href="project-reports.html" title="Project Reports">
@@ -165,7 +165,7 @@
<p><b>Full name</b>:</p>
<p>org.owasp:dependency-check-maven:1.2.4:check</p>
<p>org.owasp:dependency-check-maven:1.2.5:check</p>
<p><b>Description</b>:</p>
@@ -217,13 +217,13 @@ is not recommended that this be turned to false. Default is true.<br /><b>Defaul
<tr class="a">
<td><b><a href="#externalReport">externalReport</a></b></td>
<td><b><a href="#dataFileName">dataFileName</a></b></td>
<td><tt>boolean</tt></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>Sets whether or not the external report format should be used.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>externalReport</tt>.</td>
<td>Sets whether or not the external report format should be used.<br /><b>Default value is</b>: <tt>dependency-check.ser</tt>.<br /><b>User property is</b>: <tt>metaFileName</tt>.</td>
</tr>
<tr class="b">
@@ -295,6 +295,17 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<tr class="b">
<td><b><a href="#aggregate">aggregate</a></b></td>
<td><tt>boolean</tt></td>
<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>
</tr>
<tr class="a">
<td><b><a href="#archiveAnalyzerEnabled">archiveAnalyzerEnabled</a></b></td>
<td><tt>boolean</tt></td>
@@ -304,7 +315,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<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">
<tr class="b">
<td><b><a href="#assemblyAnalyzerEnabled">assemblyAnalyzerEnabled</a></b></td>
@@ -315,7 +326,7 @@ Dependency-Check report. This generally maps to &quot;target/site&quot;.<br /><b
<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">
<tr class="a">
<td><b><a href="#connectionString">connectionString</a></b></td>
@@ -326,7 +337,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="a">
<tr class="b">
<td><b><a href="#connectionTimeout">connectionTimeout</a></b></td>
@@ -337,7 +348,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="b">
<tr class="a">
<td><b><a href="#cveUrl12Base">cveUrl12Base</a></b></td>
@@ -348,7 +359,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="a">
<tr class="b">
<td><b><a href="#cveUrl12Modified">cveUrl12Modified</a></b></td>
@@ -359,7 +370,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="b">
<tr class="a">
<td><b><a href="#cveUrl20Base">cveUrl20Base</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 2.0.<br /><b>User property is</b>: <tt>cveUrl20Base</tt>.</td>
</tr>
<tr class="a">
<tr class="b">
<td><b><a href="#cveUrl20Modified">cveUrl20Modified</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>cveUrl20Modified</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#dataDirectory">dataDirectory</a></b></td>
@@ -392,7 +403,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="a">
<tr class="b">
<td><b><a href="#databaseDriverName">databaseDriverName</a></b></td>
@@ -403,7 +414,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="b">
<tr class="a">
<td><b><a href="#databaseDriverPath">databaseDriverPath</a></b></td>
@@ -414,7 +425,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="a">
<tr class="b">
<td><b><a href="#databasePassword">databasePassword</a></b></td>
@@ -425,7 +436,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="b">
<tr class="a">
<td><b><a href="#databaseUser">databaseUser</a></b></td>
@@ -436,19 +447,18 @@ 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="a">
<tr class="b">
<td><b><a href="#description">description</a></b></td>
<td><b><a href="#externalReport">externalReport</a></b></td>
<td><tt>String</tt></td>
<td><tt>-</tt></td>
<td>The description of the Dependency-Check report to be displayed in
the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report providing details on any published vulnerabilities within project dependencies. This report is a best effort but may contain false positives and false negatives.</tt>.<br /><b>User property is</b>: <tt>description</tt>.</td>
<td><b>Deprecated.</b> the internal report is no longer supported<br /><b>User property is</b>: <tt>externalReport</tt>.</td>
</tr>
<tr class="b">
<tr class="a">
<td><b><a href="#jarAnalyzerEnabled">jarAnalyzerEnabled</a></b></td>
@@ -459,7 +469,7 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
<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">
<tr class="b">
<td><b><a href="#logFile">logFile</a></b></td>
@@ -470,7 +480,7 @@ 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">
<tr class="a">
<td><b><a href="#mavenSettings">mavenSettings</a></b></td>
@@ -481,7 +491,7 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
<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">
<tr class="b">
<td><b><a href="#mavenSettingsProxyId">mavenSettingsProxyId</a></b></td>
@@ -492,18 +502,6 @@ the Maven Generated Reports page.<br /><b>Default value is</b>: <tt>A report pro
<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>
<td><tt>-</tt></td>
<td>The name of the report to be displayed in the Maven Generated
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="a">
<td><b><a href="#nexusAnalyzerEnabled">nexusAnalyzerEnabled</a></b></td>
@@ -642,6 +640,20 @@ 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="aggregate">aggregate</a>:</b></p>
<div>Generate aggregate reports in multi-module projects.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>aggregate</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="archiveAnalyzerEnabled">archiveAnalyzerEnabled</a>:</b></p>
<div>Whether or not the Archive Analyzer is enabled.</div>
@@ -769,6 +781,20 @@ is not recommended that this be turned to false. Default is true.</div>
<li><b>User Property</b>: <tt>dataDirectory</tt></li>
</ul><hr />
<p><b><a name="dataFileName">dataFileName</a>:</b></p>
<div>Sets whether or not the external report format should be used.</div>
<ul>
<li><b>Type</b>: <tt>java.lang.String</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
<li><b>User Property</b>: <tt>metaFileName</tt></li>
<li><b>Default</b>: <tt>dependency-check.ser</tt></li>
</ul><hr />
<p><b><a name="databaseDriverName">databaseDriverName</a>:</b></p>
<div>The database driver name. An example would be org.h2.Driver.</div>
@@ -817,10 +843,11 @@ is not recommended that this be turned to false. Default is true.</div>
<li><b>User Property</b>: <tt>databaseUser</tt></li>
</ul><hr />
<p><b><a name="description">description</a>:</b></p>
<p><b><a name="externalReport">externalReport</a>:</b></p>
<div>The description of the Dependency-Check report to be displayed in
the Maven Generated Reports page.</div>
<div><b>Deprecated.</b> the internal report is no longer supported</div>
<div>Sets whether or not the external report format should be used.</div>
<ul>
@@ -828,23 +855,7 @@ the Maven Generated Reports page.</div>
<li><b>Required</b>: <tt>No</tt></li>
<li><b>User Property</b>: <tt>description</tt></li>
<li><b>Default</b>: <tt>A report providing details on any published vulnerabilities within project dependencies. This report is a best effort but may contain false positives and false negatives.</tt></li>
</ul><hr />
<p><b><a name="externalReport">externalReport</a>:</b></p>
<div>Sets whether or not the external report format should be used.</div>
<ul>
<li><b>Type</b>: <tt>boolean</tt></li>
<li><b>Required</b>: <tt>Yes</tt></li>
<li><b>User Property</b>: <tt>externalReport</tt></li>
<li><b>Default</b>: <tt>false</tt></li>
</ul><hr />
<p><b><a name="failBuildOnCVSS">failBuildOnCVSS</a>:</b></p>
@@ -930,21 +941,6 @@ plugin unless the externalReport is set to true. Default is HTML.</div>
<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
Reports page.</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>name</tt></li>
<li><b>Default</b>: <tt>Dependency-Check</tt></li>
</ul><hr />
<p><b><a name="nexusAnalyzerEnabled">nexusAnalyzerEnabled</a>:</b></p>
<div>Whether or not the Nexus Analyzer is enabled.</div>