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

J12934 · web-flow · commit 33282efea692 · 2020-08-19T14:27:58.000+02:00
Added the persistence Hook for static reporting
diff --git a/docs/developer-guide/README.md b/docs/developer-guide/README.md
@@ -1,3 +1,11 @@
+---
+title: "Developer Guide"
+path: "docs/developer-guide"
+category: "develop"
+---
+
+<!-- end -->
+
 # Extending secureCodeBox
 
 ## Developing the SCB Operator
@@ -86,21 +94,32 @@ cd operator
 make run
 ```
 
-## How to a New Security Scanner
+## How to add a New Security Scanner
 
 ### ScanType Definition
+> ✍ **Following...**
 
 ### Parsing SDK
 
+1. Install the dependencies `npm install`
+2. Update the parser function here: `./parser/parser.js`
+3. Update the parser tests here: `./parser/parser.test.js`
+4. Run the test suite: `npm test`
+
 ## How to Integrate a New Hook
+> ✍ **Following...**
 
 ### HookType Definition
+> ✍ **Following...**
 
 ### Hook SDK
+> ✍ **Following...**
 
 ## Guidelines
+> ✍ **Following...**
 
 ### Coding Guidelines
+> ✍ **Following...**
 
 #### JSON
 
diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md
@@ -1,3 +1,11 @@
+---
+title: "User Guide"
+path: "docs/user-guide"
+category: "use"
+---
+
+<!-- end -->
+
 # Using the secureCodeBox
 
-follwing...
+> ✍ **Page under construction.**
diff --git a/hooks/declarative-subsequent-scans/README.md b/hooks/declarative-subsequent-scans/README.md
@@ -63,7 +63,7 @@ spec:
 EOF
 ```
 
-This Scan will used all CascadingRules which are labeled with a "light" intensity.
+This Scan will use all CascadingRules which are labeled with a "light" intensity.
 You can lookup which CascadingRules this selects by running:
 
 ```bash
diff --git a/hooks/generic-webhook/README.md b/hooks/generic-webhook/README.md
@@ -16,3 +16,4 @@ Installing the Generic WebHook hook will add a ReadOnly Hook to your namespace.
 ```bash
 helm upgrade --install gwh ./hooks/generic-webhook/ --set webhookUrl="http://example.com/my/webhook/target"
 ```
+> ✍ This documentation is currently work-in-progress. 
diff --git a/hooks/imperative-subsequent-scans/README.md b/hooks/imperative-subsequent-scans/README.md
@@ -0,0 +1,10 @@
+---
+title: "Imperative  Scans"
+path: "hooks/imperative-subsequent-scans"
+category: "hook"
+type: "integration"
+state: "roadmap"
+usecase: "Cascading Scans based imperative Rules."
+---
+
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
diff --git a/hooks/persistence-defectdojo/README.md b/hooks/persistence-defectdojo/README.md
@@ -3,7 +3,7 @@ title: "DefectDojo"
 path: "hooks/persistence-defectdojo"
 category: "hook"
 type: "persistenceProvider"
-state: "roadmap"
+state: "developing"
 usecase: "Publishes all Scan Findings to DefectDojo."
 ---
 
@@ -18,7 +18,7 @@ Tools which are supported both by the secureCodeBox and DefectDojo (OWASP ZAP &
 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.
+> 🔧 The implementation is currently work-in-progress and under still undergoing major changes. It'll be released here once it has stabilized.
 
 
 [DefectDojo Website]: https://www.defectdojo.org/
diff --git a/hooks/persistence-elastic/README.md b/hooks/persistence-elastic/README.md
@@ -10,7 +10,7 @@ usecase: "Publishes all Scan Findings to Elasticsearch."
 <!-- end -->
 
 ## About
-The ElasticSearch persistenceProvider hook saves all findings and reports into the configured ElasticSearch index. This allows for some easy searching and visualization of the findings. To learn more about Elasticsearch visit elastic.io.
+The ElasticSearch persistenceProvider hook saves all findings and reports into the configured ElasticSearch index. This allows for some easy searching and visualization of the findings. To learn more about Elasticsearch visit [elastic.io].
 
 ## Deployment
 
@@ -52,4 +52,6 @@ elasticsearch:
 kibana:
   enabled: true
   # image: docker.elastic.co/kibana/kibana-oss
-```
+```
+
+[elastic.io]: https://www.elastic.co/products/elasticsearch
diff --git a/hooks/persistence-static-report/README.md b/hooks/persistence-static-report/README.md
@@ -0,0 +1,15 @@
+---
+title: "Static Report"
+path: "hooks/persistence-staticreport"
+category: "hook"
+type: "persistenceProvider"
+state: "developing"
+usecase: "Publishes all Scan Findings as HTML Report."
+---
+
+<!-- end -->
+
+## Deployment
+
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
+
diff --git a/hooks/slack-webhook/README.md b/hooks/slack-webhook/README.md
@@ -13,4 +13,4 @@ usecase: "Publishes Scan Summary to Slack."
 
 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.
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
diff --git a/hooks/teams-webhook/README.md b/hooks/teams-webhook/README.md
@@ -13,4 +13,4 @@ usecase: "Publishes Scan Summary to MS Teams."
 
 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.
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
diff --git a/hooks/update-field/README.md b/hooks/update-field/README.md
@@ -16,3 +16,5 @@ Installing the _Update Field_ hook will add a ReadOnly Hook to your namespace.
 ```bash
 helm upgrade --install ufh ./hooks/update-field/ --set attribute.name="category" --set attribute.value="my-own-category"
 ```
+
+> ✍ This documentation is currently work-in-progress. 
diff --git a/scanners/amass/README.md b/scanners/amass/README.md
@@ -22,13 +22,6 @@ The AMASS scanType can be deployed via helm:
 helm upgrade --install amass ./scanners/amass/
 ```
 
