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

updated documentation

Browse Source 
Former-commit-id: cb2c5c0fd7e0dfc33ce5a1b3cf75799c015c78df
This commit is contained in:
Jeremy Long
2014-03-23 23:03:51 -04:00
parent 315a616293
commit 9b2cacc3a0
5 changed files with 140 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
dependency-check-maven/src/site/markdown/configuration.md
View File

@@ -11,28 +11,51 @@ failBuildOnCVSS | Specifies if the build should be failed if a CVSS score a
format | The report format to be generated (HTML, XML, VULN, ALL). This configuration option has no affect if using this within the Site plugin unless the externalReport is set to true. | HTML
logFile | The file path to write verbose logging information. |  
suppressionFile | The file path to the XML suppression file \- used to suppress [false positives](../suppression.html) |  
connectionTimeout | The Connection Timeout. |  
nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used. |  
nexusUrl | Defines the Nexus URL. |  
nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true
databaseDriverName | The name of the database driver. Example: org.h2.Driver. |  
databaseDriverPath | The path to the database driver JAR file; only used if the driver is not in the class path. |  
connectionString | The connection string used to connect to the database. |  
databaseUser | The username used when connecting to the database. |  
databasePassword | The password used when connecting to the database. |  
zipExtensions | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. |  
skipTestScope | Should be skip analysis for artifacts with Test Scope | true
skipProvidedScope | Should be skip analysis for artifacts with Provided Scope | false
skipRuntimeScope | Should be skip analysis for artifacts with Runtime Scope | false
dataDirectory | Data directory to hold SQL CVEs contents. This should generally not be changed. |  
cveUrl12Modified | URL for the modified CVE 1.2 | http://nvd.nist.gov/download/nvdcve-modified.xml
cveUrl20Modified | URL for the modified CVE 2.0 | http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml
Analyzer Configuration
====================
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.
Property | Description | Default Value
------------------------|------------------------------------|------------------
archiveAnalyzerEnabled | Sets whether the Archive Analyzer will be used. | true
zipExtensions | A comma-separated list of additional file extensions to be treated like a ZIP file, the contents will be extracted and analyzed. |  
jarAnalyzer | Sets whether Jar Analyzer will be used. | true
nexusAnalyzerEnabled | Sets whether Nexus Analyzer will be used. | true
nexusUrl | Defines the Nexus URL. | http://repository.sonatype.org/service/local/
nexusUsesProxy | Whether or not the defined proxy should be used when connecting to Nexus. | true
nuspecAnalyzerEnabled | Sets whether or not the .NET Nuget Nuspec Analyzer will be used. | true
assemblyAnalyzerEnabled | Sets whether or not the .NET Assembly Analyzer should be used. | true
pathToMono | The path to Mono for .NET assembly analysis on non-windows systems |  
Advanced Configuration
====================
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.
Property | Description | Default Value
---------------------|-------------------------------------------------------------------------|------------------
cveUrl12Modified | URL for the modified CVE 1.2 | http://nvd.nist.gov/download/nvdcve-modified.xml
cveUrl20Modified | URL for the modified CVE 2.0 | http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-modified.xml
cveUrl12Base | Base URL for each year's CVE 1.2, the %d will be replaced with the year | http://nvd.nist.gov/download/nvdcve-%d.xml
cveUrl20Base | Base URL for each year's CVE 2.0, the %d will be replaced with the year | http://static.nvd.nist.gov/feeds/xml/cve/nvdcve-2.0-%d.xml
pathToMono | The path to Mono for .NET assembly analysis on non-windows systems |  
connectionTimeout | The URL Connection Timeout. |  
dataDirectory | Data directory to hold SQL CVEs contents. This should generally not be changed. |  
databaseDriverName | The name of the database driver. Example: org.h2.Driver. |  
databaseDriverPath | The path to the database driver JAR file; only used if the driver is not in the class path. |  
connectionString | The connection string used to connect to the database. |  
databaseUser | The username used when connecting to the database. |  
databasePassword | The password used when connecting to the database. |  
Deprecated Properties
Deprecated Configuration
====================
The following properties have been deprecated. These can stell be set in
the dependency-check-maven plugin's configuration. However, future versions

20
dependency-check-maven/src/site/markdown/usage.md.vm
View File

@@ -10,8 +10,9 @@ Vulnerability Database (NVD) hosted by NIST: https://nvd.nist.gov
After the first batch download, as long as the plugin is executed at least once every
seven days the update will only take a few seconds.
Example 1:
---------------------
#set( $H = '#' )
$H$H$H Example 1:
Create the DependencyCheck-report.html in the target directory
```xml
@@ -39,8 +40,7 @@ Create the DependencyCheck-report.html in the target directory
</project>
```
Example 2:
---------------------
$H$H$H Example 2:
Create the DependencyCheck-report.html and fail the build for CVSS greater then 8
```xml
@@ -71,8 +71,7 @@ Create the DependencyCheck-report.html and fail the build for CVSS greater then
</project>
```
Example 3:
---------------------
$H$H$H Example 3:
Create the dependency-check report within the site
```xml
@@ -103,8 +102,8 @@ Create the dependency-check report within the site
...
</project>
```
Example 4:
---------------------
$H$H$H Example 4:
Create the DependencyCheck-report.html and skip artifacts no bundled in distribution (Provided and Runtime scope)
```xml
@@ -135,8 +134,8 @@ Create the DependencyCheck-report.html and skip artifacts no bundled in distribu
...
</project>
```
Example 5:
---------------------
$H$H$H Example 5:
Create the DependencyCheck-report.html and use internal mirroring of CVE contents
```xml
@@ -169,4 +168,3 @@ Create the DependencyCheck-report.html and use internal mirroring of CVE content
...
</project>
```