Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
a4cb415
added some additional color on creating web hooks for slack to help the
nobletrout Oct 22, 2021
63fe18b
added some additional color on creating web hooks for slack to help the
nobletrout Oct 22, 2021
7f33ce1
Merge branch 'main' of https://github.com/nobletrout/secureCodeBox in…
nobletrout Oct 22, 2021
7dde914
Merge branch 'secureCodeBox:main' into main
nobletrout Oct 25, 2021
209a4f5
adding myself to CONTRIBUTORS file
nobletrout Oct 25, 2021
f0e016a
added some additional color on creating web hooks for slack to help the
nobletrout Oct 22, 2021
24ddc1f
fix: upgrade axios from 0.21.4 to 0.22.0
snyk-bot Oct 23, 2021
a9a8958
Add a warning about DefectDojo deduplication issue
malexmave Oct 22, 2021
cd6a932
Updating Helm Docs
malexmave Oct 22, 2021
fa19a63
Update wording of last sentence
malexmave Oct 22, 2021
aeef3dc
Updating Helm Docs
malexmave Oct 22, 2021
aa04f53
Add early WIP for semgrep scanner
malexmave Oct 12, 2021
898bfab
First version of parser + unit tests
malexmave Oct 13, 2021
1670e40
Fix parser and tests
malexmave Oct 14, 2021
ded8218
Update values.yaml to SCBv3 syntax
malexmave Oct 14, 2021
ecdca18
Add support for initContainers to test framework
malexmave Oct 15, 2021
fd8581c
Add semgrep integration tests
malexmave Oct 15, 2021
5b9f48e
Add semgrep tests to CI
malexmave Oct 15, 2021
6a1b7b2
Add example with findings
malexmave Oct 15, 2021
4059949
Upgrade semgrep to 0.69.1
malexmave Oct 18, 2021
141970d
Add README for semgrep
malexmave Oct 18, 2021
18a4a08
Remove matched lines from output
malexmave Oct 19, 2021
45fada8
Add cascadingRules to docs
malexmave Oct 19, 2021
5cf35ed
Update integration tests to use local file
malexmave Oct 19, 2021
8d724c8
WIP: semgrep support for DefectDojo hook
malexmave Oct 19, 2021
4ba726c
Add unnecessary files to helmignore
malexmave Oct 20, 2021
432e4f3
Create folder for docs
malexmave Oct 21, 2021
27eda48
Rename example file to make it findable
malexmave Oct 21, 2021
b710c5a
Update documentation metadata
malexmave Oct 21, 2021
507473f
Fix typo :(
malexmave Oct 21, 2021
7dddd4a
Update semgrep to 0.70.0
malexmave Oct 21, 2021
06b0095
Add semgrep to DD-supported scan types
malexmave Oct 21, 2021
ec4d602
Updating Helm Docs
malexmave Oct 21, 2021
a7f2485
Fix templating in helm-docs
malexmave Oct 22, 2021
076964d
Add generated documentation
malexmave Oct 22, 2021
e8479e1
Updating Helm Docs
malexmave Oct 22, 2021
58c28f0
Add scb-bot support for semgrep
malexmave Oct 22, 2021
0716774
Upgrading amass from 3.14 to 3.14.1
secureCodeBoxBot Oct 19, 2021
dd72762
Upgrading kube-hunter from 0.6.1 to 0.6.3
secureCodeBoxBot Oct 22, 2021
9584f4b
Fixing release version to match the docker version
rfelber Oct 24, 2021
bb7f4fd
Updating Helm Docs
Oct 24, 2021
f919f48
Upgrading sslyze from 4.0.4 to 4.1.0
secureCodeBoxBot Oct 22, 2021
177b580
adding myself to CONTRIBUTORS file
nobletrout Oct 25, 2021
3dc6c95
Merge branch 'main' of https://github.com/nobletrout/secureCodeBox in…
nobletrout Oct 25, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ Committing with `git commit -s` will add the sign-off at the end of the commit m
- Johannes Zahn <johannes.zahn@iteratec.com>
- Jop Zitman <jop.zitman@secura.com>
- Florian Buchmeier <florian.buchmeier@audi.de>
- Max Maass <max.maass@iteratec.com>
- Max Maass <max.maass@iteratec.com>
- Chuck McAuley <nobletrout@gmail.com>
44 changes: 41 additions & 3 deletions hooks/notification/.helm-docs.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ This means that you can define key-value pairs as well as providing envs via sec
The rules can be defined in the values of the Chart.
The syntax and semantic for these rules are quite similar to CascadingRules (See: [secureCodeBox | CascadingRules](/docs/api/crds/cascading-rule))
To define Rules you will have to provide the `rules` field with one or more `matches` elements.
Each `machtes` defines one Rule.
Each `matches` defines one Rule.
For example:

```yaml
Expand All @@ -128,14 +128,52 @@ Within the `matches` you will have to provide `anyOf`
`anyOf` contains one or more conditions to be met by the finding to match the rule.
Notice that only one of these elements needs to match the finding for the rule to match.

#### Configuration of a Slack Notification
#### Configuration of a Slack Notification (WebHook)

To configure a Slack notification set the `type` to `slack` and the `endPoint` to point to your env containing your Webhook URL to slack.
You can use one of the following default templates:

- `slack-messageCard`: Sends a message with a summary listing the number of findings per category and severity.
- `slack-individual-findings-with-defectdojo`: Sends a message with a list of all findings with a link to the finding in DefectDojo. Will only work correctly if the DefectDojo hook is installed in the same namespace.

##### Example Config

The below example shows how to create a helm values chart and load secrets for access.
You must have `endPoint` point to a [defined environment variable](https://github.com/secureCodeBox/secureCodeBox/blob/main/hooks/notification/hook/hook.ts#L20), not a string.

```
# cat myvalues.yaml

notificationChannels:
- name: nmapopenports
type: slack
template: slack-messageCard
skipNotificationOnZeroFinding: true
rules:
- matches:
anyOf:
- category: "Open Port"
endPoint: POINTER_TO_ENV
env:
- name: POINTER_TO_ENV
valueFrom:
secretKeyRef:
name: myslacksecret
key: SLACK_WEB_HOOK

# cat values_slack_secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: myslacksecret
type: Opaque
data:
SLACK_WEB_HOOK: NOIDONTHINKSOBASE64STUFF

kubectl apply -f values_slack_secrets.yaml
helm upgrade --install nwh secureCodeBox/notification-hook --values myvalues.yaml
```

#### Configuration of a Slack App Notification

The `slack-app` notifier is an _alternate_ way to send notifications to slack using the slack api directly rather then using webhooks.
Expand Down Expand Up @@ -228,7 +266,7 @@ env:
value: secureCodeBox
```

### Configuration Of A MS Teams Notification
#### Configuration Of A MS Teams Notification

To configure a MS Teams notification you need to set the type to `ms-teams`.
In `endPoint` you need to specify the MS Teams webhook.
Expand Down