version 1.2.6 of the site documentation

2026-04-26 10:18:45 +02:00 · 2014-11-16 12:25:43 -05:00
parent ee9ea74a87
commit ab20a44a32
1206 changed files with 85583 additions and 20779 deletions
--- a/dependency-check-core/apidocs/index-all.html
+++ b/dependency-check-core/apidocs/index-all.html
@@ -2,16 +2,16 @@
 <!-- NewPage -->
 <html lang="en">
 <head>
-<!-- Generated by javadoc (version 1.7.0_45) on Tue Sep 16 05:39:53 EDT 2014 -->
+<!-- Generated by javadoc (version 1.7.0_45) on Sun Nov 16 09:17:35 EST 2014 -->
 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
-<title>Index (Dependency-Check Core 1.2.5 API)</title>
-<meta name="date" content="2014-09-16">
+<title>Index (Dependency-Check Core 1.2.6 API)</title>
+<meta name="date" content="2014-11-16">
 <link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style">
 </head>
 <body>
 <script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
-        parent.document.title="Index (Dependency-Check Core 1.2.5 API)";
+        parent.document.title="Index (Dependency-Check Core 1.2.6 API)";
    }
 //-->
 </script>
@@ -132,6 +132,10 @@
 <dd>
 <div class="block">Adds a new entry of updateable information to the contained collection.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/dependency/Dependency.html#addAsEvidence(java.lang.String, org.owasp.dependencycheck.data.nexus.MavenArtifact, org.owasp.dependencycheck.dependency.Confidence)">addAsEvidence(String, MavenArtifact, Confidence)</a></span> - Method in class org.owasp.dependencycheck.dependency.<a href="./org/owasp/dependencycheck/dependency/Dependency.html" title="class in org.owasp.dependencycheck.dependency">Dependency</a></dt>
+<dd>
+<div class="block">Adds the maven artifact as evidence.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html#addCpe(org.owasp.dependencycheck.suppression.PropertyType)">addCpe(PropertyType)</a></span> - Method in class org.owasp.dependencycheck.suppression.<a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html" title="class in org.owasp.dependencycheck.suppression">SuppressionRule</a></dt>
 <dd>
 <div class="block">Adds the cpe to the cpe list.</div>
@@ -299,6 +303,10 @@
 <dd>
 <div class="block">Performs the analysis on a single Dependency.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#analyzeFileType(org.owasp.dependencycheck.dependency.Dependency, org.owasp.dependencycheck.Engine)">analyzeFileType(Dependency, Engine)</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Performs the analysis.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html#analyzeFileType(org.owasp.dependencycheck.dependency.Dependency, org.owasp.dependencycheck.Engine)">analyzeFileType(Dependency, Engine)</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">JarAnalyzer</a></dt>
 <dd>
 <div class="block">Loads a specified JAR file and collects information from the manifest and checksums to identify the correct CPE
@@ -516,6 +524,21 @@
 <dd>
 <div class="block">Implements the callable interface.</div>
 </dd>
