Adding the ATP managed rule group to your web ACL

To use the AWSManagedRulesATPRuleSet rule group in your web ACL

1. Add the AWS managed rule group, AWSManagedRulesATPRuleSet to your web ACL, and Edit the rule group settings before saving.

   Note

   You are charged additional fees when you use this managed rule group. For more information, see AWS WAF Pricing.

2. In the Rule group configuration pane, provide the information that the ATP rule group uses to inspect login requests.

   1. For Use regular expression in paths, toggle this on if you want AWS WAF to perform regular expression matching for your login page path specifications.

      AWS WAF supports the pattern syntax used by the PCRE library libpcre with some exceptions. The library is documented at PCRE - Perl Compatible Regular Expressions. For information about AWS WAF support, see Supported regular expression syntax in AWS WAF.

   2. For Login path, provide the path of the login endpoint for your application. The rule group inspects only HTTP POST requests to your specified login endpoint.

      Note

      Matching for endpoints is case insensitive. Regex specifications must not contain the flag (?-i), which disables case insensitive matching. String specifications must start with a forward slash /.

      For example, for the URL https://example.com/web/login, you could provide the string path specification /web/login. Login paths that start with the path that you provide are considered a match. For example /web/login matches the login paths /web/login, /web/login/, /web/loginPage, and /web/login/thisPage, but doesn't match the login path /home/web/login or /website/login.

   3. For Request inspection, specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided. Your specification of the field names depends on the payload type.

      • JSON payload type – Specify the field names in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.

        For example, for the following example JSON payload, the username field specification is /login/username and the password field specification is /login/password.

        {
            "login": {
                "username": "THE_USERNAME",
                "password": "THE_PASSWORD"
            }
        }

      • FORM_ENCODED payload type – Use the HTML form names.

        For example, for an HTML form with input elements named username1 and password1, the username field specification is username1 and the password field specification is password1.

   4. If you're protecting Amazon CloudFront distributions, then under Response inspection, specify how your application indicates success or failure in its responses to login attempts.

      Note

      ATP response inspection is available only in web ACLs that protect CloudFront distributions.

      Specify a single component in the login response that you want ATP to inspect. For the Body and JSON component types, AWS WAF can inspect the first 65,536 bytes (64 KB) of the component.

      Provide your inspection criteria for the component type, as indicated by the interface. You must provide both success and failure criteria to inspect for in the component.

      For example, say your application indicates the status of a login attempt in the status code of the response, and uses 200 OK for success and 401 Unauthorized or 403 Forbidden for failure. You would set the response inspection Component type to Status code, then in the Success text box enter 200 and in the Failure text box, enter 401 on the first line and 403 on the second.

      The ATP rule group only counts responses that match your success or failure inspection criteria. The rule group rules act on clients while they have too high a failure rate among the responses that are counted. For accurate behavior by the rule group rules, be sure to provide complete information for both successful and failed login attempts.

      To see the rules that inspect login responses, look for VolumetricIpFailedLoginResponseHigh and VolumetricSessionFailedLoginResponseHigh in the rules listing at AWS WAF Fraud Control account takeover prevention (ATP) rule group.

3. Provide any additional configuration that you want for the rule group.

   You can further limit the scope of requests that the rule group inspects by adding a scope-down statement to the managed rule group statement. For example, you can inspect only requests with a specific query argument or cookie. The rule group will inspect only HTTP POST requests to your specified login endpoint that match the criteria in your scope-down statement. For information about scope-down statements, see Using scope-down statements in AWS WAF.

4. Save your changes to the web ACL.