Data Source: oci_waas_waas_policy

This data source provides details about a specific Waas Policy resource in Oracle Cloud Infrastructure Web Application Acceleration and Security service.

Gets the details of a WAAS policy.

Example Usage

data "oci_waas_waas_policy" "test_waas_policy" {
	#Required
	waas_policy_id = oci_waas_waas_policy.test_waas_policy.id
}

Argument Reference

The following arguments are supported:

• waas_policy_id - (Required) The OCID of the WAAS policy.

Attributes Reference

The following attributes are exported:

• additional_domains - An array of additional domains for this web application.

• cname - The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF.

• compartment_id - The OCID of the WAAS policy’s compartment.

• defined_tags - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

• display_name - The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique.

• domain - The web application domain that the WAAS policy protects.

• freeform_tags - Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

• id - The OCID of the WAAS policy.

• origin_groups - The map of origin groups and their keys used to associate origins to the wafConfig. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests.

  • origins - The list of objects containing origin references and additional properties.

• origins - A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. Examples: primary or secondary.

  • custom_headers - A list of HTTP headers to forward to your origin.
    • name - The name of the header.
    • value - The value of the header.
  • http_port - The HTTP port on the origin that the web application listens on. If unspecified, defaults to 80. If 0 is specified - the origin is not used for HTTP traffic.
  • https_port - The HTTPS port on the origin that the web application listens on. If unspecified, defaults to 443. If 0 is specified - the origin is not used for HTTPS traffic.
  • uri - The URI of the origin. Does not support paths. Port numbers should be specified in the httpPort and httpsPort fields.