-## Examples
-
-A set of examples can be found in the [examples](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners/amass/examples) folder.
-
-* Example *secureCodeBox.io* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/amass/examples/secureCodeBox.io/scan.yaml)
-* Example *example.com* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/amass/examples/example.com/scan.yaml)
-
 ## Configuration
 
 The following security scan configuration example are based on the [Amass User Guide], please take a look at the original documentation for more configuration examples.
@@ -43,21 +36,6 @@ Special command line options:
 * Disable saving data into a local database	`amass enum -nolocaldb -d example.com`
 * Domain names separated by commas (can be used multiple times)	`amass enum -d example.com`
 
-## Development
-
-### Local setup
-
-1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
-2. Ensure you have node.js installed
-   * On MacOs with brew package manager: `brew install node`
-
-### Parser Development
-
-1. Install the dependencies `npm install`
-2. Update the parser function here: `./parser/parser.js`
-3. Update the parser tests here: `./parser/parser.test.js`
-4. Run the test suite: `npm test`
-
 [OWASP_Amass_Project]: https://owasp.org/www-project-amass/
 [Amass GitHub]: https://github.com/OWASP/Amass
 [Amass User Guide]: https://github.com/OWASP/Amass/blob/master/doc/user_guide.md
diff --git a/scanners/kube-hunter/README.md b/scanners/kube-hunter/README.md
@@ -22,12 +22,6 @@ The kube-hunter ScanType can be deployed via helm:
 helm upgrade --install kube-hunter ./scanners/kube-hunter/
 ```
 
-## Examples
-
-A set of examples can be found in the [examples](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners/kube-hunter/examples) folder.
-
-* Example *in-cluster* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/kube-hunter/examples/in-cluster/scan.yaml) and [findings](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/kube-hunter/examples/in-cluster/findings.json)
-
 ## Configuration
 
 The following security scan configuration example are based on the [kube-hunter Documentation], please take a look at the original documentation for more configuration examples.
@@ -36,21 +30,6 @@ The following security scan configuration example are based on the [kube-hunter
 * To specify interface scanning, you can use the --interface option (this will scan all of the machine's network interfaces). Example: `kube-hunter --interface`
 * To specify a specific CIDR to scan, use the --cidr option. Example: `kube-hunter --cidr 192.168.0.0/24`
 
-## Development
-
-### Local setup
-
-1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
-2. Ensure you have node.js installed
-   * On MacOs with brew package manager: `brew install node`
-
-### Parser Development
-
-1. Install the dependencies `npm install`
-2. Update the parser function here: `./parser/parser.js`
-3. Update the parser tests here: `./parser/parser.test.js`
-4. Run the test suite: `npm test`
-
 [kube-hunter Website]: https://kube-hunter.aquasec.com/
 [kube-hunter GitHub]: https://github.com/aquasecurity/kube-hunter
 [kube-hunter Documentation]: https://github.com/aquasecurity/kube-hunter#scanning-options
diff --git a/scanners/kubeaudit/README.md b/scanners/kubeaudit/README.md
@@ -14,8 +14,7 @@ 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.
+> 🔧 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
diff --git a/scanners/ncrack/README.md b/scanners/ncrack/README.md
@@ -14,8 +14,7 @@ To learn more about the Ncrack scanner itself visit [Ncrack GitHub] or [Ncrack W
 
 <!-- end -->
 
-## Deployment
-The secureCodeBox core team is working on an integration of Ncrack. We will keep you informed.
+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.
 
 [Ncrack Website]: https://nmap.org/ncrack/
 [Ncrack GitHub]: https://github.com/nmap/ncrack
diff --git a/scanners/nikto/README.md b/scanners/nikto/README.md
@@ -22,12 +22,6 @@ The Nikto ScanType can be deployed via helm:
 helm upgrade --install nikto ./scanners/nikto/
 ```
 
