README.md

Scanning your application with StackHawk

For more information about StackHawk see https://www.stackhawk.com

TL;DR

1. Create an application on the StackHawk Web platform.
2. Clone this repo or copy the stackhawk-basic.yml or stackhawk-default.yml configuration file and place in the root of your project directory.

Configuration

HawkScan uses a YAML configuration file to supply operational settings to the scanner. To get started:

• Place the appropriate stackhawk.yml file in the root of your project directory.
• Udpate your applicationId and env with the values from the StackHawk Platform.
• Update the host field with the url of your running web app (example: http://localhost:3000)

For more help configuring Hawkscan, see our Documentation.

Running the scanner

Bash

docker run --rm -v $(pwd):/hawk:rw -e API_KEY=hawk.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxx -t stackhawk/hawkscan:latest stackhawk-basic.yml

Windows CLI

docker run --rm -v %cd%:/hawk -e API_KEY=hawk.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxx -t stackhawk/hawkscan:latest stackhawk-basic.yml

PowerShell

docker run --rm -v ${PWD}:/hawk -e API_KEY=hawk.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxx -t stackhawk/hawkscan:latest stackhawk-basic.yml

Linux

docker run --rm -v $(pwd):/hawk:rw -network host -e API_KEY=hawk.xxxxxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxx -t stackhawk/hawkscan:latest stackhawk-basic.yml