mirror of
https://github.com/ysoftdevs/DependencyCheck.git
synced 2026-05-08 08:04:22 +02:00
documentation v1.3.1
This commit is contained in:
Jeremy Long
@@ -1,21 +1,21 @@
|
||||
<!DOCTYPE html>
|
||||
<!--
|
||||
| Generated by Apache Maven Doxia at 2015-08-04
|
||||
| Rendered using Apache Maven Fluido Skin 1.3.1
|
||||
| Generated by Apache Maven Doxia at 2015-09-20
|
||||
| Rendered using Apache Maven Fluido Skin 1.4
|
||||
-->
|
||||
<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="20150804" />
|
||||
<meta name="Date-Revision-yyyymmdd" content="20150920" />
|
||||
<meta http-equiv="Content-Language" content="en" />
|
||||
<title>dependency-check-ant - About</title>
|
||||
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
|
||||
<title>dependency-check-ant – About</title>
|
||||
<link rel="stylesheet" href="./css/apache-maven-fluido-1.4.min.css" />
|
||||
<link rel="stylesheet" href="./css/site.css" />
|
||||
<link rel="stylesheet" href="./css/print.css" media="print" />
|
||||
|
||||
|
||||
<script type="text/javascript" src="./js/apache-maven-fluido-1.3.1.min.js"></script>
|
||||
<script type="text/javascript" src="./js/apache-maven-fluido-1.4.min.js"></script>
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@
|
||||
|
||||
|
||||
|
||||
<a href="http://github.com/jeremylong/DependencyCheck">
|
||||
<a href="https://github.com/jeremylong/DependencyCheck">
|
||||
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
|
||||
src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"
|
||||
alt="Fork me on GitHub">
|
||||
@@ -54,7 +54,7 @@
|
||||
|
||||
|
||||
<li class="">
|
||||
<a href="../../../../../../target/site/1.3.0/#" title="">
|
||||
<a href="../../../../../../target/site/1.3.1/#" title="">
|
||||
</a>
|
||||
<span class="divider">/</span>
|
||||
</li>
|
||||
@@ -67,9 +67,9 @@
|
||||
|
||||
|
||||
|
||||
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-08-04</li>
|
||||
<li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2015-09-20</li>
|
||||
<li id="projectVersion" class="pull-right">
|
||||
Version: 1.3.0
|
||||
Version: 1.3.1
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
@@ -77,7 +77,7 @@
|
||||
|
||||
|
||||
<div class="row-fluid">
|
||||
<div id="leftColumn" class="span3">
|
||||
<div id="leftColumn" class="span2">
|
||||
<div class="well sidebar-nav">
|
||||
|
||||
|
||||
@@ -87,36 +87,29 @@
|
||||
<li>
|
||||
|
||||
<a href="installation.html" title="Installation">
|
||||
<i class="none"></i>
|
||||
<span class="none"></span>
|
||||
Installation</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="usage.html" title="Usage">
|
||||
<i class="none"></i>
|
||||
Usage</a>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
|
||||
<a href="configuration.html" title="Configuration">
|
||||
<i class="none"></i>
|
||||
<span class="none"></span>
|
||||
Configuration</a>
|
||||
</li>
|
||||
<li class="nav-header">Project Documentation</li>
|
||||
|
||||
|
||||
<li>
|
||||
|
||||
<a href="project-info.html" title="Project Information">
|
||||
<i class="icon-chevron-right"></i>
|
||||
<span class="icon-chevron-right"></span>
|
||||
Project Information</a>
|
||||
</li>
|
||||
|
||||
|
||||
<li>
|
||||
|
||||
<a href="project-reports.html" title="Project Reports">
|
||||
<i class="icon-chevron-right"></i>
|
||||
<span class="icon-chevron-right"></span>
|
||||
Project Reports</a>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -159,23 +152,43 @@
|
||||
</div>
|
||||
|
||||
|
||||
<div id="bodyColumn" class="span9" >
|
||||
<div id="bodyColumn" class="span10" >
|
||||
|
||||
<h1>About</h1>
|
||||
<p>OWASP dependency-check-ant is an Ant Task that uses dependency-check-core to detect publicly disclosed vulnerabilities associated with the project’s dependencies. The task will generate a report listing the dependency, any identified Common Platform Enumeration (CPE) identifiers, and the associated Common Vulnerability and Exposure (CVE) entries.</p>
|
||||
<h1>Installation</h1>
|
||||
<p>Download dependency-check-ant from <a class="externalLink" href="http://dl.bintray.com/jeremy-long/owasp/dependency-check-ant-1.3.0.jar">bintray here</a>. To install dependency-check-ant place the dependency-check-ant-1.3.0.jar into the lib directory of your Ant instalation directory. Once installed you can add the taskdef to you build.xml and add the task to a new or existing target:</p>
|
||||
|
||||
<ol style="list-style-type: decimal">
|
||||
|
||||
<li>Download dependency-check-ant from <a class="externalLink" href="http://dl.bintray.com/jeremy-long/owasp/dependency-check-ant-1.3.1-release.zip">bintray here</a>.</li>
|
||||
|
||||
<li>Unzip the archive</li>
|
||||
|
||||
<li>
|
||||
<p>Add the taskdef to your build.xml:</p>
|
||||
|
||||
<div class="source">
|
||||
<pre><taskdef name="dependency-check" classname="org.owasp.dependencycheck.taskdefs.DependencyCheckTask"/>
|
||||
</pre></div>
|
||||
<p>If you do not want to install dependency-check-ant into your ant’s lib directory when you define the task def you must add the classpath to the taskdef:</p>
|
||||
|
||||
<div class="source">
|
||||
<pre><taskdef name="dependency-check" classname="org.owasp.dependencycheck.taskdefs.DependencyCheckTask">
|
||||
<classpath path="[path]/[to]/dependency-check-ant-1.3.0.jar"/>
|
||||
<div class="source"><pre class="prettyprint linenums"><!-- Set the value to the installation directory's path -->
|
||||
<property name="dependency-check.home" value="C:/tools/dependency-check-ant"/>
|
||||
<path id="dependency-check.path">
|
||||
<pathelement location="${dependency-check.home}/dependency-check-ant.jar"/>
|
||||
</path>
|
||||
<taskdef resource="dependency-check-taskdefs.properties">
|
||||
<classpath refid="dependency-check.path" />
|
||||
</taskdef>
|
||||
</pre></div>
|
||||
</pre></div></div></li>
|
||||
|
||||
<li>Use the defined taskdefs:
|
||||
|
||||
<ul>
|
||||
|
||||
<li><a href="configuration.html">dependency-check</a> - the primary task used to check the project dependencies.</li>
|
||||
|
||||
<li><a href="config-purge.html">dependency-check-purge</a> - deletes the local copy of the NVD; this should rarely be used (if ever).</li>
|
||||
|
||||
<li><a href="config-update.html">dependency-check-update</a> - downloads and updates the local copy of the NVD.</li>
|
||||
</ul></li>
|
||||
</ol>
|
||||
<p>It is important to understand that the first time this task is executed it may take 10 minutes or more as it downloads and processes the data from the National Vulnerability Database (NVD) hosted by NIST: <a class="externalLink" href="https://nvd.nist.gov">https://nvd.nist.gov</a></p>
|
||||
<p>After the first batch download, as long as the task is executed at least once every seven days the update will only take a few seconds.</p>
|
||||
</div>
|
||||
@@ -187,15 +200,14 @@
|
||||
<footer>
|
||||
<div class="container-fluid">
|
||||
<div class="row-fluid">
|
||||
<p >Copyright © 2012–2015
|
||||
<p >Copyright © 2012–2015
|
||||
<a href="http://www.owasp.org">OWASP</a>.
|
||||
All rights reserved.
|
||||
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
Reference in New Issue
Block a user