-## Examples
-
-A set of examples can be found in the [examples](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners/nikto/examples) folder.
-
-* Example *secureCodeBox.io* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nikto/examples/secureCodeBox.io/scan.yaml)
-
 ## Configuration
 
 The following security scan configuration example are based on the [Nikto Documentation](https://cirt.net/nikto2-docs/usage.html#id2780332), please take a look at the original documentation for more configuration examples.
@@ -55,20 +49,5 @@ Nikto also has a comprehensive list of [command line options documented](https:/
   * c - Remote source inclusion. Software allows remote inclusion of source code.
   * x - Reverse Tuning Options. Perform exclusion of the specified tuning type instead of inclusion of the specified tuning type
 
-## Development
-
-### Local setup
-
-1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
-2. Ensure you have node.js installed
-   * On MacOs with brew package manager: `brew install node`
-
-### Parser Development
-
-1. Install the dependencies `npm install`
-2. Update the parser function here: `./parser/parser.js`
-3. Update the parser tests here: `./parser/parser.test.js`
-4. Run the test suite: `npm test`
-
 [cirt.net]: https://cirt.net/
 [nikto github]: https://github.com/sullo/nikto
diff --git a/scanners/nmap/README.md b/scanners/nmap/README.md
@@ -18,20 +18,12 @@ To learn more about the Nmap scanner itself visit [nmap.org].
 
 ## Deployment
 
-The Nmap ScanType can be deployed via helm:
+The Nikto ScanType can be deployed via helm:
 
 ```bash
-helm install nmap ./scanners/nmap/
+helm upgrade --install nikto ./scanners/nikto/
 ```
 
-## Examples
-
-A set of examples can be found in the [examples](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners/nmap/examples) folder.
-
-* Example *local-network* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/local-network/scan.yaml) and [findings](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/local-network/findings.yaml)
-* Example *localhost* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/localhost/scan.yaml) and [findings](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/localhost/findings.yaml)
-* Example *scan.nmap.org* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/scan.nmap.org/scan.yaml) and [findings](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/nmap/examples/scan.nmap.org/findings.yaml)
-
 ## Nmap Configuration
 
 The nmap scan target is set via the targets location of the securityTest. The target should be a Hostname or an IP Address.
@@ -50,21 +42,3 @@ Some useful example parameters listed below:
 - `-script` xx: Replace xx with the script name. Start the scan with the given script.
 - `--script` xx: Replace xx with a coma-separated list of scripts. Start the scan with the given scripts.
 
-## Development
-
-### Local setup
-
-1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
-2. Ensure you have node.js installed
-   * On MacOs with brew package manager: `brew install node`
-
-### Parser Development
-
-1. Install the dependencies `npm install`
-2. Update the parser function here: `./parser/parser.js`
-3. Update the parser tests here: `./parser/parser.test.js`
-4. Run the test suite: `npm test`
-
-#### Basic scanner tests
-
-If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install nmap`
diff --git a/scanners/ssh_scan/README.md b/scanners/ssh_scan/README.md
@@ -22,13 +22,6 @@ The SSH_scan ScanType can be deployed via helm.
 helm upgrade --install ssh ./scanners/ssh_scan/
 ```
 
-## Examples
-
-A set of examples can be found in the [examples](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/tree/master/scanners/ssh_scan/examples) folder.
-
-* Example *example.com* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/ssh_scan/examples/example.com/scan.yaml)
-* Example *localhost* [scan](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/ssh_scan/examples/localhost/scan.yaml) and [findings](https://github.com/secureCodeBox/secureCodeBox-v2-alpha/blob/master/scanners/ssh_scan/examples/localhost/findings.yaml)
-
 ## Configuration
 
 The following security scan configuration example are based on the [ssh_scan Documentation], please take a look at the original documentation for more configuration examples.
@@ -69,20 +62,5 @@ Examples:
   ssh_scan -t 192.168.1.1 --unit-test -P custom_policy.yml
 ```
 
-## Development
-
-### Local setup
-
-1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
-2. Ensure you have node.js installed
-   * On MacOs with brew package manager: `brew install node`
-
-### Parser Development
-
-1. Install the dependencies `npm install`
-2. Update the parser function here: `./parser/parser.js`
-3. Update the parser tests here: `./parser/parser.test.js`
-4. Run the test suite: `npm test`
-
 [ssh_scan GitHub]: https://github.com/mozilla/ssh_scan
 [ssh_scan Documentation]: https://github.com/mozilla/ssh_scan#example-command-line-usage
diff --git a/scanners/sslyze/README.md b/scanners/sslyze/README.md
diff --git a/scanners/trivy/README.md b/scanners/trivy/README.md
diff --git a/scanners/wpscan/README.md b/scanners/wpscan/README.md
diff --git a/scanners/zap/README.md b/scanners/zap/README.md

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@ usecase: "Publishes Scan Summary to Slack."`
`13`	`13`
`14`	`14`	`Installing the Slack WebHook hook will add a ReadOnly Hook to your namespace.`
`15`	`15`
`16`		`-The secureCodeBox core team is working on this, we will keep you informed.`
	`16`	`+> 🔧 The implementation is currently work-in-progress and still undergoing major changes. It'll be released here once it has stabilized.`