schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
hawkconfig.json | values | The value pairs containing the token that will authorize requests. How the token is passed to your application is determined by the assigned `type`. | {"type": "array", "items": {}} |
hawkconfig.json | name | The name of the authentication script specified in the hawkAddOn.scripts.name | {"type": "string"} |
hawkconfig.json | parameters | The parameters required for the authentication script. | {} |
hawkconfig.json | credentials | The credentials required for the authentication script. These values will be redacted. | {} |
hawkconfig.json | type | Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`. | {"type": "string", "enum": ["TOKEN_PATH", "HEADER_NAME"]} |
hawkconfig.json | value | *Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token.
Example: if the authentication response JSON payload looks like `{"auth" : {"token": "<my-auth-token>"}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: <my-token>`, then the value should be `AuthToken`. | {"type": "string"} |
hawkconfig.json | cookieNames | A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application. | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | type | An enum value representing how to pass the authorization token to your application.
`HEADER` indicates that each request should have the authorization token header added to the requests.
`QUERY_PARAM` indicates that the token should be passed as a query parameter. | {"type": "string", "enum": ["HEADER", "QUERY_PARAM"]} |
hawkconfig.json | value | **Required** The name of the `HEADER` or `QUERY_PARAM` the token should be passed as. | {"type": "string"} |
hawkconfig.json | name | The name of the session script specified in the hawkAddOn.scripts.name | {"type": "string"} |
hawkconfig.json | parameters | The parameters required for the session script. | {} |
hawkconfig.json | type | An enum value representing what to match against in the response from issuing a GET request to the `testPath.path`. The supported values are `HEADER` and `BODY`. | {"type": "string", "enum": ["HEADER", "BODY"]} |
hawkconfig.json | path | **Required**. The path to a protected route in your application that requires authorization. For example `/mysettings`. A `GET` request will be made to this path using the configured authentication. | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | success | A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.
A match of the regex supplied will indicate that scanning should proceed with the specified authentication. | {"type": "string"} |
hawkconfig.json | fail | A regex that will match against the response header or body, specified by `type`, of the GET request to the `path`.
A match of the regex supplied will indicate that scanning should halt and enter an error state. | {"type": "string"} |
hawkconfig.json | requestMethod | Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. | {"type": "string", "enum": ["GET", "POST", "PUT"]} |
hawkconfig.json | requestBody | The request content to send along with POST or PUT requests for authentication verification. | {"type": "string"} |
hawkconfig.json | requestHeaders | List of key/value pairs to be included as headers in the request to the `path`.
Headers that match the following pattern are unable to be added or modified `'^(Host|Origin|Proxy-.*|Sec-.*|Content-Length)'`. | {} |
hawkconfig.json | schemaPath | Path to the GraphQL introspection endpoint, relative to the target URI | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | requestMethod | Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. | {"type": "string", "enum": ["POST", "GET"]} |
hawkconfig.json | uriMaxLength | Max length of URIs when generation queries for GET requests. | {"type": ["number", "string"], "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | maxDepth | Maximum depth for generated query graphs | {"type": ["number", "string"], "exclusiveMinimum": 0, "maximum": 50, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | enabled | Enable GraphQL scan support. HawkScan will enumerate all possible field types and input values for GraphQL Queries and Mutations. Provide relative path to the API endpoint. | {"type": "boolean"} |
hawkconfig.json | operation | GraphQL operation to enumerate and scan. Defaults to find all Query and Mutation operations. | {"type": "string", "enum": ["ALL", "QUERY", "MUTATION"]} |
hawkconfig.json | filePath | Relative path to a JSON formatted GraphQL schema (default: None) | {"type": "string"} |
hawkconfig.json | excludeOperations | GraphQL operations to exclude from the spider | {"type": "array", "items": {}} |
hawkconfig.json | fakerEnabled | Enables faker for a GraphQL scan to generate more realistic values when format is provided on the API spec or custom variables. | {"type": "boolean"} |
hawkconfig.json | customVariables | Define custom variables and values for use in GraphQL scanning. | {"type": "array", "items": {}} |
hawkconfig.json | name | {"type": "string"} |
|
hawkconfig.json | type | {"type": "string", "enum": ["ALL", "QUERY", "MUTATION"]} |
|
hawkconfig.json | field | The field name of the param to inject values into | {"type": "string"} |
hawkconfig.json | values | A list of possible values to be randomly selected for the given field | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | operationName | An optional operationName that will only inject custom values if the name of the operation on the request matches | {"type": "string"} |
hawkconfig.json | operationType | An optional GraphQL operation type (MUTATION or QUERY) that will inject custom values only when the request matches the operation type | {"type": "string", "enum": ["ALL", "QUERY", "MUTATION"]} |
hawkconfig.json | path | A string relative path to an OpenAPI specification file (JSON or YAML) from the specified app.host | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | filePath | Relative path to specification file(s) (JSON or YAML).
The path is relative to the `/hawk` mount point specified by the `-v` docker run argument. ie: `docker run -v $(pwd):/hawk`. | {"type": "string"} |
hawkconfig.json | inline | Define your openapi specification yaml inlined as a string. | {"type": "string"} |
hawkconfig.json | strict | Enable strict parsing of the openapi. | {"type": "boolean"} |
hawkconfig.json | customVariables | Define custom variables and values for use in REST API scanning. | {"type": "array", "items": {}} |
hawkconfig.json | includeAllMethods | When custom variables are provided, DELETE's are skipped for injection. Set this to true to override this default and include all methods in variable injection. | {"type": "boolean"} |
hawkconfig.json | includedMethods | List of methods to include in custom variable injection. Note: if 'includeAllMethods' is set to true, this list is ignored and all methods will be used for custom variable injection. | {"type": "array", "items": {"type": "string", "enum": ["POST", "PUT", "DELETE", "GET", "OPTIONS", "PATCH", "HEAD"]}} |
hawkconfig.json | fakerEnabled | Enables faker for a REST API scan to generate more realistic values when format is provided on the API spec or custom variables. | {"type": "boolean"} |
hawkconfig.json | maxAliasesForCollections | Maximum number of aliases for a collection when parsing YAML.
Increase this value if you see the error "Number of aliases for non-scalar nodes exceeds the specified max=100" | {"type": ["number", "string"], "default": 100, "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | field | The field name of the param to inject values into | {"type": "string"} |
hawkconfig.json | values | A list of possible values to be randomly selected for the given field | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | path | An optional path regex that will only inject custom values if the path of the request matches | {"type": "string"} |
hawkconfig.json | requestMethods | A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods. | {"type": "array", "items": {"type": "string", "enum": ["POST", "PUT", "DELETE", "GET", "OPTIONS", "PATCH", "HEAD"]}} |
hawkconfig.json | path | Host path to the SOAP WSDL, prefixed with a `/` | {"type": "string", "pattern": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | filePath | Relative path to the SOAP WSDL schema definition file | {"type": "string"} |
hawkconfig.json | path | Host path for the grpc reflection endpoint. | {"type": "string"} |
hawkconfig.json | filePath | Relative path to the grpc protobuf file | {"type": "string"} |
hawkconfig.json | customVariables | Define custom variables and values for use in gRPC scanning. | {"type": "array", "items": {}} |
hawkconfig.json | field | The field name of the param to inject values into | {"type": "string"} |
hawkconfig.json | values | A list of possible values to be randomly selected for the given field | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | injectableParam | {} |
|
hawkconfig.json | enabledRpcParam | {} |
|
hawkconfig.json | path | The path to a public reachable route in your application. For example `/index`. A `GET` request will be made to this path to confirm the host is up and ready to receive traffic. | {"type": "string", "default": "/", "pattern\"": "^\\/(([A-z0-9\\-\\%]+\\/)*[A-z0-9\\-\\%]+$)?"} |
hawkconfig.json | requestMethod | Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings. | {"type": "string", "enum": ["GET", "POST", "PUT"]} |
hawkconfig.json | requestBody | The request content to send along with POST or PUT requests for target verification. | {"type": "string"} |
hawkconfig.json | waitTimeoutMillis | The maximum amount of time in milliseconds that HawkScan will wait for your app to be available before it starts scanning | {"type": ["number", "string"], "minimum": 0, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | pollDelay | The maximum amount of time in milliseconds in between requests to your application to see if it's running | {"type": ["number", "string"], "minimum": 50, "pattern": "^([0-9][0-9]+|[1-9]|0)$"} |
hawkconfig.json | headers | List of string header names: the values of HTTP headers matching these names will be redacted from alerts and logs. | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | values | List of string static values: the values here will be added to the redacted token list. This is best used with ${ENV_VAR:default} interpolation. | {"type": "array", "items": {"type": "string"}} |
hawkconfig.json | replacer | Configuration for the replacer addOn | {} |
hawkconfig.json | scripts | List of configurations for custom scripts. | {"type": "array", "items": {}} |
hawkconfig.json | rules | List of regex match and replace rules for request headers. | {"type": "array", "items": {}} |
hawkconfig.json | matchString | If `replaceOnly` is false, only match the header name. If `replaceOnly` is true, matches the exact string on the header line. | {"type": "string"} |
hawkconfig.json | replacement | If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line. | {"type": "string"} |
hawkconfig.json | initiators | {"type": "array", "items": {"type": "string", "enum": ["PROXY", "ACTIVE_SCANNER", "SPIDER", "FUZZER", "AUTHENTICATION", "MANUAL_REQUEST", "CHECK_FOR_UPDATES", "BEAN_SHELL", "ACCESS_CONTROL_SCANNER", "AJAX_SPIDER", "FORCED_BROWSE", "TOKEN_GENERATOR", "WEB_SOCKET", "AUTHENTICATION_HELPER"]}} |
|
hawkconfig.json | replaceOnly | If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line. | {"type": "boolean"} |
hawkconfig.json | isRegex | Enable regex search for `matchString`. Useful when `replaceOnly` is true (e.g. `Referer:.*` will replace the entire `Referer:` header line) | {"type": "boolean"} |
hawkconfig.json | name | the name of this custom script | {"type": "string"} |
hawkconfig.json | type | {"type": "string", "enum": ["active", "authentication", "httpsender", "passive", "proxy", "standalone", "targeted", "session"]} |
|
hawkconfig.json | path | Path to the file location for the custom script | {"type": "string"} |
hawkconfig.json | vars | Named variables to expose to the script | {"type": "array", "items": {}} |
hawkconfig.json | language | **Required**. The language of this script | {"type": "string", "enum": ["KOTLIN", "JAVASCRIPT"]} |
hawkconfig.json | id | Plugin Id for script | {"type": ["number", "string"]} |
hawkconfig.json | name | The keyword name. | {"type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9_-]+$"} |
hawkconfig.json | value | An arbitrary value to associate with the keyword. | {"type": "string", "maxLength": 512, "minLength": 1} |
solution-filter.json | solution | Solution filter description | {"type": "object", "properties": {"path": {"type": "string"}, "projects": {"type": "array", "items": {"type": "string"}}}} |
solution-filter.json | path | Path to filtered solution. Should be relative to current .slnf | {"type": "string"} |
solution-filter.json | projects | List of projects that will be included in filitered solution. Paths should be relative to solution rather than to .slnf | {"type": "array", "items": {"type": "string"}} |
component_spec.json_schema.json | OutputSpec | Describes the component output specification | {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "type": {}, "annotations": {"type": "object"}}, "additionalProperties": false} |
component_spec.json_schema.json | InputValuePlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by the input argument value. | {"type": "object", "required": ["inputValue"], "properties": {"inputValue": {"type": "string"}}, "additionalProperties": false} |
component_spec.json_schema.json | inputValue | Name of the input. | {"type": "string"} |
component_spec.json_schema.json | InputPathPlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file containing the input argument value. | {"type": "object", "required": ["inputPath"], "properties": {"inputPath": {"type": "string"}}, "additionalProperties": false} |
component_spec.json_schema.json | inputPath | Name of the input. | {"type": "string"} |
component_spec.json_schema.json | OutputPathPlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file where the program should write its output data. | {"type": "object", "required": ["outputPath"], "properties": {"outputPath": {"type": "string"}}, "additionalProperties": false} |
component_spec.json_schema.json | outputPath | Name of the output. | {"type": "string"} |
component_spec.json_schema.json | ConcatPlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by the concatenated values of its items. | {"type": "object", "required": ["concat"], "properties": {"concat": {"type": "array", "items": {}}}, "additionalProperties": false} |
component_spec.json_schema.json | concat | Items to concatenate | {"type": "array", "items": {}} |
component_spec.json_schema.json | IsPresentPlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input. | {"type": "object", "required": ["isPresent"], "properties": {"isPresent": {"type": "string"}}, "additionalProperties": false} |
component_spec.json_schema.json | isPresent | Name of the input. | {"type": "string"} |
component_spec.json_schema.json | IfPlaceholder | Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input. | {"type": "object", "required": ["if"], "properties": {"if": {"type": "object", "required": ["cond", "then"], "properties": {"cond": {}, "then": {}, "else": {}}}}} |
component_spec.json_schema.json | image | Docker image name. | {} |
component_spec.json_schema.json | command | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. | {"type": "array", "items": {}} |
component_spec.json_schema.json | args | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. | {"type": "array", "items": {}} |
component_spec.json_schema.json | env | List of environment variables to set in the container. | {"type": "object", "additionalProperties": {}} |
component_spec.json_schema.json | ContainerImplementation | Represents the container component implementation. | {"type": "object", "required": ["container"], "properties": {"container": {}}} |
component_spec.json_schema.json | ComponentSpec | Component specification. Describes the metadata (name, description, source), the interface (inputs and outputs) and the implementation of the component. | {"type": "object", "required": ["implementation"], "properties": {"name": {"type": "string"}, "inputs": {"type": "array", "items": {}}, "outputs": {"type": "array", "items": {}}, "implementation": {}, "metadata": {}}, "additionalProperties": false} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.