updated documentation

Former-commit-id: a41eadec0c691ce907b64a688a60325dd61f9ae7
This commit is contained in:
Jeremy Long
2015-04-19 08:14:55 -04:00
parent 09122be7be
commit 4a2309a3f8
15 changed files with 66 additions and 69 deletions

View File

@@ -354,8 +354,8 @@ Copyright (c) 2012 - Jeremy Long
<report>dependency-info</report>
<report>dependency-management</report>
<report>distribution-management</report>
-->
<report>index</report>
-->
<report>summary</report>
<report>mailing-list</report>
<report>issue-tracking</report>

View File

@@ -1,6 +1,6 @@
About
====================
Dependency-check is an open source solution the OWASP Top 10 2013 entry: [A9 -
OWASP dependency-check is an open source solution the OWASP Top 10 2013 entry: [A9 -
Using Components with Known Vulnerabilities](https://www.owasp.org/index.php/Top_10_2013-A9-Using_Components_with_Known_Vulnerabilities).
Dependency-check can currently be used to scan Java applications (and their
dependent libraries) to identify known vulnerable components.
@@ -16,13 +16,9 @@ More information about dependency-check can be found here:
* [How does dependency-check work](./internals.html)
* [How to read the report](./thereport.html)
* [The OWASP dependency-check mailing list](./mail-lists.html)
**IMPORTANT NOTE**: Dependency-check automatically updates itself using the NVD Data Feeds hosted by
NIST. **The initial download of the data may take fifteen minutes
or more**, if you run the tool at least once every seven days only a small XML file
needs to be downloaded to keep the local copy of the data current.
Dependency-check's core analysis library is exposed in various forms:
OWASP dependency-check's core analysis engine can be used as:
- [Command Line Tool](dependency-check-cli/index.html)
- [Maven Plugin](dependency-check-maven/usage.html)

View File

@@ -73,67 +73,68 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved.
<item name=" " href="#"/>
</breadcrumbs>
<menu name="OWASP dependency-check">
<item collapse="false" name="General" href="./index.html">
<item name="How it Works" href="./general/internals.html">
<description>How does dependency-check work?</description>
</item>
<item name="Reading the Report" href="./general/thereport.html">
<description>How to read the report</description>
</item>
<item name="False Positives" href="./general/suppression.html">
<description>Suppressing False Positives</description>
</item>
<item name="Project Presentation (pptx)" href="./general/dependency-check.pptx">
<description>PowerPoint Deck</description>
</item>
<item name="Project Presentation (pdf)" href="./general/dependency-check.pdf">
<description>PowerPoint Deck</description>
</item>
<item name="Sample Report" href="./general/SampleReport.html">
<description>Sample Report</description>
</item>
</item>
<item collapse="true" name="File Type Analyzers" href="./analyzers/index.html">
<item name="Archive Analyzer" href="./analyzers/archive-analyzer.html">
<description>Archive Analyzer</description>
</item>
<item name="Jar Analyzer" href="./analyzers/jar-analyzer.html">
<description>Jar Analyzer</description>
</item>
<item name="Central Analyzer" href="./analyzers/central-analyzer.html">
<description>Central Analyzer</description>
</item>
<item name="Nexus Analyzer" href="./analyzers/nexus-analyzer.html">
<description>Nexus Analyzer</description>
</item>
<item name="Assembly Analyzer" href="./analyzers/assembly-analyzer.html">
<description>Assembly Analyzer</description>
</item>
<item name="Nuspec Analyzer" href="./analyzers/nuspec-analyzer.html">
<description>Nuspec Analyzer</description>
</item>
</item>
<item collapse="true" name="Modules" href="./modules.html">
<item name="dependency-check-cli" href="./dependency-check-cli/installation.html">
<description>The command line interface for OWASP dependency-check.</description>
</item>
<item name="dependency-check-ant" href="./dependency-check-ant/installation.html">
<description>An Ant task to run OWASP dependency-check.</description>
</item>
<item name="dependency-check-maven" href="./dependency-check-maven/usage.html">
<description>A Maven plugin for OWASP dependency-check.</description>
</item>
<item name="dependency-check-jenkins" href="./dependency-check-jenkins/index.html">
<description>A Jenkins plugin for OWASP dependency-check.</description>
</item>
<item name="dependency-check-core" href="./dependency-check-core/index.html">
<description>The core OWASP dependency-check engine and reporting tool.</description>
</item>
<item name="dependency-check-utils" href="./dependency-check-utils/index.html">
<description>A set of utility classes used by OWASP dependency-check.</description>
</item>
</item>
</menu>
<menu ref="reports" />
<menu name="General">
<item name="How it Works" href="./internals.html">
<description>How does dependency-check work?</description>
</item>
<item name="Reading the Report" href="./thereport.html">
<description>How to read the report</description>
</item>
<item name="False Positives" href="./suppression.html">
<description>Suppressing False Positives</description>
</item>
<item name="Project Presentation (pptx)" href="./dependency-check.pptx">
<description>PowerPoint Deck</description>
</item>
<item name="Project Presentation (pdf)" href="./dependency-check.pdf">
<description>PowerPoint Deck</description>
</item>
<item name="Sample Report" href="./SampleReport.html">
<description>Sample Report</description>
</item>
</menu>
<menu name="File Type Analyzers">
<item name="Archive Analyzer" href="./archive-analyzer.html">
<description>Archive Analyzer</description>
</item>
<item name="Jar Analyzer" href="./jar-analyzer.html">
<description>Jar Analyzer</description>
</item>
<item name="Central Analyzer" href="./central-analyzer.html">
<description>Central Analyzer</description>
</item>
<item name="Nexus Analyzer" href="./nexus-analyzer.html">
<description>Nexus Analyzer</description>
</item>
<item name="Assembly Analyzer" href="./assembly-analyzer.html">
<description>Assembly Analyzer</description>
</item>
<item name="Nuspec Analyzer" href="./nuspec-analyzer.html">
<description>Nuspec Analyzer</description>
</item>
</menu>
<menu name="Modules">
<item name="dependency-check-cli" href="./dependency-check-cli/installation.html">
<description>The command line interface for dependency-check.</description>
</item>
<item name="dependency-check-ant" href="./dependency-check-ant/installation.html">
<description>An Ant task to run dependency-check.</description>
</item>
<item name="dependency-check-maven" href="./dependency-check-maven/usage.html">
<description>A Maven plugin for dependency-check.</description>
</item>
<item name="dependency-check-jenkins" href="./dependency-check-jenkins/index.html">
<description>A Jenkins plugin for dependency-check.</description>
</item>
<item name="dependency-check-core" href="./dependency-check-core/index.html">
<description>The core dependency-check engine and reporting tool.</description>
</item>
<item name="dependency-check-utils" href="./dependency-check-utils/index.html">
<description>A set of utility classes used by dependency-check.</description>
</item>
</menu>
<footer>Copyright © 2012-2015 Jeremy Long. All Rights Reserved.</footer>
</body>
</project>