#23 Fix all missing pathes for scanners

In one of the prvious commits we renamed the scanners direcotry,
but forgotten to chnage all referncing places.

Also fixed casing of URL and file names: Use always consistent lowercase.

And fixed some spell and Markdown errors.

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

README.md

@@ -76,15 +76,15 @@ helm -n securecodebox-system install securecodebox-operator ./operator/
 Optionally deploy SCB scanner Charts for each security scanner you want to use:
 
 ```bash
-helm upgrade --install amass ./scanner/amass/
-helm upgrade --install kube-hunter ./scanner/kube-hunter/
-helm upgrade --install nikto ./scanner/nikto
-helm upgrade --install nmap ./scanner/nmap/
-helm upgrade --install ssh-scan ./scanner/ssh_scan/
-helm upgrade --install sslyze ./scanner/sslyze/
-helm upgrade --install trivy ./scanner/trivy/
-helm upgrade --install zap ./scanner/zap/
-helm upgrade --install wpscan ./scanner/wpscan/
+helm upgrade --install amass ./scanners/amass/
+helm upgrade --install kube-hunter ./scanners/kube-hunter/
+helm upgrade --install nikto ./scanners/nikto
+helm upgrade --install nmap ./scanners/nmap/
+helm upgrade --install ssh-scan ./scanners/ssh_scan/
+helm upgrade --install sslyze ./scanners/sslyze/
+helm upgrade --install trivy ./scanners/trivy/
+helm upgrade --install zap ./scanners/zap/
+helm upgrade --install wpscan ./scanners/wpscan/
 ```
 
 Optional deploy some demo apps for scanning:
@@ -109,20 +109,20 @@ helm upgrade --install elkh ./hooks/persistence-elastic/
 
 ### Examples
 
-Now everything is installed. You can try deploying scans from the `scanner/*/examples` directories.
+Now everything is installed. You can try deploying scans from the `scanners/*/examples` directories.
 
 #### Local Scan Examples
 
 E.g. localhost nmap scan:
 
 ```bash
-kubectl apply -f scanner/nmap/examples/localhost/scan.yaml
+kubectl apply -f scanners/nmap/examples/localhost/scan.yaml
 ```
 
 #### Public Scan Examples
 
 ```bash
-kubectl apply -f scanner/nmap/examples/scan.nmap.org/scan.yaml
+kubectl apply -f scanners/nmap/examples/scan.nmap.org/scan.yaml
 ```
 
 #### Then get the current State of the Scan by running:

scanners/amass/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: amass
-description: A Helm chart for the Amass security Scanner that integrates with the secureCodeBox.
+description: A Helm chart for the Amass security scanner that integrates with the secureCodeBox.
 
 type: application
 version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
   - amass
   - scanner
   - secureCodeBox
-home: https://www.securecodebox.io/scanner/Amass
-icon: https://www.securecodebox.io/integrationIcons/Amass.svg
+home: https://www.securecodebox.io/scanners/amass
+icon: https://www.securecodebox.io/scannerIcons/Amass.svg
 sources:
   - https://github.com/secureCodeBox/secureCodeBox
 maintainers:

scanners/amass/README.md

@@ -1,6 +1,6 @@
 ---
 title: "Amass"
-path: "scanner/Amass"
+path: "scanners/amass"
 category: "scanner"
 usecase: "Subdomain Enumeration Scanner"
 ---
@@ -13,35 +13,37 @@ The OWASP Amass Project has developed a tool to help information security profes
 
 ## Deployment
 
-The AMASS scanType can be deployed via helm.
+The AMASS scanType can be deployed via helm:
 
 ```bash
-helm upgrade --install amass ./scanner/amass/
+helm upgrade --install amass ./scanners/amass/
 ```
 
 ## Examples
 
 A set of examples can be found in the [examples](./examples) folder.
+
 * Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
 * Example *example.com* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
 
 ## Configuration
 
