8000 Update out of date documentation by Ilyesbdlala · Pull Request #126 · secureCodeBox/documentation · GitHub
[go: up one dir, main page]
Skip to content
This repository was archived by the owner on Sep 6, 2023. It is now read-only.

Update out of date documentation #126

Merged
J12934 merged 1 commit into from
Oct 1, 2021
Merged

Update out of date documentation #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files. Retry
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/contributing/integrating-a-hook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,27 @@ In the *secureCodeBox* we use Helm Charts for all our Resources to make the inst
The directory structure of a hook Helm Chart will look something like this:

```bash
├── Chart.yaml
├── Makefile
├── Dockerfile
├── hook.js
├── hook.test.js
├── package.json
├── package-lock.json
├── README.md
├── README.md.gotmpl
├── docs
│   ├── README.ArtifactHub.md
│   └── README.DockerHub-Hook.md
├── hook
│   ├── Dockerfile
│   ├── hook.js
│   ├── hook.test.js
│   ├── package.json
│   ├── package-lock.json
│   └── .dockerignore
├── templates
│   ├── finding-post-processing-hook.yaml
│   ├── _helpers.tpl
│   └── NOTES.txt
└── values.yaml
├── Chart.yaml
├── values.yaml
├── Makefile
├── README.md
├── .helm-docs.gotmpl
├── .helmignore
└── .gitignore
```

To create a new Helm Chart for your hook you can use the following command (replace *new-hook* with the name of the hook):
Expand Down
21 changes: 13 additions & 8 deletions docs/contributing/integrating-a-scanner.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ The directory structure of a scanner Helm Chart will look something like this:
scanners/nmap
├── cascading-rules
│   └── ...
├── Chart.yaml
├── docs
│   ├── README.ArtifactHub.md
│   ├── README.DockerHub-Parser.md
│   └── README.DockerHub-Scanner.md
├── examples
│   ├── demo-target-ssh
│   │   ├── findings.yaml
Expand All @@ -30,17 +33,19 @@ scanners/nmap
│   ├── parser.test.js
│   └── __testFiles__
│   └── ...
├── Makefile
├── README.md
├── README.md.gotmpl
├── scanner
│   ├── wrapper.sh
│   └── Dockerfile
├── templates
│   ├── cascading-rules.yaml
│   ├── nmap-parse-definition.yaml
│   └── nmap-scan-type.yaml
└── values.yaml
├── scanner
│   └── Dockerfile
├── Chart.yaml
├── values.yaml
├── Makefile
├── README.md
├── .helm-docs.gotmpl
├── .helmignore
└── .gitignore
```

To create a new Helm Chart for your scanner you can use the following command (replace *new-scanner* with the name of the scanner):
Expand Down
17 changes: 10 additions & 7 deletions docs/scanners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,13 @@ id: "scanners"
7. [Ncrack (Brute Force Authentication Aracking)](/docs/scanners/ncrack)
8. [Nikto (Webserver Scanner)](/docs/scanners/nikto)
9. [Nmap (Port Scanner)](/docs/scanners/nmap)
10. [Screenshooter](/docs/scanners/screenshooter)
11. [SSH (SSH Scanner by Mozilla)](/docs/scanners/ssh)
12. [SSLyze (SSL/TLS Config Scanner)](/docs/scanners/sslyze)
13. [Trivy (Container Vulnerability Scanner)](/docs/scanners/trivy)
14. [WPScan (WordPress Scanner)](/docs/scanners/wpscan)
15. [ZAP Advanced (Web Application Scanner)](/docs/scanners/zap-advanced)
16. [ZAP (Web Application Scanner)](/docs/scanners/zap)
10. [Nuclei (Template-based Scanner)](/docs/scanners/nuclei)
11. [Screenshooter](/docs/scanners/screenshooter)
12. [SSH (SSH Scanner by Mozilla)](/docs/scanners/ssh)
13. [SSLyze (SSL/TLS Config Scanner)](/docs/scanners/sslyze)
14. [Trivy (Container Vulnerability Scanner)](/docs/scanners/trivy)
15. [Typo3Scan (Typo3 Scanner)](/docs/scanners/typo3scan)
16. [WhatWeb (Web Scanner)](/docs/scanners/whatweb)
17. [WPScan (WordPress Scanner)](/docs/scanners/wpscan)
18. [ZAP Advanced (Web Application Scanner)](/docs/scanners/zap-advanced)
19. [ZAP (Web Application Scanner)](/docs/scanners/zap)
0