Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
115 commits
Select commit Hold shift + click to select a range
0f33819
WIP Example
J12934 May 18, 2020
de441e5
Add additional documtation and examples
J12934 May 18, 2020
1b6b08b
Renamed PersistenceProvider to ReadOnly ScanCompletion Hook
J12934 May 25, 2020
fb8a9f1
WIP
J12934 May 25, 2020
186744d
Implement ParseCompleted Step
J12934 May 25, 2020
06e0b15
WIP ReadAndWriteHookProcessing
J12934 May 25, 2020
e5e6490
Change sleep image to echo image
J12934 May 25, 2020
cf5eb78
WIP ReadAndWrite Hook Job Creation
J12934 May 25, 2020
f7be4f0
Check if job has completed
J12934 May 25, 2020
31294b6
Remove duplicated comments
J12934 May 25, 2020
11b10d9
Update crds in operators helm chart
J12934 May 25, 2020
d4a3527
Run inspect operator step post-failure
J12934 May 25, 2020
55a7612
Fix rbac in helm chart
J12934 May 25, 2020
231f4f2
Rename persistence-sdk to hook sdk
J12934 May 26, 2020
29c3312
Refactore and add update methods in the hook sdk
J12934 May 26, 2020
fa2682a
Rename persistence folder to hooks
J12934 May 26, 2020
e218e4b
Add generic-webhook ScanCompletionHook
J12934 May 26, 2020
f1d3390
Add update url to ReadAndWrite Hooks
J12934 May 26, 2020
5975f7c
Move persistence-elastic up one level
J12934 May 26, 2020
7ac2fdc
Add missing file contents to upadate call
J12934 May 26, 2020
6b34917
Configure jest to automatically run all tests in the hook dir
J12934 May 26, 2020
d7439c5
Add hook directory to ci
J12934 May 26, 2020
6e41085
Cd back before cd'ing again
J12934 May 26, 2020
e32afa7
Add missing lock file
J12934 May 26, 2020
4cbdbc8
Reanme upload method to update
J12934 May 27, 2020
7f447d8
Add `add-attributes` hook for integration tests
J12934 May 27, 2020
cb4c272
Extracted setHookStatus from reconciler function
J12934 May 27, 2020
2acb8b5
Remove demo fields
J12934 May 27, 2020
e6f4e76
Extract executeReadAndWriteHooks from reconciler func
J12934 May 27, 2020
753a34e
Fix return values
J12934 May 27, 2020
584e956
Refactore Hook handling
J12934 May 27, 2020
8f725c6
Extract scan status update logic
J12934 May 27, 2020
806bbb7
Pin to ssh_scan `0.0.43` image
J12934 May 28, 2020
0aec8b9
Added some more quickstart documentation
rfelber Jun 6, 2020
ef1f865
Upgrading AMASS to version v.3.6.3
rfelber Jun 6, 2020
be8afb3
Added a new Hook "nmap-subsequent-scans" which implements an imperati…
rfelber Jun 8, 2020
dfd71d6
Added a new scanner integration (WIP) for WPScan
rfelber Jun 8, 2020
65cd9a4
Fixing testpipeline errors
rfelber Jun 8, 2020
0099dc3
Add dummy scanner for hook integration tests
nigthknight Jun 8, 2020
a61ae35
Refactored imperical combined hook for better testability and readabi…
J12934 Jun 8, 2020
4943533
Merge branch 'hooks' of github.com:secureCodeBox/secureCodeBox-v2-alp…
nigthknight Jun 8, 2020
fce7d09
Change read-write-hook-test to general test-scan
nigthknight Jun 8, 2020
5a0ac1c
Fix spelling
nigthknight Jun 8, 2020
9d953df
Fix build for test-scan
nigthknight Jun 8, 2020
6a48e9e
Remove default namespace
nigthknight Jun 8, 2020
78ea264
Change result type for test-scan
nigthknight Jun 8, 2020
c43da41
Fix dummy parser
nigthknight Jun 8, 2020
2186f9c
Added ownerReference to all subsequent scan created by the nmap-subse…
rfelber Jun 8, 2020
1c277c8
Added AMASS subsequent scans also to nmap-subsequent-scans hook. We s…
rfelber Jun 8, 2020
b3412ce
Refactored name to a more generic one and added more tests. You need …
rfelber Jun 8, 2020
da7984f
Merge branch 'documentation' into hooks
rfelber Jun 9, 2020
36c168a
Added scanner integration readme files and example files for each sca…
rfelber Jun 9, 2020
706b4ad
Added scanner integration readme files and example files for each sca…
rfelber Jun 9, 2020
c175708
Added a general docs folder for all documentation stuff
rfelber Jun 9, 2020
42e3b77
Fixing broken header link
rfelber Jun 9, 2020
c65a8fc
Merge branch 'master' into hooks
J12934 Jun 9, 2020
61d6f50
Adding guide to build and run operator locally
nigthknight Jun 10, 2020
f7a7048
Fix directory
nigthknight Jun 10, 2020
eba2a33
Adding test-read-write-hook Hook
nigthknight Jun 10, 2020
ce7acdb
Add note on kubernetes on Mac and Windows
J12934 Jun 10, 2020
5067d9c
Change add-attribute hook to update-field hook
J12934 Jun 10, 2020
851e2b2
Add docker command for minio
nigthknight Jun 10, 2020
0f0240b
Merge branch 'hooks' of github.com:secureCodeBox/secureCodeBox-v2-alp…
nigthknight Jun 10, 2020
b45d5ac
Delete folder beacuse we will use update field hook for integration t…
jorgestiga Jun 10, 2020
9b1e3ba
Refactor integration test folder structure
jorgestiga Jun 10, 2020
9142e20
Refactor folder structure
jorgestiga Jun 10, 2020
0c89b89
Update findings stats after ReadWrite hooks
jorgestiga Jun 10, 2020
1f19210
Use shorter name for update field hook
jorgestiga Jun 10, 2020
4f674aa
Add integration test for ReadWrite hook
jorgestiga Jun 10, 2020
f9a3aeb
Improved the imperative-subsequent-scans hook to be more configurable…
rfelber Jun 11, 2020
65978f0
Fixing linter test error
rfelber Jun 11, 2020
4dec6e6
Remote commented out code
J12934 Jun 11, 2020
72aeadb
Use latest tag as default tag for test-scan parser
J12934 Jun 11, 2020
05c5831
Also tag update-field hook with git tag
J12934 Jun 11, 2020
076ad93
Run hook integration test with image of the current commit
J12934 Jun 11, 2020
a96e413
Update to Amass v3.7.0
J12934 Jun 11, 2020
d1def44
Implements #3 'Find old SMB Protocol Versions in a network with NMAP'
rfelber Jun 11, 2020
a9bec42
Trying to fix some operator issues: updating crds and rbac rules
rfelber Jun 11, 2020
22bd0d3
Trying to fix some operator issues: updating crds and rbac rules
rfelber Jun 11, 2020
1cf0c78
Optimized helm install help
rfelber Jun 11, 2020
2c22df5
Updating operator chart due to new rbac and crds
rfelber Jun 11, 2020
8d0c7d0
Fix bug which lead scans to be marked as done when the ReadOnly hooks…
J12934 Jun 12, 2020
4604fe5
Update to amass 3.7.1
J12934 Jun 12, 2020
ae8d657
Extending RBAC Rules to allow scan hooks to create new scans (used by…
rfelber Jun 12, 2020
17e451e
Extending RBAC Rules to allow scan hooks to create new scans (used by…
rfelber Jun 12, 2020
31630c3
Start combined scan in current namespace
J12934 Jun 12, 2020
41d9e64
Inline ownerReference
J12934 Jun 12, 2020
d6bbf1b
Merge branch 'hooks' of github.com:secureCodeBox/secureCodeBox-v2-alp…
J12934 Jun 12, 2020
b5665b2
Correct where the namespace is specified
J12934 Jun 12, 2020
998639e
Convert string env vars to bools
J12934 Jun 12, 2020
643369b
Bugfix if hostname is null no subsequent scan should be started (use …
rfelber Jun 12, 2020
e721734
Increasing version due to latest improvements
rfelber Jun 12, 2020
c3d4d15
Changing app version number
rfelber Jun 12, 2020
73e775a
Use shorter name for imperative-subsequent-scans hook
rfelber Jun 13, 2020
08903ca
Improved imperative scan to respect the correct identified ports for …
rfelber Jun 13, 2020
a0daed2
Updated readme for integrated scanner
rfelber Jun 13, 2020
fcb4a6b
Extended logging informations to get better debugging informations
rfelber Jun 13, 2020
35f77b4
Improved the imperative-subsequent-scans hook (if you scan a huge ran…
rfelber Jun 13, 2020
c404682
Fixed port issue with nikto
rfelber Jun 13, 2020
62e865f
Fixing the label scan-type for all subsequent scans
rfelber Jun 14, 2020
2ba12c9
Fixing wrong label name
rfelber Jun 15, 2020
0023608
Use shorter name for persistence-elastic hook based jobs because they…
rfelber Jun 15, 2020
a2fecfa
Updating operator Helm to make the resource limits configurable
rfelber Jun 15, 2020
5c26265
Updated readme to use shorter release names because this will result …
rfelber Jun 15, 2020
a70a89f
Fixing SMB scan because NMAP discovers different services sometimes i…
rfelber Jun 15, 2020
fa080b9
Preparing readme for merge to master.
rfelber Jun 16, 2020
6475f61
Fixing a typo.
rfelber Jun 16, 2020
3dd1804
Updating Readme
rfelber Jun 16, 2020
4cddd57
Removed samples because they moved directly into the different scanne…
rfelber Jun 16, 2020
5e8ce33
Renamed the integration folder to scanner because it's more intuitive.
rfelber Jun 16, 2020
ce90452
Add basic integration Test for read-only-hooks
nigthknight Jun 17, 2020
e7c7ec2
Merge branch 'hooks' of github.com:secureCodeBox/secureCodeBox-v2-alp…
nigthknight Jun 17, 2020
e13fc6f
Merge branch 'hooks' of github.com:secureCodeBox/secureCodeBox-v2-alp…
nigthknight Jun 17, 2020
7ef0a2f
Path correction
rfelber Jun 17, 2020
cd4af69
Added a ADR folder to document design descions. Documents the hook co…
rfelber Jun 18, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
115 changes: 88 additions & 27 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
run: ls
- name: "Install npm dependencies in all parser sub projects"
run: |
for dir in integrations/*/parser/
for dir in scanner/*/parser/
do
cd $dir
if [ -f package.json ] && [ -f package-lock.json ]; then
Expand All @@ -20,9 +20,9 @@ jobs:
# cd back
cd -
done
- name: "Install npm dependencies in all persistence sub projects"
- name: "Install npm dependencies in all hook sub projects"
run: |
for dir in persistence/*/
for dir in hooks/*/
do
cd $dir
if [ -f package.json ] && [ -f package-lock.json ]; then
Expand All @@ -35,7 +35,10 @@ jobs:
- name: "Install npm test dependencies"
run: |
npm ci
cd integrations/
cd scanner/
npm ci
cd -
cd hooks/
npm ci
- name: "Run tests"
run: |
Expand Down Expand Up @@ -106,7 +109,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-amass
path: ./integrations/amass/parser/
path: ./scanner/amass/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -115,7 +118,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-kube-hunter
path: ./integrations/kube-hunter/parser/
path: ./scanner/kube-hunter/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -124,7 +127,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-nikto
path: ./integrations/nikto/parser/
path: ./scanner/nikto/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -133,7 +136,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-nmap
path: ./integrations/nmap/parser/
path: ./scanner/nmap/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -142,7 +145,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-ssh-scan
path: ./integrations/ssh_scan/parser/
path: ./scanner/ssh_scan/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -151,7 +154,16 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-sslyze
path: ./integrations/sslyze/parser/
path: ./scanner/sslyze/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
name: "Build & Push test-scan Parser Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-test-scan
path: ./scanner/test-scan/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -160,7 +172,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-trivy
path: ./integrations/trivy/parser/
path: ./scanner/trivy/parser/
tag_with_ref: true
tag_with_sha: true
- uses: docker/build-push-action@v1
Expand All @@ -169,40 +181,65 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/parser-zap
path: ./integrations/zap/parser/
path: ./scanner/zap/parser/
tag_with_ref: true
tag_with_sha: true
persistenceImages:
name: "Build / PersistenceProviders"
hookImages:
name: "Build / Hooks"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
# SDK
- uses: docker/build-push-action@v1
name: "Build & Push Persistence SDK"
name: "Build & Push Hook SDK"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/persistence-sdk-nodejs
path: ./persistence-sdk/nodejs/
repository: scbexperimental/hook-sdk-nodejs
path: ./hook-sdk/nodejs/
tag_with_ref: true
# Actual PersistenceProviders
- uses: docker/build-push-action@v1
name: "Build & Push Elastic PersistenceProvider Image"
name: "Build & Push Elastic PersistenceProvider Hook Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/persistence-elastic
path: ./persistence/persistence-elastic/
path: ./hooks/persistence-elastic/
tag_with_ref: true
- uses: docker/build-push-action@v1
name: "Build & Push Elastic PersistenceProvider Dashboard Importer Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/persistence-elastic-dashboard-importer
path: ./persistence/persistence-elastic/dashboardImporter/
path: ./hooks/persistence-elastic/dashboardImporter/
tag_with_ref: true
- uses: docker/build-push-action@v1
name: "Build & Push GenericWebhook Hook Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/generic-webhook
path: ./hooks/generic-webhook/
tag_with_ref: true
- uses: docker/build-push-action@v1
name: "Build & Push ImperativeSubsequentScans Hook Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/hook-imperative-subsequent-scans
path: ./hooks/imperative-subsequent-scans/
tag_with_ref: true
- uses: docker/build-push-action@v1
name: "Build & Push UpdateField Hook Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/update-field
path: ./hooks/update-field/
tag_with_ref: true
tag_with_sha: true
scannerImages:
# Note we only build images for scanner that don't provider official public container images
name: "Build / Scanner"
Expand All @@ -215,7 +252,7 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/nmap
path: ./integrations/nmap/scanner/
path: ./scanner/nmap/scanner/
# Note: not prefixed with a "v" as this seems to match nmap versioning standards
tags: "7.80,7.80-1,latest"
- uses: docker/build-push-action@v1
Expand All @@ -224,14 +261,23 @@ jobs:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/kube-hunter
path: ./integrations/kube-hunter/scanner/
path: ./scanner/kube-hunter/scanner/
# Note: not prefixed with a "v" as this matches the aquasec/kube-hunter tags
tags: "0.3.0,latest"
- uses: docker/build-push-action@v1
name: "Build & Push test-scan Scanner Image"
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: scbexperimental/test-scan
path: ./scanner/test-scan/scanner/
# Note: not prefixed with a "v" as this seems to match nmap versioning standards
tags: "latest"
integrationTests:
name: "Test / Integration / k8s ${{ matrix.k8sVersion }}"
needs:
- scannerImages
- persistenceImages
- hookImages
- parserImages
- operator
- lurcher
Expand Down Expand Up @@ -276,23 +322,37 @@ jobs:
cd tests/integration/
npm ci
# This steps should include Integration tests which are not related to a Specific Scanner
- name: "Generic Integration Tests"
- name: "Throws NoScanDefiniton Error Integration Tests"
run: |
cd tests/integration/
npx jest --ci --color no-scan-definition-error
- name: "Hooks Integration Tests"
run: |
helm -n integration-tests install update-category ./hooks/update-field/ \
--set="image.tag=sha-$(git rev-parse --short HEAD)" \
--set="attribute.name=category" \
--set="attribute.value=fancy-category"
helm -n integration-tests install update-severity ./hooks/update-field/ \
--set="image.tag=sha-$(git rev-parse --short HEAD)" \
--set="attribute.name=severity" \
--set="attribute.value=high"
helm -n integration-tests install test-scan ./scanner/test-scan/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
cd tests/integration/
npx jest --ci --color read-write-hook
helm -n integration-tests uninstall test-scan update-category update-severity
- name: "nmap Integration Tests"
run: |
helm -n integration-tests install nmap ./integrations/nmap/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
helm -n integration-tests install nmap ./scanner/nmap/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
cd tests/integration/
npx jest --ci --color nmap
- name: "kube-hunter Integration Tests"
run: |
helm -n integration-tests install kube-hunter ./integrations/kube-hunter/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
helm -n integration-tests install kube-hunter ./scanner/kube-hunter/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
cd tests/integration/
npx jest --ci --color kube-hunter
- name: "ssh-scan Integration Tests"
run: |
helm -n integration-tests install ssh-scan ./integrations/ssh_scan/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
helm -n integration-tests install ssh-scan ./scanner/ssh_scan/ --set="parserImage.tag=sha-$(git rev-parse --short HEAD)"
# Install dummy-ssh app
helm -n demo-apps install dummy-ssh ./demo-apps/dummy-ssh/ --wait
cd tests/integration/
Expand All @@ -304,6 +364,7 @@ jobs:
kubectl -n integration-tests get jobs -o wide
kubectl -n integration-tests get pods -o wide
- name: "Inspect Operator"
if: failure()
run: |
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get deployments
Expand Down
74 changes: 59 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img alt="secureCodeBox Logo" src="securecodebox-logo.svg" width="800px">
<img alt="secureCodeBox Logo" src="./docs/resources/securecodebox-logo.svg" width="800px">
</p>

<p align="center">
Expand All @@ -20,7 +20,9 @@
- [Purpose of this Project](#purpose-of-this-project)
- [Quickstart](#quickstart)
- [Prerequisites](#prerequisites)
- [Deployment](#deployment)
- [Deployment (based on Helm)](#deployment-based-on-helm)
- [Examples](#examples)
- [Access Services](#access-services)
- [How does it work?](#how-does-it-work)
- [Architecture](#architecture)
- [License](#license)
Expand Down Expand Up @@ -56,38 +58,80 @@ There is a german article about [Security DevOps – Angreifern (immer) einen Sc

- kubernetes (last 4 mayor releases supported: `1.15`, `1.16`, `1.17` & `1.18`)

### Deployment
### Deployment (based on Helm)

```bash
# Deploy secureCodeBox Operator
# Deploy the secureCodeBox Operator first
kubectl create namespace securecodebox-system
helm -n securecodebox-system install securecodebox-operator ./operator/

# Elasticsearch Persistence Provider Deployment
helm install persistence-elastic ./persistence/persistence-elastic/
# Deploy SCB scanner Charts for each security scanner you want to use (all optional)
helm upgrade --install amass ./integrations/amass/
helm upgrade --install kube-hunter ./integrations/kube-hunter/
helm upgrade --install nikto ./integrations/nikto
helm upgrade --install nmap ./integrations/nmap/
helm upgrade --install ssh-scan ./integrations/ssh_scan/
helm upgrade --install sslyze ./integrations/sslyze/
helm upgrade --install trivy ./integrations/trivy/
helm upgrade --install zap ./integrations/zap/
helm upgrade --install wpscan ./integrations/wpscan/

# Optional Deploy some Demo Apps for scanning
helm upgrade --install dummy-ssh ./demo-apps/dummy-ssh/

# Deploy secureCodeBox Hooks
helm upgrade --install aah ./hooks/add-attributes/
helm upgrade --install gwh ./hooks/generic-webhook/
helm upgrade --install issh ./hooks/imperative-subsequent-scans/

## Persistence Provider: Elasticsearch
helm upgrade --install elkh ./hooks/persistence-elastic/
```

# Deploy definitions for the integrated scanners
helm install amass ./integrations/amass/
helm install kube-hunter ./integrations/kube-hunter/
helm install nikto ./integrations/nikto
helm install nmap ./integrations/nmap/
helm install ssh-scan ./integrations/ssh_scan/
helm install sslyze ./integrations/sslyze/
helm install zap ./integrations/zap/
### Examples

```bash
# Now everything is installed. You can try deploying scans from the `operator/config/samples/` directory
## Local Scan Examples

### E.g. localhost nmap scan
kubectl apply -f operator/config/samples/execution_v1_scan/nmap_localhost.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/kube-hunter_in_cluster.yaml

## Public Scan Examples
# E.g. www.securecodebox.io sslyze scan
kubectl apply -f operator/config/samples/execution_v1_scan/nmap_securecodebox_io.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/amass_securecodebox_io.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/sslyze_securecodebox_io.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/nikto_securecodebox_io.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/ssh_iteratec_de.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/wpscan_nurdemteam_org.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/sslyze_securecodebox_io.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/trivy_mediawiki.yaml
kubectl apply -f operator/config/samples/execution_v1_scan/trivy_juiceshop.yaml

# Then get the current State of the Scan by running:
kubectl get scans
```

### Access Services

* Minio UI:
* AccessKey: `kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.accesskey}' | base64 --decode; echo`
* SecretKey: `kubectl get secret securecodebox-operator-minio -n securecodebox-system -o=jsonpath='{.data.secretkey}' | base64 --decode; echo`
* Port Forward Minio UI: `kubectl port-forward -n securecodebox-system service/securecodebox-operator-minio 9000:9000`
* Elastic / Kibana UI:
* User: `elastic`
* Password: `kubectl get secret scb-elasticsearch-es-elastic-user -n scb-analytics -o=jsonpath='{.data.elastic}' | base64 --decode; echo`
* Port Forward Kibana: `kubectl port-forward -n default service/persistence-elastic-kibana 5601:5601`
* Port Forward Elasticsearch: `kubectl port-forward -n default service/elasticsearch-master 9200:9200`


## How does it work?

## Architecture

![secureCodeBox Architecture](scb-architecture.svg)
![secureCodeBox Architecture](./docs/resources/scb-architecture.svg)

## License

Expand Down
1 change: 1 addition & 0 deletions docs/.gitkeep
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
theme: jekyll-theme-minimal
Loading