Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Commit 847dd90

Browse files
authored
Merge pull request #27 from Weltraumschaf/23
Fix the mising parts
2 parents dcf1d48 + dc17963 commit 847dd90

File tree

19 files changed

+115
-125
lines changed

19 files changed

+115
-125
lines changed

README.md

Lines changed: 14 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ helm -n securecodebox-system install securecodebox-operator ./operator/
8383
Optionally deploy SCB scanner Charts for each security scanner you want to use:
8484

8585
```bash
86-
helm upgrade --install amass ./scanner/amass/
87-
helm upgrade --install kube-hunter ./scanner/kube-hunter/
88-
helm upgrade --install nikto ./scanner/nikto
89-
helm upgrade --install nmap ./scanner/nmap/
90-
helm upgrade --install ssh-scan ./scanner/ssh_scan/
91-
helm upgrade --install sslyze ./scanner/sslyze/
92-
helm upgrade --install trivy ./scanner/trivy/
93-
helm upgrade --install zap ./scanner/zap/
94-
helm upgrade --install wpscan ./scanner/wpscan/
86+
helm upgrade --install amass ./scanners/amass/
87+
helm upgrade --install kube-hunter ./scanners/kube-hunter/
88+
helm upgrade --install nikto ./scanners/nikto
89+
helm upgrade --install nmap ./scanners/nmap/
90+
helm upgrade --install ssh-scan ./scanners/ssh_scan/
91+
helm upgrade --install sslyze ./scanners/sslyze/
92+
helm upgrade --install trivy ./scanners/trivy/
93+
helm upgrade --install zap ./scanners/zap/
94+
helm upgrade --install wpscan ./scanners/wpscan/
9595
```
9696

9797
Optional deploy some demo apps for scanning:
@@ -116,20 +116,20 @@ helm upgrade --install elkh ./hooks/persistence-elastic/
116116

117117
### Examples
118118

119-
Now everything is installed. You can try deploying scans from the `scanner/*/examples` directories.
119+
Now everything is installed. You can try deploying scans from the `scanners/*/examples` directories.
120120

121121
#### Local Scan Examples
122122

123123
E.g. localhost nmap scan:
124124

125125
```bash
126-
kubectl apply -f scanner/nmap/examples/localhost/scan.yaml
126+
kubectl apply -f scanners/nmap/examples/localhost/scan.yaml
127127
```
128128

129129
#### Public Scan Examples
130130

131131
```bash
132-
kubectl apply -f scanner/nmap/examples/scan.nmap.org/scan.yaml
132+
kubectl apply -f scanners/nmap/examples/scan.nmap.org/scan.yaml
133133
```
134134

135135
#### Then get the current State of the Scan by running:
@@ -176,42 +176,11 @@ Contributions are welcome and extremely helpful 🙌
176176

177177
## Author Information
178178

