From 136a665e86b254fef8fbe338e85704820e240f64 Mon Sep 17 00:00:00 2001 From: Ilyes Ben Dlala Date: Thu, 30 Sep 2021 13:55:44 +0200 Subject: [PATCH] Update out of date docs Signed-off-by: Ilyes Ben Dlala --- docs/contributing/integrating-a-hook.md | 27 ++++++++++++++-------- docs/contributing/integrating-a-scanner.md | 21 ++++++++++------- docs/scanners.md | 17 ++++++++------ 3 files changed, 40 insertions(+), 25 deletions(-) diff --git a/docs/contributing/integrating-a-hook.md b/docs/contributing/integrating-a-hook.md index 371c7304..8dc980f5 100644 --- a/docs/contributing/integrating-a-hook.md +++ b/docs/contributing/integrating-a-hook.md @@ -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): diff --git a/docs/contributing/integrating-a-scanner.md b/docs/contributing/integrating-a-scanner.md index c3dd7bba..6daac11e 100644 --- a/docs/contributing/integrating-a-scanner.md +++ b/docs/contributing/integrating-a-scanner.md @@ -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 @@ -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): diff --git a/docs/scanners.md b/docs/scanners.md index 08132768..eb9f1395 100644 --- a/docs/scanners.md +++ b/docs/scanners.md @@ -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)