Download the relevant binary from the latest release and add it to your path.
curl -L -o as https://github.com/nullify-platform/attack-surface-scanner/releases/latest/download/as_linux_amd64
chmod +x as
sudo mv as /usr/local/bin
Usage: as [--verbose] [--debug] <command> [<args>]
Options:
--verbose, -v enable verbose logging
--debug, -d enable debug logging
--help, -h display this help and exit
--version display version and exit
Commands:
scan test the given app for vulnerabilities
Usage: as scan [--spec-path SPEC-PATH] [--target-host TARGET-HOST]
Options:
--spec-path SPEC-PATH
The file path to the OpenAPI file (both yaml and json are supported) e.g. ./openapi.yaml
--target-host TARGET-HOST
The base URL of the API to be scanned e.g. https://api.nullify.ai
Global options:
--verbose, -v enable verbose logging
--debug, -d enable debug logging
--help, -h display this help and exit
--version display version and exit
Example scan
as scan \
--spec-path openapi.yml \
--target-host http://localhost:8888
Example output
{
"withAuth": [
{
"method": "post",
"path": "/api/users",
"status": 401
}
],
"withoutAuth": [
{
"method": "get",
"path": "/api/users/{username}",
"status": 200
}
],
"errors": [
{
"method": "get",
"path": "/api/users/{username}/profile",
"status": 500
},
{
"method": "get",
"path": "/api/users/{username}/email",
"error": "connection closed"
}
]
}
withAuth
- endpoints that have authenticationwithoutAuth
- endpoints that do not have authenticationerrors
- any errors that occurred during the scan