Skip to content

Commit cb97278

Browse files
Reet00J12934
Reet00
authored and
J12934
committed
Change documentation after removal of zap scanner
(zap-baseline-scan and zap-advanced-scan) - Changed examples with zap files with either nmap or zap-automation-framework - removed section "Reusing components from other scanners" in Makefile.md because this was only applicable to zap-advanced Signed-off-by: Samreet Singh <samreet.singh@iteratec.com>
1 parent 0d2aa20 commit cb97278

File tree

14 files changed

+390
-437
lines changed

14 files changed

+390
-437
lines changed

‎documentation/docs/11-telemetry.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The secureCodeBox Operator collects and submits anonymized data to give the deve
1414
The total number of datapoints collected is extremely small, and they are individually evaluated to ensure that the submitted data is as anonymous as possible.
1515

1616
- Installed version of the secureCodeBox Operator (e.g. `v2.0.0`)
17-
- List of installed ScanTypes across all kubernetes Namespaces: (e.g. `['nmap', 'zap-baseline']`). Unofficial ScanTypes are reported as `other`, to avoid submission of confidential data.
17+
- List of installed ScanTypes across all kubernetes Namespaces: (e.g. `['nmap', 'zap-automation-framework']`). Unofficial ScanTypes are reported as `other`, to avoid submission of confidential data.
1818

1919
## Collection Interval
2020

‎documentation/docs/api/crds/cascading-rule.md‎

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -52,29 +52,20 @@ This helper object has the following attributes:
5252
apiVersion: "cascading.securecodebox.io/v1"
5353
kind: CascadingRule
5454
metadata:
55-
name: "zap-http"
55+
name: "nmap-hostscan"
5656
labels:
5757
securecodebox.io/invasive: non-invasive
58-
securecodebox.io/intensive: medium
58+
securecodebox.io/intensive: light
5959
spec:
6060
matches:
6161
anyOf:
62-
- category: "Open Port"
63-
attributes:
64-
service: http
65-
state: open
66-
- category: "Open Port"
67-
attributes:
68-
service: https
69-
state: open
70-
scanLabels:
71-
mynewlabel: {{ metadata.name }}
72-
scanAnnotations:
73-
defectdojo.securecodebox.io/product-name: "{{$.hostOrIP}}"
74-
defectdojo.securecodebox.io/product-type-name: "{{metadata.labels.organization}}"
75-
defectdojo.securecodebox.io/engagement-name: "{{metadata.name}}"
76-
mynewannotation: "{{category}}"
62+
- category: "Subdomain"
63+
osi_layer: "NETWORK"
7764
scanSpec:
78-
scanType: "zap-baseline"
79-
parameters: ["-t", "{{attributes.service}}://{{$.hostOrIP}}"]
65+
scanType: "nmap"
66+
parameters:
67+
# Treat all hosts as online -- skip host discovery
68+
- "-Pn"
69+
# Target Port of the finding
70+
- "{{location}}"
8071
```

‎documentation/docs/api/crds/parse-definition.md‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -85,21 +85,22 @@ resources:
8585
apiVersion: execution.securecodebox.io/v1
8686
kind: ParseDefinition
8787
metadata:
88-
name: zap-json
88+
name: zap-xml
8989
spec:
90-
image: docker.io/securecodebox/parser-zap
90+
affinity:
91+
foo: bar
92+
env: []
93+
image: docker.io/securecodebox/parser-zap-automation-framework:0.0.0
94+
imagePullPolicy: IfNotPresent
9195
imagePullSecrets:
92-
- name: dockerhub-token
93-
ttlSecondsAfterFinished: 60
94-
scopeLimiterAliases:
95-
domain: "{{attributes.host}}"
96+
- name: foo
9697
resources:
97-
requests:
98-
cpu: 42mi
99-
memory: 256Mi
100-
limits:
101-
cpu: 4
102-
memory: 4Gi
98+
foo: bar
99+
scopeLimiterAliases:
100+
foo: bar
101+
tolerations:
102+
- foo: bar
103+
ttlSecondsAfterFinished: null
103104
```
104105
105106
The Parse definition is different when integrating a new scanner. We use specific conventions when adding new ParseDefinitions to the secureCodeBox repository.