• policy_config - The configuration details for the WAAS policy.

  • certificate_id - The OCID of the SSL certificate to use if HTTPS is supported.

  • cipher_group - The set cipher group for the configured TLS protocol. This sets the configuration for the TLS connections between clients and edge nodes only.

    • DEFAULT: Cipher group supports TLS 1.0, TLS 1.1, TLS 1.2, TLS 1.3 protocols. It has the following ciphers enabled: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:!DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA

  • client_address_header - Specifies an HTTP header name which is treated as the connecting client’s IP address. Applicable only if isBehindCdn is enabled.

    The edge node reads this header and its value and sets the client IP address as specified. It does not create the header if the header is not present in the request. If the header is not present, the connecting IP address will be used as the client’s true IP address. It uses the last IP address in the header’s value as the true IP address.

    Example: X-Client-Ip: 11.1.1.1, 13.3.3.3

    In the case of multiple headers with the same name, only the first header will be used. It is assumed that CDN sets the correct client IP address to prevent spoofing.

    • X_FORWARDED_FOR: Corresponds to X-Forwarded-For header name.
    • X_CLIENT_IP: Corresponds to X-Client-Ip header name.
    • X_REAL_IP: Corresponds to X-Real-Ip header name.
    • CLIENT_IP: Corresponds to Client-Ip header name.
    • TRUE_CLIENT_IP: Corresponds to True-Client-Ip header name.

  • health_checks - Health checks monitor the status of your origin servers and only route traffic to the origins that pass the health check. If the health check fails, origin is automatically removed from the load balancing. There is roughly one health check per EDGE POP per period. Any checks that pass will be reported as “healthy”.

    • expected_response_code_group - The HTTP response codes that signify a healthy state.

      • 2XX: Success response code group.
      • 3XX: Redirection response code group.
      • 4XX: Client errors response code group.
      • 5XX: Server errors response code group.

    • expected_response_text - Health check will search for the given text in a case-sensitive manner within the response body and will fail if the text is not found.

    • headers - HTTP header fields to include in health check requests, expressed as "name": "value" properties. Because HTTP header field names are case-insensitive, any use of names that are case-insensitive equal to other names will be rejected. If Host is not specified, requests will include a Host header field with value matching the policy’s protected domain. If User-Agent is not specified, requests will include a User-Agent header field with value “waf health checks”.

      Note: The only currently-supported header fields are Host and User-Agent.

    • healthy_threshold - Number of successful health checks after which the server is marked up.

    • interval_in_seconds - Time between health checks of an individual origin server, in seconds.

    • is_enabled - Enables or disables the health checks.

    • is_response_text_check_enabled - Enables or disables additional check for predefined text in addition to response code.

    • method - An HTTP verb (i.e. HEAD, GET, or POST) to use when performing the health check.

    • path - Path to visit on your origins when performing the health check.

    • timeout_in_seconds - Response timeout represents wait time until request is considered failed, in seconds.

    • unhealthy_threshold - Number of failed health checks after which the server is marked down.

  • is_behind_cdn - Enabling isBehindCdn allows for the collection of IP addresses from client requests if the WAF is connected to a CDN.

  • is_cache_control_respected - Enable or disable automatic content caching based on the response cache-control header. This feature enables the origin to act as a proxy cache. Caching is usually defined using cache-control header. For example cache-control: max-age=120 means that the returned resource is valid for 120 seconds. Caching rules will overwrite this setting.

  • is_https_enabled - Enable or disable HTTPS support. If true, a certificateId is required. If unspecified, defaults to false.

  • is_https_forced - Force HTTP to HTTPS redirection. If unspecified, defaults to false.

  • is_origin_compression_enabled - Enable or disable GZIP compression of origin responses. If enabled, the header Accept-Encoding: gzip is sent to origin, otherwise, the empty Accept-Encoding: header is used.

  • is_response_buffering_enabled - Enable or disable buffering of responses from the origin. Buffering improves overall stability in case of network issues, but slightly increases Time To First Byte.

  • is_sni_enabled - SNI stands for Server Name Indication and is an extension of the TLS protocol. It indicates which hostname is being contacted by the browser at the beginning of the ‘handshake’-process. This allows a server to connect multiple SSL Certificates to one IP address and port.

  • load_balancing_method - An object that represents a load balancing method and its properties.

    • domain - The domain for which the cookie is set, defaults to WAAS policy domain.
    • expiration_time_in_seconds - The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session.
    • method - Load balancing methods are algorithms used to efficiently distribute traffic among origin servers.
      • IP_HASH: All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially.
      • ROUND_ROBIN: Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight.
      • STICKY_COOKIE: Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client’s next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request.
    • name - The name of the cookie used to track the persistence. Can contain any US-ASCII character except separator or control character.

  • tls_protocols - A list of allowed TLS protocols. Only applicable when HTTPS support is enabled. The TLS protocol is negotiated while the request is connecting and the most recent protocol supported by both the edge node and client browser will be selected. If no such version exists, the connection will be aborted.

    • TLS_V1: corresponds to TLS 1.0 specification.
    • TLS_V1_1: corresponds to TLS 1.1 specification.
    • TLS_V1_2: corresponds to TLS 1.2 specification.
    • TLS_V1_3: corresponds to TLS 1.3 specification.

    Enabled TLS protocols must go in a row. For example if TLS_v1_1 and TLS_V1_3 are enabled, TLS_V1_2 must be enabled too.

  • websocket_path_prefixes - ModSecurity is not capable to inspect WebSockets. Therefore paths specified here have WAF disabled if Connection request header from the client has the value Upgrade (case insensitive matching) and Upgrade request header has the value websocket (case insensitive matching). Paths matches if the concatenation of request URL path and query starts with the contents of the one of websocketPathPrefixes array value. In All other cases challenges, like JSC, HIC and etc., remain active.

• state - The current lifecycle state of the WAAS policy.

• time_created - The date and time the policy was created, expressed in RFC 3339 timestamp format.