+<dt><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer"><span class="strong">CentralAnalyzer</span></a> - Class in <a href="./org/owasp/dependencycheck/analyzer/package-summary.html">org.owasp.dependencycheck.analyzer</a></dt>
+<dd>
+<div class="block">Analyzer which will attempt to locate a dependency, and the GAV information, by querying Central for the dependency's
+ SHA-1 digest.</div>
+</dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#CentralAnalyzer()">CentralAnalyzer()</a></span> - Constructor for class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="./org/owasp/dependencycheck/data/central/CentralSearch.html" title="class in org.owasp.dependencycheck.data.central"><span class="strong">CentralSearch</span></a> - Class in <a href="./org/owasp/dependencycheck/data/central/package-summary.html">org.owasp.dependencycheck.data.central</a></dt>
+<dd>
+<div class="block">Class of methods to search Maven Central via Central.</div>
+</dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/data/central/CentralSearch.html#CentralSearch(java.net.URL)">CentralSearch(URL)</a></span> - Constructor for class org.owasp.dependencycheck.data.central.<a href="./org/owasp/dependencycheck/data/central/CentralSearch.html" title="class in org.owasp.dependencycheck.data.central">CentralSearch</a></dt>
+<dd>
+<div class="block">Creates a NexusSearch for the given repository URL.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/data/update/xml/NvdCve20Handler.html#characters(char[], int, int)">characters(char[], int, int)</a></span> - Method in class org.owasp.dependencycheck.data.update.xml.<a href="./org/owasp/dependencycheck/data/update/xml/NvdCve20Handler.html" title="class in org.owasp.dependencycheck.data.update.xml">NvdCve20Handler</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/suppression/SuppressionHandler.html#characters(char[], int, int)">characters(char[], int, int)</a></span> - Method in class org.owasp.dependencycheck.suppression.<a href="./org/owasp/dependencycheck/suppression/SuppressionHandler.html" title="class in org.owasp.dependencycheck.suppression">SuppressionHandler</a></dt>
@@ -1212,6 +1235,10 @@
 </dd>
 <dt><a href="./org/owasp/dependencycheck/utils/DBUtils.html" title="class in org.owasp.dependencycheck.utils"><span class="strong">DBUtils</span></a> - Class in <a href="./org/owasp/dependencycheck/utils/package-summary.html">org.owasp.dependencycheck.utils</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/NexusAnalyzer.html#DEFAULT_URL">DEFAULT_URL</a></span> - Static variable in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/NexusAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">NexusAnalyzer</a></dt>
+<dd>
+<div class="block">The default URL - this will be used by the CentralAnalyzer to determine whether to enable this.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/jaxb/pom/generated/Build.html#defaultGoal">defaultGoal</a></span> - Variable in class org.owasp.dependencycheck.jaxb.pom.generated.<a href="./org/owasp/dependencycheck/jaxb/pom/generated/Build.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated">Build</a></dt>
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/jaxb/pom/generated/BuildBase.html#defaultGoal">defaultGoal</a></span> - Variable in class org.owasp.dependencycheck.jaxb.pom.generated.<a href="./org/owasp/dependencycheck/jaxb/pom/generated/BuildBase.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated">BuildBase</a></dt>
@@ -1322,6 +1349,10 @@
 <div class="block">Searches the data store of CPE entries, trying to identify the CPE for the given dependency based on the evidence
 contained within.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html#determineIdentifiers(org.owasp.dependencycheck.dependency.Dependency, java.lang.String, java.lang.String, org.owasp.dependencycheck.dependency.Confidence)">determineIdentifiers(Dependency, String, String, Confidence)</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CPEAnalyzer</a></dt>
+<dd>
+<div class="block">Retrieves a list of CPE values from the CveDB based on the vendor and product passed in.</div>
+</dd>
 <dt><a href="./org/owasp/dependencycheck/jaxb/pom/generated/Developer.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated"><span class="strong">Developer</span></a> - Class in <a href="./org/owasp/dependencycheck/jaxb/pom/generated/package-summary.html">org.owasp.dependencycheck.jaxb.pom.generated</a></dt>
 <dd>
 <div class="block">Information about one of the committers on this project.</div>
@@ -1640,6 +1671,11 @@
 <dd>&nbsp;</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/jaxb/pom/generated/BuildBase.html#finalName">finalName</a></span> - Variable in class org.owasp.dependencycheck.jaxb.pom.generated.<a href="./org/owasp/dependencycheck/jaxb/pom/generated/BuildBase.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated">BuildBase</a></dt>
 <dd>&nbsp;</dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/DependencyBundlingAnalyzer.html#firstPathIsShortest(java.lang.String, java.lang.String)">firstPathIsShortest(String, String)</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/DependencyBundlingAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">DependencyBundlingAnalyzer</a></dt>
