From dc6b1dd915bdb07c6e0516db5bd236af8830a6f1 Mon Sep 17 00:00:00 2001 From: Toni de la Fuente Date: Tue, 9 Jan 2018 15:13:12 -0500 Subject: [PATCH] Added how to add Custom Checks --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index ee60e09a..bb623fbf 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - [Screenshots](#screenshots) - [Troubleshooting](#troubleshooting) - [Extras](#extras) +- [Add custom checks](#custom checks) ## Description @@ -593,3 +594,12 @@ or to run just one of the checks, to see if you have S3 buckets open: ``` ./prowler -c extraNUMBER ``` + +## Custom Checks + +In order to add any new check feel free to create a new extra check in the extras section. +To do so, you will need to follow this steps: +1 - use any existing extra check as reference +2 - add `ID7N` and `TITLE7N`, where N is a new check number part of the extras section (7) around line 361 `# List of checks IDs and Titles` +3 - add your new extra check function name at `callCheck` function (around line 1817) and below in that case inside extras option (around line 1853) +4 - finally add it in `# List only check tittles` around line 1930