-The follwing security scan configuration example are based on the [Amass User Guide], please take a look at the original documentation for more configuration examples.
+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.
 
 * The most basic use of the tool for subdomain enumeration: `amass enum -d example.com`
 * Typical parameters for DNS enumeration: `amass enum -v -src -ip -brute -min-for-recursive 2 -d example.com`
-  
+
 Special command line options:
+
 * Disable generation of altered names	`amass enum -noalts -d example.com`
 * Turn off recursive brute forcing	`amass enum -brute -norecursive -d example.com`
 * 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`
@@ -51,8 +53,8 @@ Special command line options:
 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 testsuite: `npm test`
+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
+[Amass User Guide]: https://github.com/OWASP/Amass/blob/master/doc/user_guide.md

scanners/kube-hunter/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: kube-hunter
-description: A Helm chart for the kube-hunter security Scanner that integrates with the secureCodeBox.
+description: A Helm chart for the kube-hunter security scanner that integrates with the secureCodeBox.
 
 type: application
 version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
 - kube-hunter
 - scanner
 - secureCodeBox
-home: https://www.securecodebox.io/scanner/kube-hunter
-icon: https://www.securecodebox.io/integrationIcons/kube-hunter.svg
+home: https://www.securecodebox.io/scanners/kube-hunter
+icon: https://www.securecodebox.io/scannerIcons/kube-hunter.svg
 sources:
 - https://github.com/secureCodeBox/secureCodeBox
 maintainers:

scanners/kube-hunter/README.md

@@ -1,6 +1,6 @@
 ---
 title: "kube-hunter"
-path: "scanner/kube-hunter"
+path: "scanners/kube-hunter"
 category: "scanner"
 usecase: "Kubernetes Vulnerability Scanner"
 ---
@@ -13,20 +13,21 @@ To learn more about the kube-hunter scanner itself visit [kube-hunter GitHub] or
 
 ## Deployment
 
-The kube-hunter ScanType can be deployed via helm.
+The kube-hunter ScanType can be deployed via helm:
 
 ```bash
-helm upgrade --install kube-hunter ./scanner/kube-hunter/
+helm upgrade --install kube-hunter ./scanners/kube-hunter/
 ```
 
 ## Examples
 
 A set of examples can be found in the [examples](./examples) folder.
+
 * Example *in-cluster* [scan](./examples/in-cluster/scan.yaml) and [findings](./examples/in-cluster/findings.yaml)
 
 ## Configuration
 
-The follwing security scan configuration example are based on the [kube-hunter Documentation], please take a look at the original documentation for more configuration examples.
+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.
 
 * To specify remote machines for hunting, select option 1 or use the --remote option. Example: `kube-hunter --remote some.node.com`
 * To specify interface scanning, you can use the --interface option (this will scan all of the machine's network interfaces). Example: `kube-hunter --interface`
@@ -35,6 +36,7 @@ The follwing security scan configuration example are based on the [kube-hunter D
 ## 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`
