schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
airlock-microgateway-3.2.json | log_only | If enabled, potential attack requests are only logged but not blocked. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | path_matching | The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view). | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["client_view", "backend_view"]}], "default": "client_view"} |
airlock-microgateway-3.2.json | response_validation | Check responses against API specification. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | spec | The OpenAPI specification. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | spec_file | The OpenAPI file path. | {"type": ["string", "null"], "default": "/config/openapi.json"} |
airlock-microgateway-3.2.json | treat_json_objects_as_parameters | If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules. | {"type": ["boolean", "null"], "default": "true"} |
airlock-microgateway-3.2.json | treat_path_segments_as_parameters | If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it. | {"type": ["boolean", "null"], "default": "true"} |
airlock-microgateway-3.2.json | access | A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access. | {"type": "array", "items": {"type": "object", "properties": {"method": {"allOf": [{}, {}]}, "path": {"allOf": [{}, {}]}, "roles": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | method | Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match. | {} |
airlock-microgateway-3.2.json | path | Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match. | {} |
airlock-microgateway-3.2.json | roles | Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service. | {"type": "array", "items": {"type": "string"}} |
airlock-microgateway-3.2.json | verification | The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'. | {"type": "string", "enum": ["inherit", "optional", "required"], "default": "inherit"} |
airlock-microgateway-3.2.json | denied_access_url | Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used. | {"type": ["string", "null"], "default": "/auth/check-login"} |
airlock-microgateway-3.2.json | flow | The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["redirect", "deny_access", "one_shot", "one_shot_with_body", "ntlm"]}], "default": "redirect"} |
airlock-microgateway-3.2.json | logout_propagation_path | In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | security_gate | Expert settings for the Security Gate. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | name | The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed. | {"type": "string", "default": "backend", "pattern": "^[A-Za-z0-9.\\-_:]+$"} |
airlock-microgateway-3.2.json | port | Configuring a back-end port. | {"type": "integer", "default": "8080", "minimum": 1, "maximum": 65535} |
airlock-microgateway-3.2.json | protocol | Allowed values are: http, https | {"type": "string", "enum": ["https", "http"], "default": "http"} |
airlock-microgateway-3.2.json | name | The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':', '-' and '_' are allowed. | {"type": "string", "default": "backendGroup", "pattern": "^[A-Za-z0-9.\\-_:]+$"} |
airlock-microgateway-3.2.json | backend_path | The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server. | {"type": ["string", "null"], "default": "/"} |
airlock-microgateway-3.2.json | compress_response_traffic | Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | control_api | Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | encrypted | Cookies that should be cryptographically encrypted before being sent to the client. | {} |
airlock-microgateway-3.2.json | passthrough | Cookies that should be passed in plain format to the client. | {} |
airlock-microgateway-3.2.json | enabled | Whether to enable automatic CSRF token injection and validation on this mapping. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | exceptions | All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"path": {}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | invalid_token_redirect_location | Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected. | {"type": ["string", "null"], "default": "/%ENTRYPATH%"} |
airlock-microgateway-3.2.json | enabled | Enable deny rule group | {"type": ["boolean", "null"], "default": "true"} |
airlock-microgateway-3.2.json | level | Allowed values are: basic, standard, strict. | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["basic", "standard", "strict"]}], "default": "standard"} |
airlock-microgateway-3.2.json | log_only | If enabled, offending requests are not blocked but only logged | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | rule_group_keys | If deny rule group key is defined, the settings will only affect the specific deny rule group. | {"type": "array", "items": {"type": "string"}} |
airlock-microgateway-3.2.json | entry_path | The entry path specifies the external URL path the mapping should be available under. | {"type": ["object", "null"], "properties": {"enforce_trailing_slashes": {"type": ["boolean", "null"], "default": "false"}, "ignore_case": {"type": ["boolean", "null"], "default": "false"}, "type": {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["directory", "regex"]}], "default": "directory"}, "value": {"type": ["string", "null"], "default": "/"}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | enforce_trailing_slashes | Whether a trailing slash is mandatory at the end of the entry path or not. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | ignore_case | Whether to ignore case. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | type | Allowed values are: directory, regex. | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["directory", "regex"]}], "default": "directory"} |
airlock-microgateway-3.2.json | value | This specifies the external URL path. | {"type": ["string", "null"], "default": "/"} |
airlock-microgateway-3.2.json | env_cookies | Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | http_limits | The limits for HTTP parameters. | {"type": ["object", "null"], "properties": {"max_parameter_name_length": {"type": ["integer", "null"], "default": "128"}, "max_parameter_value_length": {"type": ["integer", "null"], "default": "1024"}, "max_parameters": {"type": ["integer", "null"], "default": "128"}, "parameter_length_exception": {"allOf": [{}, {}]}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | max_parameter_name_length | Defines the maximum length of a parameter name in bytes. | {"type": ["integer", "null"], "default": "128"} |
airlock-microgateway-3.2.json | max_parameter_value_length | Defines the maximum length for a parameter value in bytes. | {"type": ["integer", "null"], "default": "1024"} |
airlock-microgateway-3.2.json | max_parameters | Defines the maximum number of parameters inside the request. | {"type": ["integer", "null"], "default": "128"} |
airlock-microgateway-3.2.json | parameter_length_exception | A regular expression which specifies any parameters which should not be checked against these length checks. | {} |
airlock-microgateway-3.2.json | json_limits | The limits for JSON structures. | {"type": ["object", "null"], "properties": {"max_array_items": {"type": ["integer", "null"], "default": "500"}, "max_key_length": {"type": ["integer", "null"], "default": "256"}, "max_keys": {"type": ["integer", "null"], "default": "250"}, "max_length_exception": {"allOf": [{}, {}]}, "max_nesting_depth": {"type": ["integer", "null"], "default": "100"}, "max_total_entries": {"type": ["integer", "null"], "default": "150000"}, "max_value_length": {"type": ["integer", "null"], "default": "8192"}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | max_array_items | Defines the maximum number of items in a single JSON array (non-recursive). | {"type": ["integer", "null"], "default": "500"} |
airlock-microgateway-3.2.json | max_key_length | Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes. | {"type": ["integer", "null"], "default": "256"} |
airlock-microgateway-3.2.json | max_keys | Defines the maximum number of keys of a single JSON object (non-recursive). | {"type": ["integer", "null"], "default": "250"} |
airlock-microgateway-3.2.json | max_length_exception | Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key. | {} |
airlock-microgateway-3.2.json | max_nesting_depth | Defines the maximum depth of nesting for JSON objects and JSON arrays. | {"type": ["integer", "null"], "default": "100"} |
airlock-microgateway-3.2.json | max_total_entries | Defines the maximum number of keys and array items in the whole JSON document (recursive). | {"type": ["integer", "null"], "default": "150000"} |
airlock-microgateway-3.2.json | max_value_length | Defines the maximum length for a JSON value (string or numbers) in bytes. | {"type": ["integer", "null"], "default": "8192"} |
airlock-microgateway-3.2.json | max_path_length | Defines the maximum path length for requests to the current mapping in bytes. | {"type": ["integer", "null"], "default": "1024"} |
airlock-microgateway-3.2.json | max_request_body_size | The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once. | {"type": ["integer", "null"], "default": "104857600"} |
airlock-microgateway-3.2.json | mapping_template_file | The Airlock Gateway mapping template file path. | {"type": ["string", "null"], "default": "/config/mapping.xml"} |
airlock-microgateway-3.2.json | name | The unique name of the mapping. | {"type": ["string", "null"], "default": "root"} |
airlock-microgateway-3.2.json | operational_mode | Allowed values are: production, integration. | {"anyOf": [{"type": "null"}, {"type": "string", "enum": ["production", "integration"]}], "default": "production"} |
airlock-microgateway-3.2.json | block_duplicates | If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. "id" is present as a POST parameter and as a query parameter simultaneously). | {"type": ["boolean", "null"], "default": "true"} |
airlock-microgateway-3.2.json | log_only | If enabled, offending requests are not blocked but only logged. | {"type": ["boolean", "null"], "default": "false"} |
airlock-microgateway-3.2.json | parameter_name_exception | Exception pattern to exclude parameters from the parameter pollution detection. | {} |
airlock-microgateway-3.2.json | join_duplicates | If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values). | {"type": ["boolean", "null"], "default": "true"} |
airlock-microgateway-3.2.json | priority | Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.
All mappings with entry_path.type regex must have a unique priority. | {"type": ["integer", "null"], "default": "0", "minimum": -999, "maximum": 999} |
airlock-microgateway-3.2.json | custom_actions | A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"add_header": {"allOf": [{}, {}]}, "add_missing_header": {"allOf": [{}, {}]}, "add_or_replace_header": {"allOf": [{}, {}]}, "geolocation_redirect": {"type": ["object", "null"], "properties": {"continent_codes": {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}}, "country_codes": {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}}, "status_code": {"type": ["integer", "null"], "default": "303"}, "target_url": {"type": ["string", "null"]}}, "additionalProperties": false}, "header_redirect": {"type": ["object", "null"], "properties": {"name": {"allOf": [{}, {}]}, "status_code": {"type": ["integer", "null"], "default": "303"}, "target_url": {"type": ["string", "null"]}, "value": {"allOf": [{}, {}]}}, "additionalProperties": false}, "name": {"type": "string"}, "remove_header": {"allOf": [{}, {}]}, "rewrite_header_value": {"allOf": [{}, {}]}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | add_header | An action to add a header to all requests. | {} |
airlock-microgateway-3.2.json | add_missing_header | An action to add a header to all requests if it is not already present. | {} |
airlock-microgateway-3.2.json | add_or_replace_header | An action to add or replace an existing header to all requests. | {} |
airlock-microgateway-3.2.json | geolocation_redirect | An action to redirect to a URL based on the geographic location of the request source IP. | {"type": ["object", "null"], "properties": {"continent_codes": {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}}, "country_codes": {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}}, "status_code": {"type": ["integer", "null"], "default": "303"}, "target_url": {"type": ["string", "null"]}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | continent_codes | A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file) | {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}} |
airlock-microgateway-3.2.json | country_codes | A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 | {"default": "[]", "type": ["array", "null"], "items": {"type": "string", "default": "[]"}} |
airlock-microgateway-3.2.json | status_code | The http status code to use on redirect | {"type": ["integer", "null"], "default": "303"} |
airlock-microgateway-3.2.json | target_url | The url to redirect to. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | header_redirect | An action to redirect to a URL based on a header name or value either matching the given name or value pattern on requests. | {"type": ["object", "null"], "properties": {"name": {"allOf": [{}, {}]}, "status_code": {"type": ["integer", "null"], "default": "303"}, "target_url": {"type": ["string", "null"]}, "value": {"allOf": [{}, {}]}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | name | A pattern for the header name. | {} |
airlock-microgateway-3.2.json | status_code | The http status code to use on redirect | {"type": ["integer", "null"], "default": "303"} |
airlock-microgateway-3.2.json | target_url | The url to redirect to. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | value | A pattern for the header value. | {} |
airlock-microgateway-3.2.json | name | A unique name for this action; if not specified, a unique name will be generated. | {"type": "string"} |
airlock-microgateway-3.2.json | remove_header | An action to remove a header either matching given name or value pattern on requests. | {} |
airlock-microgateway-3.2.json | rewrite_header_value | An action to rewrite a header value either matching given name or value pattern on requests. | {} |
airlock-microgateway-3.2.json | custom_actions | A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"add_header": {"allOf": [{}, {}]}, "add_missing_header": {"allOf": [{}, {}]}, "add_or_replace_header": {"allOf": [{}, {}]}, "name": {"type": "string"}, "remove_header": {"allOf": [{}, {}]}, "rewrite_cookie": {"type": ["object", "null"], "properties": {"cookie": {"allOf": [{}, {}]}, "domain": {"allOf": [{}, {}]}, "domain_replace": {"type": ["string", "null"]}, "http_only_mode": {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"}, "path": {"allOf": [{}, {}]}, "path_replace": {"type": ["string", "null"]}, "secure_mode": {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"}}, "additionalProperties": false}, "rewrite_header_value": {"allOf": [{}, {}]}, "rewrite_raw_cookie": {"type": ["object", "null"], "properties": {"replace": {"type": ["string", "null"]}, "value": {"allOf": [{}, {}]}}, "additionalProperties": false}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | add_header | An action to add a header to all responses. | {} |
airlock-microgateway-3.2.json | add_missing_header | An action to add a header to all responses if it is not already present. | {} |
airlock-microgateway-3.2.json | add_or_replace_header | An action to add or replace an existing header on all responses. | {} |
airlock-microgateway-3.2.json | name | A unique name for this action; if not specified, a unique name will be generated. | {"type": "string"} |
airlock-microgateway-3.2.json | remove_header | An action to remove a header either matching given name or value pattern on responses. | {} |
airlock-microgateway-3.2.json | rewrite_cookie | An action to rewrite a cookie based on patterns for cookie name, domain etc. | {"type": ["object", "null"], "properties": {"cookie": {"allOf": [{}, {}]}, "domain": {"allOf": [{}, {}]}, "domain_replace": {"type": ["string", "null"]}, "http_only_mode": {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"}, "path": {"allOf": [{}, {}]}, "path_replace": {"type": ["string", "null"]}, "secure_mode": {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | cookie | A pattern to match the name of the cookie to rewrite. If this is set the name of the cookie must match this pattern for the rewrite to happen. | {} |
airlock-microgateway-3.2.json | domain | A pattern to match the domain, or part of the domain of a cookie to rewrite it. | {} |
airlock-microgateway-3.2.json | domain_replace | What to replace the domain with; Can make back references to the pattern used to match. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | http_only_mode | Whether to `add`, `keep` or `remove` the `HttpOnly` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#HttpOnly) flag on cookies. AUTO will set the flag for encrypted cookies and KEEP it for others. | {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"} |
airlock-microgateway-3.2.json | path | A pattern to match the path of a response to rewrite. | {} |
airlock-microgateway-3.2.json | path_replace | What to replace the path with; Can make back references to the pattern used to match. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | secure_mode | Whether to `add`, `keep` or `remove` the `Secure` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure) flag on cookies. AUTO will set the flag on all connections that use HTTPS and remove it on others. | {"type": "string", "enum": ["auto", "keep", "remove", "add"], "default": "auto"} |
airlock-microgateway-3.2.json | rewrite_header_value | An action to rewrite a header value either matching given name or value pattern on responses. | {} |
airlock-microgateway-3.2.json | rewrite_raw_cookie | An action to rewrite the raw value of a cookie matching the given pattern. | {"type": ["object", "null"], "properties": {"replace": {"type": ["string", "null"]}, "value": {"allOf": [{}, {}]}}, "additionalProperties": false} |
airlock-microgateway-3.2.json | replace | A string to rewrite value pattern matches in the cookie value. Can make back references to the pattern used for matching. | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | value | A pattern for the cookie value to apply for matching. | {} |
airlock-microgateway-3.2.json | error_page_replacements | Replacement rules for error responses returned by backend systems. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"page": {"type": ["string", "null"]}, "status_code": {"allOf": [{}, {}]}}, "additionalProperties": false}} |
airlock-microgateway-3.2.json | page | Error page file name that will be delivered to the client. (eg. 400.html) | {"type": ["string", "null"]} |
airlock-microgateway-3.2.json | status_code | The http response with the matching status code that should be replaced. | {} |
airlock-microgateway-3.2.json | any | Rewrite the body of HTTP response. | {"type": "array", "items": {"type": "object", "properties": {"content": {"allOf": [{}, {}]}, "content_type": {"type": "string", "default": "^(?:text|application)/(?:html|xhtml)"}, "to": {"type": ["string", "null"]}}, "additionalProperties": false}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.