Skip to content

Instantly share code, notes, and snippets.

@m-bers

m-bers/schema.policy.json

Created January 20, 2023 23:21
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save m-bers/c3d35a7e6470cc6b68f7a795a66d3cdb to your computer and use it in GitHub Desktop.
Save m-bers/c3d35a7e6470cc6b68f7a795a66d3cdb to your computer and use it in GitHub Desktop.
Download ZIP
Raw
schema.policy.json
{
"$id" : "schema.policy.json",
"$schema" : "http://json-schema.org/draft-07/schema#",
"definitions" : {
"link" : {
"properties" : {
"link" : {
"format" : "uri",
"type" : "string"
}
},
"required" : [
"link"
],
"type" : "object"
},
"reference" : {
"properties" : {
"$ref" : {
"format" : "uri",
"type" : "string"
}
},
"required" : [
"$ref"
],
"type" : "object"
}
},
"properties" : {
"policy" : {
"properties" : {
"applicationLanguage" : {
"description" : "The character encoding for the application. The character encoding determines how the policy processes the character sets. The default is utf-8.",
"enum" : [
"big5",
"euc-jp",
"euc-kr",
"gb18030",
"gb2312",
"gbk",
"iso-8859-1",
"iso-8859-10",
"iso-8859-13",
"iso-8859-15",
"iso-8859-16",
"iso-8859-2",
"iso-8859-3",
"iso-8859-4",
"iso-8859-5",
"iso-8859-6",
"iso-8859-7",
"iso-8859-8",
"iso-8859-9",
"koi8-r",
"shift_jis",
"utf-8",
"windows-1250",
"windows-1251",
"windows-1252",
"windows-1253",
"windows-1255",
"windows-1256",
"windows-1257",
"windows-874"
],
"type" : "string"
},
"blocking-settings" : {
"description" : "This section defines policy block/alarm behaviors.",
"properties" : {
"evasions" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines behavior of 'Evasion technique detected' (VIOL_EVASION) violation sub-violations.\nUser can control which sub-violations are enabled (alarmed/blocked).\nBehavior of sub-violations depends on the block/alarm settings of 'Evasion technique detected' violation,\ndefined in /policy/blocking-settings/violations section:\n - If both alarm and block are disabled - enable flag becomes irrelevant, since there will be no block/alarm for all sub-violations",
"properties" : {
"description" : {
"description" : "Human-readable name of sub-violation.",
"enum" : [
"%u decoding",
"Apache whitespace",
"Bad unescape",
"Bare byte decoding",
"Directory traversals",
"IIS Unicode codepoints",
"IIS backslashes",
"Multiple decoding",
"Multiple slashes",
"Semicolon path parameters"
],
"type" : "string"
},
"enabled" : {
"description" : "Defines if sub-violation is enforced - alarmed or blocked, according to the 'Evasion technique detected' (VIOL_EVASION) violation blocking settings.",
"type" : "boolean"
},
"maxDecodingPasses" : {
"description" : "Defines how many times the system decodes URI and parameter values before the request is considered an evasion.\nRelevant only for the 'Multiple decoding' sub-violation.",
"maximum" : 5,
"minimum" : 2,
"type" : "integer"
}
},
"required" : [
"description"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"http-protocols" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines behavior of 'HTTP protocol compliance failed' (VIOL_HTTP_PROTOCOL) violation sub-violations.\nUser can control which sub-violations are enabled (alarmed/blocked).\nBehavior of sub-violations depends on the block/alarm settings of 'HTTP protocol compliance failed' violation,\n - If both alarm and block are disabled - enable flag becomes irrelevant, since there will be no block/alarm for all sub-violations",
"properties" : {
"description" : {
"description" : "Human-readable name of sub-violation",
"enum" : [
"POST request with Content-Length: 0",
"Multiple host headers",
"Host header contains IP address",
"Null in request",
"Header name with no header value",
"Chunked request with Content-Length header",
"Check maximum number of cookies",
"Check maximum number of parameters",
"Check maximum number of headers",
"Body in GET or HEAD requests",
"Bad multipart/form-data request parsing",
"Bad multipart parameters parsing",
"Unescaped space in URL",
"High ASCII characters in headers"
],
"type" : "string"
},
"enabled" : {
"description" : "Defines if sub-violation is enforced - alarmed or blocked, according to the 'HTTP protocol compliance failed' (VIOL_HTTP_PROTOCOL) violation blocking settings",
"type" : "boolean"
},
"maxCookies" : {
"maximum" : 100,
"minimum" : 1,
"type" : "integer"
},
"maxHeaders" : {
"description" : "Defines maximum allowed number of headers in request.\nRelevant only for the 'Check maximum number of headers' sub-violation",
"maximum" : 150,
"minimum" : 1,
"type" : "integer"
},
"maxParams" : {
"description" : "Defines maximum allowed number of parameters in request.\nRelevant only for the 'Check maximum number of parameters' sub-violation",
"maximum" : 5000,
"minimum" : 1,
"type" : "integer"
}
},
"required" : [
"description"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"violations" : {
"oneOf" : [
{
"items" : {
"properties" : {
"alarm" : {
"type" : "boolean"
},
"block" : {
"type" : "boolean"
},
"description" : {
"type" : "string"
},
"name" : {
"enum" : [
"VIOL_ASM_COOKIE_MODIFIED",
"VIOL_BLACKLISTED_IP",
"VIOL_COOKIE_EXPIRED",
"VIOL_COOKIE_LENGTH",
"VIOL_COOKIE_MALFORMED",
"VIOL_COOKIE_MODIFIED",
"VIOL_CSRF",
"VIOL_DATA_GUARD",
"VIOL_ENCODING",
"VIOL_EVASION",
"VIOL_FILETYPE",
"VIOL_FILE_UPLOAD",
"VIOL_FILE_UPLOAD_IN_BODY",
"VIOL_GRPC_FORMAT",
"VIOL_GRPC_MALFORMED",
"VIOL_GRPC_METHOD",
"VIOL_HEADER_LENGTH",
"VIOL_HEADER_METACHAR",
"VIOL_HEADER_REPEATED",
"VIOL_HTTP_PROTOCOL",
"VIOL_HTTP_RESPONSE_STATUS",
"VIOL_JSON_FORMAT",
"VIOL_JSON_MALFORMED",
"VIOL_JSON_SCHEMA",
"VIOL_MANDATORY_HEADER",
"VIOL_MANDATORY_PARAMETER",
"VIOL_MANDATORY_REQUEST_BODY",
"VIOL_METHOD",
"VIOL_PARAMETER",
"VIOL_PARAMETER_ARRAY_VALUE",
"VIOL_PARAMETER_DATA_TYPE",
"VIOL_PARAMETER_EMPTY_VALUE",
"VIOL_PARAMETER_LOCATION",
"VIOL_PARAMETER_MULTIPART_NULL_VALUE",
"VIOL_PARAMETER_NAME_METACHAR",
"VIOL_PARAMETER_NUMERIC_VALUE",
"VIOL_PARAMETER_REPEATED",
"VIOL_PARAMETER_STATIC_VALUE",
"VIOL_PARAMETER_VALUE_BASE64",
"VIOL_PARAMETER_VALUE_LENGTH",
"VIOL_PARAMETER_VALUE_METACHAR",
"VIOL_PARAMETER_VALUE_REGEXP",
"VIOL_POST_DATA_LENGTH",
"VIOL_QUERY_STRING_LENGTH",
"VIOL_RATING_THREAT",
"VIOL_RATING_NEED_EXAMINATION",
"VIOL_REQUEST_MAX_LENGTH",
"VIOL_REQUEST_LENGTH",
"VIOL_THREAT_CAMPAIGN",
"VIOL_URL",
"VIOL_URL_CONTENT_TYPE",
"VIOL_URL_LENGTH",
"VIOL_URL_METACHAR",
"VIOL_XML_FORMAT",
"VIOL_XML_MALFORMED"
],
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
}
},
"type" : "object"
},
"bot-defense" : {
"description" : "This section defines the properties of the bot defense feature.",
"properties" : {
"mitigations" : {
"description" : "This section defines the mitigation to each class or signature.",
"properties" : {
"anomalies" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"action" : {
"enum" : [
"alarm",
"block",
"default",
"detect",
"ignore"
],
"type" : "string"
},
"name" : {
"type" : "string"
},
"scoreThreshold" : {
"oneOf" : [
{
"maximum" : 150,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"default"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"browsers" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"action" : {
"enum" : [
"alarm",
"block",
"detect"
],
"type" : "string"
},
"maxVersion" : {
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
"minVersion" : {
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
"name" : {
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"classes" : {
"oneOf" : [
{
"items" : {
"description" : "List of classes and their actions.",
"properties" : {
"action" : {
"description" : "The action we set for this class.\n\n- **ignore**: The system will not detect or report bots from this class.\n- **detect**: The system will detect and report the bot, but violation won't be reported.\n- **alarm**: The system will detect and report requests made by bots from this class as illegal, but will not block them.\n- **block**: The system will detect and report requests made by bots from this class as illegal, and block them.",
"enum" : [
"alarm",
"block",
"detect",
"ignore"
],
"type" : "string"
},
"name" : {
"description" : "The class we set the action to.",
"enum" : [
"browser",
"malicious-bot",
"suspicious-browser",
"trusted-bot",
"unknown",
"untrusted-bot"
],
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"signatures" : {
"oneOf" : [
{
"items" : {
"description" : "List of signatures and their actions.\nIf a signature is not in the list - its action will be taken according to the class it belongs to.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"action" : {
"description" : "The action we set for this signature.\n\n- **ignore**: The system will not detect or report this signature.\n- **detect**: The system will detect and report the signature, but violation won't be reported.\n- **alarm**: The system will detect and report requests made by those specific bots as illegal, but will not block them.\n- **block**: The system will detect and report requests made by those specific bots as illegal, and will block them.",
"enum" : [
"alarm",
"block",
"detect",
"ignore"
],
"type" : "string"
},
"name" : {
"description" : "The name of the signature we want to change action for.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
}
},
"type" : "object"
},
"settings" : {
"oneOf" : [
{
"description" : "This section contains all bot defense settings.",
"properties" : {
"caseSensitiveHttpHeaders" : {
"description" : "If *false* the system will not check header name with case sensitivity for both relevant anomalies: Invalid HTTP Headers, Suspicious HTTP Headers.",
"type" : "boolean"
},
"isEnabled" : {
"description" : "If *true* the system detects bots.",
"type" : "boolean"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
}
},
"type" : "object"
},
"browser-definitions" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"isUserDefined" : {
"type" : "boolean"
},
"matchRegex" : {
"type" : "string"
},
"matchString" : {
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"caseInsensitive" : {
"description" : "Specifies whether the security policy treats microservice URLs, file types, URLs, and parameters as case sensitive or not. When this setting is enabled, the system stores these security policy elements in lowercase in the security policy configuration.",
"type" : "boolean"
},
"character-sets" : {
"oneOf" : [
{
"items" : {
"properties" : {
"characterSet" : {
"items" : {
"properties" : {
"isAllowed" : {
"type" : "boolean"
},
"metachar" : {
"type" : "string"
}
},
"required" : [
"metachar"
],
"type" : "object"
},
"type" : "array"
},
"characterSetType" : {
"enum" : [
"header",
"url",
"parameter-name",
"parameter-value",
"xml-content",
"json-content"
],
"type" : "string"
}
},
"required" : [
"characterSetType"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"cookie-settings" : {
"oneOf" : [
{
"description" : "The maximum length of a cookie header name and value that the system processes. The system calculates and enforces a cookie header length based on the sum of the length of the cookie header name and value.",
"properties" : {
"maximumCookieHeaderLength" : {
"description" : "Maximum Cookie Header Length must be greater than 0 and less than 65536 bytes (64K). Note: if 0 or *any* are set, then no restriction on the cookie header length is applied.",
"oneOf" : [
{
"maximum" : 65536,
"minimum" : 1,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"cookies" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines Cookie entities for your policy.\nYou can specify the cookies that you want to allow, and the ones you want to enforce in a security policy:\n\n- **Allowed cookies**: The system allows these cookies and clients can change them.\n- **Enforced cookies**: The system enforces the cookies in the list (not allowing clients to change them) and allows clients to change all others.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"accessibleOnlyThroughTheHttpProtocol" : {
"description" : "Specifies, when true, that the system adds the HttpOnly attribute to the domain cookie's response header.\nThis is done to expose the cookie to only HTTP and HTTPS entities.\nThis prevents the cookie from being modified, or intercepted even if it is not modified,\nby unwanted third parties that run scripts on the web page.\n\n**Notes**:\n- The system does not validate that the cookie has not been modified or intercepted.\n- The feature covers all security policy cookies, both enforced and allowed, explicit and wildcard.",
"type" : "boolean"
},
"attackSignaturesCheck" : {
"description" : "Specifies, when true, that you want attack signatures and threat campaigns to be detected on this cookie\nand possibly override the security policy settings of an attack signature or threat campaign specifically for this cookie.\nAfter you enable this setting, the system displays a list of attack signatures and threat campaigns.",
"type" : "boolean"
},
"decodeValueAsBase64" : {
"description" : "Specifies whether the the system should detect or require values to be Base64 encoded:\n\n - **disabled**: the value will not be decoded as Base64 content.\n - **enabled**: the value will be checked whether it can be decoded as Base64 and, if so, security checks will be performed on the decoded value.\n - **required**: the value must be decoded as Base64, and security checks will be performed on the decoded value.\n\n **Note**: This setting is only relevant if the Cookie Enforcement Type is set to Allowed.",
"enum" : [
"disabled",
"enabled",
"required"
],
"type" : "string"
},
"enforcementType" : {
"description" : "Specifies how the system treats this cookie.\n\n- **enforced**: Specifies that according to the security policy, this cookie may not be changed by the client.\n- **allowed**: Specifies that according to the security policy, this cookie may be changed by the client. The system ignores this cookie.",
"enum" : [
"allow",
"enforce"
],
"type" : "string"
},
"insertSameSiteAttribute" : {
"description" : "The introduction of the SameSite http attribute (defined in [RFC6265bis](https://tools.ietf.org/html/draft-ietf-httpbis-cookie-same-site-00))\nallows you to declare if your cookie should be restricted to a first-party or same-site context.\nIntroducing the SameSite attribute on a cookie provides three different ways of controlling same-site vs. cross-site cookie sending:\n\n- **strict**: Cookie will only be sent in a first-party context. In user terms, the cookie will only be sent if the site for the cookie matches the site currently shown in the browser's URL bar.\n- **lax**: Cookies will be sent with top level navigation\n- **none-value**: Cookies will be sent in a third-party context.",
"enum" : [
"lax",
"none",
"none-value",
"strict"
],
"type" : "string"
},
"maskValueInLogs" : {
"description" : "Specifies, when true, that the cookie's value will be masked in the request log.",
"type" : "boolean"
},
"name" : {
"description" : "Specifies the cookie name as appearing in the http cookie header.\nThe cookie name length is limited to 500 characters.\n\nNames can be one of the following according to the *type* attribute:\n\n- **explicit**: Specifies that the cookie has a specific name and is not a wildcard entity. Type the name of a cookie exactly as you expect it to appear in the request.\n- **wildcard**: Specifies that any cookie that matches the listed wildcard expression should be treated according to the wildcard attributes. Type a wildcard expression that matches the expected cookie. For example, the wildcard expression cookie_12* of type Enforced specifies that the security policy should not allow modified domain cookies for all cookies which match cookie_12*.\n\nThe syntax for wildcard entities is based on shell-style wildcard characters.\nThe list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- **\\***: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type" : "string"
},
"securedOverHttpsConnection" : {
"description" : "Specifies, when true, that the system adds the Secure attribute to the domain cookie's response header.\nThis is done to ensure that the cookies are returned to the server only over SSL (by using the HTTPS protocol).\nThis prevents the cookie from being intercepted, but does not guarantee its integrity.\n\n**Notes**:\n- The system does not validate that the cookie was received over SSL.\n- The feature covers all security policy cookies, both enforced and allowed, explicit and wildcard.",
"type" : "boolean"
},
"signatureOverrides" : {
"description" : "Array of signature overrides.\nSpecifies attack signatures whose security policy settings are overridden for this cookie,\nand which action the security policy takes when it discovers a request for this cookie that matches these attack signatures.",
"items" : {
"properties" : {
"enabled" : {
"description" : "Specifies, when true, that the overridden signature is enforced",
"type" : "boolean"
},
"name" : {
"description" : "The signature name which, along with the signature tag, identifies the signature.",
"type" : "string"
},
"signatureId" : {
"description" : "The signature ID which identifies the signature.",
"type" : "integer"
},
"tag" : {
"description" : "The signature tag which, along with the signature name, identifies the signature.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"type" : {
"description" : "Determines the type of the **name** attribute.\nOnly when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum" : [
"explicit",
"wildcard"
],
"type" : "string"
},
"wildcardOrder" : {
"description" : "Specifies the order index for wildcard cookies matching.\nWildcard cookies with lower wildcard order will get checked for a match prior to cookies with higher wildcard order.",
"type" : "integer"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"csrf-protection" : {
"oneOf" : [
{
"properties" : {
"enabled" : {
"type" : "boolean"
},
"expirationTimeInSeconds" : {
"oneOf" : [
{
"type" : "integer"
},
{
"enum" : [
"disabled"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"sslOnly" : {
"type" : "boolean"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"csrf-urls" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"enforcementAction" : {
"enum" : [
"none",
"verify-origin"
],
"type" : "string"
},
"method" : {
"enum" : [
"GET",
"POST",
"any"
],
"type" : "string"
},
"url" : {
"type" : "string"
},
"wildcardOrder" : {
"type" : "integer"
}
},
"required" : [
"url"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"data-guard" : {
"oneOf" : [
{
"description" : "Data Guard feature can prevent responses from exposing sensitive information by masking the data.",
"properties" : {
"creditCardNumbers" : {
"description" : "If *true* the system considers credit card numbers as sensitive data.",
"type" : "boolean"
},
"enabled" : {
"description" : "If *true* the system protects sensitive data.",
"type" : "boolean"
},
"enforcementMode" : {
"description" : "Specifies the URLs for which the system enforces data guard protection.\n\n- **ignore-urls-in-list**: Specifies that the system enforces data guard protection for all URLs except for those URLs in the Enforcement Mode list.\n- **enforce-urls-in-list**: Specifies that the system enforces data guard protection only for those URLs in the Enforcement Mode list",
"enum" : [
"enforce-urls-in-list",
"ignore-urls-in-list"
],
"type" : "string"
},
"enforcementUrls" : {
"description" : "List of URLS to be enforced based on enforcement mode of data guard protection.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"maskData" : {
"description" : "If *true* the system intercepts the returned responses to mask sensitive data.",
"type" : "boolean"
},
"usSocialSecurityNumbers" : {
"description" : "If *true* the system considers U.S Social Security numbers as sensitive data.",
"type" : "boolean"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"description" : {
"description" : "Specifies the description of the policy.",
"type" : "string"
},
"enforcementMode" : {
"description" : "How the system processes a request that triggers a security policy violation.\n- **Blocking:** When the enforcement mode is set to blocking, traffic is blocked if it causes a violation (configured for blocking).\n- **Transparent:** When the enforcement mode is set to transparent, traffic is not blocked even if a violation is triggered.",
"enum" : [
"blocking",
"transparent"
],
"type" : "string"
},
"enforcer-settings" : {
"oneOf" : [
{
"description" : "This section contains all enforcer settings.",
"properties" : {
"enforcerStateCookies" : {
"description" : "This section defines the properties of the enforcer state cookies.",
"properties" : {
"httpOnlyAttribute" : {
"description" : "Specifies, when true, that the system adds the state cookie HttpOnly attribute.",
"type" : "boolean"
},
"sameSiteAttribute" : {
"description" : "The value for the state cookie SameSite attribute:\n\n- **none**: The SameSite attribute is never added to the state cookie.\n- **strict**: Cookie will only be sent in a first-party context. In user terms, the cookie will only be sent if the site for the cookie matches the site currently shown in the browser's URL bar.\n- **lax**: Cookies will be sent with top level navigation\n- **none-value**: Cookies will be sent in a third-party context.",
"enum" : [
"lax",
"none",
"none-value",
"strict"
],
"type" : "string"
},
"secureAttribute" : {
"description" : "The value for the state cookie Secure attribute:\n\n- **always**: Always add the Secure attribute to the state cookie.\n- **never**: The Secure attribute is never added to the state cookie.",
"enum" : [
"always",
"never"
],
"type" : "string"
}
},
"type" : "object"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"filetypes" : {
"oneOf" : [
{
"items" : {
"description" : "File types are categorization of the URLs in the request by the extension appearing past the last dot at the end of the URL. For example, the file type of /index.php\nis \"php\". Other well known file types are html, aspx, png, jpeg and many more. A special case is the \"empty\" file type called \"no-ext\" meaning, no extension in which the URL has no dot at its last segment as in /foo_no_dot\n\nFile types usually imply the expected content type in the response. For example, html and php return HTML content, while jpeg, png and gif return images, each in its respective format. File types also imply the server technology deployed for rendering the page. For example, php (PHP), aspx (ASP) and many others.\n\nThe security policy uses file types for several purposes:\n1. Ability to define which file types are allowed and which are disallowed. By including the pure wildcard \"\\*\" file type and a list of disallowed file types you have a file type denylist.\nBy having a list of explicit file type *without* the pure wildcard \"\\*\" you have a file type allowlist.\n2. Each file type implies maximum *length restrictions* for the requests of that file type. The checked lengths are per the URL, Query String, total request length, and payload (POST data).\n3. Each file type determines whether to detect *response signatures* for requests of that file type. Typically, one would never check signatures for image file types.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"allowed" : {
"description" : "Determines whether the file type is allowed or disallowed. In either of these cases the VIOL_FILETYPE violation is issued (if enabled) for an incoming request-\n1. No allowed file type matched the file type of the request.\n2. The file type of the request matched a disallowed file type.",
"type" : "boolean"
},
"checkPostDataLength" : {
"description" : "Determines whether to enforce maximum length restriction for the body, a.k.a. \"POST data\" part of the requests that match the respective file type. The maximum length is determined by *postDataLength* attribute.\nAlthough named \"POST data\", this applies to any content type and not restricted to POST requests, e.g. PUT requests are also checked.\nThis attribute is relevant only to *allowed* file types.",
"type" : "boolean"
},
"checkQueryStringLength" : {
"description" : "Determines whether to enforce maximum length restriction for the query string of the requests that match the respective file type. The maximum length is determined by *queryStringLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type" : "boolean"
},
"checkRequestLength" : {
"description" : "Determines whether to enforce maximum length restriction for the total length of requests that match the respective file type. The maximum length is determined by *requestLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type" : "boolean"
},
"checkUrlLength" : {
"description" : "Determines whether to enforce maximum length restriction for the URL of the requests that match the respective file type. The URL does *not* include the query string, past the &. The maximum length is determined by *urlLength* attribute.\nThis attribute is relevant only to *allowed* file types.",
"type" : "boolean"
},
"name" : {
"description" : "Specifies the file type name as appearing in the URL extension. Names can be one of the following according to the *type* attribute:\n\n- **Explicit** - Specifies that the name is the literal file extension to which the file type refers. The *type* attribute has to be \"explicit\".\n- **No Extension** - Specifies the empty file type, lacking file extension. For this the reserved string **no_ext** should be used. The *type* attribute has to be \"explicit\".\n- **Wildcard** - Specifies that any file extension that matches the wildcard expression is matched to this file type in the policy. The *type* attribute has to be \"wildcard\".\n\nThe syntax for wildcard entities is based on shell-style wildcard characters. The list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- **\\***: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type" : "string"
},
"postDataLength" : {
"description" : "The maximum length in bytes of the body (POST data) of the request matching the file type. Enforced only if checkPostDataLength is set to *true*.\nIf the value is exceeded then VIOL_POST_DATA_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum" : 0,
"type" : "integer"
},
"queryStringLength" : {
"description" : "The maximum length in bytes of the query string of the request matching the file type. Enforced only if checkQueryStringLength is set to *true*.\nIf the value is exceeded then VIOL_QUERY_STRING_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum" : 0,
"type" : "integer"
},
"requestLength" : {
"description" : "The maximum total length in bytes of the request matching the file type. Enforced only if checkRequestLength is set to *true*.\nIf the value is exceeded then VIOL_REQUEST_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum" : 0,
"type" : "integer"
},
"responseCheck" : {
"description" : "Determines whether the responses to requests that match the respective file types are inspected for attack signature detection.\nThis attribute is relevant only to *allowed* file types.",
"type" : "boolean"
},
"type" : {
"description" : "Determines the type of the **name** attribute. Only when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum" : [
"explicit",
"wildcard"
],
"type" : "string"
},
"urlLength" : {
"description" : "The maximum length in bytes of the URL of the request matching the file type, excluding the query string. Enforced only if checkUrlLength is set to *true*.\nIf the value is exceeded then VIOL_URL_LENGTH violation is issued.\nThis attribute is relevant only to *allowed* file types.",
"minimum" : 0,
"type" : "integer"
},
"wildcardOrder" : {
"type" : "integer"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"fullPath" : {
"description" : "The full name of the policy including partition.",
"type" : "string"
},
"general" : {
"oneOf" : [
{
"description" : "This section includes several advanced policy configuration settings.",
"properties" : {
"allowedResponseCodes" : {
"description" : "You can specify which responses a security policy permits.\nBy default, the system accepts all response codes from 100 to 399 as valid responses.\nResponse codes from 400 to 599 are considered invalid unless added to the Allowed Response Status Codes list.\nBy default, 400, 401, 404, 407, 417, and 503 are on the list as allowed HTTP response status codes.",
"items" : {
"type" : "integer"
},
"type" : "array"
},
"customXffHeaders" : {
"description" : "If you require the system to trust a server further than one hop toward the client (the last proxy traversed), you can use the Custom XFF Headers setting to define a specific header that is inserted closer to, or at the client, that the system will trust.\nAdditionally, if you require the system to trust a proxy server that uses a different header name than the X-Forwarded-For header name, you can add the desired header name to the Custom XFF Headers setting.\nWhen adding a custom header, the X-Forwarded-For header is not trusted anymore. In case the X-Forwarded-For header is to be trusted along with other headers, you must add it to the custom headers list.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"maskCreditCardNumbersInRequest" : {
"description" : "When enabled, the security policy masks credit card numbers that appear in any part of requests. The system does not mask the information in the actual requests, but rather in various logs:\n* Credit card numbers appearing in entity names are masked in the requests of the Requests log.\n* Credit card numbers appearing in entity values are masked wherever requests can be viewed: the Requests log, and violation details within that log.\nThis setting is enabled by default, and exists in addition to masking parameters defined as containing sensitive information.",
"type" : "boolean"
},
"trustXff" : {
"description" : "When enabled, the system has confidence in an XFF (X-Forwarded-For) header in the request. When disabled, that the system does not have confidence in an XFF header in the request. The default setting is disabled.\n\nSelect this option if the system is deployed behind an internal or other trusted proxy. Then, the system uses the IP address that initiated the connection to the proxy instead of the internal proxy's IP address.\n\nLeave this option disabled if you think the HTTP header may be spoofed, or crafted, by a malicious client. With this setting disabled, if the system is deployed behind an internal proxy, the system uses the internal proxy's IP address instead of the client's IP address.",
"type" : "boolean"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"grpc-profiles" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"associateUrls" : {
"type" : "boolean"
},
"attackSignaturesCheck" : {
"type" : "boolean"
},
"decodeStringValuesAsBase64" : {
"enum" : [
"disabled",
"enabled"
],
"type" : "string"
},
"defenseAttributes" : {
"properties" : {
"allowUnknownFields" : {
"type" : "boolean"
},
"maximumDataLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
}
},
"type" : "object"
},
"description" : {
"type" : "string"
},
"hasIdlFiles" : {
"type" : "boolean"
},
"idlFiles" : {
"items" : {
"properties" : {
"idlFile" : {
"$ref" : "#/properties/policy/properties/idl-files/oneOf/0/items",
"type" : "object"
},
"importUrl" : {
"type" : "string"
},
"isPrimary" : {
"type" : "boolean"
},
"primaryIdlFileName" : {
"type" : "string"
}
},
"required" : [
"idlFile"
],
"type" : "object"
},
"type" : "array"
},
"metacharElementCheck" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"signatureOverrides" : {
"items" : {
"properties" : {
"enabled" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"signatureId" : {
"type" : "integer"
},
"tag" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"header-settings" : {
"oneOf" : [
{
"description" : "The maximum length of an HTTP header name and value that the system processes. The system calculates and enforces the HTTP header length based on the sum of the length of the HTTP header name and value.",
"properties" : {
"maximumHttpHeaderLength" : {
"description" : "Maximum HTTP Header Length must be greater than 0 and less than 65536 bytes (64K). Note: if 0 or *any* are set, then no restriction on the HTTP header length is applied.",
"oneOf" : [
{
"maximum" : 65536,
"minimum" : 1,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"headers" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines Header entities for your policy.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"allowRepeatedOccurrences" : {
"type" : "boolean"
},
"checkSignatures" : {
"type" : "boolean"
},
"decodeValueAsBase64" : {
"description" : "Specifies whether the the system should detect or require values to be Base64 encoded:\n\n - **disabled**: the value will not be decoded as Base64 content.\n - **enabled**: the value will be checked whether it can be decoded as Base64 and, if so, security checks will be performed on the decoded value.\n - **required**: the value must be decoded as Base64, and security checks will be performed on the decoded value.",
"enum" : [
"disabled",
"enabled",
"required"
],
"type" : "string"
},
"htmlNormalization" : {
"type" : "boolean"
},
"mandatory" : {
"type" : "boolean"
},
"maskValueInLogs" : {
"description" : "Specifies, when true, that the headers's value will be masked in the request log.",
"type" : "boolean"
},
"name" : {
"description" : "Specifies the HTTP header name.\nThe header name length is limited to 254 characters.\n\nNames can be one of the following according to the *type* attribute:\n\n- **explicit**: Specifies that the header has a specific name and is not a wildcard entity. The name of the header exactly as you expect it to appear in the request.\n- **wildcard**: Specifies that any header that matches the listed wildcard expression should be treated according to the wildcard attributes.\n\nThe syntax for wildcard entities is based on shell-style wildcard characters.\nThe list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- **\\***: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type" : "string"
},
"normalizationViolations" : {
"type" : "boolean"
},
"percentDecoding" : {
"type" : "boolean"
},
"signatureOverrides" : {
"description" : "Array of signature overrides.\nSpecifies attack signatures whose security policy settings are overridden for this header,\nand which action the security policy takes when it discovers a request for this header that matches these attack signatures.",
"items" : {
"properties" : {
"enabled" : {
"description" : "Specifies, when true, that the overridden signature is enforced",
"type" : "boolean"
},
"name" : {
"description" : "The signature name which, along with the signature tag, identifies the signature.",
"type" : "string"
},
"signatureId" : {
"description" : "The signature ID which identifies the signature.",
"type" : "integer"
},
"tag" : {
"description" : "The signature tag which, along with the signature name, identifies the signature.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"type" : {
"description" : "Determines the type of the **name** attribute.\nOnly when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum" : [
"explicit",
"wildcard"
],
"type" : "string"
},
"urlNormalization" : {
"type" : "boolean"
},
"wildcardOrder" : {
"description" : "Specifies the order index for wildcard header matching.\nWildcard headers with lower wildcard order will get checked for a match prior to headers with higher wildcard order.",
"type" : "integer"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"host-names" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"includeSubdomains" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"idl-files" : {
"oneOf" : [
{
"items" : {
"oneOf" : [
{
"required" : [
"id"
]
},
{
"required" : [
"id",
"$ref"
]
},
{
"required" : [
"id",
"link"
]
}
],
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"$ref" : {
"format" : "uri",
"type" : "string"
},
"contents" : {
"type" : "string"
},
"fileName" : {
"type" : "string"
},
"isBase64" : {
"type" : "boolean"
},
"link" : {
"format" : "uri",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"json-profiles" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"attackSignaturesCheck" : {
"type" : "boolean"
},
"defenseAttributes" : {
"properties" : {
"maximumArrayLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumStructureDepth" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumTotalLengthOfJSONData" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumValueLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"tolerateJSONParsingWarnings" : {
"type" : "boolean"
}
},
"type" : "object"
},
"description" : {
"type" : "string"
},
"handleJsonValuesAsParameters" : {
"type" : "boolean"
},
"hasValidationFiles" : {
"type" : "boolean"
},
"metacharElementCheck" : {
"type" : "boolean"
},
"metacharOverrides" : {
"items" : {
"properties" : {
"isAllowed" : {
"type" : "boolean"
},
"metachar" : {
"type" : "string"
}
},
"required" : [
"metachar"
],
"type" : "object"
},
"type" : "array"
},
"name" : {
"type" : "string"
},
"signatureOverrides" : {
"items" : {
"properties" : {
"enabled" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"signatureId" : {
"type" : "integer"
},
"tag" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"validationFiles" : {
"items" : {
"properties" : {
"importUrl" : {
"type" : "string"
},
"isPrimary" : {
"type" : "boolean"
},
"jsonValidationFile" : {
"$ref" : "#/properties/policy/properties/json-validation-files/oneOf/0/items",
"type" : "object"
}
},
"required" : [
"jsonValidationFile"
],
"type" : "object"
},
"type" : "array"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"json-validation-files" : {
"oneOf" : [
{
"items" : {
"oneOf" : [
{
"required" : [
"id"
]
},
{
"required" : [
"id",
"$ref"
]
},
{
"required" : [
"id",
"link"
]
}
],
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"$ref" : {
"format" : "uri",
"type" : "string"
},
"contents" : {
"type" : "string"
},
"fileName" : {
"type" : "string"
},
"isBase64" : {
"type" : "boolean"
},
"link" : {
"format" : "uri",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"methods" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"name" : {
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"name" : {
"description" : "The unique user-given name of the policy. Policy names cannot contain spaces or special characters. Allowed characters are a-z, A-Z, 0-9, dot, dash (-), colon (:) and underscore (_).",
"type" : "string"
},
"open-api-files" : {
"items" : {
"oneOf" : [
{
"properties" : {
"link" : {
"format" : "uri",
"type" : "string"
}
},
"required" : [
"link"
],
"type" : "object"
},
{
"properties" : {
"filename" : {
"type" : "string"
}
},
"required" : [
"filename"
],
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"type" : "array"
},
"parameters" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines parameters that the security policy permits in requests.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"allowEmptyValue" : {
"description" : "Determines whether an empty value is allowed for a parameter.",
"type" : "boolean"
},
"allowRepeatedParameterName" : {
"description" : "Determines whether multiple parameter instances with the same name are allowed in one request.",
"type" : "boolean"
},
"arraySerializationFormat" : {
"description" : "Specifies type of serialization for array of primitives parameter.\nSerialization defines how multiple values are delimited - format that can be transmitted and reconstructed later:\n - **pipe**: pipe-separated values. Array color=[\"blue\",\"black\"] -> color=blue|black.\n - **form**: ampersand-separated values. Array color=[\"blue\",\"black\"] -> color=blue,black.\n - **matrix**: semicolon-prefixed values. Array color=[\"blue\",\"black\"] -> ;color=blue,black.\n - **tsv**: tab-separated values. Aarray color=[\"blue\",\"black\"] -> color=blue\\tblack.\n - **csv**: comma-separated values. Array color=[\"blue\",\"black\"] -> color=blue,black.\n - **label**: dot-prefixed values. Array color=[\"blue\",\"black\"] -> .blue.black.\n - **multi**: multiple parameter instances rather than multiple values. Array color=[\"blue\",\"black\"] -> color=blue&color=black.\n - **ssv**: space-separated values. Array color=[\"blue\",\"black\"] -> color=blue black.\n - **multipart**: defines array of files.\n\n**Notes**:\n - This attribute is relevant only for parameters with **array** *valueType*.\n - **multi** and **form** serializations can be defined for parameter with *query*, *form-data* or *cookie* locations only.\n - **multipart** serialization can be defined for parameter with *form-data* location only.\n - **matrix** and **label** serializations can be defined for parameter with *path* location only.",
"enum" : [
"csv",
"form",
"label",
"matrix",
"multi",
"multipart",
"pipe",
"ssv",
"tsv"
],
"type" : "string"
},
"arrayUniqueItemsCheck" : {
"description" : "Determines whether items in an array parameter must be unique.\nThis attribute is relevant only for parameters with **array** *valueType*.",
"type" : "boolean"
},
"attackSignaturesCheck" : {
"description" : "Determines whether attack signatures and threat campaigns must be detected in a parameter's value.\nThis attribute is relevant only for parameters with **alpha-numeric** or **binary** *dataType*.",
"type" : "boolean"
},
"checkMaxItemsInArray" : {
"description" : "Determines whether an array parameter has a restricted maximum number of items.\nThis attribute is relevant only for parameters with **array** *valueType*.",
"type" : "boolean"
},
"checkMaxValue" : {
"description" : "Determines whether the parameter has a restricted maximum value.\nThis attribute is relevant only for parameters with **integer** or **decimal** *dataType*.",
"type" : "boolean"
},
"checkMaxValueLength" : {
"description" : "Determines whether a parameter has a restricted maximum length for value.",
"type" : "boolean"
},
"checkMetachars" : {
"description" : "Determines whether disallowed metacharacters must be detected in a parameter's name.\nThis attribute is relevant only for **wildcard** parameters with **alpha-numeric** *dataType*.",
"type" : "boolean"
},
"checkMinItemsInArray" : {
"description" : "Determines whether an array parameter has a restricted minimum number of items.\nThis attribute is relevant only for parameters with **array** *valueType*.",
"type" : "boolean"
},
"checkMinValue" : {
"description" : "Determines whether a parameter has a restricted minimum value.\nThis attribute is relevant only for parameters with **integer** or **decimal** *dataType*.",
"type" : "boolean"
},
"checkMinValueLength" : {
"description" : "Determines whether a parameter has a restricted minimum length for value.",
"type" : "boolean"
},
"checkMultipleOfValue" : {
"description" : "Determines whether a parameter's value is a multiple of a number defined in *multipleOf*.\nThis attribute is relevant only for parameters with **integer** or **decimal** *dataType*.",
"type" : "boolean"
},
"contentProfile" : {
"properties" : {
"contentProfile" : {
"properties" : {
"name" : {
"type" : "string"
}
},
"type" : "object"
}
},
"type" : "object"
},
"dataType" : {
"description" : "Specifies data type of parameter's value:\n\n - **alpha-numeric**: specifies that the value of parameter can be any text consisting of letters, digits, and the underscore character.\n - **binary**: specifies there is no text limit for the value of a parameter (length checks only).\n - **phone**: specifies that the value of a parameter can be text in telephone number format only.\n - **email**: specifies that the value of a parameter must be text in email format only.\n - **boolean**: specifies that the value of a parameter must be boolean (only *true* and *false* values are allowed).\n - **integer**: specifies that the value of a parameter must be whole numbers only (no decimals).\n - **decimal**: specifies that the value of a parameter is numbers only and can include decimals.\n\n**Notes**:\n- This attribute is relevant for parameters with **array** or **user-input** *valueType* only.",
"enum" : [
"alpha-numeric",
"binary",
"phone",
"email",
"boolean",
"integer",
"decimal"
],
"type" : "string"
},
"decodeValueAsBase64" : {
"description" : "Specifies whether the the system should detect or require values to be Base64 encoded:\n\n - **disabled**: the value will not be decoded as Base64 content.\n - **enabled**: the value will be checked whether it can be decoded as Base64 and, if so, security checks will be performed on the decoded value.\n - **required**: the value must be decoded as Base64. Security checks will be performed on the decoded value.\n\n**Notes**:\n- This attribute is relevant for parameters with **binary**, **auto-detect**, or **user-input** *valueType* only.",
"enum" : [
"disabled",
"enabled",
"required"
],
"type" : "string"
},
"disallowFileUploadOfExecutables" : {
"description" : "Determines whether a parameter's value cannot have binary executable content.\nThis attribute is relevant only for parameters with **binary** *dataType*.",
"type" : "boolean"
},
"enableRegularExpression" : {
"description" : "Determines whether the parameter value includes the pattern defined in *regularExpression*.\nThis attribute is relevant only for parameters with **alpha-numeric** *dataType*.",
"type" : "boolean"
},
"exclusiveMax" : {
"description" : "Determines whether the maximum value defined in *maximumValue* attribute is exclusive.\nThis attribute is relevant only if *checkMaxValue* is set to **true**.",
"type" : "boolean"
},
"exclusiveMin" : {
"description" : "Determines whether a minimum value defined in *minimumValue* attribute is exclusive.\nThis attribute is relevant only if *checkMinValue* is set to **true**.",
"type" : "boolean"
},
"explodeObjectSerialization" : {
"description" : "Specifies whether an array or object parameters should have separate values for each array item or object property.\nThis attribute is relevant only if *objectSerializationStyle* is defined.\n\n**Notes**:\n- This attribute is not relevant for parameters with **deep-object**, **space-delimited** or **pipe-delimited** *objectSerializationStyle*.",
"type" : "boolean"
},
"hostNameRepresentation" : {
"enum" : [
"any",
"domain-name",
"ip-address"
],
"type" : "string"
},
"isCookie" : {
"description" : "Determines whether a parameter is located in the value of Cookie header.\n*parameterLocation* attribute is ignored if **isCookie** is set to *true*.",
"type" : "boolean"
},
"isHeader" : {
"description" : "Determines whether a parameter is located in headers as one of the headers.\n*parameterLocation* attribute is ignored if **isHeader** is set to *true*.",
"type" : "boolean"
},
"level" : {
"description" : "Specifies whether the parameter is associated with a URL, a flow, or neither.",
"enum" : [
"global",
"url"
],
"type" : "string"
},
"mandatory" : {
"description" : "Determines whether a parameter must exist in the request.",
"type" : "boolean"
},
"maxItemsInArray" : {
"description" : "Determines the restriction for the maximum number of items in an array parameter.\nThis attribute is relevant only if *checkMaxItemsInArray* is set to **true**.",
"minimum" : 0,
"type" : "integer"
},
"maximumLength" : {
"description" : "Determines the restriction for the maximum length of parameter's value.\nThis attribute is relevant only if *checkMaxValueLength* is set to **true**.",
"minimum" : 0,
"type" : "integer"
},
"maximumValue" : {
"description" : "Determines the restriction for the maximum value of parameter.\nThis attribute is relevant only if *checkMaxValue* is set to **true**.",
"type" : "number"
},
"metacharsOnParameterValueCheck" : {
"description" : "Determines whether disallowed metacharacters must be detected in a parameter's value.\nThis attribute is relevant only for parameters with **alpha-numeric** *dataType*.",
"type" : "boolean"
},
"minItemsInArray" : {
"description" : "Determines the restriction for the minimum number of items in an array parameter.\nThis attribute is relevant only if *checkMinItemsInArray* is set to **true**.",
"minimum" : 0,
"type" : "integer"
},
"minimumLength" : {
"description" : "Determines the restriction for the minimum length of parameter's value.\nThis attribute is relevant only if *checkMinValueLength* is set to **true**.",
"minimum" : 0,
"type" : "integer"
},
"minimumValue" : {
"description" : "Determines the restriction for the minimum value of a parameter.\nThis attribute is relevant only if *checkMinValue* is set to **true**.",
"type" : "number"
},
"multipleOf" : {
"description" : "Determines the number by which a parameter's value is divisible without remainder.\nThis number must be positive and it may be a floating-point number.\nThis attribute is relevant only if *checkMultipleOfValue* is set to **true**.",
"type" : "number"
},
"name" : {
"description" : "Specifies the name of a parameter which must be permitted in requests.\nFormat of parameter name attribute differs depending on *type* attribute:\n - **explicit** *type*: name of permitted parameter in request should literally match.\n - **wildcard** *type*: name of permitted parameter in request should match wildcard expression.\n\nThe syntax for wildcard entities is based on shell-style wildcard characters.\nThe list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n - **\\***: Matches all characters\n - **?**: Matches any single character\n - **[abcde]**: Matches exactly one of the characters listed\n - **[!abcde]**: Matches any character not listed\n - **[a-e]**: Matches exactly one character in the range\n - **[!a-e]**: Matches any character not in the range\n\n**Notes**:\n - Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.\n - Empty parameter name is allowed for **explicit** *type*",
"type" : "string"
},
"nameMetacharOverrides" : {
"description" : "Determines metacharacters whose security policy settings are overridden for this parameter, and which action the security policy takes when it discovers a request for this parameter that has these metacharacters in the name.\nThis attribute is relevant only if *checkMetachars* is set to **true**.",
"items" : {
"properties" : {
"isAllowed" : {
"description" : "Specifies permission of *metachar* - when *false*, then character is prohibited.",
"type" : "boolean"
},
"metachar" : {
"description" : "Specifies character in hexadecimal format with special allowance.",
"type" : "string"
}
},
"required" : [
"metachar"
],
"type" : "object"
},
"type" : "array"
},
"objectSerializationStyle" : {
"description" : "Specifies the type of serialization for an object or complex array parameter.\nSerialization defines how multiple values are delimited - format that can be transmitted and reconstructed later:\n - **pipe-delimited**: pipe-separated values. Object color={\"R\":100,\"G\":200} -> color=R|100|G|200.\n - **form**: ampersand-separated values. Object color={\"R\":100,\"G\":200} -> color=R,100,G,200 if *explodeObjectSerialization* set to **false** or -> R=100&G=200 if *explodeObjectSerialization* set to **true**.\n - **space-delimited**: space-separated values. Object color={\"R\":100,\"G\":200} -> color=R 100 G 200.\n - **deep-object**: rendering nested objects. Object color={\"R\":100,\"G\":200} -> color[R]=100&color[G]=200.\n - **matrix**: semicolon-prefixed values. Object color={\"R\":100,\"G\":200} -> ;color=R,100,G,200 if *explodeObjectSerialization* set to **false** or -> ;R=100;G=200 if *explodeObjectSerialization* set to **true**.\n - **simple**: comma-separated values. Object color={\"R\":100,\"G\":200} -> R,100,G,200 if *explodeObjectSerialization* set to **false** or -> R=100,G=200 if *explodeObjectSerialization* set to **true**.\n - **label**: dot-prefixed values. Object color={\"R\":100,\"G\":200} -> .R.100.G.200 if *explodeObjectSerialization* set to **false** or -> .R=100.G=200 if *explodeObjectSerialization* set to **true**.\n\n**Notes**:\n - This attribute is relevant only for parameters with **object** or **openapi-array** *valueType*.\n - **form** serialization can be defined for a parameter with *query*, *form-data* or *cookie* locations only.\n - **matrix** and **label** serializations can be defined for an array parameter with *path* location only.\n - **simple** serializations can be defined for a parameter with *path* and *header* locations only.\n - **deep-object** serialization can be defined for a parameter with *query* or *form-data* locations only.",
"enum" : [
"deep-object",
"form",
"label",
"matrix",
"pipe-delimited",
"simple",
"space-delimited"
],
"type" : "string"
},
"parameterEnumValues" : {
"description" : "Determines the set of possible parameter's values.\nThis attribute is not relevant for parameters with **phone**, **email** or **binary** *dataType*.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"parameterLocation" : {
"description" : "Specifies location of parameter in request:\n\n - **any**: in query string, in POST data (body) or in URL path.\n - **query**: in query string.\n - **form-data**: in POST data (body).\n - **cookie**: in value of Cookie header.\n - **path**: in URL path.\n - **header**: in request headers.\n\n**Notes**:\n - **path** location can be defined for parameter with **global** *level* only.\n - **path**, **header** and **cookie** location can be defined for parameter with **explicit** *type* only.\n - **header** and **cookie** location cannot be defined for parameter with empty *name*.",
"enum" : [
"any",
"cookie",
"form-data",
"header",
"path",
"query"
],
"type" : "string"
},
"regularExpression" : {
"description" : "Determines a positive regular expression (PCRE) for a parameter's value.\nThis attribute is relevant only if *enableRegularExpression* is set to **true**.\n\n**Notes**:\n - The length of a regular expression is limited to 254 characters.",
"type" : "string"
},
"sensitiveParameter" : {
"description" : "Determines whether a parameter is sensitive and must be not visible in logs nor in the user interface.\nInstead of the actual value, a string of asterisks is shown for this parameter.\nUse it to protect sensitive user input, such as a password or a credit card number, in a validated request.",
"type" : "boolean"
},
"signatureOverrides" : {
"description" : "Determines attack signatures whose security policy settings are overridden for this parameter, and which action the security policy takes when it discovers a request for this parameter that matches these attack signatures.\nThis attribute is relevant only if *signatureOverrides* is set to **true**.",
"items" : {
"properties" : {
"enabled" : {
"description" : "Specifies, when true, that the overridden signature is enforced",
"type" : "boolean"
},
"name" : {
"description" : "The signature name which, along with the signature tag, identifies the signature.",
"type" : "string"
},
"signatureId" : {
"description" : "The signature ID which identifies the signature.",
"type" : "integer"
},
"tag" : {
"description" : "The signature tag which, along with the signature name, identifies the signature.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"staticValues" : {
"description" : "Determines the set of possible parameter's values.\nThis attribute is relevant for parameters with **static-content** *valueType* only.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"type" : {
"description" : "Specifies the type of the *name* attribute.",
"enum" : [
"explicit",
"wildcard"
],
"type" : "string"
},
"url" : {
"$ref" : "#/properties/policy/properties/urls/oneOf/0/items",
"type" : "object"
},
"valueMetacharOverrides" : {
"description" : "Determines metacharacters whose security policy settings are overridden for this parameter, and which action the security policy takes when it discovers a request parameter that has these metacharacters in its value.\nThis attribute is relevant only if *metacharsOnParameterValueCheck* is set to **true**.",
"items" : {
"properties" : {
"isAllowed" : {
"description" : "Specifies permission of *metachar* - when *false*, then character is prohibited.",
"type" : "boolean"
},
"metachar" : {
"description" : "Specifies character in hexadecimal format with special allowance.",
"type" : "string"
}
},
"required" : [
"metachar"
],
"type" : "object"
},
"type" : "array"
},
"valueType" : {
"description" : "Specifies type of parameter's value:\n\n - **object**: the parameter's value is complex object defined by JSON schema.\n - **dynamic-content**: the parameter's content changes dynamically.\n - **openapi-array**: the parameter's value is complex array defined by JSON schema.\n - **ignore**: the system does not perform validity checks on the value of the parameter.\n - **static-content**: the parameter has a static, or pre-defined, value(s).\n - **json**: the parameter's value is JSON data.\n - **array**: the parameter's value is array of primitives.\n - **user-input**: the parameter's value is provided by user-input.\n - **xml**: the parameter's value is XML data.\n - **auto-detect**: the parameter's value can be user-input, XML data or JSON data. The system automatically classifies the type of value.\n - **dynamic-parameter-name**: the parameter's name changes dynamically.\n\n**Notes**:\n - **dynamic-parameter-name** value type can be defined for a parameter with **flow** *level* and **explicit** *type* only.\n - **dynamic-content** value type can be defined for a parameter with **explicit** *type* only.",
"enum" : [
"array",
"auto-detect",
"ignore",
"json",
"object",
"openapi-array",
"static-content",
"user-input",
"xml"
],
"type" : "string"
},
"wildcardOrder" : {
"description" : "Specifies the order in which wildcard entities are organized.\nMatching of an enforced parameter with a defined wildcard parameter happens based on order from smaller to larger.",
"type" : "integer"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"response-pages" : {
"oneOf" : [
{
"items" : {
"description" : "The Security Policy has a default blocking response page that it returns to the client when the client request, or the web server response, is blocked by the security policy. You can change the way the system responds to blocked requests. All default response pages contain a variable, <%TS.request.ID()%>, that the system replaces with a support ID number when it issues the page.",
"properties" : {
"ajaxActionType" : {
"description" : "Which content, or URL, the system sends to the client as a response to an AJAX request that does not comply with the security policy.\n- **alert-popup**: The system opens a message as a popup screen. Type the message the system displays in the popup screen, or leave the default text.\n- **custom**: A response text that will replace the frame or page which generated the AJAX request. The system provides additional options where you can type the response body you prefer.\n- **redirect**: The system redirects the user to a specific web page instead of viewing a response page. Type the web page's full URL path, for example, http://www.redirectpage.com. ",
"enum" : [
"alert-popup",
"custom",
"redirect"
],
"type" : "string"
},
"ajaxCustomContent" : {
"description" : "Custom message typed by user as a response for blocked AJAX request.",
"type" : "string"
},
"ajaxEnabled" : {
"description" : "When enabled, the system injects JavaScript code into responses. You must enable this toggle in order to configure an Application Security Manager AJAX response page which is returned when the system detects an AJAX request that does not comply with the security policy.",
"type" : "boolean"
},
"ajaxPopupMessage" : {
"description" : "Default message provided by the system as a response for blocked AJAX request. Can be manipulated by user, but <%TS.request.ID()%> must be included in this message.",
"type" : "string"
},
"ajaxRedirectUrl" : {
"description" : "The system redirects the user to a specific web page instead of viewing a response page. Type the web page's full URL path, for example, http://www.redirectpage.com. To redirect the blocking page to a URL with a support ID in the query string, type the URL and the support ID in the following format: http://www.example.com/blocking_page.php?support_id=<%TS.request.ID()%>. The system replaces <%TS.request.ID%> with the relevant support ID so that the blocked request is redirected to the URL with the relevant support ID.",
"type" : "string"
},
"grpcStatusCode" : {
"oneOf" : [
{
"type" : "integer"
},
{
"enum" : [
"ABORTED",
"ALREADY_EXISTS",
"CANCELLED",
"DATA_LOSS",
"DEADLINE_EXCEEDED",
"FAILED_PRECONDITION",
"INTERNAL",
"INVALID_ARGUMENT",
"NOT_FOUND",
"OK",
"OUT_OF_RANGE",
"PERMISSION_DENIED",
"RESOURCE_EXHAUSTED",
"UNAUTHENTICATED",
"UNAVAILABLE",
"UNIMPLEMENTED",
"UNKNOWN"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"grpcStatusMessage" : {
"type" : "string"
},
"responseActionType" : {
"description" : "Which action the system takes, and which content the system sends to the client, as a response when the security policy blocks the client request.\n- **custom**: The system returns a response page with HTML code that the user defines.\n- **default**: The system returns the system-supplied response page in HTML. No further configuration is needed.\n- **erase-cookies**: The system deletes all client side domain cookies. This is done in order to block web application users once, and not from the entire web application. The system displays this text in the response page. You cannot edit this text.\n- **redirect**: The system redirects the user to a specific web page instead of viewing a response page. The system provides an additional setting where you can indicate the redirect web page.\n- **soap-fault**: Displays the system-supplied response written in SOAP fault message structure. Use this type when a SOAP request is blocked due to an XML related violation. You cannot edit this text.",
"enum" : [
"custom",
"default",
"erase-cookies",
"redirect",
"soap-fault"
],
"type" : "string"
},
"responseContent" : {
"description" : "The content the system sends to the client in response to an illegal blocked request.",
"type" : "string"
},
"responseHeader" : {
"description" : "The response headers that the system sends to the client as a response to an illegal blocked request.",
"type" : "string"
},
"responsePageType" : {
"description" : "The different types of blocking response pages which are available from the system:\n- **ajax**: The system sends the AJAX Blocking Response Page when the security policy blocks an AJAX request that does not comply with the security policy.\n- **default**: The system sends the default response when the security policy blocks a client request.\n- **grpc**: The system sends the gRPC response when the security policy blocks a client request that contains gRPC message that does not comply with the settings of a gRPC profile configured in the security policy.\n- **xml**: The system sends the XML response page when the security policy blocks a client request that contains XML content that does not comply with the settings of an XML profile configured in the security policy.",
"enum" : [
"ajax",
"default",
"grpc",
"xml"
],
"type" : "string"
},
"responseRedirectUrl" : {
"description" : "The particular URL to which the system redirects the user. To redirect the blocking page to a URL with a support ID in the query string, type the URL and the support ID in the following format: http://www.example.com/blocking_page.php?support_id=<%TS.request.ID()%>. The system replaces <%TS.request.ID%> with the relevant support ID so that the blocked request is redirected to the URL with the relevant support ID.",
"type" : "string"
}
},
"required" : [
"responsePageType"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"sensitive-parameters" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines sensitive parameters.\nThe contents of these parameters are not visible in logs nor in the user interfaces.\nInstead of actual values a string of asterisks is shown for these parameters.\nUse these parameters to protect sensitive user input, such as a password or a credit card number, in a validated request.\nA parameter name of \"password\" is always defined as sensitive by default.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"name" : {
"description" : "Name of a parameter whose values the system should consider sensitive.",
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"server-technologies" : {
"oneOf" : [
{
"items" : {
"description" : "The server technology is a server-side application, framework, web server or operating system type that is configured in the policy in order to adapt the policy to the checks needed for the respective technology.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"serverTechnologyName" : {
"description" : "Specifies the name of the selected policy. For example, PHP will add attack signatures that cover known PHP vulnerabilities.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"signature-requirements" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"maxRevisionDatetime" : {
"type" : "string"
},
"minRevisionDatetime" : {
"type" : "string"
},
"tag" : {
"type" : "string"
}
},
"required" : [
"tag"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"signature-sets" : {
"oneOf" : [
{
"items" : {
"description" : "Defines behavior when signatures found within a signature-set are detected in a request. Settings are culmulative, so if a signature is found in any set with block enabled, that signature will have block enabled.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"alarm" : {
"description" : "If enabled - when a signature from this signature set is detected in a request - the request is logged.",
"type" : "boolean"
},
"block" : {
"description" : "If enabled - when a signature from this signature set is detected in a request - the request is blocked.",
"type" : "boolean"
},
"name" : {
"description" : "Signature set name.",
"type" : "string"
},
"signatureSet" : {
"description" : "Defines signature set.",
"properties" : {
"filter" : {
"description" : "Specifies filter that defines signature set.",
"properties" : {
"accuracyFilter" : {
"enum" : [
"all",
"eq",
"ge",
"le"
],
"type" : "string"
},
"accuracyValue" : {
"enum" : [
"all",
"high",
"low",
"medium"
],
"type" : "string"
},
"attackType" : {
"properties" : {
"name" : {
"type" : "string"
}
},
"type" : "object"
},
"hasCve" : {
"enum" : [
"all",
"no",
"yes"
],
"type" : "string"
},
"lastUpdatedFilter" : {
"enum" : [
"after",
"all",
"before"
],
"type" : "string"
},
"lastUpdatedValue" : {
"type" : "string"
},
"riskFilter" : {
"enum" : [
"all",
"eq",
"ge",
"le"
],
"type" : "string"
},
"riskValue" : {
"enum" : [
"all",
"high",
"low",
"medium"
],
"type" : "string"
},
"signatureType" : {
"enum" : [
"all",
"request",
"response"
],
"type" : "string"
},
"tagFilter" : {
"description" : "Filter by signature tagValue.\n\n- **all**: no filter applied.\n- **eq**: only signatures with a tag that equals tagValue are added to the signature set.\n- **untagged**: only signatures without a tag are added to the signature set.",
"enum" : [
"all",
"eq",
"untagged"
],
"type" : "string"
},
"tagValue" : {
"description" : "Value for the tagFilter.\nRelevant only for the **eq** value of tagFilter.",
"type" : "string"
},
"userDefinedFilter" : {
"enum" : [
"all",
"no",
"yes"
],
"type" : "string"
}
},
"type" : "object"
},
"signatures" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
},
"signatureId" : {
"type" : "integer"
},
"tag" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"systems" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"type" : {
"enum" : [
"filter-based",
"manual"
],
"type" : "string"
}
},
"type" : "object"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"signature-settings" : {
"oneOf" : [
{
"properties" : {
"minimumAccuracyForAutoAddedSignatures" : {
"enum" : [
"high",
"low",
"medium"
],
"type" : "string"
}
},
"type" : "object"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"signatures" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines the properties of a signature on the policy.",
"properties" : {
"enabled" : {
"description" : "Specifies, if true, that the signature is enabled on the security policy. When false, the signature is disable on the security policy.",
"type" : "boolean"
},
"name" : {
"description" : "The signature name which, along with the signature tag, identifies the signature.",
"type" : "string"
},
"signatureId" : {
"description" : "The signature ID which identifies the signature.",
"type" : "integer"
},
"tag" : {
"description" : "The signature tag which, along with the signature name, identifies the signature. ",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"template" : {
"description" : "Specifies the template to populate the default attributes of a new policy.",
"properties" : {
"name" : {
"description" : "Specifies the name of the template used for the policy creation.",
"enum" : [
"POLICY_TEMPLATE_NGINX_BASE"
],
"type" : "string"
}
},
"required" : [
"name"
],
"type" : "object"
},
"threat-campaigns" : {
"oneOf" : [
{
"items" : {
"description" : "This section defines the enforcement state for the threat campaigns in the security policy.",
"properties" : {
"displayName" : {
"type" : "string"
},
"isEnabled" : {
"description" : "If enabled - threat campaign is enforced in the security policy.",
"type" : "boolean"
},
"name" : {
"description" : "Name of the threat campaign.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"urls" : {
"oneOf" : [
{
"items" : {
"description" : "In a security policy, you can manually specify the HTTP URLs that are allowed (or disallowed) in traffic to the web application being protected. When you create a security policy, wildcard URLs of * (representing all HTTP URLs) are added to the Allowed HTTP URLs lists.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"allowRenderingInFrames" : {
"description" : "Specifies the conditions for when the browser should allow this URL to be rendered in a frame or iframe.\nnever: Specifies that this URL must never be rendered in a frame or iframe. The web application instructs browsers to hide, or disable, frame and iframe parts of this URL.\nonly-same: Specifies that the browser may load the frame or iframe if the referring page is from the same protocol, port, and domain as this URL. This limits the user to navigate only within the same web application.",
"enum" : [
"never",
"only-same"
],
"type" : "string"
},
"allowRenderingInFramesOnlyFrom" : {
"description" : "Specifies that the browser may load the frame or iframe from a specified domain. Type the protocol and domain in URL format for example, http://www.mywebsite.com. Do not enter a sub-URL, such as http://www.mywebsite.com/index.",
"type" : "string"
},
"attackSignaturesCheck" : {
"description" : "Specifies, when true, that you want attack signatures and threat campaigns to be detected on this URL and possibly override the security policy settings of an attack signature or threat campaign specifically for this URL. After you enable this setting, the system displays a list of attack signatures and threat campaigns.",
"type" : "boolean"
},
"canChangeDomainCookie" : {
"type" : "boolean"
},
"clickjackingProtection" : {
"description" : "Specifies that the system adds the X-Frame-Options header to the domain URL's response header. This is done to protect the web application against clickjacking. Clickjacking occurs when an attacker lures a user to click illegitimate frames and iframes because the attacker hid them on legitimate visible website buttons. Therefore, enabling this option protects the web application from other web sites hiding malicious code behind them. The default is disabled. After you enable this option, you can select whether, and under what conditions, the browser should allow this URL to be rendered in a frame or iframe.",
"type" : "boolean"
},
"disallowFileUploadOfExecutables" : {
"type" : "boolean"
},
"html5CrossOriginRequestsEnforcement" : {
"description" : "The system extracts the Origin (domain) of the request from the Origin header.",
"properties" : {
"allowOriginsEnforcementMode" : {
"description" : "Allows you to specify a list of origins allowed to share data returned by this URL.",
"enum" : [
"replace-with",
"unmodified"
],
"type" : "string"
},
"checkAllowedMethods" : {
"description" : "Allows you to specify a list of methods that other web applications hosted in different domains can use when requesting this URL.",
"type" : "boolean"
},
"crossDomainAllowedOrigin" : {
"description" : "Allows you to specify a list of origins allowed to share data returned by this URL.",
"items" : {
"properties" : {
"includeSubDomains" : {
"description" : "If *true*, sub-domains of the allowed origin are also allowed to receive data from your web application.",
"type" : "boolean"
},
"originName" : {
"description" : "Type the domain name or IP address with which the URL can share data.\nWildcards are allowed in the names. For example: *.f5.com will match b.f5.com; however it will not match a.b.f5.com.",
"type" : "string"
},
"originPort" : {
"description" : "Select the port that other web applications can use to request data from your web application, or use the * wildcard for all ports.",
"oneOf" : [
{
"maximum" : 65535,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"all"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"originProtocol" : {
"description" : "Select the appropriate protocol for the allowed origin.",
"enum" : [
"http",
"http/https",
"https"
],
"type" : "string"
}
},
"required" : [
"originPort",
"originProtocol",
"originName"
],
"type" : "object"
},
"type" : "array"
},
"enforcementMode" : {
"description" : "Specify the option to determine how to handle CORS requests.\ndisabled: Do nothing related to cross-domain requests. Pass CORS requests exactly as set by the server.\nenforce: Allow cross-origin resource sharing as configured in the crossDomainAllowedOrigin setting. CORS requests are allowed from the domains specified as allowed origins. ",
"enum" : [
"disabled",
"enforce"
],
"type" : "string"
}
},
"type" : "object"
},
"isAllowed" : {
"description" : "If *true*, the URLs allowed by the security policy.",
"type" : "boolean"
},
"mandatoryBody" : {
"description" : "A request body is mandatory. This is relevant for any method acting as POST.",
"type" : "boolean"
},
"metacharOverrides" : {
"description" : "To allow or disallow specific meta characters in the name of this specific URL (and thus override the global meta character settings).",
"items" : {
"properties" : {
"isAllowed" : {
"description" : "If *true*, metacharacters and other characters are allowed in a URL.",
"type" : "boolean"
},
"metachar" : {
"description" : "ASCII representation of the character in Hex format",
"type" : "string"
}
},
"required" : [
"metachar"
],
"type" : "object"
},
"type" : "array"
},
"metacharsOnUrlCheck" : {
"description" : "Specifies, when true, that you want meta characters to be detected on this URL and possibly override the security policy settings of a meta character specifically for this URL. After you enable this setting, the system displays a list of meta characters.",
"type" : "boolean"
},
"method" : {
"description" : "Unique ID of a URL with a protocol type and name. Select a Method for the URL to create an API endpoint: URL + Method.",
"enum" : [
"ACL",
"BCOPY",
"BDELETE",
"BMOVE",
"BPROPFIND",
"BPROPPATCH",
"CHECKIN",
"CHECKOUT",
"CONNECT",
"COPY",
"DELETE",
"GET",
"HEAD",
"LINK",
"LOCK",
"MERGE",
"MKCOL",
"MKWORKSPACE",
"MOVE",
"NOTIFY",
"OPTIONS",
"PATCH",
"POLL",
"POST",
"PROPFIND",
"PROPPATCH",
"PUT",
"REPORT",
"RPC_IN_DATA",
"RPC_OUT_DATA",
"SEARCH",
"SUBSCRIBE",
"TRACE",
"TRACK",
"UNLINK",
"UNLOCK",
"UNSUBSCRIBE",
"VERSION_CONTROL",
"X-MS-ENUMATTS",
"*"
],
"type" : "string"
},
"methodOverrides" : {
"description" : "Specifies a list of methods that are allowed or disallowed for a specific URL. The list overrides the list of methods allowed or disallowed globally at the policy level.",
"items" : {
"properties" : {
"allowed" : {
"description" : "Specifies that the system allows you to override allowed methods for this URL. When selected, the global policy settings for methods are listed, and you can change what is allowed or disallowed for this URL.",
"type" : "boolean"
},
"method" : {
"description" : "Specifies a list of existing HTTP methods. All security policies accept standard HTTP methods by default.",
"enum" : [
"ACL",
"BCOPY",
"BDELETE",
"BMOVE",
"BPROPFIND",
"BPROPPATCH",
"CHECKIN",
"CHECKOUT",
"CONNECT",
"COPY",
"DELETE",
"GET",
"HEAD",
"LINK",
"LOCK",
"MERGE",
"MKCOL",
"MKWORKSPACE",
"MOVE",
"NOTIFY",
"OPTIONS",
"PATCH",
"POLL",
"POST",
"PROPFIND",
"PROPPATCH",
"PUT",
"REPORT",
"RPC_IN_DATA",
"RPC_OUT_DATA",
"SEARCH",
"SUBSCRIBE",
"TRACE",
"TRACK",
"UNLINK",
"UNLOCK",
"UNSUBSCRIBE",
"VERSION_CONTROL",
"X-MS-ENUMATTS"
],
"type" : "string"
}
},
"required" : [
"method"
],
"type" : "object"
},
"type" : "array"
},
"methodsOverrideOnUrlCheck" : {
"description" : "Specifies, when true, that you want methods to be detected on this URL and possibly override the security policy settings of a method specifically for this URL. After you enable this setting, the system displays a list of methods.",
"type" : "boolean"
},
"name" : {
"description" : "Specifies an HTTP URL that the security policy allows. The available types are:\n\n- **Explicit**: Specifies that the URL has a specific name and is not a wildcard entity. Type the name of a URL exactly as you expect it to appear in the request.\n- **Wildcard**: Specifies that any URL that matches the listed wildcard expression should be treated according to the wildcard attributes. Type a wildcard expression that matches the expected URL. For example, entering the wildcard expression * specifies that any URL is allowed by the security policy.\nThe syntax for wildcard entities is based on shell-style wildcard characters. The list below describes the wildcard characters that you can use so that the entity name can match multiple objects.\n\n- **\\***: Matches all characters\n- **?**: Matches any single character\n- **[abcde]**: Matches exactly one of the characters listed\n- **[!abcde]**: Matches any character not listed\n- **[a-e]**: Matches exactly one character in the range\n- **[!a-e]**: Matches any character not in the range\n\n**Note**: Wildcards do not match regular expressions. Do not use a regular expression as a wildcard.",
"type" : "string"
},
"operationId" : {
"description" : "The attribute operationId is used as an OpenAPI endpoint identifier.",
"type" : "string"
},
"positionalParameters" : {
"description" : "When checked (enabled), positional parameters are enabled in the URL.",
"items" : {
"properties" : {
"parameter" : {
"$ref" : "#/properties/policy/properties/parameters/oneOf/0/items",
"type" : "object"
},
"urlSegmentIndex" : {
"description" : "Select which to add: Text or Parameter and enter your desired segments. You can add multiple text and parameter segments.",
"minimum" : 1,
"type" : "integer"
}
},
"required" : [
"parameter",
"urlSegmentIndex"
],
"type" : "object"
},
"type" : "array"
},
"protocol" : {
"description" : "Specifies whether the protocol for the URL is HTTP or HTTPS.",
"enum" : [
"http",
"https"
],
"type" : "string"
},
"signatureOverrides" : {
"description" : "Array of signature overrides.\nSpecifies attack signatures whose security policy settings are overridden for this URL, and which action the security policy takes when it discovers a request for this URL that matches these attack signatures.",
"items" : {
"properties" : {
"enabled" : {
"description" : "Specifies, when true, that the overridden signature is enforced",
"type" : "boolean"
},
"name" : {
"description" : "The signature name which, along with the signature tag, identifies the signature.",
"type" : "string"
},
"signatureId" : {
"description" : "The signature ID which identifies the signature.",
"type" : "integer"
},
"tag" : {
"description" : "The signature tag which, along with the signature name, identifies the signature.",
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"type" : {
"description" : "Determines the type of the **name** attribute. Only when setting the type to wildcard will the special wildcard characters in the name be interpreted as such.",
"enum" : [
"explicit",
"wildcard"
],
"type" : "string"
},
"urlContentProfiles" : {
"description" : "Specifies how the system recognizes and enforces requests for this URL according to the requests' header content. The system automatically creates a default header-based content profile for HTTP, and you cannot delete it. However, requests for a URL may contain other types of content, such as JSON, XML, or other proprietary formats.",
"items" : {
"properties" : {
"contentProfile" : {
"properties" : {
"name" : {
"type" : "string"
}
},
"type" : "object"
},
"headerName" : {
"description" : "Specifies an explicit header name that must appear in requests for this URL. This field is not case-sensitive.",
"type" : "string"
},
"headerOrder" : {
"description" : "Displays the order in which the system checks header content of requests for this URL.",
"oneOf" : [
{
"type" : "integer"
},
{
"enum" : [
"default"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"headerValue" : {
"description" : "Specifies a simple pattern string (glob pattern matching) for the header value that must appear in legal requests for this URL; for example, *json*, xml_method?, or method[0-9]. If the header includes this pattern, the system assumes the request contains the type of data you select in the Request Body Handling setting. This field is case-sensitive.",
"type" : "string"
},
"type" : {
"description" : "- **Apply Content Signatures**: Do not parse the content; scan the entire payload with full-content attack signatures.\n- **Apply Value and Content Signatures**: Do not parse the content or extract parameters; process the entire payload with value and full-content attack signatures.\n- **Disallow**: Block requests for an URL containing this header content. Log the Illegal Request Content Type violation.\n- **Do Nothing**: Do not inspect or parse the content. Handle the header of the request as specified by the security policy.\n- **Form Data**: Parse content as posted form data in either URL-encoded or multi-part formats. Enforce the form parameters according to the policy.\n- **GWT**: Perform checks for data in requests, based on the configuration of the GWT (Google Web Toolkit) profile associated with this URL.\n- **JSON**: Review JSON data using an associated JSON profile, and use value attack signatures to scan the element values.\n- **XML**: Review XML data using an associated XML profile.",
"enum" : [
"apply-content-signatures",
"apply-value-and-content-signatures",
"disallow",
"do-nothing",
"form-data",
"grpc",
"gwt",
"json",
"xml"
],
"type" : "string"
}
},
"required" : [
"headerValue",
"headerName"
],
"type" : "object"
},
"type" : "array"
},
"wildcardOrder" : {
"description" : "Specifies the order index for wildcard URLs matching. Wildcard URLs with lower wildcard order will get checked for a match prior to URLs with higher wildcard order.",
"type" : "integer"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"whitelist-ips" : {
"oneOf" : [
{
"items" : {
"description" : "An IP address exception is an IP address that you want the system to treat in a specific way for a security policy.\nYou can use the IP address exception feature to create exceptions for IP addresses of internal tools that your company uses, such as penetration tools, manual or automatic scanners, or web scraping tools.\nYou can add an IP address exception and instruct the system how to handle traffic coming from that address.",
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"blockRequests" : {
"description" : "Specifies how the system responds to blocking requests sent from this IP address.\n- **Policy Default:** Specifies that the Policy Blocking Settings will be used for requests from this IP address.\n- **Never Block:** Specifies that the system does not block requests sent from this IP address, even if your security policy is configured to block all traffic.\n- **Always Block:** Specifies that the system blocks requests sent from this IP address on condition that IP is denylisted is set to Block under Policy Building Settings.",
"enum" : [
"always",
"never",
"policy-default"
],
"type" : "string"
},
"description" : {
"description" : "Specifies a brief description of the IP address.",
"type" : "string"
},
"ipAddress" : {
"description" : "Specifies the IP address that you want the system to trust.",
"type" : "string"
},
"ipMask" : {
"description" : "Specifies the netmask of the exceptional IP address. This is an optional field.",
"type" : "string"
},
"neverLogRequests" : {
"description" : "Specifies when enabled that the system does not log requests or responses sent from this IP address, even if the traffic is illegal, and even if your security policy is configured to log all traffic.",
"type" : "boolean"
}
},
"required" : [
"ipMask",
"ipAddress"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
},
"xml-profiles" : {
"oneOf" : [
{
"items" : {
"properties" : {
"$action" : {
"enum" : [
"delete"
],
"type" : "string"
},
"attackSignaturesCheck" : {
"type" : "boolean"
},
"defenseAttributes" : {
"properties" : {
"allowCDATA" : {
"type" : "boolean"
},
"allowDTDs" : {
"type" : "boolean"
},
"allowExternalReferences" : {
"type" : "boolean"
},
"allowProcessingInstructions" : {
"type" : "boolean"
},
"maximumAttributeValueLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumAttributesPerElement" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumChildrenPerElement" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumDocumentDepth" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumDocumentSize" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumElements" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumNSDeclarations" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumNameLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"maximumNamespaceLength" : {
"oneOf" : [
{
"maximum" : 2147483647,
"minimum" : 0,
"type" : "integer"
},
{
"enum" : [
"any"
],
"type" : "string"
},
{
"pattern" : "\\d+$",
"type" : "string"
}
]
},
"tolerateCloseTagShorthand" : {
"type" : "boolean"
},
"tolerateLeadingWhiteSpace" : {
"type" : "boolean"
},
"tolerateNumericNames" : {
"type" : "boolean"
}
},
"type" : "object"
},
"description" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"signatureOverrides" : {
"items" : {
"properties" : {
"enabled" : {
"type" : "boolean"
},
"name" : {
"type" : "string"
},
"signatureId" : {
"type" : "integer"
},
"tag" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "array"
},
"useXmlResponsePage" : {
"type" : "boolean"
}
},
"required" : [
"name"
],
"type" : "object"
},
"type" : "array"
},
{
"$ref" : "#/definitions/reference"
}
]
}
},
"required" : [
"name",
"template"
],
"type" : "object"
}
},
"type" : "object"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment