Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Using the secureCodeBox

First startup

  1. Access the engine http://your-docker-host:8080/
  2. Choose your admin credentials.

Admin setup

First time login

  1. Access the engine http://your-docker-host:8080/
  2. Access the admin login from the dropdown menu behind the 🏠 in the top right corner

Admin Section

  1. Use the following credentials for your first login:
Username: choosen Username
Password: choosen Password
  1. Navigate to the user management via the top bar

User management

  1. Select the TODO account
  2. Select Accountfrom the left panel
  3. Change the default logins for the TODO account
  4. Create new users via user management as shown in step 4

Starting Scan-Processes using the Camunda UI

  1. After logging in via http://your-docker-host:8080/, the welcome screen will be displayed. From here you can start the different Camunda Web Apps.
  • Cockpit is used for monitoring running and ended process instances.
  • Admin is used for managing users, groups and authorizations.
  • Tasklist is used for user tasks and starting processes.

Camunda Welcome Screen

  1. Click on Tasklist to see the list of open tasks.

Camunda Tasklist Screen

  1. Next select Start process to open the list of available processes.

List of process definitions

  1. Choose the desired scan process to display the form for configuring the scan. In this example Port Scan has been used.

Configure a scan

  1. Finally, start the scan process by clicking Start.

Note: A more detailed guide for the Camunda UI can be found here.

Configuring Persistence Providers

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.

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.

Starting securityTests using 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.

The scanning target is set within the payload. A securityTest running a nmap port scan woud look like this:

[
  {
    "name": "nmap",
    "context": "Feature Team 1",
    "target": {
      "name": "example.com website",
      "location": "example.com",
      "attributes": {
        "NMAP_PARAMETER": "-Pn"
      }
    }
  }
]

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

In Depth Scan Examples

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

  1. Scanning modern Single Page Applications like OWASP Juice Shop using Arachni
  2. Scanning Server Rendered Applications like BodgeIt Store using Arachni
  3. Scanning Server Rendered Applications like BodgeIt Store using OWASP ZAP

Starting Scan-Processes using the CLI

We have introduced a simple secureCodeBox CLI which is based on the REST-API. This CLI can be used to configure and start Scan-Process or to integrate with you CI/CD Pipeline (e.g. Jenkins).