mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-03-23 09:31:32 +01:00
version 1.1.4 of the projects documentation
This commit is contained in:
Jeremy Long
@@ -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 - Configuration</title>
|
||||
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
|
||||
@@ -54,7 +54,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>
|
||||
@@ -67,9 +67,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>
|
||||
@@ -189,6 +189,15 @@
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>outputDirectory </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>
|
||||
|
||||
<td>‘target’</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>failBuildOnCVSS </td>
|
||||
|
||||
<td>Specifies if the build should be failed if a CVSS score above a specified level is identified. The default is 11 which means since the CVSS scores are 0-10, by default the build will never fail. </td>
|
||||
@@ -196,7 +205,7 @@
|
||||
<td>11</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
<tr class="b">
|
||||
|
||||
<td>format </td>
|
||||
|
||||
@@ -205,7 +214,7 @@
|
||||
<td>HTML</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
<tr class="a">
|
||||
|
||||
<td>logFile </td>
|
||||
|
||||
@@ -214,7 +223,7 @@
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
<tr class="b">
|
||||
|
||||
<td>suppressionFile </td>
|
||||
|
||||
@@ -223,49 +232,76 @@
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>skipTestScope </td>
|
||||
|
||||
<td>Should be skip analysis for artifacts with Test Scope </td>
|
||||
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>connectionTimeout </td>
|
||||
<td>skipProvidedScope </td>
|
||||
|
||||
<td>The Connection Timeout. </td>
|
||||
<td>Should be skip analysis for artifacts with Provided Scope </td>
|
||||
|
||||
<td> </td>
|
||||
<td>false</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>proxyUrl </td>
|
||||
<td>skipRuntimeScope </td>
|
||||
|
||||
<td>The Proxy URL. </td>
|
||||
<td>Should be skip analysis for artifacts with Runtime Scope </td>
|
||||
|
||||
<td> </td>
|
||||
<td>false</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1>Analyzer Configuration</h1>
|
||||
<p>The following properties are used to configure the various file type analyzers. These properties can be used to turn off specific analyzers if it is not needed. Note, that specific analyzers will automatically disable themselves if no file types that they support are detected - so specifically disabling them may not be needed.</p>
|
||||
|
||||
<table border="0" class="table table-striped">
|
||||
<thead>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<th>Property </th>
|
||||
|
||||
<th>Description </th>
|
||||
|
||||
<th>Default Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>proxyPort </td>
|
||||
<td>archiveAnalyzerEnabled </td>
|
||||
|
||||
<td>The Proxy Port. </td>
|
||||
<td>Sets whether the Archive Analyzer will be used. </td>
|
||||
|
||||
<td> </td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>proxyUsername </td>
|
||||
<td>zipExtensions </td>
|
||||
|
||||
<td>Defines the proxy user name. </td>
|
||||
<td>A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>proxyPassword </td>
|
||||
<td>jarAnalyzer </td>
|
||||
|
||||
<td>Defines the proxy password. </td>
|
||||
<td>Sets whether Jar Analyzer will be used. </td>
|
||||
|
||||
<td> </td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
@@ -274,7 +310,7 @@
|
||||
|
||||
<td>Sets whether Nexus Analyzer will be used. </td>
|
||||
|
||||
<td> </td>
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
@@ -283,7 +319,7 @@
|
||||
|
||||
<td>Defines the Nexus URL. </td>
|
||||
|
||||
<td> </td>
|
||||
<td><a class="externalLink" href="https://repository.sonatype.org/service/local/">https://repository.sonatype.org/service/local/</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
@@ -297,6 +333,105 @@
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>nuspecAnalyzerEnabled </td>
|
||||
|
||||
<td>Sets whether or not the .NET Nuget Nuspec Analyzer will be used. </td>
|
||||
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>assemblyAnalyzerEnabled </td>
|
||||
|
||||
<td>Sets whether or not the .NET Assembly Analyzer should be used. </td>
|
||||
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>pathToMono </td>
|
||||
|
||||
<td>The path to Mono for .NET assembly analysis on non-windows systems </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1>Advanced Configuration</h1>
|
||||
<p>The following properties can be configured in the plugin. However, they are less frequently changed. One exception may be the cvedUrl properties, which can be used to host a mirror of the NVD within an enterprise environment.</p>
|
||||
|
||||
<table border="0" class="table table-striped">
|
||||
<thead>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<th>Property </th>
|
||||
|
||||
<th>Description </th>
|
||||
|
||||
<th>Default Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>cveUrl12Modified </td>
|
||||
|
||||
<td>URL for the modified CVE 1.2 </td>
|
||||
|
||||
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-modified.xml">http://nvd.nist.gov/download/nvdcve-modified.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>cveUrl20Modified </td>
|
||||
|
||||
<td>URL for the modified CVE 2.0 </td>
|
||||
|
||||
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>cveUrl12Base </td>
|
||||
|
||||
<td>Base URL for each year’s CVE 1.2, the %d will be replaced with the year </td>
|
||||
|
||||
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-%d.xml">http://nvd.nist.gov/download/nvdcve-%d.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>cveUrl20Base </td>
|
||||
|
||||
<td>Base URL for each year’s CVE 2.0, the %d will be replaced with the year </td>
|
||||
|
||||
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>connectionTimeout </td>
|
||||
|
||||
<td>The URL Connection Timeout. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>dataDirectory </td>
|
||||
|
||||
<td>Data directory to hold SQL CVEs contents. This should generally not be changed. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>databaseDriverName </td>
|
||||
|
||||
<td>The name of the database driver. Example: org.h2.Driver. </td>
|
||||
@@ -339,93 +474,57 @@
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h1>Deprecated Configuration</h1>
|
||||
<p>The following properties have been deprecated. These can stell be set in the dependency-check-maven plugin’s configuration. However, future versions will remove these properties. Instead using these properties you should use <a class="externalLink" href="https://maven.apache.org/settings.html#Proxies">Maven’s settings</a> to configure a proxy.</p>
|
||||
|
||||
<table border="0" class="table table-striped">
|
||||
<thead>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>zipExtensions </td>
|
||||
<th>Property </th>
|
||||
|
||||
<td>A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. </td>
|
||||
<th>Description </th>
|
||||
|
||||
<th>Default Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>proxyUrl </td>
|
||||
|
||||
<td>The Proxy URL. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>proxyPort </td>
|
||||
|
||||
<td>The Proxy Port. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>skipTestScope </td>
|
||||
<td>proxyUsername </td>
|
||||
|
||||
<td>Should be skip analysis for artifacts with Test Scope </td>
|
||||
|
||||
<td>true</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>skipProvidedScope </td>
|
||||
|
||||
<td>Should be skip analysis for artifacts with Provided Scope </td>
|
||||
|
||||
<td>false</td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>skipRuntimeScope </td>
|
||||
|
||||
<td>Should be skip analysis for artifacts with Runtime Scope </td>
|
||||
|
||||
<td>false</td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>dataDirectory </td>
|
||||
|
||||
<td>Data directory to hold SQL CVEs contents. This should generally not be changed. </td>
|
||||
<td>Defines the proxy user name. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>cveUrl12Modified </td>
|
||||
|
||||
<td>URL for the modified CVE 1.2 </td>
|
||||
|
||||
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-modified.xml">http://nvd.nist.gov/download/nvdcve-modified.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>cveUrl20Modified </td>
|
||||
<td>proxyPassword </td>
|
||||
|
||||
<td>URL for the modified CVE 2.0 </td>
|
||||
|
||||
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>cveUrl12Base </td>
|
||||
|
||||
<td>Base URL for each year’s CVE 1.2, the %d will be replaced with the year </td>
|
||||
|
||||
<td><a class="externalLink" href="http://nvd.nist.gov/download/nvdcve-%d.xml">http://nvd.nist.gov/download/nvdcve-%d.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="a">
|
||||
|
||||
<td>cveUrl20Base </td>
|
||||
|
||||
<td>Base URL for each year’s CVE 2.0, the %d will be replaced with the year </td>
|
||||
|
||||
<td><a class="externalLink" href="http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml">http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml</a></td>
|
||||
</tr>
|
||||
|
||||
<tr class="b">
|
||||
|
||||
<td>pathToMono </td>
|
||||
|
||||
<td>The path to Mono for .NET assembly analysis on non-windows systems </td>
|
||||
<td>Defines the proxy password. </td>
|
||||
|
||||
<td> </td>
|
||||
</tr>
|
||||
|
||||
Reference in New Issue
Block a user