From d5ed2bc76515f9ec1544e43ae31bcc2ac73f4837 Mon Sep 17 00:00:00 2001 From: Jeremy Long Date: Wed, 22 Apr 2015 20:21:31 -0400 Subject: [PATCH] updated site structure and data Former-commit-id: 9745b59268f55930b3fdff9c24ad219715cb714a --- dependency-check-ant/pom.xml | 1 - .../{installation.md.vm => index.md.vm} | 9 ++++- .../src/site/markdown/usage.md.vm | 2 +- dependency-check-ant/src/site/site.xml | 1 - dependency-check-cli/pom.xml | 1 - .../{installation.md.vm => index.md.vm} | 7 ++++ dependency-check-cli/src/site/site.xml | 3 +- dependency-check-core/pom.xml | 14 ++++++++ .../src/site/markdown/index.md | 6 ++-- dependency-check-core/src/site/site.xml | 5 ++- dependency-check-jenkins/pom.xml | 35 ++++++++++--------- dependency-check-jenkins/src/site/site.xml | 1 - dependency-check-maven/pom.xml | 14 ++++++++ .../markdown/{usage.md.vm => index.md.vm} | 0 dependency-check-maven/src/site/site.xml | 3 +- dependency-check-utils/pom.xml | 2 +- .../src/site/markdown/index.md | 4 +++ src/site/markdown/index.md | 4 +-- src/site/markdown/modules.md | 6 ++-- src/site/site.xml | 4 +-- 20 files changed, 83 insertions(+), 39 deletions(-) rename dependency-check-ant/src/site/markdown/{installation.md.vm => index.md.vm} (69%) rename dependency-check-cli/src/site/markdown/{installation.md.vm => index.md.vm} (66%) rename dependency-check-maven/src/site/markdown/{usage.md.vm => index.md.vm} (100%) create mode 100644 dependency-check-utils/src/site/markdown/index.md diff --git a/dependency-check-ant/pom.xml b/dependency-check-ant/pom.xml index e6a2c0020..e4910fbc1 100644 --- a/dependency-check-ant/pom.xml +++ b/dependency-check-ant/pom.xml @@ -280,7 +280,6 @@ Copyright (c) 2013 - Jeremy Long. All Rights Reserved. - index summary license help diff --git a/dependency-check-ant/src/site/markdown/installation.md.vm b/dependency-check-ant/src/site/markdown/index.md.vm similarity index 69% rename from dependency-check-ant/src/site/markdown/installation.md.vm rename to dependency-check-ant/src/site/markdown/index.md.vm index a49cd6568..bf6614c49 100644 --- a/dependency-check-ant/src/site/markdown/installation.md.vm +++ b/dependency-check-ant/src/site/markdown/index.md.vm @@ -1,3 +1,10 @@ +About +==================== +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. + Installation ==================== Download dependency-check-ant from [bintray here](http://dl.bintray.com/jeremy-long/owasp/dependency-check-ant-${project.version}.jar). @@ -19,7 +26,7 @@ must add the classpath to the taskdef: ``` It is important to understand that the first time this task is executed it may -take 20 minutes or more as it downloads and processes the data from the National +take 10 minutes or more as it downloads and processes the data from the National Vulnerability Database (NVD) hosted by NIST: https://nvd.nist.gov After the first batch download, as long as the task is executed at least once every diff --git a/dependency-check-ant/src/site/markdown/usage.md.vm b/dependency-check-ant/src/site/markdown/usage.md.vm index 49a4b8624..c2743a930 100644 --- a/dependency-check-ant/src/site/markdown/usage.md.vm +++ b/dependency-check-ant/src/site/markdown/usage.md.vm @@ -1,6 +1,6 @@ Usage ==================== -First, add the dependency-check-ant taskdef to your build.xml (see the [installation guide](installation.html): +First, add the dependency-check-ant taskdef to your build.xml (see the [installation guide](installation.html)): ```xml diff --git a/dependency-check-ant/src/site/site.xml b/dependency-check-ant/src/site/site.xml index ab8b1d5c8..10a94bfda 100644 --- a/dependency-check-ant/src/site/site.xml +++ b/dependency-check-ant/src/site/site.xml @@ -31,7 +31,6 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. - \ No newline at end of file diff --git a/dependency-check-cli/pom.xml b/dependency-check-cli/pom.xml index f21510003..55c1a6d8b 100644 --- a/dependency-check-cli/pom.xml +++ b/dependency-check-cli/pom.xml @@ -184,7 +184,6 @@ Copyright (c) 2012 - Jeremy Long. All Rights Reserved. - index summary license help diff --git a/dependency-check-cli/src/site/markdown/installation.md.vm b/dependency-check-cli/src/site/markdown/index.md.vm similarity index 66% rename from dependency-check-cli/src/site/markdown/installation.md.vm rename to dependency-check-cli/src/site/markdown/index.md.vm index 504de5fcf..6e0cecaa9 100644 --- a/dependency-check-cli/src/site/markdown/installation.md.vm +++ b/dependency-check-cli/src/site/markdown/index.md.vm @@ -1,3 +1,10 @@ +About +==================== +OWASP dependency-check-cli is an command line tool that uses dependency-check-core to detect +publicly disclosed vulnerabilities associated with the scanned project dependencies. The tool +will generate a report listing the dependency, any identified Common Platform Enumeration (CPE) +identifiers, and the associated Common Vulnerability and Exposure (CVE) entries. + Installation & Usage ==================== Download the dependency-check command line tool [here](http://dl.bintray.com/jeremy-long/owasp/dependency-check-${project.version}-release.zip). diff --git a/dependency-check-cli/src/site/site.xml b/dependency-check-cli/src/site/site.xml index b8093a3ea..30cd83a09 100644 --- a/dependency-check-cli/src/site/site.xml +++ b/dependency-check-cli/src/site/site.xml @@ -27,10 +27,9 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. - + - \ No newline at end of file diff --git a/dependency-check-core/pom.xml b/dependency-check-core/pom.xml index 4acb60e51..8e1de4e65 100644 --- a/dependency-check-core/pom.xml +++ b/dependency-check-core/pom.xml @@ -219,6 +219,20 @@ Copyright (c) 2012 Jeremy Long. All Rights Reserved. + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.7 + + + + summary + license + help + + + + org.apache.maven.plugins maven-javadoc-plugin diff --git a/dependency-check-core/src/site/markdown/index.md b/dependency-check-core/src/site/markdown/index.md index 747bfd87c..0cfa67600 100644 --- a/dependency-check-core/src/site/markdown/index.md +++ b/dependency-check-core/src/site/markdown/index.md @@ -10,7 +10,7 @@ for details. The engine is currently exposed via: -- [Command Line Tool](../dependency-check-cli/installation.html) -- [Maven Plugin](../dependency-check-maven/usage.html) -- [Ant Task](../dependency-check-ant/installation.html) +- [Command Line Tool](../dependency-check-cli/index.html) +- [Maven Plugin](../dependency-check-maven/index.html) +- [Ant Task](../dependency-check-ant/index.html) - [Jenkins Plugin](../dependency-check-jenkins/index.html) diff --git a/dependency-check-core/src/site/site.xml b/dependency-check-core/src/site/site.xml index ff1d10735..821c66781 100644 --- a/dependency-check-core/src/site/site.xml +++ b/dependency-check-core/src/site/site.xml @@ -19,13 +19,16 @@ Copyright (c) 2012 Jeremy Long. All Rights Reserved. OWASP dependency-check-core - OWASP dependency-check-maven + OWASP dependency-check-core ./images/dc-core.svg + + + \ No newline at end of file diff --git a/dependency-check-jenkins/pom.xml b/dependency-check-jenkins/pom.xml index bdc38ffd4..991b2ed04 100644 --- a/dependency-check-jenkins/pom.xml +++ b/dependency-check-jenkins/pom.xml @@ -67,25 +67,26 @@ true - - - org.apache.maven.plugins - maven-project-info-reports-plugin - 2.6 - - - - index - summary - license - help - - - - - + + + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.6 + + + + summary + license + help + + + + + + diff --git a/dependency-check-jenkins/src/site/site.xml b/dependency-check-jenkins/src/site/site.xml index be5471622..49a8f201c 100644 --- a/dependency-check-jenkins/src/site/site.xml +++ b/dependency-check-jenkins/src/site/site.xml @@ -26,7 +26,6 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. - \ No newline at end of file diff --git a/dependency-check-maven/pom.xml b/dependency-check-maven/pom.xml index ecaf5003d..ac6129beb 100644 --- a/dependency-check-maven/pom.xml +++ b/dependency-check-maven/pom.xml @@ -127,6 +127,20 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. + + org.apache.maven.plugins + maven-project-info-reports-plugin + 2.7 + + + + summary + license + help + + + + org.apache.maven.plugins maven-plugin-plugin diff --git a/dependency-check-maven/src/site/markdown/usage.md.vm b/dependency-check-maven/src/site/markdown/index.md.vm similarity index 100% rename from dependency-check-maven/src/site/markdown/usage.md.vm rename to dependency-check-maven/src/site/markdown/index.md.vm diff --git a/dependency-check-maven/src/site/site.xml b/dependency-check-maven/src/site/site.xml index dbb77846b..cdbaaca18 100644 --- a/dependency-check-maven/src/site/site.xml +++ b/dependency-check-maven/src/site/site.xml @@ -28,10 +28,9 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. - + - \ No newline at end of file diff --git a/dependency-check-utils/pom.xml b/dependency-check-utils/pom.xml index 220938f23..993911d36 100644 --- a/dependency-check-utils/pom.xml +++ b/dependency-check-utils/pom.xml @@ -26,7 +26,7 @@ Copyright (c) 2014 - Jeremy Long. All Rights Reserved. dependency-check-utils Dependency-Check Utils - dependency-check-utils is a collection of common utlity classes used within dependency-check that might be useful in other projects. + dependency-check-utils is a collection of common utility classes used within dependency-check that might be useful in other projects. diff --git a/dependency-check-utils/src/site/markdown/index.md b/dependency-check-utils/src/site/markdown/index.md new file mode 100644 index 000000000..de9be00ce --- /dev/null +++ b/dependency-check-utils/src/site/markdown/index.md @@ -0,0 +1,4 @@ +About +===== +OWASP dependency-check-utils is a collection of common utility classes used within dependency-check +that might be useful in other projects. \ No newline at end of file diff --git a/src/site/markdown/index.md b/src/site/markdown/index.md index 2ba258ecf..88404d809 100644 --- a/src/site/markdown/index.md +++ b/src/site/markdown/index.md @@ -21,6 +21,6 @@ More information about dependency-check can be found here: 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) -- [Ant Task](dependency-check-ant/installation.html) +- [Maven Plugin](dependency-check-maven/index.html) +- [Ant Task](dependency-check-ant/index.html) - [Jenkins Plugin](dependency-check-jenkins/index.html) diff --git a/src/site/markdown/modules.md b/src/site/markdown/modules.md index f131d1444..980998125 100644 --- a/src/site/markdown/modules.md +++ b/src/site/markdown/modules.md @@ -3,8 +3,8 @@ Modules OWASP dependency-check's core analysis engine was designed to fit into an applications normal build and reporting process: -- [Maven Plugin](dependency-check-maven/usage.html) -- [Ant Task](dependency-check-ant/installation.html) +- [Maven Plugin](dependency-check-maven/index.html) +- [Ant Task](dependency-check-ant/index.html) - [Jenkins Plugin](dependency-check-jenkins/index.html) In addition, dependency-check can be executed from the [command line](dependency-check-cli/index.html). @@ -14,4 +14,4 @@ Core Engine Information about the core engine and the utilities used can be found: - [Core](dependency-check-core/index.html) -- [Utilities](dependency-check-utilities/index.html) +- [Utilities](dependency-check-utils/index.html) diff --git a/src/site/site.xml b/src/site/site.xml index 66c4fa137..76411d793 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -115,10 +115,10 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved. - + The command line interface for OWASP dependency-check. - + An Ant task to run OWASP dependency-check.