Skip to content

CLI run_scanner.sh #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Victor-Philipp-Negoescu wants to merge 2 commits into from
Closed

CLI run_scanner.sh #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8c8e1f
Moved docker ram hint to requirements section
MartinLang1 Oct 11, 2018
e2e94b7
CLI run_scanner.sh
Victor-Philipp-Negoescu Oct 12, 2018
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
6 changes: 2 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ There is a german article about [Security DevOps – Angreifern (immer) einen Sc
### Prerequisites
* Minimal Docker version 18.03.0 is required
* Docker-Compose is required.
* Your docker host will need at least 4GB virtual memory to run the complete stack. If you want to scale out the scanner you will need more...

For a quick start checkout this repository and start the complete secureCodeBox stack with docker-compose:

Expand All @@ -53,7 +54,7 @@ git clone https://github.com/secureCodeBox/secureCodeBox
cd secureCodeBox
```

### Start with Docker-Compose
### Start with docker-compose
The docker-compose.yml file can be used to launch a secureCodeBox instance.
To start the secureCodeBox and some demo targets run the following:

Expand All @@ -66,9 +67,6 @@ Running `docker-compose up` uses the default credentials specified in the [`.env
* `CAMUNDADB_USER` MySQL username used by the Camunda Engine
* `CAMUNDADB_PW` MySQL password also used by the Camunda Engine


> **Hint**: You will need at least 4GB virtual memory to run the complete stack. If you want to scale out the scanner you will need more...

### Run your first security scan
There are several ways to start a security scan with the secureCodeBox. One way is to use the WebUI of the engine and start the scan manually.

Expand Down
2 changes: 1 addition & 1 deletion cli/arachni.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
{
"name" : "Target",
"location" : "%HOST%"
"location" : "%TARGET%"
}
]

12 changes: 6 additions & 6 deletions cli/run_scanner.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,15 +149,15 @@ if [ ! -n "${PAYLOAD_OVERRIDE}" ] && [ $# -ne 2 ] || [ "${SHOW_HELP}" == true ];
echo ""
echo "Examples:"
echo " Perform a ZAP scan:"
echo " ./run_scanner.sh http://some.system/somepath mytenant zap"
echo " ./run_scanner.sh --tenant mytenant zap http://some.system/somepath"
echo " Perform an NMAP scan:"
echo " ./run_scanner.sh some.system mytenant nmap"
echo " ./run_scanner.sh --tenant mytenant nmap some.system"
echo " Perform an SSLyze scan using authentication:"
echo " ./run_scanner.sh --auth a2VybWl0OmE= some.system mytenant sslyze"
echo " ./run_scanner.sh --auth a2VybWl0OmE= --tenant mytenant sslyze some.system"
echo " Perform a Nikto scan using a different backend:"
echo " ./run_scanner.sh --backend http://some_scb_engine:8080 http://some_scb_elasticsearch:9200 some.system mytenant nikto"
echo " ./run_scanner.sh --backend http://some_scb_engine:8080 http://some_scb_elasticsearch:9200 --tenant mytenant nikto some.system"
echo " Perform a Arachni scan using a custom target config file"
echo " ./run_scanner.sh --payload payloadFile.json arachni"
echo " ./run_scanner.sh --payload payloadFile.json arachni http://some.system/somepath"

exit 1
fi
Expand Down Expand Up @@ -243,7 +243,7 @@ fi
if [ ! -n "${PAYLOAD_OVERRIDE}" ]; then
# Verify target format
if [ "${TARGET_FORMAT}" = "uri" ]; then
if [[ ! "${TARGET}" =~ http?(s)://* ]]; then
if [[ ! "${TARGET}" =~ http(s)?://* ]]; then
error "Invalid URI to scan: '${TARGET}'! Expected: http(s)://..."
NUM_ERRORS=$((NUM_ERRORS + 1))
else
Expand Down