@@ -44,8 +46,8 @@ The follwing security scan configuration example are based on the [kube-hunter D
 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 testsuite: `npm test`
+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
+[kube-hunter Documentation]: https://github.com/aquasecurity/kube-hunter#scanning-options

scanners/nikto/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: nikto
-description: A Helm chart for the Nikto security Scanner that integrates with the secureCodeBox.
+description: A Helm chart for the Nikto security scanner that integrates with the secureCodeBox.
 
 type: application
 version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
 - nikto
 - scanner
 - secureCodeBox
-home: https://www.securecodebox.io/scanner/Nikto
-icon: https://www.securecodebox.io/integrationIcons/Nikto.svg
+home: https://www.securecodebox.io/scanners/nikto
+icon: https://www.securecodebox.io/scannerIcons/Nikto.svg
 sources:
 - https://github.com/secureCodeBox/secureCodeBox
 maintainers:

scanners/nikto/README.md

@@ -1,6 +1,6 @@
 ---
 title: "Nikto"
-path: "scanner/Nikto"
+path: "scanners/nikto"
 category: "scanner"
 usecase: "Webserver Vulnerability Scanner"
 ---
@@ -13,20 +13,21 @@ Nikto is a free software command-line vulnerability scanner that scans webserver
 
 ## Deployment
 
-The Nikto ScanType can be deployed via helm.
+The Nikto ScanType can be deployed via helm:
 
 ```bash
-helm upgrade --install nikto ./scanner/nikto/
+helm upgrade --install nikto ./scanners/nikto/
 ```
 
 ## Examples
 
 A set of examples can be found in the [examples](./examples) folder.
+
 * Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
 
 ## Configuration
 
-The follwing 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.
+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.
 
 * The most basic Nikto scan requires simply a host to target, since port 80 is assumed if none is specified. The host can either be an IP or a hostname of a machine, and is specified using the -h (-host) option. This will scan the IP 192.168.0.1 on TCP port 80: `-h 192.168.0.1`
 * To check on a different port, specify the port number with the -p (-port) option. This will scan the IP 192.168.0.1 on TCP port 443: `-h 192.168.0.1 -p 443`
@@ -49,11 +50,12 @@ Nikto also has a comprehensive list of [command line options documented](https:/
   * a - Authentication Bypass. Allows client to access a resource it should not be allowed to access.
   * b - Software Identification. Installed software or program could be positively identified.
   * 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  
+  * 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`
@@ -63,7 +65,7 @@ Nikto also has a comprehensive list of [command line options documented](https:/
 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 testsuite: `npm test`
+4. Run the test suite: `npm test`
 
 [cirt.net]: https://cirt.net/
-[nikto github]: https://github.com/sullo/nikto
+[nikto github]: https://github.com/sullo/nikto

scanners/nmap/Chart.yaml

@@ -11,8 +11,8 @@ keywords:
 - nmap
 - scanner
 - secureCodeBox
-home: https://www.securecodebox.io/scanner/Nmap
-icon: https://www.securecodebox.io/integrationIcons/Nmap.svg
+home: https://www.securecodebox.io/scanners/nmap
+icon: https://www.securecodebox.io/scannerIcons/Nmap.svg
 sources:
 - https://github.com/secureCodeBox/secureCodeBox
 maintainers:

scanners/nmap/README.md

@@ -1,6 +1,6 @@
 ---
 title: "Nmap"
-path: "scanner/Nmap"
+path: "scanners/nmap"
 category: "scanner"
 usecase: "Network Scanner"
 ---
@@ -15,15 +15,16 @@ To learn more about the Nmap scanner itself visit [nmap.org].
 
 ## Deployment
 
-The Nmap ScanType can be deployed via helm.
+The Nmap ScanType can be deployed via helm:
 
 ```bash
-helm install nmap ./scanner/nmap/
+helm install nmap ./scanners/nmap/
 ```
 
 ## Examples
 
 A set of examples can be found in the [examples](./examples) folder.
+
 * Example *local-network* [scan](./examples/local-network/scan.yaml) and [findings](./examples/local-network/findings.yaml)
 * Example *localhost* [scan](./examples/local-network/scan.yaml) and [findings](./examples/local-network/findings.yaml)
 * Example *scan.nmap.org* [scan](./examples/local-network/scan.yaml) and [findings](./examples/local-network/findings.yaml)
@@ -49,6 +50,7 @@ Some useful example parameters listed below:
 ## 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`
@@ -58,7 +60,8 @@ Some useful example parameters listed below:
 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 testsuite: `npm test`
+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`
+
+If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install nmap`

scanners/ssh_scan/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
 name: ssh-scan
-description: A Helm chart for the SSH_Scan security Scanner that integrates with the secureCodeBox.
+description: A Helm chart for the SSH_Scan security scanner that integrates with the secureCodeBox.
 
 type: application
 version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
 - ssh
 - scanner
 - secureCodeBox
-home: https://www.securecodebox.io/scanner/SSH
-icon: https://www.securecodebox.io/integrationIcons/SSH.svg
+home: https://www.securecodebox.io/scanners/ssh
+icon: https://www.securecodebox.io/scannerIcons/SSH.svg
 sources:
 - https://github.com/secureCodeBox/secureCodeBox
 maintainers: