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

Commit a68b475

Browse files
J12934J12934
authored
Merge pull request #123 from secureCodeBox/feature/helm-documentation
Feature/helm documentation
2 parents 5963b70 + 3eb5a8c commit a68b475

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+1938
-111
lines changed

‎.github/workflows/helm-docs.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: "Update Helm Docs"
2+
3+
on:
4+
push:
5+
6+
jobs:
7+
helm-docs:
8+
runs-on: ubuntu-latest
9+
10+
steps:
11+
- uses: actions/checkout@v2
12+
with:
13+
ref: ${{ github.head_ref }}
14+
15+
- name: Download Helm Docs
16+
run: |
17+
mkdir helm-docs
18+
cd helm-docs
19+
20+
curl --output helm-docs.tar.gz --location https://github.com/norwoodj/helm-docs/releases/download/v0.15.0/helm-docs_0.15.0_Linux_x86_64.tar.gz
21+
tar -xvf helm-docs.tar.gz
22+
# Verify install
23+
./helm-docs --version
24+
25+
- name: Generate Helm Docs
26+
run: |
27+
./helm-docs/helm-docs
28+
# Remove helm-docs download to ensure they dont get commited back
29+
rm -rf helm-docs
30+
- uses: stefanzweifel/[email protected]
31+
with:
32+
commit_message: Updating Helm Docs

‎demo-apps/bodgeit/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# bodgeit
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.4.0](https://img.shields.io/badge/AppVersion-v1.4.0-informational?style=flat-square)
4+
5+
The BodgeIt Store is a vulnerable web app which is aimed at people who are new to pen testing
6+
7+
**Homepage:** <https://github.com/psiinon/bodgeit>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| iteratec GmbH | [email protected] | |
14+
15+
## Source Code
16+
17+
* <https://github.com/secureCodeBox/helm>
18+
* <https://github.com/psiinon/bodgeit>
19+
20+
## Values
21+
22+
| Key | Type | Default | Description |
23+
|-----|------|---------|-------------|
24+
| affinity | object | `{}` | |
25+
| fullnameOverride | string | `""` | |
26+
| image.pullPolicy | string | `"IfNotPresent"` | |
27+
| image.repository | string | `"psiinon/bodgeit"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| ingress.annotations | object | `{}` | |
30+
| ingress.enabled | bool | `false` | |
31+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
32+
| ingress.hosts[0].paths | list | `[]` | |
33+
| ingress.tls | list | `[]` | |
34+
| nameOverride | string | `""` | |
35+
| nodeSelector | object | `{}` | |
36+
| podSecurityContext | object | `{}` | |
37+
| replicaCount | int | `1` | |
38+
| resources | object | `{}` | |
39+
| securityContext | object | `{}` | |
40+
| service.port | int | `8080` | |
41+
| service.type | string | `"ClusterIP"` | |
42+
| tolerations | list | `[]` | |

‎demo-apps/dummy-ssh/README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# dummy-ssh
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.0.0](https://img.shields.io/badge/AppVersion-v1.0.0-informational?style=flat-square)
4+
5+
SSH Server for scan testing.
6+
7+
**Homepage:** <https://wordpress.org>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| iteratec GmbH | [email protected] | |
14+
15+
## Source Code
16+
17+
* <https://github.com/secureCodeBox/secureCodeBox/tree/master/demo/dummy-ssh>
18+
19+
## Values
20+
21+
| Key | Type | Default | Description |
22+
|-----|------|---------|-------------|
23+
| affinity | object | `{}` | |
24+
| fullnameOverride | string | `""` | |
25+
| image.pullPolicy | string | `"IfNotPresent"` | |
26+
| image.repository | string | `"securecodebox/dummy-ssh"` | |
27+
| imagePullSecrets | list | `[]` | |
28+
| nameOverride | string | `""` | |
29+
| nodeSelector | object | `{}` | |
30+
| podSecurityContext | object | `{}` | |
31+
| replicaCount | int | `1` | |
32+
| resources | object | `{}` | |
33+
| securityContext | object | `{}` | |
34+
| service.port | int | `22` | |
35+
| service.type | string | `"ClusterIP"` | |
36+
| tolerations | list | `[]` | |

‎demo-apps/http-webhook/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# http-webhook
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.16.0](https://img.shields.io/badge/AppVersion-1.16.0-informational?style=flat-square)
4+
5+
A Dummy webserver to echo HTTP requests in log
6+
7+
## Values
8+
9+
| Key | Type | Default | Description |
10+
|-----|------|---------|-------------|
11+
| affinity | object | `{}` | |
12+
| autoscaling.enabled | bool | `false` | |
13+
| autoscaling.maxReplicas | int | `100` | |
14+
| autoscaling.minReplicas | int | `1` | |
15+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16+
| fullnameOverride | string | `""` | |
17+
| image.pullPolicy | string | `"IfNotPresent"` | |
18+
| image.registry | string | `"docker.io"` | |
19+
| image.repository | string | `"mendhak/http-https-echo"` | |
20+
| image.tag | string | `"latest"` | |
21+
| imagePullSecrets | list | `[]` | |
22+
| ingress.annotations | object | `{}` | |
23+
| ingress.enabled | bool | `false` | |
24+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
25+
| ingress.hosts[0].paths | list | `[]` | |
26+
| ingress.tls | list | `[]` | |
27+
| nameOverride | string | `""` | |
28+
| nodeSelector | object | `{}` | |
29+
| podAnnotations | object | `{}` | |
30+
| podSecurityContext | object | `{}` | |
31+
| replicaCount | int | `1` | |
32+
| resources | object | `{}` | |
33+
| securityContext | object | `{}` | |
34+
| service.port | int | `80` | |
35+
| service.type | string | `"ClusterIP"` | |
36+
| serviceAccount.annotations | object | `{}` | |
37+
| serviceAccount.create | bool | `true` | |
38+
| serviceAccount.name | string | `""` | |
39+
| tolerations | list | `[]` | |

‎demo-apps/juice-shop/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# juice-shop
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v12.0.2](https://img.shields.io/badge/AppVersion-v12.0.2-informational?style=flat-square)
4+
5+
OWASP Juice Shop: Probably the most modern and sophisticated insecure web application
6+
7+
**Homepage:** <https://owasp.org/www-project-juice-shop/>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| iteratec GmbH | [email protected] | |
14+
15+
## Source Code
16+
17+
* <https://github.com/secureCodeBox/helm>
18+
* <https://github.com/bkimminich/juice-shop>
19+
20+
## Values
21+
22+
| Key | Type | Default | Description |
23+
|-----|------|---------|-------------|
24+
| affinity | object | `{}` | |
25+
| fullnameOverride | string | `""` | |
26+
| image.pullPolicy | string | `"IfNotPresent"` | |
27+
| image.repository | string | `"bkimminich/juice-shop"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| ingress.annotations | object | `{}` | |
30+
| ingress.enabled | bool | `false` | |
31+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
32+
| ingress.hosts[0].paths | list | `[]` | |
33+
| ingress.tls | list | `[]` | |
34+
| nameOverride | string | `""` | |
35+
| nodeSelector | object | `{}` | |
36+
| podSecurityContext | object | `{}` | |
37+
| replicaCount | int | `1` | |
38+
| resources | object | `{}` | |
39+
| securityContext | object | `{}` | |
40+
| service.port | int | `3000` | |
41+
| service.type | string | `"ClusterIP"` | |
42+
| tolerations | list | `[]` | |

‎demo-apps/old-wordpress/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# old-wordpress
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.0](https://img.shields.io/badge/AppVersion-4.0-informational?style=flat-square)
4+
5+
Insecure & Outdated Wordpress Instance: Never expose it to the internet!
6+
7+
**Homepage:** <https://wordpress.org>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| iteratec GmbH | [email protected] | |
14+
15+
## Source Code
16+
17+
* <https://github.com/secureCodeBox/helm>
18+
* <https://github.com/secureCodeBox/secureCodeBox/tree/master/demo/old-wordpress>
19+
20+
## Values
21+
22+
| Key | Type | Default | Description |
23+
|-----|------|---------|-------------|
24+
| affinity | object | `{}` | |
25+
| fullnameOverride | string | `""` | |
26+
| image.pullPolicy | string | `"IfNotPresent"` | |
27+
| image.repository | string | `"securecodebox/old-wordpress"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| nameOverride | string | `""` | |
30+
| nodeSelector | object | `{}` | |
31+
| podSecurityContext | object | `{}` | |
32+
| replicaCount | int | `1` | |
33+
| resources | object | `{}` | |
34+
| securityContext | object | `{}` | |
35+
| service.port | int | `80` | |
36+
| service.type | string | `"ClusterIP"` | |
37+
| tolerations | list | `[]` | |

‎demo-apps/swagger-petstore/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# swagger-petstore
2+
3+
![Version: latest](https://img.shields.io/badge/Version-latest-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.3](https://img.shields.io/badge/AppVersion-1.0.3-informational?style=flat-square)
4+
5+
This is the sample petstore application
6+
7+
**Homepage:** <https://github.com/swagger-api/swagger-petstore>
8+
9+
## Maintainers
10+
11+
| Name | Email | Url |
12+
| ---- | ------ | --- |
13+
| iteratec GmbH | [email protected] | |
14+
15+
## Source Code
16+
17+
* <https://github.com/secureCodeBox/helm>
18+
* <https://github.com/swagger-api/swagger-petstore>
19+
20+
## Values
21+
22+
| Key | Type | Default | Description |
23+
|-----|------|---------|-------------|
24+
| affinity | object | `{}` | |
25+
| fullnameOverride | string | `""` | |
26+
| image.pullPolicy | string | `"IfNotPresent"` | |
27+
| image.repository | string | `"swaggerapi/petstore"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| ingress.annotations | object | `{}` | |
30+
| ingress.enabled | bool | `false` | |
31+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
32+
| ingress.hosts[0].paths | list | `[]` | |
33+
| ingress.tls | list | `[]` | |
34+
| nameOverride | string | `""` | |
35+
| nodeSelector | object | `{}` | |
36+
| podSecurityContext | object | `{}` | |
37+
| replicaCount | int | `1` | |
38+
| resources | object | `{}` | |
39+
| securityContext | object | `{}` | |
40+
| service.port | int | `80` | |
41+
| service.type | string | `"ClusterIP"` | |
42+
| swaggerHostOverride | string | `"http://swagger-petstore.demo-apps.svc"` | |
43+
| tolerations | list | `[]` | |

‎hooks/declarative-subsequent-scans/Chart.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ type: application
66

77
# version - gets automatically set to the secureCodeBox release version when the helm charts gets published
88
version: latest
9+
kubeVersion: ">=v1.11.0"
910

1011
dependencies: []

‎hooks/declarative-subsequent-scans/README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ usecase: "Cascading Scans based declarative Rules."
1111

1212
## Deployment
1313

14-
Installing the Cascading Scans hook will add a ReadOnly Hook to your namespace which looks for matching _CascadingRules_ in the namespace and start the according scans.
14+
Installing the Cascading Scans hook will add a ReadOnly Hook to your namespace which looks for matching _CascadingRules_ in the namespace and start the according scans.
1515

1616
```bash
1717
helm upgrade --install dssh ./hooks/declarative-subsequent-scans/
@@ -25,7 +25,7 @@ dssh ReadOnly docker.io/scbexperimental/hook-declarative-subsequent-scans:la
2525
```
2626

2727
## CascadingScan Rules
28-
The CascadingRules are included directly in each helm chart of the individual scanners.
28+
The CascadingRules are included directly in each helm chart of the individual scanners.
2929

3030
```bash
3131
# Check your CascadingRules
@@ -113,4 +113,11 @@ pop3s-tls-scan sslyze non-invasive light
113113
smtps-tls-scan sslyze non-invasive light
114114
ssh-scan ssh-scan non-invasive light
115115
zap-http zap-baseline non-invasive medium
116-
```
116+
```
117+
118+
## Chart Configuration
119+
120+
| Key | Type | Default | Description |
121+
|-----|------|---------|-------------|
122+
| image.repository | string | `"docker.io/scbexperimental/hook-declarative-subsequent-scans"` | Hook image repository |
123+
| image.tag | string | `nil` | |

0 commit comments

Comments
 (0)