‎documentation/docs/architecture/06_runtime_view.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Since sequence diagrams are hard to maintain and tend to be very complicated we
1515

1616
## Runtime Scenario 1: Basic Scan with kubectl {#__runtime_scenario_1}
1717

18-
This scenario describes a simple [ZAP](/docs/scanners/zap) scan which is initialized by a _Developer_ actor and which persists the _findings_ in [Elastic][elastic] and [DefectDojo][defectdojo].
18+
This scenario describes a simple [ZAP](/docs/scanners/zap-automation-framework) scan which is initialized by a _Developer_ actor and which persists the _findings_ in [Elastic][elastic] and [DefectDojo][defectdojo].
1919

2020
![Runtime view diagram](/img/docs/architecture/runtime-basic-scan-via-kubectl.png)
2121

‎documentation/docs/auto-discovery/installation.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,6 @@ You should now see a ZAP Automation Framework [ScheduledScan](/docs/api/crds/sch
6565

6666
```bash
6767
$ kubectl get scheduledscans.execution.securecodebox.io
68-
NAME TYPE INTERVAL FINDINGS
69-
juice-shop-service-port-3000 zap-automation-framework 168h0m0s 5
68+
NAME TYPE INTERVAL FINDINGS
69+
juice-shop-service-port-3000 zap-automation-framework 168h0m0s 5
7070
```

‎documentation/docs/contributing/integrating-a-scanner/makefile.md‎

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -77,45 +77,3 @@ deploy-test-deps:
7777
```
7878

7979
Furthermore, it overrides the deploy-test-deps target such that juice-shop is installed in the correct namespace (nmap-tests).
80-
81-
### Reusing components from other scanners
82-
83-
```makefile
84-
#!/usr/bin/make -f
85-
86-
include_guard = set
87-
scanner = zap-advanced
88-
custom_scanner = set
89-
90-
include ../../scanners.mk
91-
92-
unit-tests:
93-
@$(MAKE) -s unit-test-py
94-
95-
unit-tests-parser:
96-
$(MAKE) -s -f ../../scanners.mk unit-tests-parser include_guard=set scanner=zap
97-
98-
install-deps:
99-
cd ../zap/ && $(MAKE) -s install-deps
100-
101-
docker-build-parser:
102-
cd ../zap/ && $(MAKE) -s docker-build-parser
103-
104-
docker-export-parser:
105-
cd ../zap/ && $(MAKE) -s docker-export-parser
106-
107-
kind-import-parser:
108-
cd ../zap/ && $(MAKE) -s kind-import-parser
109-
110-
deploy-with-scanner:
111-
@echo ".: 💾 Deploying custom '$(scanner)' scanner HelmChart with the docker tag '$(IMG_TAG)' into kind namespace 'integration-tests'."
112-
helm -n integration-tests upgrade --install $(scanner) ./ --wait \
113-
--set="parser.image.repository=docker.io/$(IMG_NS)/$(parser-prefix)-zap" \
114-
--set="parser.image.tag=$(IMG_TAG)" \
115-
--set="scanner.image.repository=docker.io/$(IMG_NS)/$(scanner-prefix)-$(scanner)" \
116-
--set="scanner.image.tag=$(IMG_TAG)"
117-
118-
deploy-test-deps: deploy-test-dep-nginx deploy-test-dep-bodgeit deploy-test-dep-juiceshop deploy-test-dep-petstore
119-
```
120-
121-
Zap-advanced reuses the parser container from zap scanner, thus in the makefile, we overwrite the targets for parser build so that they reference the makefile from zap.

‎documentation/docs/getting-started/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ helm upgrade --install ssh-audit oci://ghcr.io/securecodebox/helm/ssh-audit
129129
helm upgrade --install sslyze oci://ghcr.io/securecodebox/helm/sslyze
130130
helm upgrade --install trivy oci://ghcr.io/securecodebox/helm/trivy
131131
helm upgrade --install wpscan oci://ghcr.io/securecodebox/helm/wpscan
132-
helm upgrade --install zap oci://ghcr.io/securecodebox/helm/zap
132+
helm upgrade --install zap-automation-framework oci://ghcr.io/securecodebox/helm/zap-automation-framework
133133
```
134134

135135
## Install some demo targets

0 commit comments

Comments
 (0)