Skip to content

Commit eddd469

Browse files
Merge pull request #592 from secureCodeBox/scanner/whatweb
Integrating new scanner Whatweb to the secureCodeBox (closes #567)
2 parents dddac0d + a990aa9 commit eddd469

25 files changed

Lines changed: 850 additions & 0 deletions

‎.github/workflows/ci.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,6 +488,7 @@ jobs:
488488
- sslyze
489489
- test-scan
490490
- trivy
491+
- whatweb
491492
- typo3scan
492493
- wpscan
493494
- zap
@@ -563,6 +564,7 @@ jobs:
563564
- kubeaudit
564565
- ncrack
565566
- nmap
567+
- whatweb
566568
steps:
567569
- name: Checkout
568570
uses: actions/checkout@v2
@@ -1052,6 +1054,19 @@ jobs:
10521054
cd tests/integration/
10531055
npx jest --ci --color scanner/sslyze.test.js
10541056
1057+
# ---- Whatweb Integration Tests ----
1058+
1059+
- name: "Whatweb Integration Tests"
1060+
run: |
1061+
kubectl -n integration-tests delete scans --all
1062+
helm -n integration-tests install whatweb ./scanners/whatweb/ \
1063+
--set="parser.image.tag=sha-$(git rev-parse --short HEAD)" \
1064+
--set="parser.image.repository=docker.io/${{ env.DOCKER_NAMESPACE }}/parser-whatweb"
1065+
--set="parser.env[0].name=CRASH_ON_FAILED_VALIDATION" \
1066+
--set-string="parser.env[0].value=true"
1067+
cd tests/integration/
1068+
npx jest --ci --color scanner/whatweb.test.js
1069+
10551070
# ---- WPScan Integration Tests ----
10561071

10571072
- name: "WPScan Integration Tests"

‎scanners/whatweb/.helm-docs.gotmpl‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{{- /*
2+
SPDX-FileCopyrightText: 2021 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
*/ -}}
6+
7+
{{- define "extra.docsSection" -}}
8+
---
9+
title: "Whatweb"
10+
category: "scanner"
11+
type: "Network"
12+
state: "released"
13+
appVersion: "{{ template "chart.appVersion" . }}"
14+
usecase: "Website identification"
15+
---
16+
17+
![Whatweb logo](https://morningstarsecurity.com/wp-content/uploads/2019/02/WhatWeb-Logo-800px.png)
18+
19+
{{- end }}
20+
21+
{{- define "extra.dockerDeploymentSection" -}}
22+
## Supported Tags
23+
- `latest` (represents the latest stable release build)
24+
- tagged releases, e.g. `{{ template "chart.appVersion" . }}`
25+
{{- end }}
26+
27+
{{- define "extra.chartAboutSection" -}}
28+
## What is WHATWEB?
29+
Whatweb identifies websites. It can recognize technology used to build a website, such as content management systems (CMS), JavaScript libraries, web server and much more. This makes whatweb especially interesting to use in a cascading-rules pipeline.
30+
31+
To learn more about the whatweb scanner itself visit [https://morningstarsecurity.com/research/whatweb].
32+
{{- end }}

‎scanners/whatweb/.helmignore‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# SPDX-FileCopyrightText: 2021 iteratec GmbH
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
.DS_Store
5+
6+
parser/
7+
scanner/
8+
examples/
9+
docs/
10+
integration-tests/
11+
coverage/
12+
Makefile

‎scanners/whatweb/Chart.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# SPDX-FileCopyrightText: 2021 iteratec GmbH
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
apiVersion: v2
6+
name: whatweb
7+
description: A Helm chart for the whatweb security Scanner that integrates with the secureCodeBox.
8+
9+
type: application
10+
# version - gets automatically set to the secureCodeBox release version when the helm charts gets published
11+
version: v3.1.0-alpha1
12+
appVersion: v0.5.5
13+
kubeVersion: ">=v1.11.0-0"
14+
15+
keywords:
16+
- security
17+
- whatweb
18+
- scanner
19+
- secureCodeBox
20+
home: https://docs.securecodebox.io/docs/scanners/Whatweb
21+
icon: https://docs.securecodebox.io/img/integrationIcons/Whatweb.svg
22+
sources:
23+
- https://github.com/secureCodeBox/secureCodeBox
24+
maintainers:
25+
- name: iteratec GmbH
26+
email: secureCodeBox@iteratec.com

‎scanners/whatweb/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Whatweb"
3+
category: "scanner"
4+
type: "Network"
5+
state: "released"
6+
appVersion: "v0.5.5"
7+
usecase: "Website identification"
8+
---
9+
10+
![Whatweb logo](https://morningstarsecurity.com/wp-content/uploads/2019/02/WhatWeb-Logo-800px.png)
11+
12+
<!--
13+
SPDX-FileCopyrightText: 2021 iteratec GmbH
14+
15+
SPDX-License-Identifier: Apache-2.0
16+
-->
17+
<!--
18+
.: IMPORTANT! :.
19+
--------------------------
20+
This file is generated automatically with `helm-docs` based on the following template files:
21+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
22+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
23+
24+
Please be aware of that and apply your changes only within those template files instead of this file.
25+
Otherwise your changes will be reverted/overwritten automatically due to the build process `./.github/workflows/helm-docs.yaml`
26+
--------------------------
27+
-->
28+
29+
<p align="center">
30+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
31+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"/></a>
32+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"/></a>
33+
<a href="https://artifacthub.io/packages/search?repo=securecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/securecodebox"/></a>
34+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"/></a>
35+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"/></a>
36+
</p>
37+
38+
## What is WHATWEB?
39+
Whatweb identifies websites. It can recognize technology used to build a website, such as content management systems (CMS), JavaScript libraries, web server and much more. This makes whatweb especially interesting to use in a cascading-rules pipeline.
40+
41+
To learn more about the whatweb scanner itself visit [https://morningstarsecurity.com/research/whatweb].
42+
43+
## Deployment
44+
The whatweb chart can be deployed via helm:
45+
46+
```bash
47+
# Install HelmChart (use -n to configure another namespace)
48+
helm upgrade --install whatweb secureCodeBox/whatweb
49+
```
50+
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# SPDX-FileCopyrightText: 2021 iteratec GmbH
2+
#
3+
# SPDX-License-Identifier: Apache-2.0
4+
5+
apiVersion: "cascading.securecodebox.io/v1"
6+
kind: CascadingRule
7+
metadata:
8+
name: "whatweb-subdomain-scan"
9+
labels:
10+
securecodebox.io/invasive: non-invasive
11+
securecodebox.io/intensive: light
12+
spec:
13+
matches:
14+
anyOf:
15+
- category: "Subdomain"
16+
osi_layer: "NETWORK"
17+
scanSpec:
18+
scanType: "whatweb"
19+
parameters:
20+
# Target domain name of the finding and start a whatweb scan
21+
- "{{location}}"

‎scanners/whatweb/docs/.gitkeep‎

Whitespace-only changes.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2021 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
<!--
7+
.: IMPORTANT! :.
8+
--------------------------
9+
This file is generated automatically with `helm-docs` based on the following template files:
10+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
11+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
12+
13+
Please be aware of that and apply your changes only within those template files instead of this file.
14+
Otherwise your changes will be reverted/overwritten automatically due to the build process `./.github/workflows/helm-docs.yaml`
15+
--------------------------
16+
-->
17+
18+
<p align="center">
19+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
20+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"/></a>
21+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"/></a>
22+
<a href="https://artifacthub.io/packages/search?repo=securecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/securecodebox"/></a>
23+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"/></a>
24+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"/></a>
25+
</p>
26+
27+
## What is OWASP secureCodeBox?
28+
29+
<p align="center">
30+
<img alt="secureCodeBox Logo" src="https://docs.securecodebox.io/img/Logo_Color.svg" width="250px"/>
31+
</p>
32+
33+
_[OWASP secureCodeBox][scb-github]_ is an automated and scalable open source solution that can be used to integrate various *security vulnerability scanners* with a simple and lightweight interface. The _secureCodeBox_ mission is to support *DevSecOps* Teams to make it easy to automate security vulnerability testing in different scenarios.
34+
35+
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
36+
37+
The secureCodeBox project is running on [Kubernetes](https://kubernetes.io/). To install it you need [Helm](https://helm.sh), a package manager for Kubernetes. It is also possible to start the different integrated security vulnerability scanners based on a docker infrastructure.
38+
39+
### Quickstart with secureCodeBox on kubernetes
40+
41+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox project](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
42+
43+
## What is WHATWEB?
44+
Whatweb identifies websites. It can recognize technology used to build a website, such as content management systems (CMS), JavaScript libraries, web server and much more. This makes whatweb especially interesting to use in a cascading-rules pipeline.
45+
46+
To learn more about the whatweb scanner itself visit [https://morningstarsecurity.com/research/whatweb].
47+
48+
## Deployment
49+
The whatweb chart can be deployed via helm:
50+
51+
```bash
52+
# Install HelmChart (use -n to configure another namespace)
53+
helm upgrade --install whatweb secureCodeBox/whatweb
54+
```
55+
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2021 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
<!--
7+
.: IMPORTANT! :.
8+
--------------------------
9+
This file is generated automatically with `helm-docs` based on the following template files:
10+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
11+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
12+
13+
Please be aware of that and apply your changes only within those template files instead of this file.
14+
Otherwise your changes will be reverted/overwritten automatically due to the build process `./.github/workflows/helm-docs.yaml`
15+
--------------------------
16+
-->
17+
18+
<p align="center">
19+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
20+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"/></a>
21+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"/></a>
22+
<a href="https://artifacthub.io/packages/search?repo=securecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/securecodebox"/></a>
23+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"/></a>
24+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"/></a>
25+
</p>
26+
27+
## What is OWASP secureCodeBox?
28+
29+
<p align="center">
30+
<img alt="secureCodeBox Logo" src="https://docs.securecodebox.io/img/Logo_Color.svg" width="250px"/>
31+
</p>
32+
33+
_[OWASP secureCodeBox][scb-github]_ is an automated and scalable open source solution that can be used to integrate various *security vulnerability scanners* with a simple and lightweight interface. The _secureCodeBox_ mission is to support *DevSecOps* Teams to make it easy to automate security vulnerability testing in different scenarios.
34+
35+
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
36+
37+
The secureCodeBox project is running on [Kubernetes](https://kubernetes.io/). To install it you need [Helm](https://helm.sh), a package manager for Kubernetes. It is also possible to start the different integrated security vulnerability scanners based on a docker infrastructure.
38+
39+
### Quickstart with secureCodeBox on kubernetes
40+
41+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox project](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
42+
43+
## Supported Tags
44+
- `latest` (represents the latest stable release build)
45+
- tagged releases, e.g. `v0.5.5`
46+
47+
## How to use this image
48+
This `parser` image is intended to work in combination with the corresponding security scanner docker image to parse the `findings` results. For more information details please take a look at the documentation page: https://docs.securecodebox.io/docs/scanners/Whatweb.
49+
50+
```bash
51+
docker pull securecodebox/parser-whatweb
52+
```
53+
54+
## What is WHATWEB?
55+
Whatweb identifies websites. It can recognize technology used to build a website, such as content management systems (CMS), JavaScript libraries, web server and much more. This makes whatweb especially interesting to use in a cascading-rules pipeline.
56+
57+
To learn more about the whatweb scanner itself visit [https://morningstarsecurity.com/research/whatweb].
58+
59+
## Community
60+
61+
You are welcome, please join us on... 👋
62+
63+
- [GitHub][scb-github]
64+
- [Slack][scb-slack]
65+
- [Twitter][scb-twitter]
66+
67+
secureCodeBox is an official [OWASP][scb-owasp] project.
68+
69+
## License
70+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
71+
72+
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
73+
74+
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.
75+
76+
[scb-owasp]: https://www.owasp.org/index.php/OWASP_secureCodeBox
77+
[scb-docs]: https://docs.securecodebox.io/
78+
[scb-site]: https://www.securecodebox.io/
79+
[scb-github]: https://github.com/secureCodeBox/
80+
[scb-twitter]: https://twitter.com/secureCodeBox
81+
[scb-slack]: https://join.slack.com/t/securecodebox/shared_invite/enQtNDU3MTUyOTM0NTMwLTBjOWRjNjVkNGEyMjQ0ZGMyNDdlYTQxYWQ4MzNiNGY3MDMxNThkZjJmMzY2NDRhMTk3ZWM3OWFkYmY1YzUxNTU
82+
[scb-license]: https://github.com/secureCodeBox/secureCodeBox/blob/master/LICENSE
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2021 iteratec GmbH
3+
4+
SPDX-License-Identifier: Apache-2.0
5+
-->
6+
<!--
7+
.: IMPORTANT! :.
8+
--------------------------
9+
This file is generated automatically with `helm-docs` based on the following template files:
10+
- ./.helm-docs/templates.gotmpl (general template data for all charts)
11+
- ./chart-folder/.helm-docs.gotmpl (chart specific template data)
12+
13+
Please be aware of that and apply your changes only within those template files instead of this file.
14+
Otherwise your changes will be reverted/overwritten automatically due to the build process `./.github/workflows/helm-docs.yaml`
15+
--------------------------
16+
-->
17+
18+
<p align="center">
19+
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License Apache-2.0" src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
20+
<a href="https://github.com/secureCodeBox/secureCodeBox/releases/latest"><img alt="GitHub release (latest SemVer)" src="https://img.shields.io/github/v/release/secureCodeBox/secureCodeBox?sort=semver"/></a>
21+
<a href="https://owasp.org/www-project-securecodebox/"><img alt="OWASP Incubator Project" src="https://img.shields.io/badge/OWASP-Incubator%20Project-365EAA"/></a>
22+
<a href="https://artifacthub.io/packages/search?repo=securecodebox"><img alt="Artifact HUB" src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/securecodebox"/></a>
23+
<a href="https://github.com/secureCodeBox/secureCodeBox/"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/secureCodeBox/secureCodeBox?logo=GitHub"/></a>
24+
<a href="https://twitter.com/securecodebox"><img alt="Twitter Follower" src="https://img.shields.io/twitter/follow/securecodebox?style=flat&color=blue&logo=twitter"/></a>
25+
</p>
26+
27+
## What is OWASP secureCodeBox?
28+
29+
<p align="center">
30+
<img alt="secureCodeBox Logo" src="https://docs.securecodebox.io/img/Logo_Color.svg" width="250px"/>
31+
</p>
32+
33+
_[OWASP secureCodeBox][scb-github]_ is an automated and scalable open source solution that can be used to integrate various *security vulnerability scanners* with a simple and lightweight interface. The _secureCodeBox_ mission is to support *DevSecOps* Teams to make it easy to automate security vulnerability testing in different scenarios.
34+
35+
With the _secureCodeBox_ we provide a toolchain for continuous scanning of applications to find the low-hanging fruit issues early in the development process and free the resources of the penetration tester to concentrate on the major security issues.
36+
37+
The secureCodeBox project is running on [Kubernetes](https://kubernetes.io/). To install it you need [Helm](https://helm.sh), a package manager for Kubernetes. It is also possible to start the different integrated security vulnerability scanners based on a docker infrastructure.
38+
39+
### Quickstart with secureCodeBox on kubernetes
40+
41+
You can find resources to help you get started on our [documentation website](https://docs.securecodebox.io) including instruction on how to [install the secureCodeBox project](https://docs.securecodebox.io/docs/getting-started/installation) and guides to help you [run your first scans](https://docs.securecodebox.io/docs/getting-started/first-scans) with it.
42+
43+
## Supported Tags
44+
- `latest` (represents the latest stable release build)
45+
- tagged releases, e.g. `v0.5.5`
46+
47+
## How to use this image
48+
This `scanner` image is intended to work in combination with the corresponding `parser` image to parse the scanner `findings` to generic secureCodeBox results. For more information details please take a look at the [project page][scb-docs] or [documentation page][https://docs.securecodebox.io/docs/scanners/Whatweb].
49+
50+
```bash
51+
docker pull securecodebox/scanner-whatweb
52+
```
53+
54+
## What is WHATWEB?
55+
Whatweb identifies websites. It can recognize technology used to build a website, such as content management systems (CMS), JavaScript libraries, web server and much more. This makes whatweb especially interesting to use in a cascading-rules pipeline.
56+
57+
To learn more about the whatweb scanner itself visit [https://morningstarsecurity.com/research/whatweb].
58+

0 commit comments

Comments
 (0)