• waf_config - The Web Application Firewall configuration for the WAAS policy.

  • access_rules - The access rules applied to the Web Application Firewall. Used for defining custom access policies with the combination of ALLOW, DETECT, and BLOCK rules, based on different criteria.

    • action - The action to take when the access criteria are met for a rule. If unspecified, defaults to ALLOW.

      • ALLOW: Takes no action, just logs the request.
      • DETECT: Takes no action, but creates an alert for the request.
      • BLOCK: Blocks the request by returning specified response code or showing error page.
      • BYPASS: Bypasses some or all challenges.
      • REDIRECT: Redirects the request to the specified URL. These fields are required when REDIRECT is selected: redirectUrl, redirectResponseCode.
      • SHOW_CAPTCHA: Show a CAPTCHA Challenge page instead of the requested page.

      Regardless of action, no further rules are processed once a rule is matched.

    • block_action - The method used to block requests if action is set to BLOCK and the access criteria are met. If unspecified, defaults to SET_RESPONSE_CODE.

    • block_error_page_code - The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the access criteria are met. If unspecified, defaults to ‘Access rules’.

    • block_error_page_description - The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the access criteria are met. If unspecified, defaults to ‘Access blocked by website owner. Please contact support.’

    • block_error_page_message - The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the access criteria are met. If unspecified, defaults to ‘Access to the website is blocked.’

    • block_response_code - The response status code to return when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE, and the access criteria are met. If unspecified, defaults to 403. The list of available response codes: 200, 201, 202, 204, 206, 300, 301, 302, 303, 304, 307, 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 444, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.

    • bypass_challenges - The list of challenges to bypass when action is set to BYPASS. If unspecified or empty, all challenges are bypassed.

      • JS_CHALLENGE: Bypasses JavaScript Challenge.
      • DEVICE_FINGERPRINT_CHALLENGE: Bypasses Device Fingerprint Challenge.
      • HUMAN_INTERACTION_CHALLENGE: Bypasses Human Interaction Challenge.
      • CAPTCHA: Bypasses CAPTCHA Challenge.

    • captcha_footer - The text to show in the footer when showing a CAPTCHA challenge when action is set to SHOW_CAPTCHA and the request is challenged.

    • captcha_header - The text to show in the header when showing a CAPTCHA challenge when action is set to SHOW_CAPTCHA and the request is challenged.

    • captcha_submit_label - The text to show on the label of the CAPTCHA challenge submit button when action is set to SHOW_CAPTCHA and the request is challenged.

    • captcha_title - The title used when showing a CAPTCHA challenge when action is set to SHOW_CAPTCHA and the request is challenged.

    • criteria - The list of access rule criteria. The rule would be applied only for the requests that matched all the listed conditions.

      • condition - The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.

        • URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the value field. URL must start with a /.
        • URL_IS_NOT: Matches if the concatenation of request URL path and query is not identical to the contents of the value field. URL must start with a /.
        • URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the value field. URL must start with a /.
        • URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the value field.
        • URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the value field.
        • URL_REGEX: Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
        • URL_DOES_NOT_MATCH_REGEX: Matches if the concatenation of request URL path and query is not described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
        • URL_DOES_NOT_START_WITH: Matches if the concatenation of request URL path and query does not start with the contents of the value field.
        • URL_PART_DOES_NOT_CONTAIN: Matches if the concatenation of request URL path and query does not contain the contents of the value field.
        • URL_PART_DOES_NOT_END_WITH: Matches if the concatenation of request URL path and query does not end with the contents of the value field.
        • IP_IS: Matches if the request originates from one of the IP addresses contained in the defined address list. The value in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n Example: “1.1.1.1\n1.1.1.2\n1.2.2.¹⁄₃₀”
        • IP_IS_NOT: Matches if the request does not originate from any of the IP addresses contained in the defined address list. The value in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n Example: “1.1.1.1\n1.1.1.2\n1.2.2.¹⁄₃₀”
        • IP_IN_LIST: Matches if the request originates from one of the IP addresses contained in the referenced address list. The value in this case is OCID of the address list.
        • IP_NOT_IN_LIST: Matches if the request does not originate from any IP address contained in the referenced address list. The value field in this case is OCID of the address list.
        • HTTP_HEADER_CONTAINS: The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. host:test.example.com is an example of a criteria value where host is the header field name and test.example.com is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. Example: With a criteria value of host:test.example.com, where host is the name of the field and test.example.com is the value of the host field, a request with the header values, Host: www.test.example.com will match, where as a request with header values of host: www.example.com or host: test.sub.example.com will not match.
        • HTTP_METHOD_IS: Matches if the request method is identical to one of the values listed in field. The value in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

        Example: “GET\nPOST” * HTTP_METHOD_IS_NOT: Matches if the request is not identical to any of the contents of the value field. The value in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

        Example: “GET\nPOST” * COUNTRY_IS: Matches if the request originates from one of countries in the value field. The value in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO’s website. Example: “AL\nDZ\nAM” * COUNTRY_IS_NOT: Matches if the request does not originate from any of countries in the value field. The value in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO’s website. Example: “AL\nDZ\nAM” * USER_AGENT_IS: Matches if the requesting user agent is identical to the contents of the value field. Example: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0 * USER_AGENT_IS_NOT: Matches if the requesting user agent is not identical to the contents of the value field. Example: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0

      • is_case_sensitive - When enabled, the condition will be matched with case-sensitive rules.

      • value - The criteria value.

    • name - The unique name of the access rule.

    • redirect_response_code - The response status code to return when action is set to REDIRECT.

      • MOVED_PERMANENTLY: Used for designating the permanent movement of a page (numerical code - 301).
      • FOUND: Used for designating the temporary movement of a page (numerical code - 302).

    • redirect_url - The target to which the request should be redirected, represented as a URI reference. Required when action is REDIRECT.

    • response_header_manipulation - An object that represents an action to apply to an HTTP response headers if all rule criteria will be matched regardless of action value.

      • action - The action can be one of these values: ADD_HTTP_RESPONSE_HEADER, EXTEND_HTTP_RESPONSE_HEADER, REMOVE_HTTP_RESPONSE_HEADER
      • header - A header field name that conforms to RFC 7230. Example: example_header_name
      • value - A header field value that conforms to RFC 7230. Example: example_value

  • address_rate_limiting - The IP address rate limiting settings used to limit the number of requests from an address.

    • allowed_rate_per_address - The number of allowed requests per second from one IP address. If unspecified, defaults to 1.
    • block_response_code - The response status code returned when a request is blocked. If unspecified, defaults to 503. The list of available response codes: 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.
    • is_enabled - Enables or disables the address rate limiting Web Application Firewall feature.
    • max_delayed_count_per_address - The maximum number of requests allowed to be queued before subsequent requests are dropped. If unspecified, defaults to 10.

  • caching_rules - A list of caching rules applied to the web application.

    • action - The action to take when the criteria of a caching rule are met.

      • CACHE: Caches requested content when the criteria of the rule are met.
      • BYPASS_CACHE: Allows requests to bypass the cache and be directed to the origin when the criteria of the rule is met.

    • caching_duration - The duration to cache content for the caching rule, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is 99. Mixing of multiple units is not supported. Only applies when the action is set to CACHE. Example: PT1H

    • client_caching_duration - The duration to cache content in the user’s browser, specified in ISO 8601 extended format. Supported units: seconds, minutes, hours, days, weeks, months. The maximum value that can be set for any unit is 99. Mixing of multiple units is not supported. Only applies when the action is set to CACHE. Example: PT1H

    • criteria - The array of the rule criteria with condition and value. The caching rule would be applied for the requests that matched any of the listed conditions.

      • condition - The condition of the caching rule criteria.

        • URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the value field.
        • URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the value field.
        • URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the value field.
        • URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the value field.

        URLs must start with a /. URLs can’t contain restricted double slashes //. URLs can’t contain the restricted ' & ? symbols. Resources to cache can only be specified by a URL, any query parameters are ignored.

      • value - The value of the caching rule criteria.

    • is_client_caching_enabled - Enables or disables client caching. Browsers use the Cache-Control header value for caching content locally in the browser. This setting overrides the addition of a Cache-Control header in responses.

    • key - The unique key for the caching rule.

    • name - The name of the caching rule.

  • captchas - A list of CAPTCHA challenge settings. These are used to challenge requests with a CAPTCHA to block bots.

    • failure_message - The text to show when incorrect CAPTCHA text is entered. If unspecified, defaults to The CAPTCHA was incorrect. Try again.
    • footer_text - The text to show in the footer when showing a CAPTCHA challenge. If unspecified, defaults to ‘Enter the letters and numbers as they are shown in the image above.’
    • header_text - The text to show in the header when showing a CAPTCHA challenge. If unspecified, defaults to ‘We have detected an increased number of attempts to access this website. To help us keep this site secure, please let us know that you are not a robot by entering the text from the image below.’
    • session_expiration_in_seconds - The amount of time before the CAPTCHA expires, in seconds. If unspecified, defaults to 300.
    • submit_label - The text to show on the label of the CAPTCHA challenge submit button. If unspecified, defaults to Yes, I am human.
    • title - The title used when displaying a CAPTCHA challenge. If unspecified, defaults to Are you human?
    • url - The unique URL path at which to show the CAPTCHA challenge.

  • custom_protection_rules - A list of the custom protection rule OCIDs and their actions.

    • action - The action to take when the custom protection rule is triggered. DETECT - Logs the request when the criteria of the custom protection rule are met. BLOCK - Blocks the request when the criteria of the custom protection rule are met.
    • exclusions -
      • exclusions - An array of The target property of a request that would allow it to bypass the protection rule. For example, when target is REQUEST_COOKIE_NAMES, the list may include names of cookies to exclude from the protection rule. When the target is ARGS, the list may include strings of URL query parameters and values from form-urlencoded XML, JSON, AMP, or POST payloads to exclude from the protection rule. Exclusions properties must not contain whitespace, comma or |. Note: If protection rules have been enabled that utilize the maxArgumentCount or maxTotalNameLengthOfArguments properties, and the target property has been set to ARGS, it is important that the exclusions properties be defined to honor those protection rule settings in a consistent manner.
      • target - The target of the exclusion.
    • id - The OCID of the custom protection rule.

  • device_fingerprint_challenge - The device fingerprint challenge settings. Used to detect unique devices based on the device fingerprint information collected in order to block bots.

    • action - The action to take on requests from detected bots. If unspecified, defaults to DETECT.
    • action_expiration_in_seconds - The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.
    • challenge_settings - The challenge settings if action is set to BLOCK.
      • block_action - The method used to block requests that fail the challenge, if action is set to BLOCK. If unspecified, defaults to SHOW_ERROR_PAGE.
      • block_error_page_code - The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE and the request is blocked. If unspecified, defaults to 403.
      • block_error_page_description - The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access blocked by website owner. Please contact support.
      • block_error_page_message - The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access to the website is blocked.
      • block_response_code - The response status code to return when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE or SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to 403. The list of available response codes: 200, 201, 202, 204, 206, 300, 301, 302, 303, 304, 307, 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 444, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.
      • captcha_footer - The text to show in the footer when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, default to Enter the letters and numbers as they are shown in image above.
      • captcha_header - The text to show in the header when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.
      • captcha_submit_label - The text to show on the label of the CAPTCHA challenge submit button when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Yes, I am human.
      • captcha_title - The title used when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Are you human?
    • failure_threshold - The number of failed requests allowed before taking action. If unspecified, defaults to 10.
    • failure_threshold_expiration_in_seconds - The number of seconds before the failure threshold resets. If unspecified, defaults to 60.
    • is_enabled - Enables or disables the device fingerprint challenge Web Application Firewall feature.
    • max_address_count - The maximum number of IP addresses permitted with the same device fingerprint. If unspecified, defaults to 20.
    • max_address_count_expiration_in_seconds - The number of seconds before the maximum addresses count resets. If unspecified, defaults to 60.

  • human_interaction_challenge - The human interaction challenge settings. Used to look for natural human interactions such as mouse movements, time on site, and page scrolling to identify bots.

    • action - The action to take against requests from detected bots. If unspecified, defaults to DETECT.
    • action_expiration_in_seconds - The number of seconds between challenges for the same IP address. If unspecified, defaults to 60.
    • challenge_settings - The challenge settings if action is set to BLOCK.
      • block_action - The method used to block requests that fail the challenge, if action is set to BLOCK. If unspecified, defaults to SHOW_ERROR_PAGE.
      • block_error_page_code - The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE and the request is blocked. If unspecified, defaults to 403.
      • block_error_page_description - The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access blocked by website owner. Please contact support.
      • block_error_page_message - The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access to the website is blocked.
      • block_response_code - The response status code to return when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE or SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to 403. The list of available response codes: 200, 201, 202, 204, 206, 300, 301, 302, 303, 304, 307, 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 444, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.
      • captcha_footer - The text to show in the footer when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, default to Enter the letters and numbers as they are shown in image above.
      • captcha_header - The text to show in the header when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.
      • captcha_submit_label - The text to show on the label of the CAPTCHA challenge submit button when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Yes, I am human.
      • captcha_title - The title used when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Are you human?
    • failure_threshold - The number of failed requests before taking action. If unspecified, defaults to 10.
    • failure_threshold_expiration_in_seconds - The number of seconds before the failure threshold resets. If unspecified, defaults to 60.
    • interaction_threshold - The number of interactions required to pass the challenge. If unspecified, defaults to 3.
    • is_enabled - Enables or disables the human interaction challenge Web Application Firewall feature.
    • is_nat_enabled - When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.
    • recording_period_in_seconds - The number of seconds to record the interactions from the user. If unspecified, defaults to 15.
    • set_http_header - Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action is set to DETECT.
      • name - The name of the header.
      • value - The value of the header.

  • js_challenge - The JavaScript challenge settings. Used to challenge requests with a JavaScript challenge and take the action if a browser has no JavaScript support in order to block bots.

    • action - The action to take against requests from detected bots. If unspecified, defaults to DETECT.

    • action_expiration_in_seconds - The number of seconds between challenges from the same IP address. If unspecified, defaults to 60.

    • are_redirects_challenged - When enabled, redirect responses from the origin will also be challenged. This will change HTTP ³⁰¹⁄₃₀₂ responses from origin to HTTP 200 with an HTML body containing JavaScript page redirection.

    • challenge_settings - The challenge settings if action is set to BLOCK.

      • block_action - The method used to block requests that fail the challenge, if action is set to BLOCK. If unspecified, defaults to SHOW_ERROR_PAGE.
      • block_error_page_code - The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE and the request is blocked. If unspecified, defaults to 403.
      • block_error_page_description - The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access blocked by website owner. Please contact support.
      • block_error_page_message - The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to Access to the website is blocked.
      • block_response_code - The response status code to return when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE or SHOW_ERROR_PAGE, and the request is blocked. If unspecified, defaults to 403. The list of available response codes: 200, 201, 202, 204, 206, 300, 301, 302, 303, 304, 307, 400, 401, 403, 404, 405, 408, 409, 411, 412, 413, 414, 415, 416, 422, 444, 494, 495, 496, 497, 499, 500, 501, 502, 503, 504, 507.
      • captcha_footer - The text to show in the footer when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, default to Enter the letters and numbers as they are shown in image above.
      • captcha_header - The text to show in the header when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to We have detected an increased number of attempts to access this webapp. To help us keep this webapp secure, please let us know that you are not a robot by entering the text from captcha below.
      • captcha_submit_label - The text to show on the label of the CAPTCHA challenge submit button when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Yes, I am human.
      • captcha_title - The title used when showing a CAPTCHA challenge when action is set to BLOCK, blockAction is set to SHOW_CAPTCHA, and the request is blocked. If unspecified, defaults to Are you human?

    • criteria - When defined, the JavaScript Challenge would be applied only for the requests that matched all the listed conditions.

      • condition - The criteria the access rule and JavaScript Challenge uses to determine if action should be taken on a request.

        • URL_IS: Matches if the concatenation of request URL path and query is identical to the contents of the value field. URL must start with a /.
        • URL_IS_NOT: Matches if the concatenation of request URL path and query is not identical to the contents of the value field. URL must start with a /.
        • URL_STARTS_WITH: Matches if the concatenation of request URL path and query starts with the contents of the value field. URL must start with a /.
        • URL_PART_ENDS_WITH: Matches if the concatenation of request URL path and query ends with the contents of the value field.
        • URL_PART_CONTAINS: Matches if the concatenation of request URL path and query contains the contents of the value field.
        • URL_REGEX: Matches if the concatenation of request URL path and query is described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
        • URL_DOES_NOT_MATCH_REGEX: Matches if the concatenation of request URL path and query is not described by the regular expression in the value field. The value must be a valid regular expression recognized by the PCRE library in Nginx (https://www.pcre.org).
        • URL_DOES_NOT_START_WITH: Matches if the concatenation of request URL path and query does not start with the contents of the value field.
        • URL_PART_DOES_NOT_CONTAIN: Matches if the concatenation of request URL path and query does not contain the contents of the value field.
        • URL_PART_DOES_NOT_END_WITH: Matches if the concatenation of request URL path and query does not end with the contents of the value field.
        • IP_IS: Matches if the request originates from one of the IP addresses contained in the defined address list. The value in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n Example: “1.1.1.1\n1.1.1.2\n1.2.2.¹⁄₃₀”
        • IP_IS_NOT: Matches if the request does not originate from any of the IP addresses contained in the defined address list. The value in this case is string with one or multiple IPs or CIDR notations separated by new line symbol \n Example: “1.1.1.1\n1.1.1.2\n1.2.2.¹⁄₃₀”
        • IP_IN_LIST: Matches if the request originates from one of the IP addresses contained in the referenced address list. The value in this case is OCID of the address list.
        • IP_NOT_IN_LIST: Matches if the request does not originate from any IP address contained in the referenced address list. The value field in this case is OCID of the address list.
        • HTTP_HEADER_CONTAINS: The HTTP_HEADER_CONTAINS criteria is defined using a compound value separated by a colon: a header field name and a header field value. host:test.example.com is an example of a criteria value where host is the header field name and test.example.com is the header field value. A request matches when the header field name is a case insensitive match and the header field value is a case insensitive, substring match. Example: With a criteria value of host:test.example.com, where host is the name of the field and test.example.com is the value of the host field, a request with the header values, Host: www.test.example.com will match, where as a request with header values of host: www.example.com or host: test.sub.example.com will not match.
        • HTTP_METHOD_IS: Matches if the request method is identical to one of the values listed in field. The value in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

        Example: “GET\nPOST” * HTTP_METHOD_IS_NOT: Matches if the request is not identical to any of the contents of the value field. The value in this case is string with one or multiple HTTP methods separated by new line symbol \n The list of available methods: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

        Example: “GET\nPOST” * COUNTRY_IS: Matches if the request originates from one of countries in the value field. The value in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO’s website. Example: “AL\nDZ\nAM” * COUNTRY_IS_NOT: Matches if the request does not originate from any of countries in the value field. The value in this case is string with one or multiple countries separated by new line symbol \n Country codes are in ISO 3166-1 alpha-2 format. For a list of codes, see ISO’s website. Example: “AL\nDZ\nAM” * USER_AGENT_IS: Matches if the requesting user agent is identical to the contents of the value field. Example: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0 * USER_AGENT_IS_NOT: Matches if the requesting user agent is not identical to the contents of the value field. Example: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0

      • is_case_sensitive - When enabled, the condition will be matched with case-sensitive rules.

      • value - The criteria value.

    • failure_threshold - The number of failed requests before taking action. If unspecified, defaults to 10.

    • is_enabled - Enables or disables the JavaScript challenge Web Application Firewall feature.

    • is_nat_enabled - When enabled, the user is identified not only by the IP address but also by an unique additional hash, which prevents blocking visitors with shared IP addresses.

    • set_http_header - Adds an additional HTTP header to requests that fail the challenge before being passed to the origin. Only applicable when the action is set to DETECT.

      • name - The name of the header.
      • value - The value of the header.

  • origin - The key in the map of origins referencing the origin used for the Web Application Firewall. The origin must already be included in Origins. Required when creating the WafConfig resource, but not on update.

  • origin_groups - The map of origin groups and their keys used to associate origins to the wafConfig. Origin groups allow you to apply weights to groups of origins for load balancing purposes. Origins with higher weights will receive larger proportions of client requests. To add additional origins to your WAAS policy, update the origins field of a UpdateWaasPolicy request.

  • protection_settings - The settings to apply to protection rules.

    • allowed_http_methods - The list of allowed HTTP methods. If unspecified, default to [OPTIONS, GET, HEAD, POST]. This setting only applies if a corresponding protection rule is enabled, such as the “Restrict HTTP Request Methods” rule (key: 911100).

    • block_action - If action is set to BLOCK, this specifies how the traffic is blocked when detected as malicious by a protection rule. If unspecified, defaults to SET_RESPONSE_CODE.

    • block_error_page_code - The error code to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 403.

    • block_error_page_description - The description text to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to Access blocked by website owner. Please contact support.

    • block_error_page_message - The message to show on the error page when action is set to BLOCK, blockAction is set to SHOW_ERROR_PAGE, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to ‘Access to the website is blocked.’

    • block_response_code - The response code returned when action is set to BLOCK, blockAction is set to SET_RESPONSE_CODE, and the traffic is detected as malicious by a protection rule. If unspecified, defaults to 403. The list of available response codes: 400, 401, 403, 405, 409, 411, 412, 413, 414, 415, 416, 500, 501, 502, 503, 504, 507.

    • is_response_inspected - Inspects the response body of origin responses. Can be used to detect leakage of sensitive data. If unspecified, defaults to false.

      Note: Only origin responses with a Content-Type matching a value in mediaTypes will be inspected.

    • max_argument_count - The maximum number of arguments allowed to be passed to your application before an action is taken. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to 255. This setting only applies if a corresponding protection rule is enabled, such as the “Number of Arguments Limits” rule (key: 960335). Example: If maxArgumentCount to 2 for the Max Number of Arguments protection rule (key: 960335), the following requests would be blocked: GET /myapp/path?query=one&query=two&query=three POST /myapp/path with Body {"argument1":"one","argument2":"two","argument3":"three"}

    • max_name_length_per_argument - The maximum length allowed for each argument name, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to 400. This setting only applies if a corresponding protection rule is enabled, such as the “Values Limits” rule (key: 960208).

    • max_response_size_in_ki_b - The maximum response size to be fully inspected, in binary kilobytes (KiB). Anything over this limit will be partially inspected. If unspecified, defaults to 1024.

    • max_total_name_length_of_arguments - The maximum length allowed for the sum of the argument name and value, in characters. Arguements are query parameters or body parameters in a PUT or POST request. If unspecified, defaults to 64000. This setting only applies if a corresponding protection rule is enabled, such as the “Total Arguments Limits” rule (key: 960341).

    • media_types - The list of media types to allow for inspection, if isResponseInspected is enabled. Only responses with MIME types in this list will be inspected. If unspecified, defaults to ["text/html", "text/plain", "text/xml"].

      Supported MIME types include:

      • text/html
      • text/plain
      • text/asp
      • text/css
      • text/x-script
      • application/json
      • text/webviewhtml
      • text/x-java-source
      • application/x-javascript
      • application/javascript
      • application/ecmascript
      • text/javascript
      • text/ecmascript
      • text/x-script.perl
      • text/x-script.phyton
      • application/plain
      • application/xml
      • text/xml

    • recommendations_period_in_days - The length of time to analyze traffic traffic, in days. After the analysis period, WafRecommendations will be populated. If unspecified, defaults to 10.

      Use GET /waasPolicies/{waasPolicyId}/wafRecommendations to view WAF recommendations.

  • whitelists - A list of IP addresses that bypass the Web Application Firewall.

    • address_lists - A list of OCID of IP address lists to include in the whitelist.
    • addresses - A set of IP addresses or CIDR notations to include in the whitelist.
    • name - The unique name of the whitelist.