updated documentation per #556

This commit is contained in:
Jeremy Long
2016-10-09 08:00:02 -04:00
parent 7e2c4af0b3
commit 9e671d1065
4 changed files with 30 additions and 0 deletions

View File

@@ -0,0 +1,11 @@
CocoaPods Analyzer
================
*Experimental*: This analyzer is considered experimental. While this analyzer may
be useful and provide valid results more testing must be completed to ensure that
the false negative/false positive rates are acceptable.
OWASP dependency-check includes an analyzer that will analyze SWIFT and Objective-C
packages by scanning [CocoaPods](https://cocoapods.org/) specification file.
Files Types Scanned: [*.podspec](https://guides.cocoapods.org/making/specs-and-specs-repo.html)

View File

@@ -24,7 +24,9 @@ several teams have found them useful in their current state.
| -------- | ------------------ | --------------- |
| [Autoconf](./autoconf.html) | Autoconf project configuration files (configure, configure.in, configure.ac) | [Regex](https://en.wikipedia.org/wiki/Regular_expression) scan for AC_INIT metadata, including in generated configuration script. |
| [CMake](./cmake.html) | CMake project files (CMakeLists.txt) and scripts (\*.cmake) | Regex scan for project initialization and version setting commands. |
| [CocoaPods](./cocoapods.html) | CocoaPods `.podspec` files | Extracts dependency information from specification file. |
| [Composer Lock](./composer-lock.html) | PHP [Composer](http://getcomposer.org) Lock files (composer.lock) | Parses PHP [Composer](http://getcomposer.org) lock files for exact versions of dependencies. |
| [Node.js](./nodejs.html) | NPM package specification files (package.json) | Parse JSON format for metadata. |
| [Python](./python.html) | Python source files (\*.py); Package metadata files (PKG-INFO, METADATA); Package Distribution Files (\*.whl, \*.egg, \*.zip) | Regex scan of Python source files for setuptools metadata; Parse RFC822 header format for metadata in all other artifacts. |
| [Ruby Gemspec](./ruby-gemspec.html) | Ruby makefiles (Rakefile); Ruby Gemspec files (\*.gemspec) | Regex scan Gemspec initialization blocks for metadata. |
| [SWIFT](./swift.html) | SWIFT Package Manager's `Package.swift` | Extracts dependency information from swift package file. |

View File

@@ -0,0 +1,11 @@
SWIFT Package Manager Analyzer
================
*Experimental*: This analyzer is considered experimental. While this analyzer may
be useful and provide valid results more testing must be completed to ensure that
the false negative/false positive rates are acceptable.
OWASP dependency-check includes an analyzer that will scan the [SWIFT Package
Manager](https://swift.org/package-manager/)'s `Package.swift` file to obtain information on the dependencies used.
Files Types Scanned: [Package.swift](https://swift.org/package-manager/#example-usage)

View File

@@ -121,6 +121,9 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved.
<item name="CMake" href="./analyzers/cmake.html">
<description>CMake Analyzer</description>
</item>
<item name="CocoaPods" href="./analyzers/cocoapods.html">
<description>CocoaPods Analyzer</description>
</item>
<item name="Jar" href="./analyzers/jar-analyzer.html">
<description>Jar Analyzer</description>
</item>
@@ -142,6 +145,9 @@ Copyright (c) 2013 Jeremy Long. All Rights Reserved.
<item name="Ruby Gemspec" href="./analyzers/ruby-gemspec.html">
<description>Ruby Gemspec Analyzer</description>
</item>
<item name="Swift" href="./analyzers/swift.html">
<description>Swift Package Manager Analyzer</description>
</item>
</item>
<item collapse="true" name="Modules" href="./modules.html">
<item name="CLI" href="./dependency-check-cli/index.html">