go install github.com/filewalkwithme/impl@latest
go generate ./...cd cmd/vulcan-api
go install
vulcan-api -c ../../_resources/config/local.tomlThe Vulcan API needs a Postgres database and an Authentication service (SAML provider). Run the commands bellow to launch the Docker containers we need:
- Keycloak
- Postgres
- PgAdmin
# navigate to the contri/dev folder
cd contrib/dev
# launch dependencies
./setup-dependencies.shAfter having the dependencies ready, start the Vulcan API using the
local-dev.toml file, which is already configured to point to
dependencies we set in the previous step. Remember to re-run this
step every time you modify the Vulcan API.
# run the API using the local dev config file
./run.sh local-dev.tomlIf you want to clean up your environment, run the following command to
destroy the Docker containers launched by setup-dependencies.sh
# destroy all containers created by setup-dependencies.sh
./teardown.shThose are the variables you have to setup:
| Variable | Description | Sample |
|---|---|---|
| PORT | 8080 | |
| SECRET_KEY | SUPERSECRETSIGNKEY | |
| COOKIE_DOMAIN | localhost | |
| PG_HOST | localhost | |
| PG_NAME | vulcanito | |
| PG_USER | vulcanito | |
| PG_PASSWORD | vulcanito | |
| PG_PORT | 5432 | |
| PG_SSLMODE | One of these (disable,allow,prefer,require,verify-ca,verify-full) | disable |
| PG_CA_B64 | A base64 encoded ca certificate | |
| LOG_LEVEL | ERROR, WARN, INFO or DEBUG (default INFO) | |
| SAML_MEATADATA | ||
| SAML_ISSUER | ||
| SAML_CALLBACK | http://localhost:8080/api/v1/login/callback | |
| SAML_TRUSTED_DOMAINS | ["localhost"] | |
| SCANENGINE_URL | http://localhost:8081/v1/ | |
| SCHEDULER_URL | http://localhost:8082/ | |
| SQS_POLLING_INTERVAL | 10 | |
| SQS_WAIT_TIME | 20 | |
| SQS_TIMEOUT | 3600 | |
| SQS_QUEUE_ARN | arn:aws:sqs:xxx:123456789012:yyy | |
| AWS_SQS_ENDPOINT | Optional | |
| REPORTS_SNS_ARN | arn:aws:sns:xxx:123456789012:yyy | |
| AWS_SNS_ENDPOINT | Optional | |
| REPORTS_API_URL | http://localhost:8084 | |
| PERSISTENCE_HOST | persistence.vulcan.example.com | |
| VULNERABILITYDB_URL | http://localhost:8083 | |
| SCAN_REDIRECT_URL | Redirecting URL for reports, OPTIONAL | https://insights-redirect.vulcan.s3-xxx.amazonaws.com/index.html?reportUrl= |
| VULCAN_UI_URL | Vulcan UI base URL for Digest report link | http://localhost:1234 |
| GPC_${i}_NAME | Specify the name of the global policy that the ${i} ALLOW/BLOCK list will apply. Rquired if any ALLOW/BLOCK list is specified. | web-scanning-global |
| GPC_${i}_ALLOWED_ASSETTYPES | Specify an array of allowed assettypes for the specified global policy. Optional. | [] |
| GPC_${i}_BLOCKED_ASSETTYPES | Specify an array of blocked assettypes for the specified global policy. Optional. | [] |
| GPC_${i}_ALLOWED_CHECKS | Specify an array of allowed checks for the specified global policy. Optional. | ["vulcan-zap","vulcan-burp"] |
| GPC_${i}_BLOCKED_CHECKS | Specify an array of blocked checks for the specified global policy. Optional. | ["vulcan-masscan"] |
| GPC_${i}_EXCLUDING_SUFFIXES | Specify an array of suffixes for checks to be excluded. Optional. | ["experimental"] |
First we have to build the vulcan-api because the build only copies the file.
We need to provide linux compiled binary to the docker build command. This won't be necessary when this component has been open sourced.
For now, we need to do some extra steps:
./build.sh
docker build . -t va
# Use the default config.toml customized with env variables.
docker run --env-file ./local.env va
# Or set the env variables one by one....
docker run --env PORT=8888 ......... ./local.env va
# Use custom config.toml
docker run -v `pwd`/custom.toml:/app/config.toml va