179-
Sponsored by [iteratec GmbH](https://www.iteratec.de/) -
180-
[secureCodeBox.io](https://www.securecodebox.io/)
181-
182-
[nginx]: https://nginx.org/en/
183-
[camunda]: https://camunda.com/de/
184-
[exteralservicetask]: https://docs.camunda.org/manual/latest/user-guide/process-engine/external-tasks/
185-
[bpmn]: https://en.wikipedia.org/wiki/Business_Process_Model_and_Notation
186-
[docker]: https://www.docker.com/
187-
[consul]: https://www.consul.io/
188-
[microservices]: https://martinfowler.com/articles/microservices.html
189-
[beta-testers]: https://www.securecodebox.io/
179+
Sponsored by [iteratec GmbH](https://www.iteratec.de/) - [secureCodeBox.io](https://www.securecodebox.io/)
180+
190181
[owasp]: https://www.owasp.org/index.php/OWASP_secureCodeBox
191182
[objspec]: https://www.sigs-datacom.de/fachzeitschriften/objektspektrum.html
192183
[secdevops-objspec]: http://www.sigs.de/public/ots/2017/OTS_DevOps_2017/Seedorff_Pfaender_OTS_%20DevOps_2017.pdf
193-
[jenkins]: https://jenkins.io/
194-
[nmap]: https://nmap.org/
195-
[nikto]: https://cirt.net/Nikto2
196-
[arcachni]: http://www.arachni-scanner.com/
197-
[sslyze]: https://github.com/nabla-c0d3/sslyze
198-
[sqlmap]: http://sqlmap.org/
199-
[sshscan]: https://github.com/mozilla/ssh_scan_api
200-
[burp]: https://portswigger.net/burp
201-
[arachni]: http://www.arachni-scanner.com/
202-
[wpscan]: https://wpscan.org/
203-
[amass]: https://github.com/owasp/amass
204-
[wordpress]: https://wordpress.com/
205-
[consul]: https://www.consul.io/
206-
[resty]: https://openresty.org/en/
207-
[keycloak]: http://www.keycloak.org/
208-
[openid]: https://de.wikipedia.org/wiki/OpenID
209-
[elasticsearch]: https://www.elastic.co/products/elasticsearch
210-
[kibana]: https://www.elastic.co/de/products/kibana
211-
[logstash]: https://www.elastic.co/products/logstash
212-
[dvwa]: http://www.dvwa.co.uk/
213-
[bodgeit]: https://github.com/psiinon/bodgeit
214-
[juiceshop]: https://www.owasp.org/index.php/OWASP_Juice_Shop_Project
215184
[scb-github]: https://github.com/secureCodeBox/
216185
[scb-engine]: https://github.com/secureCodeBox/engine
217186
[scb-twitter]: https://twitter.com/secureCodeBox

scanners/amass/Chart.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: amass
3-
description: A Helm chart for the Amass security Scanner that integrates with the secureCodeBox.
3+
description: A Helm chart for the Amass security scanner that integrates with the secureCodeBox.
44

55
type: application
66
version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
1111
- amass
1212
- scanner
1313
- secureCodeBox
14-
home: https://www.securecodebox.io/scanner/Amass
15-
icon: https://www.securecodebox.io/integrationIcons/Amass.svg
14+
home: https://www.securecodebox.io/scanners/amass
15+
icon: https://www.securecodebox.io/scannerIcons/Amass.svg
1616
sources:
1717
- https://github.com/secureCodeBox/secureCodeBox
1818
maintainers:

scanners/amass/README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Amass"
3-
path: "scanner/Amass"
3+
path: "scanners/amass"
44
category: "scanner"
55
usecase: "Subdomain Enumeration Scanner"
66
---
@@ -13,35 +13,37 @@ The OWASP Amass Project has developed a tool to help information security profes
1313

1414
## Deployment
1515

16-
The AMASS scanType can be deployed via helm.
16+
The AMASS scanType can be deployed via helm:
1717

1818
```bash
19-
helm upgrade --install amass ./scanner/amass/
19+
helm upgrade --install amass ./scanners/amass/
2020
```
2121

2222
## Examples
2323

2424
A set of examples can be found in the [examples](./examples) folder.
25+
2526
* Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
2627
* Example *example.com* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
2728

2829
## Configuration
2930

30-
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.
31+
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.
3132

3233
* The most basic use of the tool for subdomain enumeration: `amass enum -d example.com`
3334
* Typical parameters for DNS enumeration: `amass enum -v -src -ip -brute -min-for-recursive 2 -d example.com`
34-
35+
3536
Special command line options:
37+
3638
* Disable generation of altered names `amass enum -noalts -d example.com`
3739
* Turn off recursive brute forcing `amass enum -brute -norecursive -d example.com`
3840
* Disable saving data into a local database `amass enum -nolocaldb -d example.com`
3941
* Domain names separated by commas (can be used multiple times) `amass enum -d example.com`
4042

41-
4243
## Development
4344

4445
### Local setup
46+
4547
1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
4648
2. Ensure you have node.js installed
4749
* On MacOs with brew package manager: `brew install node`
@@ -51,8 +53,8 @@ Special command line options:
5153
1. Install the dependencies `npm install`
5254
2. Update the parser function here: `./parser/parser.js`
5355
3. Update the parser tests here: `./parser/parser.test.js`
54-
4. Run the testsuite: `npm test`
56+
4. Run the test suite: `npm test`
5557

5658
[OWASP_Amass_Project]: https://owasp.org/www-project-amass/
5759
[Amass GitHub]: https://github.com/OWASP/Amass
58-
[Amass User Guide]: https://github.com/OWASP/Amass/blob/master/doc/user_guide.md
60+
[Amass User Guide]: https://github.com/OWASP/Amass/blob/master/doc/user_guide.md

scanners/kube-hunter/Chart.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: kube-hunter
3-
description: A Helm chart for the kube-hunter security Scanner that integrates with the secureCodeBox.
3+
description: A Helm chart for the kube-hunter security scanner that integrates with the secureCodeBox.
44

55
type: application
66
version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
1111
- kube-hunter
1212
- scanner
1313
- secureCodeBox
14-
home: https://www.securecodebox.io/scanner/kube-hunter
15-
icon: https://www.securecodebox.io/integrationIcons/kube-hunter.svg
14+
home: https://www.securecodebox.io/scanners/kube-hunter
15+
icon: https://www.securecodebox.io/scannerIcons/kube-hunter.svg
1616
sources:
1717
- https://github.com/secureCodeBox/secureCodeBox
1818
maintainers:

scanners/kube-hunter/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "kube-hunter"
3-
path: "scanner/kube-hunter"
3+
path: "scanners/kube-hunter"
44
category: "scanner"
55
usecase: "Kubernetes Vulnerability Scanner"
66
---
@@ -13,20 +13,21 @@ To learn more about the kube-hunter scanner itself visit [kube-hunter GitHub] or
1313

1414
## Deployment
1515

16-
The kube-hunter ScanType can be deployed via helm.
16+
The kube-hunter ScanType can be deployed via helm:
1717

1818
```bash
19-
helm upgrade --install kube-hunter ./scanner/kube-hunter/
19+
helm upgrade --install kube-hunter ./scanners/kube-hunter/
2020
```
2121

2222
## Examples
2323

2424
A set of examples can be found in the [examples](./examples) folder.
25+
2526
* Example *in-cluster* [scan](./examples/in-cluster/scan.yaml) and [findings](./examples/in-cluster/findings.yaml)
2627

2728
## Configuration
2829

29-
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.
30+
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.
3031

3132
* To specify remote machines for hunting, select option 1 or use the --remote option. Example: `kube-hunter --remote some.node.com`
3233
* 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
3536
## Development
3637

3738
### Local setup
39+
3840
1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
3941
2. Ensure you have node.js installed
4042
* 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
4446
1. Install the dependencies `npm install`
4547
2. Update the parser function here: `./parser/parser.js`
4648
3. Update the parser tests here: `./parser/parser.test.js`
47-
4. Run the testsuite: `npm test`
49+
4. Run the test suite: `npm test`
4850

4951
[kube-hunter Website]: https://kube-hunter.aquasec.com/
5052
[kube-hunter GitHub]: https://github.com/aquasecurity/kube-hunter
51-
[kube-hunter Documentation]: https://github.com/aquasecurity/kube-hunter#scanning-options
53+
[kube-hunter Documentation]: https://github.com/aquasecurity/kube-hunter#scanning-options

scanners/nikto/Chart.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: nikto
3-
description: A Helm chart for the Nikto security Scanner that integrates with the secureCodeBox.
3+
description: A Helm chart for the Nikto security scanner that integrates with the secureCodeBox.
44

55
type: application
66
version: 0.1.0
@@ -11,8 +11,8 @@ keywords:
1111
- nikto
1212
- scanner
1313
- secureCodeBox
14-
home: https://www.securecodebox.io/scanner/Nikto
15-
icon: https://www.securecodebox.io/integrationIcons/Nikto.svg
14+
home: https://www.securecodebox.io/scanners/nikto
15+
icon: https://www.securecodebox.io/scannerIcons/Nikto.svg
1616
sources:
1717
- https://github.com/secureCodeBox/secureCodeBox
1818
maintainers:

scanners/nikto/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Nikto"
3-
path: "scanner/Nikto"
3+
path: "scanners/nikto"
44
category: "scanner"
55
usecase: "Webserver Vulnerability Scanner"
66
---
@@ -13,20 +13,21 @@ Nikto is a free software command-line vulnerability scanner that scans webserver
1313

1414
## Deployment
1515

16-
The Nikto ScanType can be deployed via helm.
16+
The Nikto ScanType can be deployed via helm:
1717

1818
```bash
19-
helm upgrade --install nikto ./scanner/nikto/
19+
helm upgrade --install nikto ./scanners/nikto/
2020
```
2121

2222
## Examples
2323

2424
A set of examples can be found in the [examples](./examples) folder.
25+
2526
* Example *secureCodeBox.io* [scan](./examples/secureCodeBox.io/scan.yaml) and [findings](./examples/secureCodeBox.io/findings.yaml)
2627

2728
## Configuration
2829

29-
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.
30+
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.
3031

3132
* 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`
3233
* 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:/
4950
* a - Authentication Bypass. Allows client to access a resource it should not be allowed to access.
5051
* b - Software Identification. Installed software or program could be positively identified.
5152
* c - Remote source inclusion. Software allows remote inclusion of source code.
52-
* x - Reverse Tuning Options. Perform exclusion of the specified tuning type instead of inclusion of the specified tuning type
53+
* x - Reverse Tuning Options. Perform exclusion of the specified tuning type instead of inclusion of the specified tuning type
5354

5455
## Development
5556

5657
### Local setup
58+
5759
1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
5860
2. Ensure you have node.js installed
5961
* 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:/
6365
1. Install the dependencies `npm install`
6466
2. Update the parser function here: `./parser/parser.js`
6567
3. Update the parser tests here: `./parser/parser.test.js`
66-
4. Run the testsuite: `npm test`
68+
4. Run the test suite: `npm test`
6769

6870
[cirt.net]: https://cirt.net/
69-
[nikto github]: https://github.com/sullo/nikto
71+
[nikto github]: https://github.com/sullo/nikto

scanners/nmap/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ keywords:
1111
- nmap
1212
- scanner
1313
- secureCodeBox
14-
home: https://www.securecodebox.io/scanner/Nmap
15-
icon: https://www.securecodebox.io/integrationIcons/Nmap.svg
14+
home: https://www.securecodebox.io/scanners/nmap
15+
icon: https://www.securecodebox.io/scannerIcons/Nmap.svg
1616
sources:
1717
- https://github.com/secureCodeBox/secureCodeBox
1818
maintainers:

scanners/nmap/README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Nmap"
3-
path: "scanner/Nmap"
3+
path: "scanners/nmap"
44
category: "scanner"
55
usecase: "Network Scanner"
66
---
@@ -15,15 +15,16 @@ To learn more about the Nmap scanner itself visit [nmap.org].
1515

1616
## Deployment
1717

18-
The Nmap ScanType can be deployed via helm.
18+
The Nmap ScanType can be deployed via helm:
1919

2020
```bash
21-
helm install nmap ./scanner/nmap/
21+
helm install nmap ./scanners/nmap/
2222
```
2323

2424
## Examples
2525

2626
A set of examples can be found in the [examples](./examples) folder.
27+
2728
* Example *local-network* [scan](./examples/local-network/scan.yaml) and [findings](./examples/local-network/findings.yaml)
2829
* Example *localhost* [scan](./examples/local-network/scan.yaml) and [findings](./examples/local-network/findings.yaml)
2930
* 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:
4950
## Development
5051

5152
### Local setup
53+
5254
1. Clone the repository `git clone git@github.com:secureCodeBox/secureCodeBox-v2-alpha.git`
5355
2. Ensure you have node.js installed
5456
* On MacOs with brew package manager: `brew install node`
@@ -58,7 +60,8 @@ Some useful example parameters listed below:
5860
1. Install the dependencies `npm install`
5961
2. Update the parser function here: `./parser/parser.js`
6062
3. Update the parser tests here: `./parser/parser.test.js`
61-
4. Run the testsuite: `npm test`
63+
4. Run the test suite: `npm test`
6264

6365
#### Basic scanner tests
64-
If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install nmap`
66+
67+
If you want to test sslyze localy you can use brew (only on macOS) to install it: `brew install nmap`

0 commit comments

Comments
 (0)