Merge pull request #73 from secureCodeBox/feature/improve-readme-files

Feature/improve readme files

Author: nigthknight

hooks/declarative-subsequent-scans/README.md

@@ -4,7 +4,7 @@ path: "hooks/declarative-subsequent-scans"
 category: "hook"
 type: "processing"
 state: "released"
-usecase: "Enables cascading Scans based declarative _CascadingRules_."
+usecase: "Cascading Scans based declarative Rules."
 ---
 
 <!-- end -->

hooks/persistence-defectdojo/README.md

@@ -0,0 +1,26 @@
+---
+title: "DefectDojo"
+path: "hooks/persistence-defectdojo"
+category: "hook"
+type: "persistenceProvider"
+state: "roadmap"
+usecase: "Publishes all Scan Findings to elasticsearch (ECK)."
+---
+
+<!-- end -->
+
+## About
+
+DefectDojo is an OpenSource Tools for importing and managing findings of security scanner. The DefectDojo persistence provider can be used to create new Engagements for SecurityTests run via the secureCodeBox and import all findings which were identified.
+
+Tools which are supported by the secureCodeBox and DefectDojo (OWASP ZAP, Arachni & Nmap) this is done by importing the raw scan report into DefectDojo. Findings by other secureCodeBox supported scanners are currently not directly supported by DefectDojo. These findings are imported via a generic finding api of defectDojo, which might cause some loss of information about the findings.  
+
+To learn more about DefectDojo visit [DefectDojo GitHub] or [DefectDojo Website].
+
+## Deployment
+The secureCodeBox core team is working on an integration of DefectDojo. We will keep you informed.
+
+
+[DefectDojo Website]: https://www.defectdojo.org/
+[DefectDojo GitHub]: https://github.com/DefectDojo/django-DefectDojo
+[DefectDojo Documentation]: https://defectdojo.readthedocs.io/en/latest/

hooks/persistence-elastic/README.md

@@ -4,7 +4,7 @@ path: "hooks/persistence-elastic"
 category: "hook"
 type: "persistenceProvider"
 state: "released"
-usecase: "Publishes all Scan Findings to elasticsearch (ECK)."
+usecase: "Publishes all Scan Findings to Elasticsearch."
 ---
 
 <!-- end -->

hooks/slack-webhook/README.md

@@ -0,0 +1,16 @@
+---
+title: "Slack WebHook"
+path: "hooks/slack-webhook"
+category: "hook"
+type: "integration"
+state: "roadmap"
+usecase: "Publishes Scan Summary to Slack."
+---
+
+<!-- end -->
+
+## Deployment
+
+Installing the Slack WebHook hook will add a ReadOnly Hook to your namespace. 
+
+The secureCodeBox core team is working on this, we will keep you informed.

hooks/teams-webhook/README.md

@@ -0,0 +1,16 @@
+---
+title: "MS Teams WebHook"
+path: "hooks/teams-webhook"
+category: "hook"
+type: "integration"
+state: "roadmap"
+usecase: "Publishes Scan Summary to MS Teams."
+---
+
+<!-- end -->
+
+## Deployment
+
+Installing the Teams WebHook hook will add a ReadOnly Hook to your namespace. 
+
+The secureCodeBox core team is working on this, we will keep you informed.

hooks/update-field/README.md

@@ -1,6 +1,6 @@
 ---
-title: "Generic WebHook"
-path: "hooks/udapte-field"
+title: "Update Field"
+path: "hooks/update-field"
 category: "hook"
 type: "dataProcessing"
 state: "released"

scanners/amass/README.md

@@ -4,7 +4,7 @@ path: "scanners/amass"
 category: "scanner"
 type: "Network"
 state: "released"
-appVersion: 3.7.2
+appVersion: "3.7.2"
 usecase: "Subdomain Enumeration Scanner"
 ---
 

scanners/kube-hunter/README.md

@@ -4,7 +4,7 @@ path: "scanners/kube-hunter"
 category: "scanner"
 type: "Kubernetes"
 state: "released"
-appVersion: 0.3.1
+appVersion: "0.3.1"
 usecase: "Kubernetes Vulnerability Scanner"
 ---
 

scanners/kubeaudit/README.md

@@ -0,0 +1,21 @@
+---
+title: "kubeaudit"
+path: "scanners/kubeaudit"
+category: "scanner"
+type: "Kubernetes"
+state: "roadmap"
+appVersion: "0.9.0"
+usecase: "Audit your Kubernetes clusters"
+---
+
+kubeaudit helps you audit your Kubernetes clusters against common security controls.
+
+To learn more about the kubeaudit scanner itself visit [kubeaudit GitHub].
+
+<!-- end -->
+
+## Deployment
+The secureCodeBox core team is working on an integration of kubeaudit. We will keep you informed.
+
+[kubeaudit GitHub]: https://github.com/Shopify/kubeaudit
+[kubeaudit Documentation]: https://github.com/Shopify/kubeaudit#quick-start

scanners/ncrack/README.md

@@ -0,0 +1,22 @@
+---
+title: "Ncrack"
+path: "scanners/Ncrack"
+category: "scanner"
+type: "Authentication"
+state: "developing"
+appVersion: "0.7"
+usecase: "Network authentication bruteforcing"
+---
+
+Ncrack is a high-speed network authentication cracking tool. It was built to help companies secure their networks by proactively testing all their hosts and networking devices for poor passwords. Security professionals also rely on Ncrack when auditing their clients. Ncrack was designed using a modular approach, a command-line syntax similar to Nmap and a dynamic engine that can adapt its behaviour based on network feedback. It allows for rapid, yet reliable large-scale auditing of multiple hosts.
+
+To learn more about the Ncrack scanner itself visit [Ncrack GitHub] or [Ncrack Website].
+
+<!-- end -->
+
+## Deployment
+The secureCodeBox core team is working on an integration of Ncrack. We will keep you informed.
+
+[Ncrack Website]: https://nmap.org/ncrack/
+[Ncrack GitHub]: https://github.com/nmap/ncrack
+[Ncrack Documentation]: https://nmap.org/ncrack/man.html