+<dd>
+<div class="block">Determines which path is shortest; if path lengths are equal then we use compareTo of the string method to
+ determine if the first path is smaller.</div>
+</dd>
 </dl>
 <a name="_G_">
 <!--   -->
@@ -1690,6 +1726,10 @@
 <dd>
 <div class="block">Returns the phase this analyzer runs under.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#getAnalysisPhase()">getAnalysisPhase()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Returns the analysis phase under which the analyzer runs.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html#getAnalysisPhase()">getAnalysisPhase()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CPEAnalyzer</a></dt>
 <dd>
 <div class="block">Returns the analysis phase that this analyzer should run in.</div>
@@ -1751,6 +1791,10 @@
 <dd>
 <div class="block">Returns the key used in the properties file to reference the analyzer's enabled property.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#getAnalyzerEnabledSettingKey()">getAnalyzerEnabledSettingKey()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Returns the key used in the properties file to to reference the analyzer's enabled property.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html#getAnalyzerEnabledSettingKey()">getAnalyzerEnabledSettingKey()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">JarAnalyzer</a></dt>
 <dd>
 <div class="block">Returns the key used in the properties file to reference the analyzer's enabled property.</div>
@@ -2574,6 +2618,10 @@
 <dd>
 <div class="block">Gets this analyzer's name.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#getName()">getName()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Returns the analyzer's name.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html#getName()">getName()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CPEAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CPEAnalyzer</a></dt>
 <dd>
 <div class="block">Returns the name of this analyzer.</div>
@@ -3125,6 +3173,10 @@
 <dd>
 <div class="block">Gets the set of extensions supported by this analyzer.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#getSupportedExtensions()">getSupportedExtensions()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Returns the extensions for which this Analyzer runs.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html#getSupportedExtensions()">getSupportedExtensions()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">JarAnalyzer</a></dt>
 <dd>
 <div class="block">Returns a list of file EXTENSIONS supported by this analyzer.</div>
@@ -3672,6 +3724,10 @@
 <dd>
 <div class="block">Initialize the analyzer.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#initializeFileTypeAnalyzer()">initializeFileTypeAnalyzer()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Initializes the analyzer once before any analysis is performed.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html#initializeFileTypeAnalyzer()">initializeFileTypeAnalyzer()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/JarAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">JarAnalyzer</a></dt>
 <dd>
 <div class="block">Initializes the JarAnalyzer.</div>
@@ -3707,13 +3763,17 @@
 <dd>
 <div class="block">Gets the value of the activeByDefault property.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/data/nvdcve/CveDB.html#isAffected(java.lang.String, java.lang.String, org.owasp.dependencycheck.utils.DependencyVersion, java.lang.String, java.lang.String)">isAffected(String, String, DependencyVersion, String, String)</a></span> - Method in class org.owasp.dependencycheck.data.nvdcve.<a href="./org/owasp/dependencycheck/data/nvdcve/CveDB.html" title="class in org.owasp.dependencycheck.data.nvdcve">CveDB</a></dt>
+<dd>
+<div class="block">Determines if the given identifiedVersion is affected by the given cpeId and previous version flag.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/agent/DependencyCheckScanAgent.html#isAutoUpdate()">isAutoUpdate()</a></span> - Method in class org.owasp.dependencycheck.agent.<a href="./org/owasp/dependencycheck/agent/DependencyCheckScanAgent.html" title="class in org.owasp.dependencycheck.agent">DependencyCheckScanAgent</a></dt>
 <dd>
 <div class="block">Get the value of autoUpdate.</div>
 </dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html#isBase()">isBase()</a></span> - Method in class org.owasp.dependencycheck.suppression.<a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html" title="class in org.owasp.dependencycheck.suppression">SuppressionRule</a></dt>
 <dd>
-<div class="block">Get the value of base</div>
+<div class="block">Get the value of base.</div>
 </dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/suppression/PropertyType.html#isCaseSensitive()">isCaseSensitive()</a></span> - Method in class org.owasp.dependencycheck.suppression.<a href="./org/owasp/dependencycheck/suppression/PropertyType.html" title="class in org.owasp.dependencycheck.suppression">PropertyType</a></dt>
 <dd>
