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

Commit e25b09a

Browse files
committed
Bugfixing some comments.
1 parent 6d71571 commit e25b09a

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
- [Local Scan Examples](#local-scan-examples)
3636
- [Public Scan Examples](#public-scan-examples)
3737
- [Then get the current State of the Scan by running:](#then-get-the-current-state-of-the-scan-by-running)
38+
- [To delete a scan, use ```kubectl delete```, e.g. for localhost nmap scan:](#to-delete-a-scan-use-kubectl-delete-eg-for-localhost-nmap-scan)
3839
- [Access Services](#access-services)
3940
- [How does it work?](#how-does-it-work)
4041
- [Architecture](#architecture)
@@ -85,16 +86,15 @@ helm -n securecodebox-system upgrade --install securecodebox-operator ./operator
8586
Optionally deploy SCB scanner charts for each security scanner you want to use. They should not be installed into the `securecodebox-system` like the operator so that different teams can use different kinds of scanners.
8687

8788
```bash
88-
kubectl create namespace scans
89-
helm upgrade --install -n scans amass ./scanners/amass/
90-
helm upgrade --install -n scans kube-hunter ./scanners/kube-hunter/
91-
helm upgrade --install -n scans nikto ./scanners/nikto
92-
helm upgrade --install -n scans nmap ./scanners/nmap/
93-
helm upgrade --install -n scans ssh-scan ./scanners/ssh_scan/
94-
helm upgrade --install -n scans sslyze ./scanners/sslyze/
95-
helm upgrade --install -n scans trivy ./scanners/trivy/
96-
helm upgrade --install -n scans zap ./scanners/zap/
97-
helm upgrade --install -n scans wpscan ./scanners/wpscan/
89+
helm upgrade --install amass ./scanners/amass/
90+
helm upgrade --install kube-hunter ./scanners/kube-hunter/
91+
helm upgrade --install nikto ./scanners/nikto
92+
helm upgrade --install nmap ./scanners/nmap/
93+
helm upgrade --install ssh-scan ./scanners/ssh_scan/
94+
helm upgrade --install sslyze ./scanners/sslyze/
95+
helm upgrade --install trivy ./scanners/trivy/
96+
helm upgrade --install zap ./scanners/zap/
97+
helm upgrade --install wpscan ./scanners/wpscan/
9898
```
9999

100100
Optional deploy some demo apps for scanning:
@@ -110,7 +110,7 @@ helm upgrade --install swagger-petstore ./demo-apps/swagger-petstore/
110110
Deploy secureCodeBox Hooks:
111111

112112
```bash
113-
helm upgrade --install aah ./hooks/update-field/
113+
helm upgrade --install ufh ./hooks/update-field/
114114
helm upgrade --install gwh ./hooks/generic-webhook/
115115
helm upgrade --install issh ./hooks/imperative-subsequent-scans/
116116
helm upgrade --install dssh ./hooks/declarative-subsequent-scans/

hooks/declarative-subsequent-scans/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ helm upgrade --install dssh ./hooks/declarative-subsequent-scans/
1919

2020
### Verification
2121
```bash
22-
$ kubectl get ScanCompletionHooks
22+
kubectl get ScanCompletionHooks
2323
NAME TYPE IMAGE
2424
dssh ReadOnly docker.io/scbexperimental/hook-declarative-subsequent-scans:latest
2525
```
@@ -29,7 +29,7 @@ The CascadingRules are included directly in each helm chart of the individual sc
2929

3030
```bash
3131
# Check your CascadingRules
32-
$ kubectl get CascadingRules
32+
kubectl get CascadingRules
3333
NAME STARTS INVASIVENESS INTENSIVENESS
3434
https-tls-scan sslyze non-invasive light
3535
imaps-tls-scan sslyze non-invasive light
@@ -67,7 +67,7 @@ This Scan will used all CascadingRules which are labeled with a "light" intensit
6767
You can lookup which CascadingRules this selects by running:
6868

6969
```bash
70-
$ kubectl get CascadingRules -l "securecodebox.io/intensive=light"
70+
kubectl get CascadingRules -l "securecodebox.io/intensive=light"
7171
NAME STARTS INVASIVENESS INTENSIVENESS
7272
https-tls-scan sslyze non-invasive light
7373
imaps-tls-scan sslyze non-invasive light

hooks/update-field/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "Generic WebHook"
3-
path: "hooks/generic-webhook"
3+
path: "hooks/udapte-field"
44
category: "hook"
5-
type: "integration"
5+
type: "dataProcessing"
66
state: "released"
7-
usecase: "Publishes Scan Findings as WebHook."
7+
usecase: "Updates fields in finding results."
88
---
99

1010
<!-- end -->
@@ -14,5 +14,5 @@ usecase: "Publishes Scan Findings as WebHook."
1414
Installing the _Update Field_ hook will add a ReadOnly Hook to your namespace.
1515

1616
```bash
17-
helm upgrade --install gwh ./hooks/generic-webhook/ --set webhookUrl="http://example.com/my/webhook/target"
17+
helm upgrade --install ufh ./hooks/update-field/ --set attribute.name="category" --set attribute.value="my-own-category"
1818
```

scanners/sslyze/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: "SSLyze"
33
path: "scanners/sslyze"
44
category: "scanner"
5-
type: "Kubernetes"
6-
state: "SSL"
5+
type: "SSL"
6+
state: "released"
77
appVersion: 3.0.8
88
usecase: "SSL/TLS Configuration Scanner"
99
---

0 commit comments

Comments
 (0)