schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
yippee-ki-json_config_schema.json | ruleValidate | JSON Schema validate | {"type": "object", "properties": {"name": {"type": "string", "const": "validate"}, "path": {"type": "string", "const": "$"}, "params": {"type": "object", "properties": {"schema": {"allOf": [{}, {}]}, "onFailure": {"type": "object", "properties": {"transformation": {"type": "string", "enum": ["ABORT", "SKIP_REST", "CONTINUE"], "additionalItems": false}, "violation": {"type": "string", "enum": ["LOG_ONLY", "COMMENT_JSON", "IGNORE"], "additionalItems": false}}, "required": ["transformation", "violation"], "additionalProperties": false}}, "required": ["onFailure", "schema"], "additionalProperties": false}}, "required": ["name", "params", "path"], "additionalProperties": false} |
yippee-ki-json_config_schema.json | name | The name of the component. | {"type": "string", "const": "validate"} |
yippee-ki-json_config_schema.json | path | Must be the root JSON Path as the validator cannot work on sub-schema. | {"type": "string", "const": "$"} |
yippee-ki-json_config_schema.json | params | Additional parameters of the rule. | {"type": "object", "properties": {"schema": {"allOf": [{}, {}]}, "onFailure": {"type": "object", "properties": {"transformation": {"type": "string", "enum": ["ABORT", "SKIP_REST", "CONTINUE"], "additionalItems": false}, "violation": {"type": "string", "enum": ["LOG_ONLY", "COMMENT_JSON", "IGNORE"], "additionalItems": false}}, "required": ["transformation", "violation"], "additionalProperties": false}}, "required": ["onFailure", "schema"], "additionalProperties": false} |
yippee-ki-json_config_schema.json | schema | The supplier providing the schema we will use for validation. | {} |
yippee-ki-json_config_schema.json | transformation | Defines how the transformation should handle a validation failure. | {"type": "string", "enum": ["ABORT", "SKIP_REST", "CONTINUE"], "additionalItems": false} |
yippee-ki-json_config_schema.json | violation | Defines how the rule should document/report the violations. | {"type": "string", "enum": ["LOG_ONLY", "COMMENT_JSON", "IGNORE"], "additionalItems": false} |
yippee-ki-json_config_schema.json | name | The name of the rule. | {"type": "string", "enum": ["add", "calculate", "copy", "delete", "deleteFrom", "rename", "replace", "replaceMap", "validate"], "additionalItems": false} |
yippee-ki-json_config_schema.json | params | The optional parameter map to allow configuration of the selected rule. | {"type": "object"} |
yippee-ki-json_config_schema.json | actionName | The name of the action (rule list) to allow selecting it when we want to start transformation. | {} |
yippee-ki-json_config_schema.json | rules | The array of rules representing the sequentially triggered steps of the transformation action. | {"type": "array", "items": {}, "minItems": 1, "additionalItems": false} |
yippee-ki-json_config_schema.json | actions | The array of transformation action we will be able to select from at startup. | {"type": "array", "items": {}, "minItems": 1, "additionalItems": false} |
nodehawkrc.json | paths | A string or an array of paths to watch. Supports globbing. | {"default": "./src", "examples": ["./src"], "oneOf": [{"type": "string", "default": "./src"}, {"type": "array", "default": ["./src"], "items": {"type": "string"}}]} |
nodehawkrc.json | root | The root path from which all other paths will be resolved. | {"type": "string", "default": ".", "examples": ["."]} |
nodehawkrc.json | ignored | Paths, globs or regular expressions to ignore. | {"type": "string", "default": ""} |
nodehawkrc.json | exec | The command to execute on file change. | {"type": "string", "default": "", "examples": ["babel-node src/server", "ts-node src/server"]} |
nodehawkrc.json | port | The port on which the server should run. This is passed to your application as `process.env.PORT` which should be used by you. | {"type": "integer", "default": 4000} |
nodehawkrc.json | logLevel | The level of logging. 0 - fatal, 1 - error, 2 - warning, 3 - info, 4 - debug | {"type": "integer", "default": 3} |
nodehawkrc.json | buffer | The buffer duration to wait before triggering a restart. | {"type": "integer", "default": 1500} |
nodehawkrc.json | bufferPoll | The buffer polling interval to check for the file stability. | {"type": "integer", "default": 100} |
nodehawkrc.json | display | The various messages to display during different events. | {"type": "object", "properties": {"onBeforeStart": {"type": "string", "default": "Starting..."}, "onStart": {"type": "string", "default": "Started"}, "onBeforeRestart": {"type": "string", "default": "Restarting..."}, "onRestart": {"type": "string", "default": "Restarted"}, "onBeforeStop": {"type": "string", "default": "Stopping..."}}} |
nodehawkrc.json | onBeforeStart | The message to display before the watcher starts. | {"type": "string", "default": "Starting..."} |
nodehawkrc.json | onStart | The message to display after the watcher starts. | {"type": "string", "default": "Started"} |
nodehawkrc.json | onBeforeRestart | The message to display before the watcher restarts. | {"type": "string", "default": "Restarting..."} |
nodehawkrc.json | onRestart | The message to display after the watcher restarts. | {"type": "string", "default": "Restarted"} |
nodehawkrc.json | onBeforeStop | The message to display before the watcher stops. | {"type": "string", "default": "Stopping..."} |
nodehawkrc.json | clearScreen | Clear the screen on start and on every restart. | {"type": "boolean", "default": true} |
nodehawkrc.json | env | A set of key-value pairs which will be promptly passed on to your process and accessible via `process.env`. | {"type": "object", "default": {}} |
hawkconfig.json | hawk | Parameters for scanner runtime and how it should look for vulnerabilities. | {} |
hawkconfig.json | app | **Required** Parameters for the target application and specifics for how it should be scanned. | {} |
hawkconfig.json | hawkAddOn | Parameters for additional HawkScan add-ons. | {} |
hawkconfig.json | tags | Searchable keywords to associate with this scan | {"type": "array", "items": {}} |
hawkconfig.json | spider | Spider configuration | {} |
hawkconfig.json | startupTimeoutMinutes | Maximum time in minutes to wait for the scanner process to start | {"type": "number", "exclusiveMinimum": 0} |
hawkconfig.json | failureThreshold | The lowest alert level that returns a failed scan status. Accepted values: high, medium, or low | {"type": "string", "pattern": "\\b(?:high|medium|low|HIGH|MEDIUM|LOW)\\b"} |
hawkconfig.json | scan | Scan Configuration | {} |
hawkconfig.json | config | Scanner configuration overrides, provided as a list of strings. | {"type": "array", "items": {"type": "string", "pattern": "^([a-zA-Z0-9]*\\.)*([a-zA-Z_$0-9])+=.*$"}} |
hawkconfig.json | outboundProxy | Configuration for an outbound proxy | {} |
hawkconfig.json | base | Enable the basic web crawler for discovering your application’s routes. This spider is appropriate for most traditional web applications. | {"type": "boolean", "default": true} |
hawkconfig.json | ajax | Enable the ajax web crawler for discovering your application’s routes. This spider is appropriate for single-page web applications. | {"type": "boolean", "default": true} |
hawkconfig.json | maxDurationMinutes | Maximum allowed time for enabled spiders to crawl your web application. defaults to 5 | {"type": "number", "exclusiveMinimum": 0} |
hawkconfig.json | ajaxBrowser | The browser to type and style to use when running the AjaxSpider. This value is ignored when running the hawkscan docker container and use's the default FIREFOX_HEADLESS. | {"type": "string", "enum": ["FIREFOX_HEADLESS", "CHROME_HEADLESS", "FIREFOX", "CHROME"]} |
hawkconfig.json | seedPaths | List of seed paths to add to the site tree. Will be crawled in addition to the root of the application. Used to add unreachable paths to the scanner. | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | custom | {} |
|
hawkconfig.json | postmanConfig | {} |
|
hawkconfig.json | apikey | api key to authenticated the user with Postman | {"type": "string"} |
hawkconfig.json | collectionUID | Id of the collection to be pulled from Postman | {"type": "string"} |
hawkconfig.json | filePath | File path of the Postman collection | {"type": "string"} |
hawkconfig.json | maxDurationMinutes | Maximum duration that a scan will run. | {"type": ["number", "string"], "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | maxRuleDurationMinutes | Maximum duration that a scan will spend on a rule. | {"type": ["number", "string"], "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | requestDelayMillis | Delay time between sending requests. | {"type": ["number", "string"], "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | concurrentRequests | Number of request threads. _If you need that little extra push._ defaults to 20 | {"type": ["number", "string"], "exclusiveMinimum": 0, "pattern": "^([0-9][0-9]+|[1-9])$"} |
hawkconfig.json | throttlePassiveBacklog | Pause active scan when passive backlog is greater than this value, resumes once backlog is empty. defaults to 50 | {"type": ["number", "string"], "exclusiveMinimum": 0, "pattern": "^([0-9][0-9]+|[1-9])$"} |
hawkconfig.json | policyName | Name of the scan policy to use. This field is optional and defaults will be selected if omitted | {"type": "string"} |
hawkconfig.json | includedPlugins | Specify to only run scan on the listed plugins | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | host | **Required**. The host of the outbound proxy | {"type": "string"} |
hawkconfig.json | credentials | Credentials for logging into the proxy | {} |
hawkconfig.json | username | **Required**. The username for proxy credentials | {"type": "string"} |
hawkconfig.json | password | **Required**. The password for proxy credentials | {"type": "string"} |
hawkconfig.json | realm | Realm for proxy credentials | {"type": "string"} |
hawkconfig.json | scheme | Scheme of auth: BASIC, NTLM, | {"type": "string"} |
hawkconfig.json | host | **Required** The base url of the application to scan ex: `http://localhost:8000`. If the url cannot be reached, the scan will not proceed. | {"type": "string", "pattern": "(?:(?:https?|ftp|file):\\/\\/|www\\.|ftp\\.)(?:\\([-\\w\\d+&@#\\/%=~_|$?!:,.]*\\)|[-\\w\\d+&@#\\/%=~_|$?!:,.])*(?:\\([-\\w\\d+&@#\\/%=~_|$?!:,.]*\\)|[\\w\\d+&@#\\/%=~_|$])"} |
hawkconfig.json | sessionTokens | The names of any session tokens used by your application, provided as an array of strings (Hint: these are the names of session cookies used by your application). | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | antiCsrfParam | The name of your CSRF security parameter used in any application form inputs. Globally set, HawkScan will parse this parameter value from form responses to use in subsequent requests. | {"type": "string"} |
hawkconfig.json | authentication | Authenticated scan configuration | {} |
hawkconfig.json | excludePaths | An array of strings, used as regexes to match against routes that should be ignored entirely by HawkScan. This field is useful for prohibiting asset directories or other resources that don’t require vulnerability scanning. (TODO: ADD EXAMPLE) | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | applicationId | **Required**. The `applicationId` of an application from the StackHawk platform | {"type": "string", "pattern": "\\b[0-9a-f]{8}\\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\\b[0-9a-f]{12}\\b"} |
hawkconfig.json | env | **Required**. The `env` environment name to organize Scan Results | {"type": "string"} |
hawkconfig.json | graphqlConf | GraphQL API scanner parameters. | {} |
hawkconfig.json | includePaths | An array of strings, used as regexes to constrain the application routes HawkScan will specifically visit. This field is useful for constraining the reach of the HawkScan scanner and spider. (TODO: add examples) | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | autoPolicy | Set to `true` to enable an optimized policy when scanning specific APIs like GraphQL and OpenAPI. Defaults to True | {"type": "boolean"} |
hawkconfig.json | autoInputVectors | Set to `true` to automatically enabled the correct input data types when scanning API’s like GraphQL and OpenAPI. This can increase scan accuracy and reduce false positives. Defaults to True | {"type": "boolean"} |
hawkconfig.json | openApiConf | OpenApi scanner parameters. | {} |
hawkconfig.json | soapConf | SOAP API scanner parameters. | {} |
hawkconfig.json | grpcConf | gRPC scanner parameters | {} |
hawkconfig.json | inputVectors | Fine grained control of injectable input vectors | {} |
hawkconfig.json | waitForAppTarget | Adds a wait time for app to startup | {} |
hawkconfig.json | redact | Specification for additional redaction of words in the scan logs | {} |
hawkconfig.json | usernamePassword | Optional configuration specifying a username and password based authentication configuration. Do not configure if using `external`. | {} |
hawkconfig.json | external | Optional configuration block for specifying an externally supplied authorization token. Do not configure if using `usernamePassword`. | {} |
hawkconfig.json | script | Optional configuration block for using an authentication script. | {} |
hawkconfig.json | tokenExtraction | Optional configuration block for extracting the authorization token from the authentication response. | {} |
hawkconfig.json | cookieAuthorization | Optional configuration specifying if authorization is maintained via a cookie session. Do not configure if using `tokenAuthorization`. | {} |
hawkconfig.json | tokenAuthorization | Optional configuration telling HawkScan how to pass the authorization token to your application on each request to maintain authorized access. Do not configure if using `cookieAuthorization`. | {} |
hawkconfig.json | sessionScript | Optional configuration for using a session management script. | {} |
hawkconfig.json | loggedInIndicator | **Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is still logged in to the app, provided as a string (ex. `"\\Qsigned in as\\E"`). | {"type": "string"} |
hawkconfig.json | loggedOutIndicator | **Required**. A regex to match against http responses from pages in the web application to determine if the scanned pages user session is logged out of the app, provided as a string | {"type": "string"} |
hawkconfig.json | testPath | A configuration block specifying how to verify authentication/authorization is working | {} |
hawkconfig.json | loginPagePath | The path to your login form, if applicable. This is an optional path but is often required if the `POST` to the loginPath requires an anti csrf token to be passed as part of the `POST`. The `app.antiCsrfParam` will be extracted from the response body of a GET request to this page. | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | loginPath | **Required** login route to `POST` credentials for a user in the application (ex. `/login`). An http `POST` request using the type specified will be made to this path. | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | usernameField | **Required** the username html field used in your application form or json, provided as a string. | {"type": "string"} |
hawkconfig.json | passwordField | **Required** The password html field used in your application form or json, provided as a string. | {"type": "string"} |
hawkconfig.json | scanUsername | *Required** The username credentials provided to authentication when attempting to login to the web application, provided as a string.
HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_USERNAME:admin}" will use the $SCAN_USERNAME environment variable as the scanUsername, or fallback to admin). | {"type": "string"} |
hawkconfig.json | scanPassword | *Required** The password credentials provided to authentication when attempting to login to the web application, provided as a string.
HawkScan best practices recommend using [environment variable runtime overrides](https://docs.stackhawk.com/hawkscan/configuration/#environment-variable-runtime-overrides) for this value (ex. "${SCAN_PASSWORD}" will use the $SCAN_PASSWORD environment variable as the scanPassword). | {"type": "string"} |
hawkconfig.json | type | An enum value describing the type of `POST` data expected by the `loginPath` | {"type": "string", "enum": ["FORM", "JSON", "HTTP"]} |
hawkconfig.json | otherParams | Other request parameters required by your login payload, provided as an array of objects with `name` and `value` string keys. This setting is helpful if your authentication process requires other parameters included in the form POST besides the username and password parameters. If in doubt, this setting can be safely left unconfigured. | {"type": "array", "items": {}} |
hawkconfig.json | realm | Realm for NTLM authentication | {"type": "string"} |
hawkconfig.json | name | {"type": "string"} |
|
hawkconfig.json | val | {"type": "string"} |
|
hawkconfig.json | type | Specifies the type of token being supplied. If `COOKIE` is specified the .external.value should be in the form of a cookie value <cookie-name>=<cookie-value> . Defaults to `Token`. | {"type": "string", "enum": ["TOKEN", "COOKIE"]} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.