@@ -3755,6 +3815,14 @@
 <dd>
 <div class="block">Get the value of enabled.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html#isEnabled()">isEnabled()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/CentralAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">CentralAnalyzer</a></dt>
+<dd>
+<div class="block">Determine whether to enable this analyzer or not.</div>
+</dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/analyzer/NexusAnalyzer.html#isEnabled()">isEnabled()</a></span> - Method in class org.owasp.dependencycheck.analyzer.<a href="./org/owasp/dependencycheck/analyzer/NexusAnalyzer.html" title="class in org.owasp.dependencycheck.analyzer">NexusAnalyzer</a></dt>
+<dd>
+<div class="block">Determine whether to enable this analyzer or not.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/jaxb/pom/generated/RepositoryPolicy.html#isEnabled()">isEnabled()</a></span> - Method in class org.owasp.dependencycheck.jaxb.pom.generated.<a href="./org/owasp/dependencycheck/jaxb/pom/generated/RepositoryPolicy.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated">RepositoryPolicy</a></dt>
 <dd>
 <div class="block">Gets the value of the enabled property.</div>
@@ -4452,6 +4520,14 @@
 </head>
 <body></div>
 </dd>
+<dt><a href="./org/owasp/dependencycheck/data/central/package-summary.html">org.owasp.dependencycheck.data.central</a> - package org.owasp.dependencycheck.data.central</dt>
+<dd>
+<div class="block"><html>
+ <head>
+ <title>org.owasp.dependencycheck.data.central</title>
+ </head>
+ <body></div>
+</dd>
 <dt><a href="./org/owasp/dependencycheck/data/cpe/package-summary.html">org.owasp.dependencycheck.data.cpe</a> - package org.owasp.dependencycheck.data.cpe</dt>
 <dd>
 <div class="block"><html>
@@ -5140,6 +5216,10 @@
 <dd>
 <div class="block">Constructs a new SearchFieldAnalyzer.</div>
 </dd>
+<dt><span class="strong"><a href="./org/owasp/dependencycheck/data/central/CentralSearch.html#searchSha1(java.lang.String)">searchSha1(String)</a></span> - Method in class org.owasp.dependencycheck.data.central.<a href="./org/owasp/dependencycheck/data/central/CentralSearch.html" title="class in org.owasp.dependencycheck.data.central">CentralSearch</a></dt>
+<dd>
+<div class="block">Searches the configured Central URL for the given sha1 hash.</div>
+</dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/data/nexus/NexusSearch.html#searchSha1(java.lang.String)">searchSha1(String)</a></span> - Method in class org.owasp.dependencycheck.data.nexus.<a href="./org/owasp/dependencycheck/data/nexus/NexusSearch.html" title="class in org.owasp.dependencycheck.data.nexus">NexusSearch</a></dt>
 <dd>
 <div class="block">Searches the configured Nexus repository for the given sha1 hash.</div>
@@ -5241,7 +5321,7 @@
 </dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html#setBase(boolean)">setBase(boolean)</a></span> - Method in class org.owasp.dependencycheck.suppression.<a href="./org/owasp/dependencycheck/suppression/SuppressionRule.html" title="class in org.owasp.dependencycheck.suppression">SuppressionRule</a></dt>
 <dd>
-<div class="block">Set the value of base</div>
+<div class="block">Set the value of base.</div>
 </dd>
 <dt><span class="strong"><a href="./org/owasp/dependencycheck/jaxb/pom/generated/Model.html#setBuild(org.owasp.dependencycheck.jaxb.pom.generated.Build)">setBuild(Build)</a></span> - Method in class org.owasp.dependencycheck.jaxb.pom.generated.<a href="./org/owasp/dependencycheck/jaxb/pom/generated/Model.html" title="class in org.owasp.dependencycheck.jaxb.pom.generated">Model</a></dt>
 <dd>