Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ env:
- DEFAULT_TAG=develop
script:
- cp test/.env.test .env
- docker-compose -f docker-compose.yml -f docker-compose.demo.yml up -d engine camundadb bodgeit juice-shop nginx scanner-infrastructure-nmap scanner-webapplication-arachni scanner-webapplication-zap scanner-infrastructure-amass scanner-webapplication-sslyze scanner-webserver-nikto
- docker-compose -f docker-compose.yml -f docker-compose.demo.yml up -d engine camundadb bodgeit juice-shop nginx scanner-infrastructure-nmap scanner-webapplication-arachni scanner-webapplication-zap scanner-infrastructure-amass scanner-webapplication-sslyze scanner-webserver-nikto scanner-infrastructure-ssh
- cd test
- npm ci
- npm test -- --verbose --forceExit
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

![secureCodeBox](docs/resources/logo.png "secureCodeBox")

> _secureCodeBox_ is a docker based, modularized toolchain for continuous security scans of your software project. It's goal is to orchestrate and easily automate a bunch of security-testing tools out of the box.
> _secureCodeBox_ is a docker based, modularized toolchain for continuous security scans of your software project. Its goal is to orchestrate and easily automate a bunch of security-testing tools out of the box.

## Overview

Expand Down
14 changes: 14 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,20 @@ services:
- ENGINE_ADDRESS=http://engine:8080
- ENGINE_BASIC_AUTH_USER=${ENGINE_SCANNERSERVICES_USER}
- ENGINE_BASIC_AUTH_PASSWORD=${ENGINE_SCANNERSERVICES_PASSWORD}

scanner-infrastructure-ssh:
image: securecodebox/ssh:${DEFAULT_TAG}
depends_on:
engine:
condition: service_healthy
networks:
- frontend
labels:
container_group: scanner
environment:
- ENGINE_ADDRESS=http://engine:8080
- ENGINE_BASIC_AUTH_USER=${ENGINE_SCANNERSERVICES_USER}
- ENGINE_BASIC_AUTH_PASSWORD=${ENGINE_SCANNERSERVICES_PASSWORD}

persistence-elasticsearch:
image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.3.1
Expand Down
17 changes: 14 additions & 3 deletions docs/user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
Username: choosen Username
Password: choosen Password
```

4. You are now logged in. Additional users can be created in the user managment section. New users are created without any permissions by default. They are not even permitted to log in. This can be changed by assigning them to the pre-exsisting groups or by granting them the required permission individually.

![User management](../resources/userManagement.png)
Expand Down Expand Up @@ -56,11 +57,15 @@ Password: choosen Password

The secureCodeBox can save the security tests results into different data stores. A list with all availible stores and how to configure and use them can be found [here](./persistence/README.md).

## Meta Fields and How to use them
## Starting securityTests

MetaFields can be used to tag security tests with custom data relevant for you. We have encountered some data values which we found paticulary usefull and standardized their format to be used in multiple places. The list and formats can be found [here](./metafields/README.md).
### Starting securityTests using the UI

When a scan is started via the Camunda UI, the scan is considered to be a manual scans. This means that its results has to be confirmed before they it gets persisted by the configured persistence provider (e.g. elasticsearch). The results will show up in the tasklist and will get persistet once their the task has been marked as completed.

### Starting securityTests using the REST-API

## Starting securityTests using the REST-API
When a scan is started via the REST-API, the scan is considered to be automated. This means that the results will get automatically persisted into the configured perssitence provider (e.g. elasticsearch). The results of the securityTest will however **not** show up in the tasklist. The securityTest will be completed directly and the results are only availible via the persistence provider or by accessing it via the Rest-API.

In order to start a scan via the REST-API, send a PUT-Request to the following URL:
`<<Engine_Address>>/box/securityTests`.
Expand All @@ -85,6 +90,12 @@ The scanning target is set within the payload. A securityTest running a nmap por

You can check out a more detailed API documentation in the Swagger Docs of the secureCodeBox Engine. The Swagger Docs come together with the secureCodeBox Engine. You can access it at `<<Engine_Address>>/swagger-ui.html`. If you dont have one running yet you can look at the staticly exported version of it here: [Static API Docs](../developer-guide/api-doc.md)

#### Meta Fields and How to use them

MetaFields can be used to tag security tests with custom data relevant for you. We have encountered some data values which we found paticulary usefull and standardized their format to be used in multiple places. The list and formats can be found [here](./metafields/README.md).

MetaFields can currently only be set via the rest api. See the swagger docs for how to set them.

### In Depth Scan Examples

The following links contain completes examples and explanations how to set up and start scans against demo application.
Expand Down
Loading