Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
waf-apiref-358	waf-apiref.pdf	358	TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ SqlInjectionMatchTuple 1729 AWS WAFV2 API Reference • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. SqlInjectionMatchTuple 1730 AWS WAFV2 NONE API Reference Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchTuple 1731 AWS WAFV2 API Reference SubscribedRuleGroupSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. A summary of the rule groups you are subscribed to. Contents MetricName A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. SubscribedRuleGroupSummary 1732 AWS WAFV2 Required: Yes RuleGroupId A unique identiﬁer for a RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SubscribedRuleGroupSummary 1733 AWS WAFV2 API Reference Tag Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Contents Key Type: String
waf-apiref-359	waf-apiref.pdf	359	key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Contents Key Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Value Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Tag 1734 AWS WAFV2 Pattern: .* Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag 1735 AWS WAFV2 API Reference TagInfoForResource Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Information for a tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Contents ResourceARN Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: No TagList Type: Array of Tag objects Array Members: Minimum number of 1 item. TagInfoForResource 1736 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TagInfoForResource 1737 AWS WAFV2 API Reference TimeWindow Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the speciﬁed number of requests from among the ﬁrst 5,000 requests that your AWS resource receives during the speciﬁed time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request. Contents EndTime The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes TimeWindow 1738 AWS WAFV2 StartTime API Reference The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS
waf-apiref-360	waf-apiref.pdf	360	TimeWindow 1738 AWS WAFV2 StartTime API Reference The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TimeWindow 1739 AWS WAFV2 API Reference WafAction Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. For the action that is associated with a rule in a WebACL, speciﬁes the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, speciﬁes the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. Contents Type Speciﬁes how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: • ALLOW: AWS WAF allows requests • BLOCK: AWS WAF blocks requests • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. Type: String Valid Values: BLOCK \| ALLOW \| COUNT Required: Yes WafAction 1740 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WafAction 1741 AWS WAFV2 API Reference WafOverrideAction Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. The action to take if any rule within the RuleGroup matches a request. Contents Type COUNT overrides the action speciﬁed by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place. Type: String Valid Values: NONE \| COUNT Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WafOverrideAction 1742 AWS WAFV2 API Reference WebACL Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from speciﬁed IP addresses or block requests from speciﬁed referrers. You also associate the WebACL with an Amazon CloudFront distribution to identify the requests that you want AWS WAF to ﬁlter. If you add more than one Rule to a WebACL, a request needs to match only one of the speciﬁcations to be allowed, blocked, or counted. For more information, see UpdateWebACL. Contents DefaultAction The action to perform if none of the Rules contained in the WebACL match. The action is speciﬁed by the WafAction object. Type: WafAction object Required: Yes Rules An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. Type: Array of ActivatedRule objects Required: Yes WebACL 1743 AWS WAFV2 WebACLId API Reference A unique identiﬁer for
waf-apiref-361	waf-apiref.pdf	361	add more than one Rule to a WebACL, a request needs to match only one of the speciﬁcations to be allowed, blocked, or counted. For more information, see UpdateWebACL. Contents DefaultAction The action to perform if none of the Rules contained in the WebACL match. The action is speciﬁed by the WafAction object. Type: WafAction object Required: Yes Rules An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. Type: Array of ActivatedRule objects Required: Yes WebACL 1743 AWS WAFV2 WebACLId API Reference A unique identiﬁer for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MetricName A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No WebACL 1744 AWS WAFV2 WebACLArn API Reference Tha Amazon Resource Name (ARN) of the web ACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACL 1745 AWS WAFV2 API Reference WebACLSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Contains the identiﬁer and the name or description of the WebACL. Contents Name A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes WebACLId A unique identiﬁer for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. WebACLSummary 1746 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACLSummary 1747 AWS WAFV2 API Reference WebACLUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Speciﬁes whether to insert a Rule into or delete a Rule from a WebACL. Contents Action Speciﬁes whether to insert a Rule into or delete a Rule from a WebACL. Type: String Valid Values: INSERT \| DELETE Required: Yes ActivatedRule The ActivatedRule object in an UpdateWebACL request speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). Type: ActivatedRule object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: WebACLUpdate 1748 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference WebACLUpdate 1749 AWS WAFV2 API Reference XssMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
waf-apiref-362	waf-apiref.pdf	362	to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). Type: ActivatedRule object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: WebACLUpdate 1748 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference WebACLUpdate 1749 AWS WAFV2 API Reference XssMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the speciﬁed parts of the request to be considered a match. Contents XssMatchSetId A unique identiﬁer for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes XssMatchTuples Speciﬁes the parts of web requests that you want to inspect for cross-site scripting attacks. XssMatchSet 1750 AWS WAFV2 API Reference Type: Array of XssMatchTuple objects Required: Yes Name The name, if any, of the XssMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSet 1751 AWS WAFV2 API Reference XssMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. The Id and Name of an XssMatchSet. Contents Name The name of the XssMatchSet, if any, speciﬁed by Id. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes XssMatchSetId A unique identiﬁer for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. XssMatchSetSummary 1752 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSetSummary 1753 AWS WAFV2 API Reference XssMatchSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Speciﬁes the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the speciﬁcation to an XssMatchSet or delete it from an XssMatchSet. Contents Action Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes XssMatchTuple Speciﬁes the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. Type: XssMatchTuple object Required: Yes XssMatchSetUpdate 1754 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK
waf-apiref-363	waf-apiref.pdf	363	it from an XssMatchSet. Contents Action Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes XssMatchTuple Speciﬁes the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. Type: XssMatchTuple object Required: Yes XssMatchSetUpdate 1754 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSetUpdate 1755 AWS WAFV2 API Reference XssMatchTuple Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Speciﬁes the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. Contents FieldToMatch Speciﬁes where in a web request to look for cross-site scripting attacks. Type: FieldToMatch object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ XssMatchTuple 1756 AWS WAFV2 API Reference • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. XssMatchTuple 1757 AWS WAFV2 NONE API Reference Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchTuple 1758 AWS WAFV2 API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. 1759 AWS WAFV2 API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string
waf-apiref-364	waf-apiref.pdf	364	a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. 1759 AWS WAFV2 API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. 1760 AWS WAFV2 Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional 1761 AWS WAFV2 API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 1762 AWS WAFV2 RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 1763
waf-dg-001	waf-dg.pdf	1	Developer Guide AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS WAF, AWS Firewall Manager, and AWS Shield Advanced: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Table of Contents What are AWS WAF, Shield Advanced, and Firewall Manager? ..................................................... 1 AWS WAF ........................................................................................................................................................ 1 Shield Advanced ........................................................................................................................................... 3 AWS Firewall Manager ................................................................................................................................. 3 Setting up your account .................................................................................................................. 5 Sign up for an AWS account ...................................................................................................................... 5 Create a user with administrative access ................................................................................................ 5 Download tools ............................................................................................................................................. 7 AWS WAF .......................................................................................................................................... 8 Setting up AWS WAF ................................................................................................................................... 9 Step 1: Set up AWS WAF .................................................................................................................... 10 Step 2: Create a Web ACL ................................................................................................................... 10 Step 3: Add a string match rule ........................................................................................................ 11 Step 4: Add an AWS Managed Rules rule group ............................................................................ 13 Step 5: Finish your web ACL conﬁguration ..................................................................................... 14 Step 6: Clean up your resources ........................................................................................................ 15 How AWS WAF works ................................................................................................................................ 15 Resources that you can protect with AWS WAF ............................................................................. 17 Using web ACLs .......................................................................................................................................... 18 Creating a web ACL .............................................................................................................................. 20 Editing a web ACL ................................................................................................................................ 26 Managing rule group behavior in a web ACL .................................................................................. 29 Associating or disassociating a web ACL with an AWS resource ................................................. 32 Using web ACLs with rules and rule groups ................................................................................... 34 Setting the web ACL default action ................................................................................................. 42 Managing body inspection size limits .............................................................................................. 43 Conﬁguring CAPTCHA, challenge, and tokens ................................................................................ 44 Viewing web traﬃc metrics ................................................................................................................ 44 Deleting a web ACL .............................................................................................................................. 45 AWS WAF rules ........................................................................................................................................... 45 Using rule actions ................................................................................................................................. 47 Using rule statements .......................................................................................................................... 49 Using match rule statements ............................................................................................................. 76 Using logical rule statements ............................................................................................................ 99 iii AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Using rate-based rule statements ................................................................................................... 107 Using rule group rule statements ................................................................................................... 126 AWS WAF rule groups ............................................................................................................................. 129 Using managed rule groups ............................................................................................................. 130 Managing your own rule groups ..................................................................................................... 315 AWS Marketplace rule groups .......................................................................................................... 321 Recognizing rule groups from other services ............................................................................... 324 Web ACL capacity units (WCUs) ............................................................................................................ 325 Determining the WCUs for a rule group or web ACL .................................................................. 327 Oversize web request components ...................................................................................................... 327 Blocking oversized components ...................................................................................................... 329 Supported regular expression syntax .................................................................................................. 330 IP sets and regex pattern sets .............................................................................................................. 331 Creating and managing an IP set ................................................................................................... 332 Creating and managing a regex pattern set ................................................................................. 334 Customized web requests and responses ........................................................................................... 335 Inserting custom request headers insertions ............................................................................... 337 Sending custom responses ............................................................................................................... 339 Supported response status codes ................................................................................................... 342 Web request labeling .............................................................................................................................. 344 How labeling works ........................................................................................................................... 345 Label syntax and naming requirements ........................................................................................ 347 Rules that add labels ......................................................................................................................... 350 Rules that match labels .................................................................................................................... 351 Intelligent threat mitigation .................................................................................................................. 356 Mitigation options .............................................................................................................................. 357 Best practices ...................................................................................................................................... 368 Tokens in intelligent threat mitigation .......................................................................................... 370 AWS WAF Fraud Control account creation fraud prevention (ACFP) ........................................ 384 AWS WAF Fraud Control account takeover prevention (ATP) .................................................... 407 AWS WAF Bot Control ....................................................................................................................... 427 Client application integrations ........................................................................................................ 456 CAPTCHA and Challenge ................................................................................................................... 494 Data protection and logging for web traﬃc ...................................................................................... 507 Logging ................................................................................................................................................. 508 Data protection ................................................................................................................................... 550 iv AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Testing and tuning your protections ................................................................................................... 577 Testing and tuning high-level steps ............................................................................................... 578 Preparing for testing ......................................................................................................................... 579 Monitoring and tuning your AWS WAF protections .................................................................... 582 Enabling your protections in production ....................................................................................... 597 Using AWS WAF with Amazon CloudFront ......................................................................................... 599 How AWS WAF works with diﬀerent distribution types ............................................................. 599 Use cases .............................................................................................................................................. 601 Security in your use of the AWS WAF service .................................................................................... 606 Protecting your data .......................................................................................................................... 607 Using IAM with AWS WAF ................................................................................................................ 608 Logging and monitoring ................................................................................................................... 665 Validating compliance ....................................................................................................................... 666 Building for resilience ........................................................................................................................ 668 Infrastructure security ....................................................................................................................... 668 AWS WAF quotas ..................................................................................................................................... 669 Migrating your AWS WAF Classic resources to AWS WAF ................................................................ 673 Why migrate to AWS WAF? .............................................................................................................. 673 Migration caveats ............................................................................................................................... 675 How the migration works ................................................................................................................. 676 Migrating a web ACL ......................................................................................................................... 677 AWS WAF Classic ......................................................................................................................... 683 Setting up AWS WAF Classic ................................................................................................................. 684 Sign up for an AWS account ................................................................................................................ 5 Create a user with administrative
waf-dg-002	waf-dg.pdf	2	the AWS WAF service .................................................................................... 606 Protecting your data .......................................................................................................................... 607 Using IAM with AWS WAF ................................................................................................................ 608 Logging and monitoring ................................................................................................................... 665 Validating compliance ....................................................................................................................... 666 Building for resilience ........................................................................................................................ 668 Infrastructure security ....................................................................................................................... 668 AWS WAF quotas ..................................................................................................................................... 669 Migrating your AWS WAF Classic resources to AWS WAF ................................................................ 673 Why migrate to AWS WAF? .............................................................................................................. 673 Migration caveats ............................................................................................................................... 675 How the migration works ................................................................................................................. 676 Migrating a web ACL ......................................................................................................................... 677 AWS WAF Classic ......................................................................................................................... 683 Setting up AWS WAF Classic ................................................................................................................. 684 Sign up for an AWS account ................................................................................................................ 5 Create a user with administrative access ........................................................................................... 5 Download tools ................................................................................................................................... 687 How AWS WAF Classic works ................................................................................................................ 688 AWS WAF Classic pricing ........................................................................................................................ 692 ................................................................................................................................................................ 692 Getting started with AWS WAF Classic ............................................................................................... 692 Step 1: Set up AWS WAF Classic ..................................................................................................... 694 Step 2: Create a Web ACL ................................................................................................................ 694 Step 3: Create an IP match condition ............................................................................................ 695 Step 4: Create a geo match condition ........................................................................................... 696 Step 5: Create a string match condition ....................................................................................... 696 Step 5A: Create a regex condition (optional) ............................................................................... 699 v AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Step 6: Create a SQL injection match condition .......................................................................... 701 Step 7: (Optional) create additional conditions ........................................................................... 702 Step 8: Create a rule and add conditions ...................................................................................... 702 Step 9: Add the rule to a Web ACL ................................................................................................ 705 Step 10: Clean up your resources ................................................................................................... 705 Creating and conﬁguring a Web Access Control List (Web ACL) .................................................... 708 Working with conditions ................................................................................................................... 710 Working with rules ............................................................................................................................. 758 Working with web ACLs .................................................................................................................... 770 Working with AWS WAF Classic rule groups for use with AWS Firewall Manager ....................... 786 Creating an AWS WAF Classic rule group ...................................................................................... 787 Adding and deleting rules from an AWS WAF Classic rule group ............................................. 789 Getting started with AWS Firewall Manager to enable AWS WAF Classic rules .......................... 791 Step 1: Complete the prerequisites ................................................................................................ 792 Step 2: Create rules ........................................................................................................................... 792 Step 3: Create a rule group ............................................................................................................. 793 Step 4: Create and apply an AWS Firewall ManagerAWS WAF Classic policy ......................... 794 Tutorial: Creating an AWS Firewall Manager policy with hierarchical rules ................................. 797 Step 1: Designate a Firewall Manager administrator account ................................................... 798 Step 2: Create a rule group using the Firewall Manager administrator account .................... 798 Step 3: Create a Firewall Manager policy and attach the common rule group ...................... 798 Step 4: Add account-speciﬁc rules .................................................................................................. 799 Conclusion ............................................................................................................................................ 799 Logging Web ACL traﬃc information .................................................................................................. 800 Listing IP addresses blocked by rate-based rules ............................................................................. 807 How AWS WAF Classic works with Amazon CloudFront features .................................................. 808 Using AWS WAF Classic with CloudFront custom error pages .................................................. 809 Using AWS WAF Classic with CloudFront for applications running on your own HTTP server ..................................................................................................................................................... 809 Choosing the HTTP methods that CloudFront responds to ...................................................... 810 Security ...................................................................................................................................................... 811 Data protection ................................................................................................................................... 812 Identity and access management ................................................................................................... 814 Logging and monitoring ................................................................................................................... 839 Compliance validation ....................................................................................................................... 840 Resilience .............................................................................................................................................. 842 vi AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Infrastructure security ....................................................................................................................... 842 AWS WAF Classic quotas ........................................................................................................................ 843 AWS Shield ................................................................................................................................... 848 How Shield and Shield Advanced work .............................................................................................. 849 AWS Shield Standard overview ....................................................................................................... 851 AWS Shield Advanced overview ...................................................................................................... 851 Examples of DDoS attacks ............................................................................................................... 858 How Shield detects events ............................................................................................................... 859 How Shield mitigates events ........................................................................................................... 864 Building DDoS resilient architectures .................................................................................................. 872 DDoS resiliency architecture for web applications ...................................................................... 873 DDoS resiliency architecture for TCP and UDP applications ...................................................... 875 Combining Shield Advanced with other AWS services ..................................................................... 877 Setting up AWS Shield Advanced ........................................................................................................ 878 Subscribing to Shield Advanced ...................................................................................................... 879 Adding and conﬁguring resource protections .............................................................................. 881 Setting up SRT support .................................................................................................................... 886 Creating a DDoS dashboard ............................................................................................................. 889 SRT support .............................................................................................................................................. 889 Granting access for the SRT ............................................................................................................. 891 Setting up proactive engagement .................................................................................................. 893 Contacting the SRT ............................................................................................................................ 895 Setting up custom mitigations with the SRT ............................................................................... 896 Resource protections ............................................................................................................................... 896 List of protected resources ............................................................................................................... 897 Protecting Amazon EC2 instances and Network Load Balancers .............................................. 899 Protecting the application layer (layer 7) ...................................................................................... 899 Health-based detection using health checks ................................................................................ 917 Adding protection to a resource ..................................................................................................... 927 Editing protections ............................................................................................................................. 928 Creating alarms and notiﬁcations ................................................................................................... 930 Removing protection from a resource ........................................................................................... 931 Protection groups ............................................................................................................................... 932 Tracking protection changes ............................................................................................................ 935 Visibility into DDoS events .................................................................................................................... 935 Global and account activity .............................................................................................................. 937 vii AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Events .................................................................................................................................................... 940 Event visibility across accounts ....................................................................................................... 950 Responding to DDoS events .................................................................................................................. 952 Contacting support for an application layer attack .................................................................... 953 Manually mitigating an application layer attack ......................................................................... 955 Requesting a credit after an attack ..................................................................................................... 956 Security in
waf-dg-003	waf-dg.pdf	3	917 Adding protection to a resource ..................................................................................................... 927 Editing protections ............................................................................................................................. 928 Creating alarms and notiﬁcations ................................................................................................... 930 Removing protection from a resource ........................................................................................... 931 Protection groups ............................................................................................................................... 932 Tracking protection changes ............................................................................................................ 935 Visibility into DDoS events .................................................................................................................... 935 Global and account activity .............................................................................................................. 937 vii AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Events .................................................................................................................................................... 940 Event visibility across accounts ....................................................................................................... 950 Responding to DDoS events .................................................................................................................. 952 Contacting support for an application layer attack .................................................................... 953 Manually mitigating an application layer attack ......................................................................... 955 Requesting a credit after an attack ..................................................................................................... 956 Security in your use of the Shield service .......................................................................................... 957 Protecting your data .......................................................................................................................... 959 Using IAM with Shield ....................................................................................................................... 960 Logging and monitoring ................................................................................................................... 988 Validating compliance ....................................................................................................................... 989 Building for resilience ........................................................................................................................ 990 Infrastructure security ....................................................................................................................... 990 AWS Shield Advanced quotas ............................................................................................................... 991 AWS Firewall Manager ................................................................................................................ 992 AWS Firewall Manager prerequisites ................................................................................................... 993 Joining and conﬁguring AWS Organizations for using Firewall Manager ............................... 993 Creating an AWS Firewall Manager default administrator account .......................................... 994 Enabling AWS Conﬁg for using Firewall Manager ....................................................................... 995 Subscribing in the AWS Marketplace and conﬁguring third-party settings for Firewall Manager third-party policies ............................................................................................................ 997 Enabling resource sharing for Network Firewall and DNS Firewall policies with AWS RAM ....................................................................................................................................................... 998 Using AWS Firewall Manager in Regions that are disabled by default .................................... 998 Using Firewall Manager administrators .............................................................................................. 999 Creating a Firewall Manager administrator account ................................................................. 1001 Updating a Firewall Manager administrator account ............................................................... 1003 Revoking a Firewall Manager administrator account ................................................................ 1003 Changing the default administrator account ............................................................................. 1004 Disqualifying changes to an administrator account ................................................................. 1005 Setting up AWS Firewall Manager policies ...................................................................................... 1006 Setting up AWS WAF policies ........................................................................................................ 1007 Setting up AWS Shield Advanced policies .................................................................................. 1010 Setting up Amazon VPC security group policies ....................................................................... 1015 Setting up Amazon VPC network ACL policies .......................................................................... 1019 Setting up AWS Network Firewall policies ................................................................................. 1022 viii AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Setting up DNS Firewall policies ................................................................................................... 1025 Setting up Palo Alto Networks Cloud NGFW policies ............................................................... 1028 Setting up Fortigate CNF policies ................................................................................................. 1032 Using AWS Firewall Manager policies ............................................................................................... 1036 General settings ................................................................................................................................ 1037 Creating a policy .............................................................................................................................. 1037 Deleting a policy .............................................................................................................................. 1075 Using the policy scope .................................................................................................................... 1075 AWS WAF policies ............................................................................................................................ 1078 AWS Shield Advanced policies ...................................................................................................... 1091 Security group policies .................................................................................................................... 1097 Network ACL policies ....................................................................................................................... 1109 Network Firewall policies ............................................................................................................... 1118 DNS Firewall policies ....................................................................................................................... 1129 Palo Alto Networks Cloud NGFW policies ................................................................................... 1131 Fortigate CNF policies ..................................................................................................................... 1132 Resource sharing for Network Firewall and DNS Firewall policies ......................................... 1132 Using managed lists .............................................................................................................................. 1133 Managed list versioning .................................................................................................................. 1134 Using managed lists ........................................................................................................................ 1135 Creating a custom managed list ................................................................................................... 1135 Viewing a managed list .................................................................................................................. 1137 Deleting a custom managed list ................................................................................................... 1137 Grouping your resources ...................................................................................................................... 1139 Considerations when working with resource sets in Firewall Manager ................................. 1139 Creating resource sets ..................................................................................................................... 1140 Deleting a resource set ................................................................................................................... 1141 Viewing compliance for a policy ........................................................................................................ 1141 Firewall Manager integration with Security Hub ............................................................................ 1146 AWS WAF policy ﬁndings ............................................................................................................... 1147 AWS Shield Advanced policy ﬁndings ......................................................................................... 1148 Security group common policy ﬁndings ..................................................................................... 1149 Security group content audit policy ﬁndings ............................................................................. 1150 Security group usage audit policy ﬁndings ................................................................................ 1150 DNS Firewall policy ﬁndings .......................................................................................................... 1151 Security in your use of the Firewall Manager service .................................................................... 1151 ix AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Data protection ................................................................................................................................. 1152 Identity and Access Management ................................................................................................. 1153 Logging and monitoring ................................................................................................................. 1186 Compliance validation ..................................................................................................................... 1187 Resilience ............................................................................................................................................ 1188 Infrastructure security ..................................................................................................................... 1188 AWS Firewall Manager quotas ............................................................................................................ 1188 Soft quotas ........................................................................................................................................ 1189 Hard quotas ....................................................................................................................................... 1192 Monitoring ................................................................................................................................. 1194 Monitoring tools .................................................................................................................................... 1195 Automated monitoring tools ......................................................................................................... 1195 Manual tools ...................................................................................................................................... 1196 Monitoring with CloudWatch .............................................................................................................. 1197 Viewing metrics and dimensions .................................................................................................. 1198 AWS WAF metrics and dimensions ............................................................................................... 1199 AWS Shield Advanced metrics ....................................................................................................... 1214 AWS Firewall Manager notiﬁcations ............................................................................................ 1220 Logging API calls with AWS CloudTrail ............................................................................................. 1220 AWS WAF information in AWS CloudTrail ................................................................................... 1221 AWS Shield Advanced information in CloudTrail ...................................................................... 1231 AWS Firewall Manager information in CloudTrail ..................................................................... 1233 Using the AWS WAF and AWS Shield Advanced API ............................................................... 1236 Using the AWS SDKs ............................................................................................................................. 1236 Making HTTPS requests to AWS WAF or Shield Advanced ........................................................... 1236 Request URI ....................................................................................................................................... 1236 HTTP headers .................................................................................................................................... 1236 HTTP request body .......................................................................................................................... 1238 HTTP responses ..................................................................................................................................... 1239 Error responses ................................................................................................................................. 1240 Authenticating requests ....................................................................................................................... 1240 Related information .................................................................................................................. 1243 Document history ...................................................................................................................... 1245 Updates before 2018 ............................................................................................................................ 1294 x AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide What are AWS WAF, AWS Shield Advanced, and AWS Firewall Manager? You can use AWS WAF, AWS Shield, and AWS Firewall Manager
waf-dg-004	waf-dg.pdf	4	Using the AWS WAF and AWS Shield Advanced API ............................................................... 1236 Using the AWS SDKs ............................................................................................................................. 1236 Making HTTPS requests to AWS WAF or Shield Advanced ........................................................... 1236 Request URI ....................................................................................................................................... 1236 HTTP headers .................................................................................................................................... 1236 HTTP request body .......................................................................................................................... 1238 HTTP responses ..................................................................................................................................... 1239 Error responses ................................................................................................................................. 1240 Authenticating requests ....................................................................................................................... 1240 Related information .................................................................................................................. 1243 Document history ...................................................................................................................... 1245 Updates before 2018 ............................................................................................................................ 1294 x AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide What are AWS WAF, AWS Shield Advanced, and AWS Firewall Manager? You can use AWS WAF, AWS Shield, and AWS Firewall Manager together to create a comprehensive security solution. AWS WAF is a web application ﬁrewall that you can use to monitor web requests that your end users send to your applications and to control access to your content. Shield Advanced provides protection against distributed denial of service (DDoS) attacks for AWS resources, at the network and transport layers (layer 3 and 4) and the application layer (layer 7). AWS Firewall Manager provides management of protections like AWS WAF and Shield Advanced across accounts and resources, even as new resources are added. Topics • What is AWS WAF? • What is AWS Shield Advanced? • What is AWS Firewall Manager? What is AWS WAF? AWS WAF is a web application ﬁrewall that lets you monitor the HTTP and HTTPS requests that are forwarded to your protected web application resources. You can protect the following resource types: • Amazon CloudFront distribution • Amazon API Gateway REST API • Application Load Balancer • AWS AppSync GraphQL API • Amazon Cognito user pool • AWS App Runner service • AWS Veriﬁed Access instance • AWS Amplify AWS WAF lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, your protected resource AWS WAF 1 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide responds to requests either with the requested content, with an HTTP 403 status code (Forbidden), or with a custom response. At the simplest level, AWS WAF lets you choose one of the following behaviors: • Allow all requests except the ones that you specify – This is useful when you want Amazon CloudFront, Amazon API Gateway, Application Load Balancer, AWS AppSync, Amazon Cognito, AWS App Runner, or AWS Veriﬁed Access to serve content for a public website, but you also want to block requests from attackers. • Block all requests except the ones that you specify – This is useful when you want to serve content for a restricted website whose users are readily identiﬁable by properties in web requests, such as the IP addresses that they use to browse to the website. • Count requests that match your criteria – You can use the Count action to track your web traﬃc without modifying how you handle it. You can use this for general monitoring and also to test your new web request handling rules. When you want to allow or block requests based on new properties in the web requests, you can ﬁrst conﬁgure AWS WAF to count the requests that match those properties. This lets you conﬁrm your new conﬁguration settings before you switch your rules to allow or block matching requests. • Run CAPTCHA or challenge checks against requests that match your criteria – You can implement CAPTCHA and silent challenge controls against requests to help reduce bot traﬃc to your protected resources. Using AWS WAF has several beneﬁts: • Additional protection against web attacks using criteria that you specify. You can deﬁne criteria using characteristics of web requests such as the following: • IP addresses that requests originate from. • Country that requests originate from. • Values in request headers. • Strings that appear in requests, either speciﬁc strings or strings that match regular expression (regex) patterns. • Length of requests. • Presence of SQL code that is likely to be malicious (known as SQL injection). • Presence of a script that is likely to be malicious (known as cross-site scripting). AWS WAF 2 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Rules that can allow, block, or count web requests that meet the speciﬁed criteria. Alternatively, rules can block or count web requests that not only meet the speciﬁed criteria, but also exceed a speciﬁed number of requests in a minute or in ﬁve minutes. • Rules that you can reuse for multiple web applications. • Managed rule groups from AWS and AWS Marketplace sellers. • Real-time metrics and sampled web requests. • Automated administration using the AWS WAF API. If you want granular control over the protections that you add to your resources, AWS WAF alone might be the right choice. For
waf-dg-005	waf-dg.pdf	5	can allow, block, or count web requests that meet the speciﬁed criteria. Alternatively, rules can block or count web requests that not only meet the speciﬁed criteria, but also exceed a speciﬁed number of requests in a minute or in ﬁve minutes. • Rules that you can reuse for multiple web applications. • Managed rule groups from AWS and AWS Marketplace sellers. • Real-time metrics and sampled web requests. • Automated administration using the AWS WAF API. If you want granular control over the protections that you add to your resources, AWS WAF alone might be the right choice. For more information about AWS WAF, see AWS WAF. What is AWS Shield Advanced? You can use AWS WAF web access control lists (web ACLs) to help minimize the eﬀects of a Distributed Denial of Service (DDoS) attack. For additional protection against DDoS attacks, AWS also provides AWS Shield Standard and AWS Shield Advanced. AWS Shield Standard is automatically included at no extra cost beyond what you already pay for AWS WAF and your other AWS services. Shield Advanced provides expanded DDoS attack protection for your Amazon EC2 instances, Elastic Load Balancing load balancers, CloudFront distributions, Route 53 hosted zones, and AWS Global Accelerator standard accelerators. Shield Advanced incurs additional charges. Shield Advanced options and features include automatic application layer DDoS mitigation, advanced event visibility, and dedicated support from the Shield Response Team (SRT). If you own high visibility websites or are otherwise prone to frequent DDoS attacks, consider purchasing the additional protections that Shield Advanced provides. For additional information, see AWS Shield Advanced capabilities and options and Deciding whether to subscribe to AWS Shield Advanced and apply additional protections. What is AWS Firewall Manager? AWS Firewall Manager simpliﬁes your administration and maintenance tasks across multiple accounts and resources for a variety of protections, including AWS WAF, AWS Shield Advanced, Amazon VPC security groups and network ACLs, AWS Network Firewall, and Amazon Route 53 Resolver DNS Firewall. With Firewall Manager, you set up your protections just once and the service Shield Advanced 3 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide automatically applies them across your accounts and resources, even as you add new accounts and resources. For more information about Firewall Manager, see AWS Firewall Manager. AWS Firewall Manager 4 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Setting up your account to use the services This topic describes preliminary steps, such as creating an account, to prepare you to use AWS WAF, AWS Firewall Manager, and AWS Shield Advanced. You aren't charged for these preliminary items. You are charged only for AWS services that you use. Topics • Sign up for an AWS account • Create a user with administrative access • Download tools Sign up for an AWS account If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a veriﬁcation code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. AWS sends you a conﬁrmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Sign up for an AWS account 5 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your
waf-dg-006	waf-dg.pdf	6	help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Conﬁgure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. Create a user with administrative access 6 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Download tools The AWS Management Console includes a console for AWS WAF, AWS Shield Advanced, and AWS Firewall Manager, but if you want to access the services programmatically, see the following: • The API guides document the operations that the services support and provide links to the related SDK and CLI documentation: • AWS WAF API Reference • AWS Shield Advanced API Reference • AWS Firewall Manager API Reference • To call an API without having to handle low-level details like assembling raw HTTP requests, you can use an AWS SDK. The AWS SDKs provide functions and data types that encapsulate the functionality of AWS services. To download an AWS SDK and access installation instructions, see the applicable page: • Java • JavaScript • .NET • Node.js • PHP • Python • Ruby For a complete list of AWS SDKs, see Tools for Amazon Web Services. • You can use the AWS Command Line Interface (AWS CLI) to control multiple AWS services from the command line. You can also automate your commands using scripts. For more information, see AWS Command Line Interface. • AWS Tools for Windows PowerShell supports these AWS services. For more information, see AWS Tools for PowerShell Cmdlet Reference. Download tools 7 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS WAF AWS WAF is a web application ﬁrewall that lets you monitor the HTTP(S) requests that are forwarded to your protected web application resources. You can protect the following resource types: • Amazon CloudFront distribution • Amazon API Gateway REST API • Application Load Balancer • AWS AppSync GraphQL API • Amazon Cognito user pool • AWS App Runner service • AWS Veriﬁed Access instance • AWS Amplify AWS WAF lets you control access to your content. Based on criteria that you specify, such as the IP addresses that requests originate from or the values of query strings, the service associated with your protected resource responds to requests either with the requested content, with an HTTP 403 status code (Forbidden), or with a custom response. Note You can also use AWS WAF to protect your applications that are hosted in Amazon Elastic Container Service (Amazon ECS) containers. Amazon ECS is a highly scalable, fast container management service that makes it easy to run, stop, and manage Docker containers on a cluster. To use this option, you conﬁgure Amazon ECS to use an Application Load Balancer that is enabled for AWS WAF to route and protect HTTP(S) layer 7 traﬃc across the tasks in your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide. Topics • Setting up AWS WAF and its components • How AWS WAF works 8 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Using web ACLs in AWS WAF • AWS WAF rules • AWS WAF rule groups • Web ACL capacity units (WCUs) in AWS WAF • Oversize web request components in AWS WAF • Supported regular expression syntax in AWS WAF • IP sets and regex pattern sets in AWS WAF • Customized web requests and responses in AWS WAF • Web request labeling in AWS WAF • Intelligent threat
waf-dg-007	waf-dg.pdf	7	Container Service Developer Guide. Topics • Setting up AWS WAF and its components • How AWS WAF works 8 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Using web ACLs in AWS WAF • AWS WAF rules • AWS WAF rule groups • Web ACL capacity units (WCUs) in AWS WAF • Oversize web request components in AWS WAF • Supported regular expression syntax in AWS WAF • IP sets and regex pattern sets in AWS WAF • Customized web requests and responses in AWS WAF • Web request labeling in AWS WAF • Intelligent threat mitigation in AWS WAF • Data protection and logging for AWS WAF web ACL traﬃc • Testing and tuning your AWS WAF protections • Using AWS WAF with Amazon CloudFront • Security in your use of the AWS WAF service • AWS WAF quotas • Migrating your AWS WAF Classic resources to AWS WAF Setting up AWS WAF and its components This tutorial shows how to use AWS WAF to perform the following tasks: • Set up AWS WAF. • Create a web access control list (web ACL) using the wizard in the AWS WAF console. • Choose the AWS resources that you want AWS WAF to inspect web requests for. This tutorial covers the steps for Amazon CloudFront. The process is essentially the same for an Amazon API Gateway REST API, an Application Load Balancer, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, AWS Amplify, or an AWS Veriﬁed Access instance. • Add the rules and rule groups that you want to use to ﬁlter web requests. For example, you can specify the IP addresses that the requests originate from and specify values in the request that are used only by attackers. For each rule, you specify how to handle matching web requests. You can do things like block or count them and you can run bot challenges like CAPTCHA. You deﬁne an action for each rule that you deﬁne inside a web ACL and for each rule that you deﬁne inside a rule group. Setting up AWS WAF 9 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Specify a default action for the web ACL, either Block or Allow. This is the action that AWS WAF takes on a request when the rules in the web ACL don't explicitly allow or block it. Note AWS typically bills you less than US $0.25 per day for the resources that you create during this tutorial. When you're ﬁnished with the tutorial, we recommend that you delete the resources to prevent incurring unnecessary charges. Topics • Step 1: Set up AWS WAF • Step 2: Create a Web ACL • Step 3: Add a string match rule • Step 4: Add an AWS Managed Rules rule group • Step 5: Finish your web ACL conﬁguration • Step 6: Clean up your resources Step 1: Set up AWS WAF If you haven't already followed the general setup steps in Setting up your account to use the services, do that now. Step 2: Create a Web ACL The AWS WAF console guides you through the process of conﬁguring AWS WAF to block or allow web requests based on criteria that you specify, such as the IP addresses that the requests originate from or values in the requests. In this step, you create a web ACL. For more information about AWS WAF web ACLs, see Using web ACLs in AWS WAF. To create a web ACL 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. From the AWS WAF home page, choose Create web ACL. Step 1: Set up AWS WAF 10 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 3. For Name, enter the name that you want to use to identify this web ACL. Note You can't change the name after you create the web ACL. 4. 5. 6. 7. (Optional) For Description - optional, enter a longer description for the web ACL if you want to. For CloudWatch metric name, change the default name if applicable. Follow the guidance on the console for valid characters. The name can't contain special characters, white space, or metric names reserved for AWS WAF, including "All" and "Default_Action." Note You can't change the CloudWatch metric name after you create the web ACL. For Resource type, choose CloudFront distributions. The Region automatically populates to Global (CloudFront) for CloudFront distributions. (Optional) For Associated AWS resources - optional, choose Add AWS resources. In the dialog box, choose the resources that you want to associate, and then choose Add. AWS WAF returns you to the Describe web ACL and associated AWS resources page. 8. Choose Next.
waf-dg-008	waf-dg.pdf	8	guidance on the console for valid characters. The name can't contain special characters, white space, or metric names reserved for AWS WAF, including "All" and "Default_Action." Note You can't change the CloudWatch metric name after you create the web ACL. For Resource type, choose CloudFront distributions. The Region automatically populates to Global (CloudFront) for CloudFront distributions. (Optional) For Associated AWS resources - optional, choose Add AWS resources. In the dialog box, choose the resources that you want to associate, and then choose Add. AWS WAF returns you to the Describe web ACL and associated AWS resources page. 8. Choose Next. Step 3: Add a string match rule In this step, you create a rule with a string match statement and indicate what to do with matching requests. A string match rule statement identiﬁes strings that you want AWS WAF to search for in a request. Usually, a string consists of printable ASCII characters, but you can specify any character from hexadecimal 0x00 to 0xFF (decimal 0 to 255). In addition to specifying the string to search for, you specify the web request component that you want to search, such as a header, a query string, or the request body. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Step 3: Add a string match rule 11 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. For additional information about AWS WAF rules, see AWS WAF rules. To create a string match rule statement 1. On the Add rules and rule groups page, choose Add rules, Add my own rules and rule groups, Rule builder, then Rule visual editor. Note The console provides the Rule visual editor and also a Rule JSON editor. The JSON editor makes it easy for you to copy conﬁgurations between web ACLs and is required for more complex rule sets, like those with multiple levels of nesting. This procedure uses the Rule visual editor. 2. 3. 4. For Name, enter the name that you want to use to identify this rule. For Type choose Regular rule. For If a request choose matches the statement. The other options are for the logical rule statement types. You can use them to combine or negate the results of other rule statements. 5. On Statement, for Inspect, open the dropdown and choose the web request component that you want AWS WAF to inspect. For this example, choose Single header. Step 3: Add a string match rule 12 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide When you choose Single header, you also specify which header you want AWS WAF to inspect. Enter User-Agent. This value isn't case sensitive. 6. For Match type, choose where the speciﬁed string must appear in the User-Agent header. 7. 8. 9. For this example, choose Exactly matches string. This indicates that AWS WAF inspects the user-agent header in each web request for a string that is identical to the string that you specify. For String to match, specify a string that you want AWS WAF to search for. The maximum length of String to match is 200 characters. If you want to specify a base64-encoded value, you can specify up to 200 characters before encoding. For this example, enter MyAgent. AWS WAF will inspect the User-Agent header in web requests for the value MyAgent. Leave Text transformation set to None. For Action, select the action that you want the rule to take when it matches a web request. For this example, choose Count and leave the other choices as they are. The count action creates metrics for web requests that match the rule, but doesn't aﬀect whether the request is allowed or blocked. For more information about action choices, see Using rule actions in AWS WAF and Using web ACLs with rules and rule groups in AWS WAF. 10. Choose Add rule. Step 4: Add an AWS Managed Rules rule group AWS Managed Rules oﬀers a set of managed rule groups for your use, most of which are free of charge
waf-dg-009	waf-dg.pdf	9	take when it matches a web request. For this example, choose Count and leave the other choices as they are. The count action creates metrics for web requests that match the rule, but doesn't aﬀect whether the request is allowed or blocked. For more information about action choices, see Using rule actions in AWS WAF and Using web ACLs with rules and rule groups in AWS WAF. 10. Choose Add rule. Step 4: Add an AWS Managed Rules rule group AWS Managed Rules oﬀers a set of managed rule groups for your use, most of which are free of charge to AWS WAF customers. For more information about rule groups, see AWS WAF rule groups. We'll add an AWS Managed Rules rule group to this web ACL. To add an AWS Managed Rules rule group 1. On the Add rules and rule groups page, choose Add rules, and then choose Add managed rule groups. 2. On the Add managed rule groups page, expand the listing for the AWS managed rule groups. (You'll also see listings oﬀered for AWS Marketplace sellers. You can subscribe to their oﬀerings and then use them in the same way as for AWS Managed Rules rule groups.) 3. For the rule group that you want to add, do the following: Step 4: Add an AWS Managed Rules rule group 13 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide a. b. In the Action column, turn on the Add to web ACL toggle. Select Edit and, in the rule group's Rules listing, open the Override all rule actions dropdown and select Count. This sets the action for all rules in the rule group to count only. This allows you to see how all of the rules in the rule group behave with your web requests before you put any of them to use. c. Choose Save rule. 4. In the Add managed rule groups page, choose Add rules. This returns you to the Add rules and rule groups page. Step 5: Finish your web ACL conﬁguration When you're done adding rules and rule groups to your web ACL conﬁguration, ﬁnish up by managing the priority of the rules in the web ACL and conﬁguring settings like metrics, tagging, and logging. To ﬁnish your web ACL conﬁguration 1. On the Add rules and rule groups page, choose Next. 2. On the Set rule priority page, you can see the processing order for the rules and rule groups in the web ACL. AWS WAF processes them starting from the top of the list. You can change the processing order by moving the rules up or down. To do this, select one in the list and choose Move up or Move down. For more information about rule priority, see Setting rule priority in a web ACL. 3. Choose Next. 4. On the Conﬁgure metrics page, for Amazon CloudWatch metrics, you can see the planned metrics for your rules and rule groups and you can see the web request sampling options. For information about viewing sampled requests, see Viewing a sample of web requests. For information about Amazon CloudWatch metrics, see Monitoring with Amazon CloudWatch. You can access summaries of the web traﬃc metrics on the web ACL's page in the AWS WAF console, under the Traﬃc overview tab. The console dashboards provide near real-time summaries of the web ACL's Amazon CloudWatch metrics. For more information, see Web ACL traﬃc overview dashboards. 5. Choose Next. 6. On the Review and create web ACL page, review your settings, then choose Create web ACL. Step 5: Finish your web ACL conﬁguration 14 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The wizard returns you to the Web ACL page, where your new web ACL is listed. Step 6: Clean up your resources You've now successfully completed the tutorial. To prevent your account from accruing additional AWS WAF charges, clean up the AWS WAF objects that you created. Alternatively, you can change the conﬁguration to match the web requests that you really want to manage using AWS WAF. Note AWS typically bills you less than US $0.25 per day for the resources that you create during this tutorial. When you're ﬁnished, we recommend that you delete the resources to prevent incurring unnecessary charges. To delete the objects that AWS WAF charges for 1. In the Web ACL page, select your web ACL from the list and choose Edit. 2. On the Associated AWS resources tab, for each associated resource, select the radio button next to the resource name and then choose Disassociate. This disassociates the web ACL from your AWS resources. 3. In each of the following screens, choose Next until you return to the Web ACL page. In the Web ACL page, select your web ACL from
waf-dg-010	waf-dg.pdf	10	When you're ﬁnished, we recommend that you delete the resources to prevent incurring unnecessary charges. To delete the objects that AWS WAF charges for 1. In the Web ACL page, select your web ACL from the list and choose Edit. 2. On the Associated AWS resources tab, for each associated resource, select the radio button next to the resource name and then choose Disassociate. This disassociates the web ACL from your AWS resources. 3. In each of the following screens, choose Next until you return to the Web ACL page. In the Web ACL page, select your web ACL from the list and choose Delete. Rules and rule statements don't exist outside of rule group and web ACL deﬁnitions. If you delete a web ACL, this deletes all individual rules that you've deﬁned in the web ACL. When you remove a rule group from a web ACL, you just remove the reference to it. How AWS WAF works You use AWS WAF to control how your protected resources respond to HTTP(S) web requests. You do this by deﬁning a web access control list (ACL) and then associating it with one or more web application resources that you want to protect. The associated resources forward incoming requests to AWS WAF for inspection by the web ACL. In your web ACL, you create rules to deﬁne traﬃc patterns to look for in requests and to specify the actions to take on matching requests. The action choices include the following: Step 6: Clean up your resources 15 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Allow the requests to go to the protected resource for processing and response. • Block the requests. • Count the requests. • Run CAPTCHA or challenge checks against requests to verify human users and standard browser use. AWS WAF components The following are the central components of AWS WAF: • Web ACLs – You use a web access control list (ACL) to protect a set of AWS resources. You create a web ACL and deﬁne its protection strategy by adding rules. Rules deﬁne criteria for inspecting web requests and they specify the action to take on requests that match their criteria. You also set a default action for the web ACL that indicates whether to block or allow through any requests that the rules haven't already blocked or allowed. For more information about web ACLs, see Using web ACLs in AWS WAF. A web ACL is an AWS WAF resource. • Rules – Each rule contains a statement that deﬁnes the inspection criteria, and an action to take if a web request meets the criteria. When a web request meets the criteria, that's a match. You can conﬁgure rules to block matching requests, allow them through, count them, or run bot controls against them that use CAPTCHA puzzles or silent client browser challenges. For more information about rules, see AWS WAF rules. A rule is not an AWS WAF resource. It only exists in the context of a web ACL or rule group. • Rule groups – You can deﬁne rules directly inside a web ACL or in reusable rule groups. AWS Managed Rules and AWS Marketplace sellers provide managed rule groups for your use. You can also deﬁne your own rule groups. For more information about rule groups, see AWS WAF rule groups. A rule group is an AWS WAF resource. • Web ACL capacity units (WCUs) – AWS WAF uses WCUs to calculate and control the operating resources that are required to run your rules, rule groups, and web ACLs. A WCU is not an AWS WAF resource. It only exists in the context of a web ACL, rule, or rule group. How AWS WAF works 16 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Resources that you can protect with AWS WAF You can use an AWS WAF web ACL to protect global or regional resource types. You do this by associating the web ACL with the resources that you want to protect. The web ACL and any AWS WAF resources that it uses must be located in the Region where the associated resource is located. For Amazon CloudFront distributions, this is set to US East (N. Virginia). Amazon CloudFront distributions You can associate an AWS WAF web ACL with a CloudFront distribution using the AWS WAF console or APIs. You can also associate a web ACL with a CloudFront distribution when you create or update the distribution itself. To conﬁgure an association in AWS CloudFormation, you must use the CloudFront distribution conﬁguration. For information about Amazon CloudFront, see Using AWS WAF to Control Access to Your Content in the Amazon CloudFront Developer Guide. AWS WAF is available globally for CloudFront distributions, but you must use the Region
waf-dg-011	waf-dg.pdf	11	CloudFront distributions, this is set to US East (N. Virginia). Amazon CloudFront distributions You can associate an AWS WAF web ACL with a CloudFront distribution using the AWS WAF console or APIs. You can also associate a web ACL with a CloudFront distribution when you create or update the distribution itself. To conﬁgure an association in AWS CloudFormation, you must use the CloudFront distribution conﬁguration. For information about Amazon CloudFront, see Using AWS WAF to Control Access to Your Content in the Amazon CloudFront Developer Guide. AWS WAF is available globally for CloudFront distributions, but you must use the Region US East (N. Virginia) to create your web ACL and any resources used in the web ACL, such as rule groups, IP sets, and regex pattern sets. Some interfaces oﬀer a region choice of "Global (CloudFront)". Choosing this is identical to choosing Region US East (N. Virginia) or "us-east-1". Regional resources You can protect regional resources in all Regions where AWS WAF is available. You can see the list at AWS WAF endpoints and quotas in the Amazon Web Services General Reference. You can use AWS WAF to protect the following regional resource types: • Amazon API Gateway REST API • Application Load Balancer • AWS AppSync GraphQL API • Amazon Cognito user pool • AWS App Runner service • AWS Veriﬁed Access instance • AWS Amplify You can only associate a web ACL to an Application Load Balancer that's within AWS Regions. For example, you cannot associate a web ACL to an Application Load Balancer that's on AWS Outposts. Resources that you can protect with AWS WAF 17 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You must create web ACLs that you want to associate with an Amplify app in the Global CloudFront Region. Regional web ACLs might already exist in your AWS account, but they are not compatible with Amplify. The web ACL and any other AWS WAF resources that it uses must be located in the same Region as the protected resources. When monitoring and managing web requests for a protected regional resource, AWS WAF keeps all data in the same Region as the protected resource. Restrictions on multiple resource associations You can associate a single web ACL with one or more AWS resources, with the following restrictions: • You can associate each AWS resource with only one web ACL. The relationship between web ACL and AWS resources is one-to-many. • You can associate a web ACL with one or more CloudFront distributions. You cannot associate a web ACL that you have associated with a CloudFront distribution with any other AWS resource type. Using web ACLs in AWS WAF This page explains what a web access control list (web ACL) and how it works. A web ACL gives you ﬁne-grained control over all of the HTTP(S) web requests that your protected resource responds to. You can protect Amazon CloudFront, Amazon API Gateway, Application Load Balancer, AWS AppSync, Amazon Cognito, AWS App Runner, AWS Amplify, and AWS Veriﬁed Access resources. You can use criteria like the following to allow or block requests: • IP address origin of the request • Country of origin of the request • String match or regular expression (regex) match in a part of the request • Size of a particular part of the request • Detection of malicious SQL code or scripting You can also test for any combination of these conditions. You can block or count web requests that not only meet the speciﬁed conditions, but also exceed a speciﬁed number of requests in a Using web ACLs 18 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide single minute. You can combine conditions using logical operators. You can also run CAPTCHA puzzles and silent client session challenges against requests. You provide your matching criteria and the action to take on matches in AWS WAF rule statements. You can deﬁne rule statements directly inside your web ACL and in reusable rule groups that you use in your web ACL. For a full list of the options, see Using rule statements in AWS WAF and Using rule actions in AWS WAF. When you create a web ACL, you specify the types of resources that you want to use it with. For information, see Creating a web ACL in AWS WAF. After you deﬁne a web ACL, you can associate it with your resources to begin providing protection for them. For more information, see Associating or disassociating a web ACL with an AWS resource. Note On some occasions, AWS WAF might encounter an internal error that delays the response to associated AWS resources about whether to allow or block a request. On those occasions, CloudFront typically allows the request or serves the content, while the Regional services typically
waf-dg-012	waf-dg.pdf	12	you specify the types of resources that you want to use it with. For information, see Creating a web ACL in AWS WAF. After you deﬁne a web ACL, you can associate it with your resources to begin providing protection for them. For more information, see Associating or disassociating a web ACL with an AWS resource. Note On some occasions, AWS WAF might encounter an internal error that delays the response to associated AWS resources about whether to allow or block a request. On those occasions, CloudFront typically allows the request or serves the content, while the Regional services typically deny the request and don't serve the content. Production traﬃc risk Before you deploy changes in your web ACL for production traﬃc, test and tune them in a staging or testing environment until you are comfortable with the potential impact to your traﬃc. Then test and tune your updated rules in count mode with your production traﬃc before enabling them. For guidance, see Testing and tuning your AWS WAF protections. Note Using more than 1,500 WCUs in a web ACL incurs costs beyond the basic web ACL price. For more information, see Web ACL capacity units (WCUs) in AWS WAF and AWS WAF Pricing. Temporary inconsistencies during updates Using web ACLs 19 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in eﬀect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Topics • Creating a web ACL in AWS WAF • Editing a web ACL in AWS WAF • Managing rule group behavior in a web ACL • Associating or disassociating a web ACL with an AWS resource • Using web ACLs with rules and rule groups in AWS WAF • Setting the web ACL default action in AWS WAF • Managing body inspection size limits for AWS WAF • Conﬁguring CAPTCHA, challenge, and tokens in AWS WAF • Viewing web traﬃc metrics in AWS WAF • Deleting a web ACL Creating a web ACL in AWS WAF This section provides procedures for creating web ACLs through the AWS console. To create a new web ACL, use the web ACL creation wizard following the procedure on this page. Creating a web ACL 20 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Production traﬃc risk Before you deploy changes in your web ACL for production traﬃc, test and tune them in a staging or testing environment until you are comfortable with the potential impact to your traﬃc. Then test and tune your updated rules in count mode with your production traﬃc before enabling them. For guidance, see Testing and tuning your AWS WAF protections. Note Using more than 1,500 WCUs in a web ACL incurs costs beyond the basic web ACL price. For more information, see Web ACL capacity units (WCUs) in AWS WAF and AWS WAF Pricing. To create a web ACL 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. Choose Web ACLs in the navigation pane, and then choose Create web ACL. 3. For Name, enter the name that you want to use to identify this web ACL. Note You can't change the name after you create the web ACL. 4. 5. (Optional) For Description - optional, enter a longer description for the web ACL if you want to. For CloudWatch metric name, change the default name if applicable. Follow the guidance on the console for valid characters. The name can't contain special characters, white space, or metric names reserved for AWS WAF, including "All" and "Default_Action." Note You can't change the CloudWatch metric name after you create the web ACL. Creating a web ACL 21 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 6. Under Resource type, choose the category of AWS resource
waf-dg-013	waf-dg.pdf	13	the web ACL. 4. 5. (Optional) For Description - optional, enter a longer description for the web ACL if you want to. For CloudWatch metric name, change the default name if applicable. Follow the guidance on the console for valid characters. The name can't contain special characters, white space, or metric names reserved for AWS WAF, including "All" and "Default_Action." Note You can't change the CloudWatch metric name after you create the web ACL. Creating a web ACL 21 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 6. Under Resource type, choose the category of AWS resource that you want to associate with this web ACL, either Amazon CloudFront distributions or Regional resources. For more information, see Associating or disassociating a web ACL with an AWS resource. 7. For Region, if you've chosen a Regional resource type, choose the Region where you want AWS WAF to store the web ACL. 8. 9. You only need to choose this option for Regional resource types. For CloudFront distributions, the Region is hard-coded to the US East (N. Virginia) Region, us-east-1, for Global (CloudFront) applications. (CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access) For Web request inspection size limit - optional, if you want to specify a diﬀerent body inspection size limit, select the limit. Inspecting body sizes over the default of 16 KB can incur additional costs. For information about this option, see Managing body inspection size limits for AWS WAF. (Optional) For Associated AWS resources - optional, if you want to specify your resources now, choose Add AWS resources. In the dialog box, choose the resources that you want to associate, and then choose Add. AWS WAF returns you to the Describe web ACL and associated AWS resources page. 10. Choose Next. 11. (Optional) If you want to add managed rule groups, on the Add rules and rule groups page, choose Add rules, and then choose Add managed rule groups. Do the following for each managed rule group that you want to add: a. On the Add managed rule groups page, expand the listing for AWS managed rule groups or for the AWS Marketplace seller of your choice. b. For the rule group that you want to add, in the Action column, turn on the Add to web ACL toggle. To customize how your web ACL uses the rule group, choose Edit. The following are common customization settings: • Override the rule actions for some or all rules. If you don't deﬁne an override action for a rule, the evaluation uses the rule action that's deﬁned inside the rule group. For information about this option, see Overriding rule group actions in AWS WAF. • Reduce the scope of the web requests that the rule group inspects by adding a scope- down statement. For information about this option, see Using scope-down statements in AWS WAF. Creating a web ACL 22 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Some managed rule groups require you to provide additional conﬁguration. See the documentation from your managed rule group provider. For information speciﬁc to the AWS Managed Rules rule groups, see AWS Managed Rules for AWS WAF. When you're ﬁnished with your settings, choose Save rule. Choose Add rules to ﬁnish adding managed rules and return to the Add rules and rule groups page. Note If you add more than one rule to a web ACL, AWS WAF evaluates the rules in the order that they're listed for the web ACL. For more information, see Using web ACLs with rules and rule groups in AWS WAF. 12. (Optional) If you want to add your own rule group, on the Add rules and rule groups page, choose Add rules, and then choose Add my own rules and rule groups. Do the following for each rule group that you want to add: a. On the Add my own rules and rule groups page, choose Rule group. b. For Name, enter the name that you want to use for the rule group rule in this web ACL. Don't use names that start with AWS, Shield, PreFM, or PostFM. These strings are either reserved or could cause confusion with rule groups that are managed for you by other services. See Recognizing rule groups provided by other services. c. Choose your rule group from the list. Note If you want to override the rule actions for a rule group of your own, ﬁrst save it to the web ACL, and then edit the web ACL and the rule group reference statement in the web ACL's rule listing. You can override the rule actions to any valid action setting, the same as you can do for managed rule groups. d. Choose Add rule. 13. (Optional) If you want to add your own
waf-dg-014	waf-dg.pdf	14	groups that are managed for you by other services. See Recognizing rule groups provided by other services. c. Choose your rule group from the list. Note If you want to override the rule actions for a rule group of your own, ﬁrst save it to the web ACL, and then edit the web ACL and the rule group reference statement in the web ACL's rule listing. You can override the rule actions to any valid action setting, the same as you can do for managed rule groups. d. Choose Add rule. 13. (Optional) If you want to add your own rule, on the Add rules and rule groups page, choose Add rules, Add my own rules and rule groups, Rule builder, then Rule visual editor. Creating a web ACL 23 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note The console Rule visual editor supports one level of nesting. For example, you can use a single logical AND or OR statement and nest one level of other statements inside it, but you can't nest logical statements within logical statements. To manage more complex rule statements, use the Rule JSON editor. For information about all options for rules, see AWS WAF rules. This procedure covers the Rule visual editor. a. For Name, enter the name that you want to use to identify this rule. Don't use names that start with AWS, Shield, PreFM, or PostFM. These strings are either reserved or could cause confusion with rule groups that are managed for you by other services. b. Enter your rule deﬁnition, according to your needs. You can combine rules inside logical AND and OR rule statements. The wizard guides you through the options for each rule, according to context. For information about your rules options, see AWS WAF rules. c. For Action, select the action you want the rule to take when it matches a web request. For information on your choices, see Using rule actions in AWS WAF and Using web ACLs with rules and rule groups in AWS WAF. If you are using the CAPTCHA or Challenge action, adjust the Immunity time conﬁguration as needed for the rule. If you don't specify the setting, the rule inherits it from the web ACL. To modify the web ACL immunity time settings, edit the web ACL after you create it. For more information about immunity times, see Setting timestamp expiration and token immunity times in AWS WAF. Note You are charged additional fees when you use the CAPTCHA or Challenge rule action in one of your rules or as a rule action override in a rule group. For more information, see AWS WAF Pricing. If you want to customize the request or response, choose the options for that and ﬁll in the details of your customization. For more information, see Customized web requests and responses in AWS WAF. Creating a web ACL 24 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you want to have your rule add labels to matching web requests, choose the options for that and ﬁll in your label details. For more information, see Web request labeling in AWS WAF. d. Choose Add rule. 14. Choose the default action for the web ACL, either Block or Allow. This is the action that AWS WAF takes on a request when the rules in the web ACL don't explicitly allow or block it. For more information, see Setting the web ACL default action in AWS WAF. If you want to customize the default action, choose the options for that and ﬁll in the details of your customization. For more information, see Customized web requests and responses in AWS WAF. 15. You can deﬁne a Token domain list to enable token sharing between protected applications. Tokens are used by the CAPTCHA and Challenge actions and by the application integration SDKs that you implement when you use the AWS Managed Rules rule groups for AWS WAF Fraud Control account creation fraud prevention (ACFP), AWS WAF Fraud Control account takeover prevention (ATP), and AWS WAF Bot Control. Public suﬃxes aren't allowed. For example, you can't use gov.au or co.uk as a token domain. By default, AWS WAF accepts tokens only for the domain of the protected resource. If you add token domains in this list, AWS WAF accepts tokens for all domains in the list and for the domain of the associated resource. For more information, see AWS WAF web ACL token domain list conﬁguration. 16. Choose Next. 17. In the Set rule priority page, select and move your rules and rule groups to the order that you want AWS WAF to process them. AWS WAF processes rules starting from the top of the list. When you save the web ACL AWS WAF assigns numeric priority
waf-dg-015	waf-dg.pdf	15	WAF accepts tokens only for the domain of the protected resource. If you add token domains in this list, AWS WAF accepts tokens for all domains in the list and for the domain of the associated resource. For more information, see AWS WAF web ACL token domain list conﬁguration. 16. Choose Next. 17. In the Set rule priority page, select and move your rules and rule groups to the order that you want AWS WAF to process them. AWS WAF processes rules starting from the top of the list. When you save the web ACL AWS WAF assigns numeric priority settings to the rules, in the order that you have them listed. For more information, see Setting rule priority in a web ACL. 18. Choose Next. 19. In the Conﬁgure metrics page, review the options and apply any updates that you need. You can combine metrics from multiple sources by providing the same CloudWatch metric name for them. 20. Choose Next. 21. In the Review and create web ACL page, check over your deﬁnitions. If you want to change any area, choose Edit for the area. This returns you to the page in the web ACL wizard. Make Creating a web ACL 25 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide any changes, then choose Next through the pages until you come back to the Review and create web ACL page. 22. Choose Create web ACL. Your new web ACL is listed in the Web ACLs page. Editing a web ACL in AWS WAF This section provides procedures for editing web ACLs through the AWS console. To add or remove rules from a web ACL or change conﬁguration settings, access the web ACL using the procedure on this page. While updating a web ACL, AWS WAF provides continuous coverage to the resources that you have associated with the web ACL. Production traﬃc risk Before you deploy changes in your web ACL for production traﬃc, test and tune them in a staging or testing environment until you are comfortable with the potential impact to your traﬃc. Then test and tune your updated rules in count mode with your production traﬃc before enabling them. For guidance, see Testing and tuning your AWS WAF protections. Note Using more than 1,500 WCUs in a web ACL incurs costs beyond the basic web ACL price. For more information, see Web ACL capacity units (WCUs) in AWS WAF and AWS WAF Pricing. To edit a web ACL 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. In the navigation pane, choose Web ACLs. 3. Choose the name of the web ACL that you want to edit. The console takes you to the web ACL's description. 4. Edit the web ACL as needed. Select the tabs for the conﬁguration areas that you're interested in and edit the mutable settings. For each setting that you edit, when you choose Save and return to the web ACL's description page, the console saves your changes to the web ACL. Editing a web ACL 26 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The following lists the tabs that contain web ACL conﬁguration components. • Rules tab • Rules deﬁned in the web ACL – You can edit and manage the rules that you have deﬁned in the web ACL, similar to how you did during web ACL creation. Note Don't change the names of any rules that you didn't add by hand to your web ACL. If you are using other services to manage rules for you, changing their names could remove or lessen their ability to provide the intended protections. AWS Shield Advanced and AWS Firewall Manager both can create rules in your web ACL. For information, see Recognizing rule groups provided by other services. Note If you change the name of a rule and you want the rule's metric name to reﬂect the change, you must update the metric name as well. AWS WAF doesn't automatically update the metric name for a rule when you change the rule name. You can change the metric name when you edit the rule in the console, by using the rule JSON editor. You can also change both names through the APIs and in any JSON listing that you use to deﬁne your web ACL or rule group. For information about rules and rule group settings, see AWS WAF rules and AWS WAF rule groups. • Web ACL rule capacity units used – The current capacity usage for your web ACL. This is view only. • Default web ACL action for requests that don't match any rules– For information about this setting, see Setting the web ACL default action in AWS WAF. • Web ACL CAPTCHA and
waf-dg-016	waf-dg.pdf	16	by using the rule JSON editor. You can also change both names through the APIs and in any JSON listing that you use to deﬁne your web ACL or rule group. For information about rules and rule group settings, see AWS WAF rules and AWS WAF rule groups. • Web ACL rule capacity units used – The current capacity usage for your web ACL. This is view only. • Default web ACL action for requests that don't match any rules– For information about this setting, see Setting the web ACL default action in AWS WAF. • Web ACL CAPTCHA and challenge conﬁgurations – These immunity times determine how long a CAPTCHA or challenge token remains valid after it's acquired. You can only modify this setting here, after you create the web ACL. For information about these settings, see Setting timestamp expiration and token immunity times in AWS WAF. Editing a web ACL 27 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Token domain list – AWS WAF accepts tokens for all domains in the list and for the domain of the associated resource. For more information, see AWS WAF web ACL token domain list conﬁguration. • Associated AWS resources tab • Web request inspection size limit – Included only for web ACLs that protect CloudFront distributions. The body inspection size limit determines how much of the body component is forwarded to AWS WAF for inspection. For more information about this setting, see Managing body inspection size limits for AWS WAF. • Associated AWS resources – The list of resources that the web ACL is currently associated with and protecting. You can locate resources that are within the same Region as the web ACL and associate them to the web ACL. For more information, see Associating or disassociating a web ACL with an AWS resource. • Custom response bodies tab • Custom response bodies that are available for use by your web ACL rules that have the action set to Block. For more information, see Sending custom responses for Block actions. • Logging and metrics tab • Logging – Logging for the traﬃc that the web ACL evaluates. For information, see Logging AWS WAF web ACL traﬃc. • Security Lake integration – The status of any data collection that you've conﬁgured for the web ACL in Amazon Security Lake. For information, see Collecting data from AWS services in the Amazon Security Lake user guide. • Sampled requests – Information about the rules that match web requests. For information about viewing sampled requests, see Viewing a sample of web requests. • Data protection settings – You can conﬁgure web traﬃc data redaction and ﬁltering for all data that's available for the web ACL and for just the data that the AWS WAF sends to the conﬁgured web ACL logging destination. For information about data protection, see Data protection and logging for AWS WAF web ACL traﬃc. • CloudWatch metrics – Metrics for the rules in your web ACL. For information about Amazon CloudWatch metrics, see Monitoring with Amazon CloudWatch. Temporary inconsistencies during updates Editing a web ACL 28 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in eﬀect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Managing rule group behavior in a web ACL This section describes your options for modifying how you use a rule group in your web ACL. This information applies to all rule group types. After you add a rule group to a web ACL, you can override the actions of the individual rules in the rule group to Count or to any other valid rule action setting. You can also override the rule group's resulting action to Count, which has no eﬀect on how the rules are evaluated inside the rule group. For
waf-dg-017	waf-dg.pdf	17	in one area while still allowed in another. Managing rule group behavior in a web ACL This section describes your options for modifying how you use a rule group in your web ACL. This information applies to all rule group types. After you add a rule group to a web ACL, you can override the actions of the individual rules in the rule group to Count or to any other valid rule action setting. You can also override the rule group's resulting action to Count, which has no eﬀect on how the rules are evaluated inside the rule group. For information about these options, see Overriding rule group actions in AWS WAF. Overriding rule actions in a rule group For each rule group in a web ACL, you can override the contained rule's actions for some or all of the rules. The most common use case for this is overriding the rule actions to Count to test new or updated rules. If you have metrics enabled, you receive metrics for each rule that you override. For more information about testing, see Testing and tuning your AWS WAF protections. To override rule actions in a rule group You can make these changes when you're adding a managed rule group to the web ACL, and you can make them to any type of rule group when you edit the web ACL. These instructions are for Managing rule group behavior in a web ACL 29 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide a rule group that has already been added to the web ACL. See additional information about this option at Rule group rule action overrides. 1. 2. 3. Edit the web ACL. In the web ACL page Rules tab, select the rule group, then choose Edit. In the Rules section for the rule group, manage the action settings as needed. • All rules – To set an override action for all rules in the rule group, open the Override all rule actions dropdown and select the override action. To remove the overrides for all rules, select Remove all overrides. • Single rule – To set an override action for a single rule, open the rule's dropdown and select the override action. To remove an override for a rule, open the rule's dropdown and select Remove override. 4. When you are ﬁnished making your changes, choose Save rule. The rule action and override action settings are listed in the rule group page. The following example JSON listing shows a rule group declaration inside a web ACL that overrides the rule actions to Count for the rules CategoryVerifiedSearchEngine and CategoryVerifiedSocialMedia. In the JSON, you override all rule actions by providing a RuleActionOverrides entry for each individual rule. { "Name": "AWS-AWSBotControl-Example", "Priority": 5, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesBotControlRuleSet", "RuleActionOverrides": [ { "ActionToUse": { "Count": {} }, "Name": "CategoryVerifiedSearchEngine" }, { "ActionToUse": { "Count": {} }, Managing rule group behavior in a web ACL 30 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Name": "CategoryVerifiedSocialMedia" } ], "ExcludedRules": [] }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSBotControl-Example" } } Overriding a rule group's evaluation result to Count You can override the action that results from a rule group evaluation, without altering how the rules in the rule group are conﬁgured or evaluated. This option is not commonly used. If any rule in the rule group results in a match, this override sets the resulting action from the rule group to Count. Note This is an uncommon use case. Most action overrides are done at the rule level, inside the rule group, as described in Overriding rule actions in a rule group. You can override the rule group's resulting action in the web ACL when you add or edit the rule group. In the console, open the rule group's Override rule group action - optional pane and enable the override. In the JSON set OverrideAction in the rule group statement, as shown in the following example listing: { "Name": "AWS-AWSBotControl-Example", "Priority": 5, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesBotControlRuleSet" } }, "OverrideAction": { "Count": {} Managing rule group behavior in a web ACL 31 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSBotControl-Example" } } Associating or disassociating a web ACL with an AWS resource You can use AWS WAF to create the following associations between web ACLS and your resources: • Associate a regional web ACL with any of the regional resources listed below. For this option, the web ACL must be in the same region as your resource. • Amazon API Gateway REST API • Application Load Balancer • AWS AppSync GraphQL API • Amazon Cognito user pool • AWS App Runner
waf-dg-018	waf-dg.pdf	18	WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSBotControl-Example" } } Associating or disassociating a web ACL with an AWS resource You can use AWS WAF to create the following associations between web ACLS and your resources: • Associate a regional web ACL with any of the regional resources listed below. For this option, the web ACL must be in the same region as your resource. • Amazon API Gateway REST API • Application Load Balancer • AWS AppSync GraphQL API • Amazon Cognito user pool • AWS App Runner service • AWS Veriﬁed Access instance • AWS Amplify • Associate a global web ACL with a Amazon CloudFront distribution. The global web ACL will have a hard-coded Region of US East (N. Virginia) Region. You can also associate a web ACL with a CloudFront distribution when you create or update the distribution itself. For information, see Using AWS WAF to Control Access to Your Content in the Amazon CloudFront Developer Guide. Restrictions on multiple associations You can associate a single web ACL with one or more AWS resources, according to the following restrictions: • You can associate each AWS resource with only one web ACL. The relationship between web ACL and AWS resources is one-to-many. Associating or disassociating a web ACL with an AWS resource 32 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • You can associate a web ACL with one or more CloudFront distributions. You cannot associate a web ACL that you have associated with a CloudFront distribution with any other AWS resource type. Additional restrictions The following additional restrictions apply to web ACL associations: • You can only associate a web ACL to an Application Load Balancer within AWS Regions. For example, you cannot associate a web ACL to an Application Load Balancer that is on AWS Outposts. • You can't associate an Amazon Cognito user pool with a web ACL that uses the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet or the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet. For information about account creation fraud prevention, see AWS WAF Fraud Control account creation fraud prevention (ACFP). For information about account takeover prevention, see AWS WAF Fraud Control account takeover prevention (ATP). Production traﬃc risk Before you deploy your web ACL for production traﬃc, test and tune it in a staging or testing environment until you are comfortable with the potential impact to your traﬃc. Then test and tune your rules in count mode with your production traﬃc before enabling them. For guidance, see Testing and tuning your AWS WAF protections. Associating a web ACL with an AWS resource To associate a web ACL with an AWS resource, perform the following procedure. To associate a web ACL with an AWS resource 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. In the navigation pane, choose Web ACLs. Associating or disassociating a web ACL with an AWS resource 33 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 3. Choose the name of the web ACL that you want to associate with a resource. The console takes you to the web ACL's description, where you can edit it. 4. On the Associated AWS resources tab, choose Add AWS resources. 5. When prompted, choose the resource type, select the radio button next to the resource that you want to associate, and then choose Add. Disassociating a web ACL from an AWS resource To dissociate a web ACL from an AWS resource, perform the following procedure. To disassociate a web ACL from an AWS resource 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. In the navigation pane, choose Web ACLs. 3. Choose the name of the web ACL that you want to disassociate from your resource. The console takes you to the web ACL's description, where you can edit it. 4. On the Associated AWS resources tab, select the resource that you want to disassociate this web ACL from. Note You must disassociate one resource at a time. Do not choose multiple resources. 5. Choose Disassociate. The console opens a conﬁrmation dialogue. Conﬁrm your choice to disassociate the web ACL from the AWS resource. Using web ACLs with rules and rule groups in AWS WAF This section introduces how web ACLs work with rules and rule groups. The way a web ACL handles a web request depends on the following: • The numeric priority settings of the rules in the web ACL and inside rule groups • The action settings on the rules and web ACL • Any overrides that you place on
waf-dg-019	waf-dg.pdf	19	one resource at a time. Do not choose multiple resources. 5. Choose Disassociate. The console opens a conﬁrmation dialogue. Conﬁrm your choice to disassociate the web ACL from the AWS resource. Using web ACLs with rules and rule groups in AWS WAF This section introduces how web ACLs work with rules and rule groups. The way a web ACL handles a web request depends on the following: • The numeric priority settings of the rules in the web ACL and inside rule groups • The action settings on the rules and web ACL • Any overrides that you place on the rules in the rule groups that you add Using web ACLs with rules and rule groups 34 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For a list of the rule action settings, see Using rule actions in AWS WAF. You can customize request and response handling in your rule action settings and default web ACL action settings. For information, see Customized web requests and responses in AWS WAF. Topics • Setting rule priority in a web ACL • How AWS WAF handles rule and rule group actions in a web ACL • Overriding rule group actions in AWS WAF Setting rule priority in a web ACL This section explains how AWS WAF uses numeric priority settings to set the evaluation order for rules. In a web ACL and inside any rule group, you determine the evaluation order of the rules using numeric priority settings. You must give each rule in a web ACL a unique priority setting within that web ACL, and you must give each rule in a rule group a unique priority setting within that rule group. Note When you manage rule groups and web ACLs through the console, AWS WAF assigns unique numeric priority settings for you based on the order of the rules in the list. AWS WAF assigns the lowest numeric priority to the rule at the top of the list, and the highest numeric priority to the rule at the bottom. When AWS WAF evaluates any web ACL or rule group against a web request, it evaluates the rules from the lowest numeric priority setting on up until it either ﬁnds a match that terminates the evaluation or exhausts all of the rules. For example, say you have the following rules and rule groups in your web ACL, prioritized as shown: • Rule1 – priority 0 • RuleGroupA – priority 100 • RuleA1 – priority 10,000 Using web ACLs with rules and rule groups 35 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • RuleA2 – priority 20,000 • Rule2 – priority 200 • RuleGroupB – priority 300 • RuleB1 – priority 0 • RuleB2 – priority 1 AWS WAF would evaluate the rules for this web ACL in the following order: • Rule1 • RuleGroupA RuleA1 • RuleGroupA RuleA2 • Rule2 • RuleGroupB RuleB1 • RuleGroupB RuleB2 How AWS WAF handles rule and rule group actions in a web ACL This section explains how AWS WAF uses rules and rule groups to handle actions. When you conﬁgure your rules and rule groups, you choose how you want AWS WAF to handle matching web requests: • Allow and Block are terminating actions – Allow and Block actions stop all other processing of the web ACL on the matching web request. If a rule in a web ACL ﬁnds a match for a request and the rule action is Allow or Block, that match determines the ﬁnal disposition of the web request for the web ACL. AWS WAF doesn't process any other rules in the web ACL that come after the matching one. This is true for rules that you add directly to the web ACL and rules that are inside an added rule group. With the Block action, the protected resource doesn't receive or process the web request. • Count is a non-terminating action – When a rule with a Count action matches a request, AWS WAF counts the request, then continues processing the rules that follow in the web ACL rule set. • CAPTCHA and Challenge can be non-terminating or terminating actions – When a rule with one of these actions matches a request, AWS WAF checks its token status. If the request has a valid token, AWS WAF treats the match similar to a Count match, and then continues processing the rules that follow in the web ACL rule set. If the request doesn't have a valid token, AWS WAF Using web ACLs with rules and rule groups 36 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide terminates the evaluation and sends the client a CAPTCHA puzzle or silent background client session challenge to solve. If the rule evaluation doesn't result
waf-dg-020	waf-dg.pdf	20	rule with one of these actions matches a request, AWS WAF checks its token status. If the request has a valid token, AWS WAF treats the match similar to a Count match, and then continues processing the rules that follow in the web ACL rule set. If the request doesn't have a valid token, AWS WAF Using web ACLs with rules and rule groups 36 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide terminates the evaluation and sends the client a CAPTCHA puzzle or silent background client session challenge to solve. If the rule evaluation doesn't result in any terminating action, then AWS WAF applies the web ACL default action to the request. For information, see Setting the web ACL default action in AWS WAF. In your web ACL, you can override the action settings for rules inside a rule group and you can override the action that's returned by a rule group. For information, see Overriding rule group actions in AWS WAF. Interaction between actions and priority settings The actions that AWS WAF applies to a web request are aﬀected by the numeric priority settings of the rules in the web ACL. For example, say that your web ACL has a rule with Allow action and a numeric priority of 50 and another rule with Count action and a numeric priority of 100. AWS WAF evaluates the rules in a web ACL in the order of their priority, starting from the lowest setting, so it will evaluate the allow rule before the count rule. A web request that matches both rules will match the allow rule ﬁrst. Since Allow is a terminating action, AWS WAF will stop the evaluation at this match and won't evaluate the request against the count rule. • If you only want to include requests that don't match the allow rule in your count rule metrics, then the priority settings of the rules would work. • On the other hand, if you want count metrics from the count rule even for requests that match the allow rule, you'd need to give the count rule a lower numeric priority setting than the allow rule, so that it runs ﬁrst. For more information about priority settings, see Setting rule priority in a web ACL. Overriding rule group actions in AWS WAF This section explains how to override rule group actions. When you add a rule group to your web ACL, you can override the actions it takes on matching web requests. Overriding the actions for a rule group inside your web ACL conﬁguration doesn't alter the rule group itself. It only alters how AWS WAF uses the rule group in the context of the web ACL. Using web ACLs with rules and rule groups 37 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule group rule action overrides You can override the actions of the rules inside a rule group to any valid rule action. When you do this, matching requests are handled exactly as if the conﬁgured rule's action were the override setting. Note Rule actions can be terminating or non-terminating. A terminating action stops the web ACL evaluation of the request and either lets it continue to your protected application or blocks it. Here are the rule action options: • Allow – AWS WAF allows the request to be forwarded to the protected AWS resource for processing and response. This is a terminating action. In rules that you deﬁne, you can insert custom headers into the request before forwarding it to the protected resource. • Block – AWS WAF blocks the request. This is a terminating action. By default, your protected AWS resource responds with an HTTP 403 (Forbidden) status code. In rules that you deﬁne, you can customize the response. When AWS WAF blocks a request, the Block action settings determine the response that the protected resource sends back to the client. • Count – AWS WAF counts the request but does not determine whether to allow it or block it. This is a non-terminating action. AWS WAF continues processing the remaining rules in the web ACL. In rules that you deﬁne, you can insert custom headers into the request and you can add labels that other rules can match against. • CAPTCHA and Challenge – AWS WAF uses CAPTCHA puzzles and silent challenges to verify that the request is not coming from a bot, and AWS WAF uses tokens to track recent successful client responses. CAPTCHA puzzles and silent challenges can only run when browsers are accessing HTTPS endpoints. Browser clients must be running in secure contexts in order to acquire tokens. Using web ACLs with rules and rule groups 38 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note You are charged additional
waf-dg-021	waf-dg.pdf	21	the request and you can add labels that other rules can match against. • CAPTCHA and Challenge – AWS WAF uses CAPTCHA puzzles and silent challenges to verify that the request is not coming from a bot, and AWS WAF uses tokens to track recent successful client responses. CAPTCHA puzzles and silent challenges can only run when browsers are accessing HTTPS endpoints. Browser clients must be running in secure contexts in order to acquire tokens. Using web ACLs with rules and rule groups 38 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note You are charged additional fees when you use the CAPTCHA or Challenge rule action in one of your rules or as a rule action override in a rule group. For more information, see AWS WAF Pricing. These rule actions can be terminating or non-terminating, depending on the state of the token in the request: • Non-terminating for valid, unexpired token – If the token is valid and unexpired according to the conﬁgured CAPTCHA or challenge immunity time, AWS WAF handles the request similar to the Count action. AWS WAF continues to inspect the web request based on the remaining rules in the web ACL. Similar to the Count conﬁguration, in rules that you deﬁne, you can optionally conﬁgure these actions with custom headers to insert into the request, and you can add labels that other rules can match against. • Terminating with blocked request for invalid or expired token – If the token is invalid or the indicated timestamp is expired, AWS WAF terminates the inspection of the web request and blocks the request, similar to the Block action. AWS WAF then responds to the client with a custom response code. For CAPTCHA, if the request contents indicate that the client browser can handle it, AWS WAF sends a CAPTCHA puzzle in a JavaScript interstitial, which is designed to distinguish human clients from bots. For the Challenge action, AWS WAF sends a JavaScript interstitial with a silent challenge that is designed to distinguish normal browsers from sessions that are being run by bots. For additional information, see CAPTCHA and Challenge in AWS WAF. For information about how to use this option, see Overriding rule actions in a rule group. Overriding the rule action to Count The most common use case for rule action overrides is overriding some or all of the rule actions to Count, to test and monitor a rule group's behavior before putting it into production. You can also use this to troubleshoot a rule group that's generating false positives. False positives occur when a rule group blocks traﬃc that you aren't expecting it to block. If you identify a rule within a rule group that would block requests that you want to allow through, you can keep the count action override on that rule, to exclude it from acting on your requests. Using web ACLs with rules and rule groups 39 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For more information about using the rule action override in testing, see Testing and tuning your AWS WAF protections. JSON listing: RuleActionOverrides replaces ExcludedRules If you set rule group rule actions to Count in your web ACL conﬁguration before October 27, 2022, AWS WAF saved your overrides in the web ACL JSON as ExcludedRules. Now, the JSON setting for overriding a rule to Count is in the RuleActionOverrides settings. We recommend that you update all of your ExcludedRules settings in your JSON listings to RuleActionOverrides settings with the action set to Count. The API accepts either setting, but you'll get consistency in your JSON listings, between your console work and your API work, if you only use the new RuleActionOverrides setting. Note In the AWS WAF console, the web ACL Sampled requests tab doesn't show samples for rules with the old setting. For more information, see Viewing a sample of web requests. When you use the AWS WAF console to edit the existing rule group settings, the console automatically converts any ExcludedRules settings in the JSON to RuleActionOverrides settings, with the override action set to Count. • Current setting example: "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesAdminProtectionRuleSet", "RuleActionOverrides": [ { "Name": "AdminProtection_URIPATH", "ActionToUse": { "Count": {} } } ] • Old setting example: OLD SETTING Using web ACLs with rules and rule groups 40 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesAdminProtectionRuleSet", "ExcludedRules": [ { "Name": "AdminProtection_URIPATH" } ] OLD SETTING Rule group return action override to Count You can override the action that the rule group returns, setting it to Count. Note This is not a good option for testing the rules in a rule group, because it doesn't alter how AWS WAF evaluates the rule group itself. It only
waf-dg-022	waf-dg.pdf	22	"Name": "AdminProtection_URIPATH", "ActionToUse": { "Count": {} } } ] • Old setting example: OLD SETTING Using web ACLs with rules and rule groups 40 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesAdminProtectionRuleSet", "ExcludedRules": [ { "Name": "AdminProtection_URIPATH" } ] OLD SETTING Rule group return action override to Count You can override the action that the rule group returns, setting it to Count. Note This is not a good option for testing the rules in a rule group, because it doesn't alter how AWS WAF evaluates the rule group itself. It only aﬀects how AWS WAF handles results that are returned to the web ACL from the rule group evaluation. If you want to test the rules in a rule group, use the option described in the preceding section, Rule group rule action overrides. When you override the rule group action to Count, AWS WAF processes the rule group evaluation normally. If no rules in the rule group match or if all matching rules have a Count action, then this override has no eﬀect on the processing of the rule group or the web ACL. The ﬁrst rule in the rule group that matches a web request and that has a terminating rule action causes AWS WAF to stop evaluating the rule group and return the terminating action result to the web ACL evaluation level. At this point, in the web ACL evaluation, this override takes eﬀect. AWS WAF overrides the terminating action so that the result of the rule group evaluation is only a Count action. AWS WAF then continues processing the rest of the rules in the web ACL. For information about how to use this option, see Overriding a rule group's evaluation result to Count. Using web ACLs with rules and rule groups 41 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Setting the web ACL default action in AWS WAF This section explains how web ACL default actions work. When you create and conﬁgure a web ACL, you must set the web ACL default action. AWS WAF applies this action to any web request that makes it through all of the web ACL's rule evaluations without having a terminating action applied to it. A terminating action stops the web ACL evaluation of the request and either lets it continue to your protected application or blocks it. For information about rule actions, see Using rule actions in AWS WAF. The web ACL default action must determine the ﬁnal disposition of the web request, so it's a terminating action: • Allow – If you want to allow most users to access your website, but you want to block access to attackers whose requests originate from speciﬁed IP addresses, or whose requests appear to contain malicious SQL code or speciﬁed values, choose Allow for the default action. Then, when you add rules to your web ACL, add rules that identify and block the speciﬁc requests that you want to block. With this action, you can insert custom headers into the request before forwarding it to the protected resource. • Block – If you want to prevent most users from accessing your website, but you want to allow access to users whose requests originate from speciﬁed IP addresses, or whose requests contain speciﬁed values, choose Block for the default action. Then when you add rules to your web ACL, add rules that identify and allow the speciﬁc requests that you want to allow in. By default, for the Block action, the AWS resource responds with an HTTP 403 (Forbidden) status code, but you can customize the response. For information about customizing requests and responses, see Customized web requests and responses in AWS WAF. Your conﬁguration of your own rules and rule groups depends in part on whether you want to allow or block most web requests. For example, if you want to allow most requests, you would set the web ACL default action to Allow, and then add rules that identify web requests that you want to block, such as the following: • Requests that originate from IP addresses that are making an unreasonable number of requests • Requests that originate from countries that either you don't do business in or are the frequent source of attacks • Requests that include fake values in the User-agent header Setting the web ACL default action 42 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Requests that appear to include malicious SQL code Managed rule group rules usually use the Block action, but not all do. For examples, some rules used for Bot Control use the CAPTCHA and Challenge action settings. For information about managed rule groups, see Using managed rule groups in AWS WAF. Managing body inspection
waf-dg-023	waf-dg.pdf	23	that originate from countries that either you don't do business in or are the frequent source of attacks • Requests that include fake values in the User-agent header Setting the web ACL default action 42 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Requests that appear to include malicious SQL code Managed rule group rules usually use the Block action, but not all do. For examples, some rules used for Bot Control use the CAPTCHA and Challenge action settings. For information about managed rule groups, see Using managed rule groups in AWS WAF. Managing body inspection size limits for AWS WAF This section explains what a body inspection size limit is and how it works. The body inspection size limit is the maximum request body size that AWS WAF can inspect. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection. • For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for any of the resource types by increments of 16 KB, up to 64 KB. The setting options are 16 KB, 32 KB, 48 KB, and 64 KB. Oversize body handling If your web traﬃc includes bodies that are larger than the limit, your conﬁgured oversize handling will apply. For information about the options for oversize handling, see Oversize web request components in AWS WAF. Pricing considerations for increasing the limit setting AWS WAF charges a base rate for inspecting traﬃc that's within the default limit for the resource type. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access resources, if you increase the limit setting, the traﬃc that AWS WAF can inspect includes body sizes up to your new limit. You're charged extra only for the inspection of requests that have body sizes larger than the default 16 KB. For more information about pricing, see AWS WAF Pricing. Options for modifying the body inspection size limit You can conﬁgure the body inspection size limit for CloudFront, API Gateway, Amazon Cognito, App Runner, or Veriﬁed Access resources. Managing body inspection size limits 43 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide When you create or edit a web ACL, you can modify the body inspection size limits in the resource association conﬁguration. For the API, see the web ACL's association conﬁguration at AssociationConﬁg. For the console, see the conﬁguration on the page where you specify the web ACL's associated resources. For guidance on the console conﬁguration, see Viewing web traﬃc metrics in AWS WAF. Conﬁguring CAPTCHA, challenge, and tokens in AWS WAF You can conﬁgure options in your web ACL for the rules that use the CAPTCHA or Challenge rule actions and for the application integration SDKs that manage silent client challenges for AWS WAF managed protections. These features mitigate bot activity by challenging end users with CAPTCHA puzzles and by presenting client sessions with silent challenges. When the client responds successfully, AWS WAF provides a token for them to use in their web request, timestamped with the last successful puzzle and challenge responses. For more information, see Intelligent threat mitigation in AWS WAF. In your web ACL conﬁguration, you can conﬁgure how AWS WAF manages these tokens: • CAPTCHA and challenge immunity times – These specify how long a CAPTCHA or challenge timestamp remains valid. The web ACL settings are inherited by all rules that don't have their own immunity time settings conﬁgured and also by the application integration SDKs. For more information, see Setting timestamp expiration and token immunity times in AWS WAF. • Token domains – By default, AWS WAF accepts tokens only for the domain of the resource that the web ACL is associated with. If you conﬁgure a token domain list, AWS WAF accepts tokens for all domains in the list and for the domain of the associated resource. For more information, see AWS WAF web ACL token domain list conﬁguration. Viewing web traﬃc metrics in AWS WAF This section explains how to access summaries of web traﬃc metrics. For any web ACL that you're using, you can access summaries of the web traﬃc metrics on the web ACL's page in the AWS WAF console, under the Traﬃc overview tab. The console dashboards provide near real-time summaries of the Amazon CloudWatch metrics that AWS WAF collects when it evaluates your application web traﬃc. For more information about the dashboards, see Web ACL traﬃc overview dashboards. For additional information about monitoring your web ACL's traﬃc, see Monitoring and tuning your AWS WAF protections. Conﬁguring CAPTCHA,
waf-dg-024	waf-dg.pdf	24	metrics in AWS WAF This section explains how to access summaries of web traﬃc metrics. For any web ACL that you're using, you can access summaries of the web traﬃc metrics on the web ACL's page in the AWS WAF console, under the Traﬃc overview tab. The console dashboards provide near real-time summaries of the Amazon CloudWatch metrics that AWS WAF collects when it evaluates your application web traﬃc. For more information about the dashboards, see Web ACL traﬃc overview dashboards. For additional information about monitoring your web ACL's traﬃc, see Monitoring and tuning your AWS WAF protections. Conﬁguring CAPTCHA, challenge, and tokens 44 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Deleting a web ACL This section provides procedures for deleting web ACLs through the AWS console. To delete a web ACL, you ﬁrst disassociate all AWS resources from the web ACL. Perform the following procedure. To delete a web ACL 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// 2. 3. console.aws.amazon.com/wafv2/. In the navigation pane, choose Web ACLs. Select the name of the web ACL that you want to delete. The console takes you to the web ACL's description, where you can edit it. Note If you don't see the web ACL that you want to delete, make sure the Region selection inside the Web ACLs section is correct. Web ACLs that protect Amazon CloudFront distributions are in Global (CloudFront). 4. On the Associated AWS resources tab, for each associated resource, select the radio button next to the resource name and then choose Disassociate. This disassociates the web ACL from your AWS resources. 5. 6. In the navigation pane, choose Web ACLs. Select the radio button next to the web ACL that you are deleting, and then choose Delete. AWS WAF rules This section explains what an AWS WAF rule is and how it works. An AWS WAF rule deﬁnes how to inspect HTTP(S) web requests and the action to take on a request when it matches the inspection criteria. You deﬁne rules only in the context of a rule group or web ACL. Rules don't exist in AWS WAF on their own. They aren't AWS resources, and they don't have Amazon Resource Names (ARNs). You can access a rule by name in the rule group or web ACL where it's deﬁned. You can manage rules and copy them to other web ACLs by using the JSON view of the Deleting a web ACL 45 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide rule group or web ACL that contains the rule. You can also manage them through the AWS WAF console rule builder, which is available for web ACLs and rule groups. Rule name Each rule requires a name. Avoid names that start with AWS and names that are used for rule groups or rules that are managed for you by other services. See Recognizing rule groups provided by other services. Note If you change the name of a rule and you want the rule's metric name to reﬂect the change, you must update the metric name as well. AWS WAF doesn't automatically update the metric name for a rule when you change the rule name. You can change the metric name when you edit the rule in the console, by using the rule JSON editor. You can also change both names through the APIs and in any JSON listing that you use to deﬁne your web ACL or rule group. Rule statement Each rule also requires a rule statement that deﬁnes how the rule inspects web requests. The rule statement might contain other, nested statements at any depth, depending on the rule and statement type. Some rule statements take sets of criteria. For example, you can specify up to 10,000 IP addresses or IP address ranges for an IP set match rule. You can deﬁne rules that inspect for criteria like the following: • Scripts that are likely to be malicious. Attackers embed scripts that can exploit vulnerabilities in web applications. This is known as cross-site scripting (XSS). • IP addresses or address ranges that requests originate from. • Country or geographical location that requests originate from. • Length of a speciﬁed part of the request, such as the query string. • SQL code that is likely to be malicious. Attackers try to extract data from your database by embedding malicious SQL code in a web request. This is known as SQL injection. • Strings that appear in the request, for example, values that appear in the User-Agent header or text strings that appear in the query string. You can also use regular expressions (regex) to specify these strings. AWS WAF rules 46 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced
waf-dg-025	waf-dg.pdf	25	location that requests originate from. • Length of a speciﬁed part of the request, such as the query string. • SQL code that is likely to be malicious. Attackers try to extract data from your database by embedding malicious SQL code in a web request. This is known as SQL injection. • Strings that appear in the request, for example, values that appear in the User-Agent header or text strings that appear in the query string. You can also use regular expressions (regex) to specify these strings. AWS WAF rules 46 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Labels that prior rules in the web ACL have added to the request. In addition to statements with web request inspection criteria, like the ones in the preceding list, AWS WAF supports logical statements for AND, OR, and NOT that you use to combine statements in a rule. For example, based on recent requests that you've seen from an attacker, you might create a rule with a logical AND statement that combines the following nested statements: • The requests come from 192.0.2.44. • They contain the value BadBot in the User-Agent header. • They appear to include SQL-like code in the query string. In this case, the web request needs to match all of the statements to result in a match for the top- level AND. Topics • Using rule actions in AWS WAF • Using rule statements in AWS WAF • Using match rule statements in AWS WAF • Using logical rule statements in AWS WAF • Using rate-based rule statements in AWS WAF • Using rule group rule statements in AWS WAF Using rule actions in AWS WAF This section explains how rule actions work. The rule action tells AWS WAF what to do with a web request when it matches the criteria deﬁned in the rule. You can optionally add custom behavior to each rule action. Using rule actions 47 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note Rule actions can be terminating or non-terminating. A terminating action stops the web ACL evaluation of the request and either lets it continue to your protected application or blocks it. Here are the rule action options: • Allow – AWS WAF allows the request to be forwarded to the protected AWS resource for processing and response. This is a terminating action. In rules that you deﬁne, you can insert custom headers into the request before forwarding it to the protected resource. • Block – AWS WAF blocks the request. This is a terminating action. By default, your protected AWS resource responds with an HTTP 403 (Forbidden) status code. In rules that you deﬁne, you can customize the response. When AWS WAF blocks a request, the Block action settings determine the response that the protected resource sends back to the client. • Count – AWS WAF counts the request but does not determine whether to allow it or block it. This is a non-terminating action. AWS WAF continues processing the remaining rules in the web ACL. In rules that you deﬁne, you can insert custom headers into the request and you can add labels that other rules can match against. • CAPTCHA and Challenge – AWS WAF uses CAPTCHA puzzles and silent challenges to verify that the request is not coming from a bot, and AWS WAF uses tokens to track recent successful client responses. CAPTCHA puzzles and silent challenges can only run when browsers are accessing HTTPS endpoints. Browser clients must be running in secure contexts in order to acquire tokens. Note You are charged additional fees when you use the CAPTCHA or Challenge rule action in one of your rules or as a rule action override in a rule group. For more information, see AWS WAF Pricing. These rule actions can be terminating or non-terminating, depending on the state of the token in the request: Using rule actions 48 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Non-terminating for valid, unexpired token – If the token is valid and unexpired according to the conﬁgured CAPTCHA or challenge immunity time, AWS WAF handles the request similar to the Count action. AWS WAF continues to inspect the web request based on the remaining rules in the web ACL. Similar to the Count conﬁguration, in rules that you deﬁne, you can optionally conﬁgure these actions with custom headers to insert into the request, and you can add labels that other rules can match against. • Terminating with blocked request for invalid or expired token – If the token is invalid or the indicated timestamp is expired, AWS WAF terminates the inspection of the web request and blocks the request, similar to the Block action. AWS WAF then responds to the
waf-dg-026	waf-dg.pdf	26	Count action. AWS WAF continues to inspect the web request based on the remaining rules in the web ACL. Similar to the Count conﬁguration, in rules that you deﬁne, you can optionally conﬁgure these actions with custom headers to insert into the request, and you can add labels that other rules can match against. • Terminating with blocked request for invalid or expired token – If the token is invalid or the indicated timestamp is expired, AWS WAF terminates the inspection of the web request and blocks the request, similar to the Block action. AWS WAF then responds to the client with a custom response code. For CAPTCHA, if the request contents indicate that the client browser can handle it, AWS WAF sends a CAPTCHA puzzle in a JavaScript interstitial, which is designed to distinguish human clients from bots. For the Challenge action, AWS WAF sends a JavaScript interstitial with a silent challenge that is designed to distinguish normal browsers from sessions that are being run by bots. For additional information, see CAPTCHA and Challenge in AWS WAF. For information about customizing requests and responses, see Customized web requests and responses in AWS WAF. For information about adding labels to matching requests, see Web request labeling in AWS WAF. For information about how web ACL and rule settings interact, see Using web ACLs with rules and rule groups in AWS WAF. Using rule statements in AWS WAF This section explains how rule statements work. Rule statements are the part of a rule that tells AWS WAF how to inspect a web request. When AWS WAF ﬁnds the inspection criteria in a web request, we say that the web request matches the statement. Every rule statement speciﬁes what to look for and how, according to the statement type. Every rule in AWS WAF has a single top-level rule statement, which can contain other statements. Rule statements can be very simple. For example, you could have a statement that provides a set of originating countries to inspect your web requests for or you could have a rule statement in a web ACL that just references a rule group. Rule statements can also be very complex. For example, Using rule statements 49 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide you could have a statement that combines many other statements with logical AND, OR, and NOT statements. For most rules, you can add custom AWS WAF labeling to matching requests. The rules in the AWS Managed Rules rule groups add labels to matching requests. The labels that a rule adds provide information about the request to rules that are evaluated later in the web ACL and also in AWS WAF logs and metrics. For information about labeling, see Web request labeling in AWS WAF and Label match rule statement. Nesting rule statements AWS WAF supports nesting for many rule statements, but not for all. For example, you can't nest a rule group statement inside of another statement. You need to use nesting for some scenarios, such as scope-down statements and logical statements. The rule statement lists and rule details that follow describe the nesting capabilities and requirements for each category and rule. The visual editor for rules in the console supports only one level of nesting for rule statements. For example, you can nest many types of statements inside a logical AND or OR rule, but you can't nest another AND or OR rule, because that requires a second level of nesting. To implement multiple levels of nesting, provide the rule deﬁnition in JSON, either through the JSON rule editor in the console or through the APIs. Topics • Adjusting rule statement settings in AWS WAF • Using scope-down statements in AWS WAF • Referencing reusable entities in AWS WAF Adjusting rule statement settings in AWS WAF This section describes the settings that you can specify in rule statements that inspect a component of the web request. For information on usage, see the individual rule statements at Using match rule statements in AWS WAF. A subset of these web request components can also be used in rate-based rules, as custom request aggregation keys. For information, see Aggregating rate-based rules in AWS WAF. For the request component settings, you specify the component type itself, and any additional options, depending on the component type. For example, when you inspect a component type that contains text, you can apply text transformations to it before inspecting it. Using rule statements 50 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note Unless otherwise noted, if a web request doesn't have the request component that's speciﬁed in the rule statement, AWS WAF evaluates the request as not matching the rule criteria. Contents • Request components in AWS WAF • HTTP method • Single
waf-dg-027	waf-dg.pdf	27	AWS WAF. For the request component settings, you specify the component type itself, and any additional options, depending on the component type. For example, when you inspect a component type that contains text, you can apply text transformations to it before inspecting it. Using rule statements 50 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note Unless otherwise noted, if a web request doesn't have the request component that's speciﬁed in the rule statement, AWS WAF evaluates the request as not matching the rule criteria. Contents • Request components in AWS WAF • HTTP method • Single header • All headers • Header order • Cookies • URI fragment • URI path • JA3 ﬁngerprint • JA4 ﬁngerprint • Query string • Single query parameter • All query parameters • Body • JSON body • Using forwarded IP addresses in AWS WAF • Inspecting HTTP/2 pseudo headers in AWS WAF • Using text transformations in AWS WAF Request components in AWS WAF This section describes the components of the web request that you can specify for inspection. You specify the request component for match rule statements that look for patterns inside the web request. These types of statements include string match, regex match, size constraint, and SQL Using rule statements 51 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide injection attack statements. For information on how to use these request component settings, see the individual rule statements at Using match rule statements in AWS WAF Unless otherwise noted, if a web request doesn't have the request component that's speciﬁed in the rule statement, AWS WAF evaluates the request as not matching the rule criteria. Note You specify a single request component for each rule statement that requires it. To inspect more than one component of a request, create a rule statement for each component. The AWS WAF console and API documentation provide guidance for the request component settings in the following locations: • Rule builder on the console – In the Statement settings for a regular rule type, choose the component that you want to inspect in the Inspect dialogue under Request components. • API statement contents – FieldToMatch The rest of this section describes the options for the part of the web request to inspect. Topics • HTTP method • Single header • All headers • Header order • Cookies • URI fragment • URI path • JA3 ﬁngerprint • JA4 ﬁngerprint • Query string • Single query parameter • All query parameters Using rule statements 52 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Body • JSON body HTTP method Inspects the HTTP method for the request. The HTTP method indicates the type of operation that the web request is asking your protected resource to perform, such as POST or GET. Single header Inspects a single named header in the request. For this option, you specify the header name, for example, User-Agent or Referer. The string match for the name is not case sensitive. All headers Inspects all of the request headers, including cookies. You can apply a ﬁlter to inspect a subset of all headers. For this option, you provide the following speciﬁcations: • Match patterns – The ﬁlter to use to obtain a subset of headers for inspection. AWS WAF looks for these patterns in the headers keys. The match patterns setting can be one of the following: • All – Match all keys. Evaluate the rule inspection criteria for all headers. • Excluded headers – Inspect only the headers whose keys don't match any of the strings that you specify here. The string match for a key is not case sensitive. • Included headers – Inspect only the headers that have a key that matches one of the strings that you specify here. The string match for a key is not case sensitive. • Match scope – The parts of the headers that AWS WAF should inspect with the rule inspection criteria. You can specify Keys, Values, or All to inspect both keys and values for a match. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. Using rule statements 53 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Oversize handling – How AWS WAF should handle requests that have header data that is larger than AWS WAF can inspect. AWS WAF can inspect at most the ﬁrst 8 KB (8,192 bytes)
waf-dg-028	waf-dg.pdf	28	found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. Using rule statements 53 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Oversize handling – How AWS WAF should handle requests that have header data that is larger than AWS WAF can inspect. AWS WAF can inspect at most the ﬁrst 8 KB (8,192 bytes) of the request headers and at most the ﬁrst 200 headers. The content is available for inspection by AWS WAF up to the ﬁrst limit reached. You can choose to continue the inspection, or to skip inspection and mark the request as matching or not matching the rule. For more information about handling oversize content, see Oversize web request components in AWS WAF. Header order Inspect a string containing the list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and then uses that as the ﬁeld to match component in its inspection. AWS WAF separates the header names in the string with colons and with no added spaces, for example host:user- agent:accept:authorization:referer. For this option, you provide the following speciﬁcations: • Oversize handling – How AWS WAF should handle requests that have header data that is more numerous or larger than AWS WAF can inspect. AWS WAF can inspect at most the ﬁrst 8 KB (8,192 bytes) of the request headers and at most the ﬁrst 200 headers. The content is available for inspection by AWS WAF up to the ﬁrst limit reached. You can choose to continue inspecting the headers that are available, or to skip inspection and mark the request as matching or not matching the rule. For more information about handling oversize content, see Oversize web request components in AWS WAF. Cookies Inspects all of the request cookies. You can apply a ﬁlter to inspect a subset of all cookies. For this option, you provide the following speciﬁcations: • Match patterns – The ﬁlter to use to obtain a subset of cookies for inspection. AWS WAF looks for these patterns in the cookie keys. The match patterns setting can be one of the following: • All – Match all keys. Evaluate the rule inspection criteria for all cookies. • Excluded cookies – Inspect only the cookies whose keys don't match any of the strings that you specify here. The string match for a key is case sensitive and must be exact. Using rule statements 54 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Included cookies – Inspect only the cookies that have a key that matches one of the strings that you specify here. The string match for a key is case sensitive and must be exact. • Match scope – The parts of the cookies that AWS WAF should inspect with the rule inspection criteria. You can specify Keys, Values, or All for both keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. • Oversize handling – How AWS WAF should handle requests that have cookie data that is larger than AWS WAF can inspect. AWS WAF can inspect at most the ﬁrst 8 KB (8,192 bytes) of the request cookies and at most the ﬁrst 200 cookies. The content is available for inspection by AWS WAF up to the ﬁrst limit reached. You can choose to continue the inspection, or to skip inspection and mark the request as matching or not matching the rule. For more information about handling oversize content, see Oversize web request components in AWS WAF. URI fragment Note Uri Fragment inspection is available only for CloudFront distributions and Application Load Balancers. Inspects the part of a URL that follows the "#" symbol, providing additional information about the resource, for example, #section2. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. If you don't use a text transformation with this option, AWS WAF doesn't normalize the URI fragment and inspects it exactly as it receives it from the client in the request. For information about text transformations, see Using text transformations in AWS WAF. Rule statement requirements You must provide a fallback behavior for this rule statement. The fallback behavior
waf-dg-029	waf-dg.pdf	29	Fragment inspection is available only for CloudFront distributions and Application Load Balancers. Inspects the part of a URL that follows the "#" symbol, providing additional information about the resource, for example, #section2. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. If you don't use a text transformation with this option, AWS WAF doesn't normalize the URI fragment and inspects it exactly as it receives it from the client in the request. For information about text transformations, see Using text transformations in AWS WAF. Rule statement requirements You must provide a fallback behavior for this rule statement. The fallback behavior is the match status that you want AWS WAF to assign to the web request if URI is missing the fragment or associated service is not Application Load Balancer or CloudFront. If you choose to match, AWS Using rule statements 55 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide WAF treats the request as matching the rule statement and applies the rule action to the request. If you choose to not match, AWS WAF treats the request as not matching the rule statement. URI path Inspects the part of a URL that identiﬁes a resource, for example, /images/daily-ad.jpg. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. If you don't use a text transformation with this option, AWS WAF doesn't normalize the URI and inspects it exactly as it receives it from the client in the request. For information about text transformations, see Using text transformations in AWS WAF. JA3 ﬁngerprint Inspects the request's JA3 ﬁngerprint. Note JA3 ﬁngerprint inspection is available only for Amazon CloudFront distributions and Application Load Balancers. The JA3 ﬁngerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. How to get the JA3 ﬁngerprint for a client You can obtain the JA3 ﬁngerprint for a client's requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds for web ACL traﬃc. Rule statement requirements You can inspect the JA3 ﬁngerprint only inside a string match statement that's set to exactly match the string that you provide. Provide the JA3 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. For information about the string match statement, see String match rule statement. You must provide a fallback behavior for this rule statement. The fallback behavior is the match status that you want AWS WAF to assign to the web request if AWS WAF is unable to calculate Using rule statements 56 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide the JA3 ﬁngerprint. If you choose to match, AWS WAF treats the request as matching the rule statement and applies the rule action to the request. If you choose to not match, AWS WAF treats the request as not matching the rule statement. To use this match option, you must log your web ACL traﬃc. For information, see Logging AWS WAF web ACL traﬃc. JA4 ﬁngerprint Inspects the request's JA4 ﬁngerprint. Note JA4 ﬁngerprint inspection is available only for Amazon CloudFront distributions and Application Load Balancers. The JA4 ﬁngerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. JA4 ﬁngerprinting is an extension of the JA3 ﬁngerprinting that can result in fewer unique ﬁngerprints for some browsers. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. How to get the JA4 ﬁngerprint for a client You can obtain the JA4 ﬁngerprint for a client's requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds for web ACL traﬃc. Rule statement requirements You can inspect the JA4 ﬁngerprint only inside a string match statement that's set to exactly match the string that you provide. Provide the JA4 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. For information about the string match statement, see String match rule statement. You must provide a fallback behavior for this rule statement. The fallback behavior is the match status that you want AWS WAF to assign to the web request if
waf-dg-030	waf-dg.pdf	30	ﬁelds, see Log ﬁelds for web ACL traﬃc. Rule statement requirements You can inspect the JA4 ﬁngerprint only inside a string match statement that's set to exactly match the string that you provide. Provide the JA4 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. For information about the string match statement, see String match rule statement. You must provide a fallback behavior for this rule statement. The fallback behavior is the match status that you want AWS WAF to assign to the web request if AWS WAF is unable to calculate the JA4 ﬁngerprint. If you choose to match, AWS WAF treats the request as matching the rule Using rule statements 57 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide statement and applies the rule action to the request. If you choose to not match, AWS WAF treats the request as not matching the rule statement. To use this match option, you must log your web ACL traﬃc. For information, see Logging AWS WAF web ACL traﬃc. Query string Inspects the part of the URL that appears after a ? character, if any. Note For cross-site scripting match statements, we recommend that you choose All query parameters instead of Query string. Choosing All query parameters adds 10 WCUs to the base cost. Single query parameter Inspects a single query parameter that you have deﬁned as part of the query string. AWS WAF inspects the value of the parameter that you specify. For this option, you also specify a Query argument. For example, if the URL is www.xyz.com? UserName=abc&SalesRegion=seattle, you can specify UserName or SalesRegion for the query argument. The maximum length for the name of the argument is 30 characters. The name is not case sensitive, so if you specify UserName, AWS WAF matches all variations of UserName, including username and UsERName. If the query string contains more than one instance of the query argument that you've speciﬁed, AWS WAF inspects all the values for a match, using OR logic. For example, in the URL www.xyz.com?SalesRegion=boston&SalesRegion=seattle, AWS WAF evaluates the name that you've speciﬁed against boston and seattle. If either is a match, the inspection is a match. All query parameters Inspects all query parameters in the request. This is similar to the single query parameter component choice, but AWS WAF inspects the values of all arguments within the query string. For example, if the URL is www.xyz.com?UserName=abc&SalesRegion=seattle, AWS WAF triggers a match if either the value of UserName or SalesRegion match the inspection criteria. Choosing this option adds 10 WCUs to the base cost. Using rule statements 58 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Body Inspects the request body, evaluated as plain text. You can also evaluate the body as JSON using the JSON content type. The request body is the part of the request that immediately follows the request headers. It contains any additional data that is needed for the web request, for example, data from a form. • In the console, you select this under the Request option choice Body, by selecting the Content type choice Plain text. • In the API, in the rule's FieldToMatch speciﬁcation, you specify Body to inspect the request body as plain text. For Application Load Balancer and AWS AppSync, AWS WAF can inspect the ﬁrst 8 KB of the body of a request. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, by default, AWS WAF can inspect the ﬁrst 16 KB, and you can increase the limit up to 64 KB in your web ACL conﬁguration. For more information, see Managing body inspection size limits for AWS WAF. You must specify oversize handling for this component type. Oversize handling deﬁnes how AWS WAF handles requests that have body data that is larger than AWS WAF can inspect. You can choose to continue the inspection, or to skip inspection and mark the request as matching or not matching the rule. For more information about handling oversize content, see Oversize web request components in AWS WAF. You can also evaluate the body as parsed JSON. For information about this, see the section that follows. JSON body Inspects the request body, evaluated as JSON. You can also evaluate the body as plain text. The request body is the part of the request that immediately follows the request headers. It contains any additional data that is needed for the web request, for example, data from a form. • In the console, you select this under the Request option choice Body, by selecting the Content type choice JSON. • In the API, in the rule's FieldToMatch speciﬁcation, you specify JsonBody. Using rule statements 59 AWS WAF, AWS Firewall Manager, and
waf-dg-031	waf-dg.pdf	31	about this, see the section that follows. JSON body Inspects the request body, evaluated as JSON. You can also evaluate the body as plain text. The request body is the part of the request that immediately follows the request headers. It contains any additional data that is needed for the web request, for example, data from a form. • In the console, you select this under the Request option choice Body, by selecting the Content type choice JSON. • In the API, in the rule's FieldToMatch speciﬁcation, you specify JsonBody. Using rule statements 59 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For Application Load Balancer and AWS AppSync, AWS WAF can inspect the ﬁrst 8 KB of the body of a request. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, by default, AWS WAF can inspect the ﬁrst 16 KB, and you can increase the limit up to 64 KB in your web ACL conﬁguration. For more information, see Managing body inspection size limits for AWS WAF. You must specify oversize handling for this component type. Oversize handling deﬁnes how AWS WAF handles requests that have body data that is larger than AWS WAF can inspect. You can choose to continue the inspection, or to skip inspection and mark the request as matching or not matching the rule. For more information about handling oversize content, see Oversize web request components in AWS WAF. Choosing this option doubles the match statement's base cost WCUs. For example, if the match statement base cost is 5 WCUs without JSON parsing, using JSON parsing doubles the cost to 10 WCUs. For this option, you provide additional speciﬁcations, as described in the following section. How AWS WAF handles JSON body inspection When AWS WAF inspects the web request body as JSON, it performs steps to parse the body and extract the JSON elements for inspection. AWS WAF performs these steps in accordance with your conﬁguration choices. The following lists the steps that AWS WAF performs. 1. Parse the body contents – AWS WAF parses the contents of the web request body in order to extract the JSON elements for inspection. AWS WAF does its best to parse the entire contents of the body, but parsing can fail for a variety of error states in the contents. Examples include invalid characters, duplicate keys, truncation, and content whose root node isn't an object or an array. The option Body parsing fallback behavior determines what AWS WAF does if it fails to completely parse the JSON body: • None (default behavior) - AWS WAF evaluates the content only up to the point where it encountered a parsing error. • Evaluate as string - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you deﬁned for the JSON inspection to the body text string. Using rule statements 60 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Match - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • No match - Treat the web request as not matching the rule statement. Note This fallback behavior only triggers when AWS WAF encounters an error while parsing the JSON string. Parsing doesn't fully validate the JSON AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. For example, AWS WAF parses the following invalid JSON without error: • Missing comma: {"key1":"value1""key2":"value2"} • Missing colon: {"key1":"value1","key2""value2"} • Extra colons: {"key1"::"value1","key2""value2"} For cases such as these where the parsing succeeds but the result isn't completely valid JSON, the outcome of the subsequent steps in the evaluation can vary. The extraction might miss some elements, or the rule evaluation might have unexpected results. We recommend that you validate the JSON that you receive in your application and handle invalid JSON as needed. 2. Extract the JSON elements – AWS WAF identiﬁes the subset of JSON elements to inspect according to your settings: • The option JSON match scope speciﬁes the types of elements in the JSON that AWS WAF should inspect. You can specify Keys, Values, or All for both keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. • The option Content to inspect speciﬁes how to ﬁlter the element set to the subset that you want AWS WAF to inspect. Using rule statements 61 AWS
waf-dg-032	waf-dg.pdf	32	both keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. • The option Content to inspect speciﬁes how to ﬁlter the element set to the subset that you want AWS WAF to inspect. Using rule statements 61 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You must specify one of the following: • Full JSON content - Evaluate all elements. • Only included elements - Evaluate only elements whose paths match the JSON Pointer criteria that you provide. Don't use this option to indicate all paths in the JSON. Instead, use Full JSON content. For information about JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, in the console, you can provide the following: /dogs/0/name /dogs/1/name In the API or CLI, you can provide the following: "IncludedPaths": ["/dogs/0/name", "/dogs/1/name"] For example, say that the Content to inspect setting is Only included elements, and the included elements setting is /a/b. For the following example JSON body: { "a":{ "c":"d", "b":{ "e":{ "f":"g" } } } } The element sets that AWS WAF would inspect for each JSON match scope setting are listed below. Note that the key b, which is part of the included elements path, isn't evaluated. • All: e, f, and g. • Keys: e and f. Using rule statements 62 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Values: g. 3. Inspect the JSON element set – AWS WAF applies any text transformations that you've speciﬁed to the extracted JSON elements and then matches the resulting element set against the rule statement's match criteria. This is the same transformation and evaluation behavior as for other web request components. If any of the extracted JSON elements match, the web request is a match for the rule. Using forwarded IP addresses in AWS WAF This section applies to rule statements that use the IP address of a web request. By default, AWS WAF uses the IP address from the web request origin. However, if a web request goes through one or more proxies or load balancers, the web request origin will contain the address of the last proxy, and not the originating address of the client. In this case, the originating client address is usually forwarded in another HTTP header. This header is typically X-Forwarded-For (XFF), but it can be a diﬀerent one. Rule statements that use IP addresses The rule statements that use IP addresses are the following: • IP set match - Inspects the IP address for a match with the addresses that are deﬁned in an IP set. • Geographic match - Uses the IP address to determine country and region of origin and matches the country of origin against a list of countries. • Using rate-based rule statements - Can aggregate requests by their IP addresses to ensure that no individual IP address sends requests at too high a rate. You can use IP address aggregation by itself or in combination with other aggregation keys. You can instruct AWS WAF to use a forwarded IP address for any of these rule statements, either from the X-Forwarded-For header or from another HTTP header, instead of using the web request's origin. For details on how to provide the speciﬁcations, see the guidance for the individual rule statement types. Using rule statements 63 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note If the header that you specify isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. Fallback behavior When you use the forwarded IP address, you indicate the match status for AWS WAF to assign to the web request if the request doesn't have a valid IP address in the speciﬁed position: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO MATCH - Treat the web request as not matching the rule statement. IP addresses used in AWS WAF Bot Control The Bot Control managed rule group veriﬁes bots using the IP addresses from AWS WAF. If you use Bot Control and you have veriﬁed bots that route through a proxy or load balancer, you need to explicitly allow them using a custom rule. For example, you can conﬁgure a custom IP set match rule that uses forwarded IP addresses to detect and allow your
waf-dg-033	waf-dg.pdf	33	as matching the rule statement. AWS WAF applies the rule action to the request. • NO MATCH - Treat the web request as not matching the rule statement. IP addresses used in AWS WAF Bot Control The Bot Control managed rule group veriﬁes bots using the IP addresses from AWS WAF. If you use Bot Control and you have veriﬁed bots that route through a proxy or load balancer, you need to explicitly allow them using a custom rule. For example, you can conﬁgure a custom IP set match rule that uses forwarded IP addresses to detect and allow your veriﬁed bots. You can use the rule to customize your bot management in a number of ways. For information and examples, see AWS WAF Bot Control. General considerations for using forwarded IP addresses Before you use a forwarded IP address, note the following general caveats: • A header can be modiﬁed by proxies along the way, and the proxies might handle the header in diﬀerent ways. • Attackers might alter the contents of the header in an attempt to bypass AWS WAF inspections. • The IP address inside the header can be malformed or invalid. • The header that you specify might not be present at all in a request. Considerations for using forwarded IP addresses with AWS WAF The following list describes requirements and caveats for using forwarded IP addresses in AWS WAF: Using rule statements 64 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • For any single rule, you can specify one header for the forwarded IP address. The header speciﬁcation is case insensitive. • For rate-based rule statements, any nested scoping statements do not inherit the forwarded IP conﬁguration. Specify the conﬁguration for each statement that uses a forwarded IP address. • For geo match and rate-based rules, AWS WAF uses the ﬁrst address in the header. For example, if a header contains 10.1.1.1, 127.0.0.0, 10.10.10.10 AWS WAF uses 10.1.1.1 • For IP set match, you indicate whether to match against the ﬁrst, last, or any address in the header. If you specify any, AWS WAF inspects all addresses in the header for a match, up to 10 addresses. If the header contains more than 10 addresses, AWS WAF inspects the last 10. • Headers that contain multiple addresses must use a comma separator between the addresses. If a request uses a separator other than a comma, AWS WAF considers the IP addresses in the header malformed. • If the IP addresses inside the header are malformed or invalid, AWS WAF designates the web request as matching the rule or not matching, according to the fallback behavior that you specify in the forwarded IP conﬁguration. • If the header that you specify isn’t present in a request, AWS WAF doesn’t apply the rule to the request at all. This means that AWS WAF doesn't apply the rule action and doesn't apply the fallback behavior. • A rule statement that uses a forwarded IP header for the IP address won’t use the IP address that’s reported by the web request origin. Best practices for using forwarded IP addresses with AWS WAF When you use forwarded IP addresses, use the following best practices: • Carefully consider all possible states of your request headers before enabling forwarded IP conﬁguration. You might need to use more than one rule to get the behavior you want. • To inspect multiple forwarded IP headers or to inspect the web request origin and a forwarded IP header, use one rule for each IP address source. • To block web requests that have an invalid header, set the rule action to block and set the fallback behavior for the forwarded IP conﬁguration to match. Example JSON for forwarded IP addresses Using rule statements 65 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The following geo match statement matches only if the X-Forwarded-For header contains an IP whose country of origin is US: { "Name": "XFFTestGeo", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "XFFTestGeo" }, "Statement": { "GeoMatchStatement": { "CountryCodes": [ "US" ], "ForwardedIPConfig": { "HeaderName": "x-forwarded-for", "FallbackBehavior": "MATCH" } } } } The following rate-based rule aggregates requests based on the ﬁrst IP in the X-Forwarded-For header. The rule counts only requests that match the nested geo match statement, and it only blocks requests that match the geo match statement. The nested geo match statement also uses the X-Forwarded-For header to determine whether the IP address indicates a country of origin of US. If it does, or if the header is present but malformed, the geo match statement returns a match. { "Name": "XFFTestRateGeo", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, Using rule statements 66 AWS WAF,
waf-dg-034	waf-dg.pdf	34	} The following rate-based rule aggregates requests based on the ﬁrst IP in the X-Forwarded-For header. The rule counts only requests that match the nested geo match statement, and it only blocks requests that match the geo match statement. The nested geo match statement also uses the X-Forwarded-For header to determine whether the IP address indicates a country of origin of US. If it does, or if the header is present but malformed, the geo match statement returns a match. { "Name": "XFFTestRateGeo", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, Using rule statements 66 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "CloudWatchMetricsEnabled": true, "MetricName": "XFFTestRateGeo" }, "Statement": { "RateBasedStatement": { "Limit": "100", "AggregateKeyType": "FORWARDED_IP", "ScopeDownStatement": { "GeoMatchStatement": { "CountryCodes": [ "US" ], "ForwardedIPConfig": { "HeaderName": "x-forwarded-for", "FallbackBehavior": "MATCH" } } }, "ForwardedIPConfig": { "HeaderName": "x-forwarded-for", "FallbackBehavior": "MATCH" } } } } Inspecting HTTP/2 pseudo headers in AWS WAF This section explains how you can use AWS WAF to inspect HTTP/2 pseudo headers. Protected AWS resources that support HTTP/2 traﬃc do not forward HTTP/2 pseudo headers to AWS WAF for inspection, but they provide contents of pseudo headers in web request components that AWS WAF inspects. You can use AWS WAF to inspect only the pseudo headers that are listed in the following table. HTTP/2 pseudo header contents mapped to web request components HTTP/2 pseudo header Web request component to inspect Documentation :method HTTP method HTTP method Using rule statements 67 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide HTTP/2 pseudo header Web request component to inspect Documentation :authority Host header Single header :path URI path URI path All headers URI path :path query Query string Query string Single query parameter All query parameters Using text transformations in AWS WAF This section explains how to provide transformations for AWS WAF to apply before inspecting the request. In statements that look for patterns or set constraints, you can provide transformations for AWS WAF to apply before inspecting the request. A transformation reformats a web request to eliminate some of the unusual formatting that attackers use in an eﬀort to bypass AWS WAF. When you use this with the JSON body request component selection, AWS WAF applies your transformations after parsing and extracting the elements to inspect from the JSON. For more information, see JSON body. If you provide more than one transformation, you also set the order for AWS WAF to apply them. WCUs – Each text transformation is 10 WCUs. The AWS WAF console and API documentation also provide guidance for these settings in the following locations: • Rule builder on the console – Text transformation. This option is available when you use request components. • API statement contents – TextTransformations Using rule statements 68 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Options for text transformations Each transformation listing shows the console and API speciﬁcations followed by the description. Base64 decode – BASE64_DECODE AWS WAF decodes a Base64-encoded string. Base64 decode extension – BASE64_DECODE_EXT AWS WAF decodes a Base64-encoded string, but uses a forgiving implementation that ignores characters that aren't valid. Command line – CMD_LINE This option mitigates situations where attackers might be injecting an operating system command-line command and are using unusual formatting to disguise some or all of the command. Use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters, A-Z, to lowercase, a-z Compress whitespace – COMPRESS_WHITE_SPACE AWS WAF compresses white space by replacing multiple spaces with one space and replacing the following characters with a space character (ASCII 32): • Formfeed (ASCII 12) • Tab (ASCII 9) • Newline (ASCII 10) • Carriage return (ASCII 13) • Vertical tab (ASCII 11) • Non-breaking space (ASCII 160) CSS decode – CSS_DECODE AWS WAF decodes characters that were encoded using CSS 2.x escape rules syndata.html#characters. This function uses up to two bytes in the decoding process, so Using rule statements 69 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript. Escape sequences decode – ESCAPE_SEQ_DECODE AWS WAF decodes the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \\, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output. Hex decode – HEX_DECODE AWS WAF decodes a string of hexadecimal characters into a binary. HTML entity decode –
waf-dg-035	waf-dg.pdf	35	AWS Shield Advanced Developer Guide it can help to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example, ja\vascript for javascript. Escape sequences decode – ESCAPE_SEQ_DECODE AWS WAF decodes the following ANSI C escape sequences: \a, \b, \f, \n, \r, \t, \v, \\, \?, \', \", \xHH (hexadecimal), \0OOO (octal). Encodings that aren't valid remain in the output. Hex decode – HEX_DECODE AWS WAF decodes a string of hexadecimal characters into a binary. HTML entity decode – HTML_ENTITY_DECODE AWS WAF replaces characters that are represented in hexadecimal format &#xhhhh; or decimal format &#nnnn; with the corresponding characters. AWS WAF replaces the following HTML-encoded characters with unencoded characters. This list uses lowercase HTML encoding, but the handling is case insensitive, for example &QuOt; and " are treated the same. HTML-encoded character replaced with... " & < > " & < >   or &NonBreakingSpace; non-breaking space, decimal 160 &NewLine; &Tab; { or { \|, \|, or &VerticalLine; } or } \n, decimal 10 \t, decimal 9 { \| } Using rule statements 70 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide HTML-encoded character replaced with... &excl; &num; &dollar; &percent; or &percnt; ' ( ) &ast; or &midast; + , &period; / &colon; &semi; = &quest; &tilde; or &DiacriticalTilde; − [ or [ ! # $ % \ ( ) * + , . / : ; = ? ~ - [ \ \\ Using rule statements 71 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide HTML-encoded character replaced with... ] or ] &hat; &lowbar; or &underbar; &grave; or &DiacriticalGrave; ] ^ _ ` JS decode – JS_DECODE AWS WAF decodes JavaScript escape sequences. If a \uHHHH code is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss of information. Lowercase – LOWERCASE AWS WAF converts uppercase letters (A-Z) to lowercase (a-z). MD5 – MD5 AWS WAF calculates an MD5 hash from the data in the input. The computed hash is in a raw binary form. None – NONE AWS WAF inspects the web request as received, without any text transformations. Normalize path – NORMALIZE_PATH AWS WAF normalizes the input string by removing multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input. Normalize path Windows – NORMALIZE_PATH_WIN AWS WAF converts backslash characters to forward slashes and then processes the resulting string using the NORMALIZE_PATH transformation. Remove nulls – REMOVE_NULLS AWS WAF removes all NULL bytes from the input. Using rule statements 72 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Replace comments – REPLACE_COMMENTS AWS WAF replaces each occurrence of a C-style comment (/* ... /) with a single space. It doesn't compress multiple consecutive occurrences. It replaces unterminated comments with a space (ASCII 0x20). It doesn't change a standalone termination of a comment (/). Replace nulls – REPLACE_NULLS AWS WAF replaces each NULL byte in the input with the space character (ASCII 0x20). SQL hex decode – SQL_HEX_DECODE AWS WAF decodes SQL hex data. For example, AWS WAF decodes (0x414243) to (ABC). URL decode – URL_DECODE AWS WAF decodes a URL-encoded value. URL decode Unicode – URL_DECODE_UNI Like URL_DECODE, but with support for Microsoft-speciﬁc %u encoding. If the code is in the full- width ASCII code range of FF01-FF5E, the higher byte is used to detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed. UTF8 to Unicode – UTF8_TO_UNICODE AWS WAF converts all UTF-8 character sequences to Unicode. This helps normalize input and it minimizes false-positives and false-negatives for non-English languages. Using scope-down statements in AWS WAF This section explains what a scope-down statement and how it works. A scope-down statement is a nestable rule statement that you add inside a managed rule group statement or a rate-based statement to narrow the set of requests that the containing rule evaluates. The containing rule only evaluates the requests that ﬁrst match the scope-down statement. • Managed rule group statement – If you add a scope-down statement to a managed rule group statement, AWS WAF evaluates any request that doesn't match the scope-down statement as not matching the rule group. Only those requests that match the scope-down statement are evaluated against the rule group. For managed rule groups with pricing that's based on the number of requests evaluated, scope-down statements can help contain costs. Using rule statements 73 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For more information about managed
waf-dg-036	waf-dg.pdf	36	rule only evaluates the requests that ﬁrst match the scope-down statement. • Managed rule group statement – If you add a scope-down statement to a managed rule group statement, AWS WAF evaluates any request that doesn't match the scope-down statement as not matching the rule group. Only those requests that match the scope-down statement are evaluated against the rule group. For managed rule groups with pricing that's based on the number of requests evaluated, scope-down statements can help contain costs. Using rule statements 73 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For more information about managed rule group statements, see Using managed rule group statements in AWS WAF. • Rate-based rule statement – A rate-based rule statement without a scope-down statement rate limits all requests that the rule evaluates. If you want to only control the rate for a speciﬁc category of requests, add a scope-down statement to the rate-based rule. For example, to only track and control the rate of requests from a speciﬁc geographical area, you can specify that geographical area in a geographic match statement and add it to your rate-based rule as the scope-down statement. For more information about rate-based rule statements, see Using rate-based rule statements in AWS WAF. You can use any nestable rule in a scope-down statement. For the available statements, see Using match rule statements in AWS WAF and Using logical rule statements in AWS WAF. The WCUs for a scope-down statement are the WCUs required for the rule statement that you deﬁne in it. There's no additional cost for the use of a scope-down statement. You can conﬁgure a scope-down statement in the same way as you do when you use the statement in a regular rule. For example, you can apply text transformations to a web request component that you're inspecting and you can specify a forwarded IP address to use as the IP address. These conﬁgurations apply only to the scope-down statement and are not inherited by the containing managed rule group or rate-based rule statement. For example, if you apply text transformations to a query string in your scope-down statement, the scope-down statement inspects the query string after applying the transformations. If the request matches the scope-down statement criteria, AWS WAF then passes the web request to the containing rule in its original state, without the scope-down statement's transformations. The rule that contains the scope-down statement might apply text transformations of its own, but it doesn't inherit any from the scope-down statement. You can't use a scope-down statement to specify any request inspection conﬁguration for the containing rule statement. You can't use a scope-down statement as a web request preprocessor for the containing rule statement. The only role of a scope-down statement is to determine which requests are passed to the containing rule statement for inspection. Referencing reusable entities in AWS WAF This section explains how reusable entities work in AWS WAF. Using rule statements 74 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Some rules use entities that are reusable and that are managed outside of your web ACLs, either by you, AWS, or an AWS Marketplace seller. When the reusable entity is updated, AWS WAF propagates the update to your rule. For example, if you use an AWS Managed Rules rule group in a web ACL, when AWS updates the rule group, AWS propagates the change to your web ACL, to update its behavior. If you use an IP set statement in a rule, when you update the set, AWS WAF propagates the change to all rules that reference it, so any web ACLs that use those rules are kept up-to-date with your changes. The following are the reusable entities that you can use in a rule statement. • IP sets – You create and manage your own IP sets. On the console, you can access these from the navigation pane. For information about managing IP sets, see IP sets and regex pattern sets in AWS WAF. • Regex match sets – You create and manage your own regex match sets. On the console, you can access these from the navigation pane. For information about managing regex pattern sets, see IP sets and regex pattern sets in AWS WAF. • AWS Managed Rules rule groups – AWS manages these rule groups. On the console, these are available for your use when you add a managed rule group to your web ACL. For more information about these, see AWS Managed Rules rule groups list. • AWS Marketplace managed rule groups – AWS Marketplace sellers manage these rule groups and you can subscribe to them to use them. To manage your subscriptions, on the navigation pane of the console, choose AWS Marketplace. The AWS Marketplace managed rule groups are listed when
waf-dg-037	waf-dg.pdf	37	see IP sets and regex pattern sets in AWS WAF. • AWS Managed Rules rule groups – AWS manages these rule groups. On the console, these are available for your use when you add a managed rule group to your web ACL. For more information about these, see AWS Managed Rules rule groups list. • AWS Marketplace managed rule groups – AWS Marketplace sellers manage these rule groups and you can subscribe to them to use them. To manage your subscriptions, on the navigation pane of the console, choose AWS Marketplace. The AWS Marketplace managed rule groups are listed when you add a managed rule group to your web ACL. For rule groups that you haven't yet subscribed to, you can ﬁnd a link to AWS Marketplace on that page as well. For more information about AWS Marketplace seller managed rule groups, see AWS Marketplace rule groups. • Your own rule groups – You manage your own rule groups, usually when you need some behavior that isn't available through the managed rule groups. On the console, you can access these from the navigation pane. For more information, see Managing your own rule groups. Deleting a referenced set or rule group When you delete a referenced entity, AWS WAF checks to see if it's currently being used in a web ACL. If AWS WAF ﬁnds that it's in use, it warns you. AWS WAF is almost always able to determine if an entity is being referenced by a web ACL. However, in rare cases, it might not be able to do so. If you need to be sure that the entity that you want to delete isn't in use, check for it in your web ACLs before deleting it. Using rule statements 75 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Using match rule statements in AWS WAF This section explains what a match statement is and how it works. Match statements compare the web request or its origin against criteria that you provide. For many statements of this type, AWS WAF compares a speciﬁc component of the request for matching content. Match statements are nestable. You can nest any of these statements inside logical rule statements and you can use them in scope-down statements. For information about logical rule statements, see Using logical rule statements in AWS WAF. For information about scope-down statements, see Using scope-down statements in AWS WAF. This table describes the regular match statements that you can add to a rule and provides some guidelines for calculating web ACL capacity units (WCU) usage for each. For information about WCUs, see Web ACL capacity units (WCUs) in AWS WAF. Match Statement Description WCUs Geographic match Inspects the request's country of origin and applies labels 1 for the country and region of origin. IP set match Inspects the request against a set of IP addresses and 1 for most cases. If you conﬁgure the statement to address ranges. use a header with forwarded IP addresses and specify a position in the header of Any, then increase the WCUs by 4. Label match rule statement Inspects the request for labels that have been added by other rules in the same web ACL. 1 Using match rule statements 76 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Match Statement Description WCUs Regex match rule statement Compares a regex pattern against a speciﬁed request c omponent. 3, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. Regex pattern set Compares regex patterns against a speciﬁed request 25 per pattern set, as a base cost. component. Size constraint Checks size constraints against a speciﬁed request c omponent. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. 1, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. Using match rule statements 77 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Match Statement Description WCUs SQLi attack Inspects for malicious SQL code in a speciﬁed request c omponent. 20, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. String match Compares a string to a speciﬁed request component. The base
waf-dg-038	waf-dg.pdf	38	double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. Using match rule statements 77 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Match Statement Description WCUs SQLi attack Inspects for malicious SQL code in a speciﬁed request c omponent. 20, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. String match Compares a string to a speciﬁed request component. The base cost depends on the XSS scripting attack Inspects for cross-site scripting attacks in a speciﬁed request component. type of string match and is between 1 and 10. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. 40, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. Using match rule statements 78 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Geographic match rule statement This section explains what a geographic match statement is and how it works. Use geographic or geo match statements to manage web requests based on country and region of origin. A geo match statement add labels to web requests that indicate the country of origin and the region of origin. It adds these labels regardless of whether the statement criteria is a match for the request. A geo match statement also performs matching against the request's country of origin. How to use the geo match statement You can use the geo match statement for country or region matching, as follows: • Country — You can use a geo match rule by itself to manage requests based solely on their country of origin. The rule statement matches against country codes. You can also follow a geo match rule with a label match rule that matches on the country of origin label. • Region — Use a geo match rule followed by a label match rule to manage requests based on their region of origin. You can't use a geo match rule alone to match against region codes. For information about using label match rules, see Label match rule statement and Web request labeling in AWS WAF. How the geo match statement works With the geo match statement, AWS WAF manages each web request as follows: 1. Determines the request's country and region codes — AWS WAF determines the country and region of a request based on its IP address. By default, AWS WAF uses the IP address of the web request's origin. You can instruct AWS WAF to use an IP address from an alternate request header, like X-Forwarded-For, by enabling forwarded IP conﬁguration in the rule statement settings. AWS WAF determines the location of requests using MaxMind GeoIP databases. MaxMind reports very high accuracy of their data at the country level, although accuracy varies according to factors such as country and type of IP. For more information about MaxMind, see MaxMind IP Geolocation. If you think any of the GeoIP data is incorrect, you can submit a correction request to Maxmind at MaxMind Correct GeoIP2 Data. Using match rule statements 79 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS WAF uses the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. You can ﬁnd the codes at the following locations: • At the ISO website, you can search the country codes at ISO Online Browsing Platform (OBP). • On Wikipedia, the country codes are listed at ISO 3166-2. The region codes for a country are listed at the URL https://en.wikipedia.org/wiki/ ISO_3166-2:<ISO country code>. For example, the regions for the United States are at ISO 3166-2:US and for Ukraine they're at ISO 3166-2:UA. 2. Determines the country label and region label to add to the request — The labels indicate whether the geo match statement uses the origin IP or a forwarded IP conﬁguration. • Origin IP The country label is awswaf:clientip:geo:country:<ISO country code>. Example for the United States: awswaf:clientip:geo:country:US. The region label is awswaf:clientip:geo:region:<ISO country code>-<ISO region code>. Example for Oregon in the United States: awswaf:clientip:geo:region:US-OR. • Forwarded IP The country label is awswaf:forwardedip:geo:country:<ISO country code>. Example for the United States: awswaf:forwardedip:geo:country:US. The region label is awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>. Example for Oregon in the United States: awswaf:forwardedip:geo:region:US-OR. If the country or region code isn't available for a request's speciﬁed IP address, AWS WAF uses XX in the
waf-dg-039	waf-dg.pdf	39	whether the geo match statement uses the origin IP or a forwarded IP conﬁguration. • Origin IP The country label is awswaf:clientip:geo:country:<ISO country code>. Example for the United States: awswaf:clientip:geo:country:US. The region label is awswaf:clientip:geo:region:<ISO country code>-<ISO region code>. Example for Oregon in the United States: awswaf:clientip:geo:region:US-OR. • Forwarded IP The country label is awswaf:forwardedip:geo:country:<ISO country code>. Example for the United States: awswaf:forwardedip:geo:country:US. The region label is awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>. Example for Oregon in the United States: awswaf:forwardedip:geo:region:US-OR. If the country or region code isn't available for a request's speciﬁed IP address, AWS WAF uses XX in the labels, in the place of the value. For example, the following label is for a client IP whose country code isn't available: awswaf:clientip:geo:country:XX and the following is for a forwarded IP whose country is the United States, but whose region code isn't available: awswaf:forwardedip:geo:region:US-XX. 3. Evaluates the request's country code against the rule criteria The geo match statement adds country and region labels to all requests that it inspects, regardless of whether it ﬁnds a match. Using match rule statements 80 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note AWS WAF adds any labels at the end of a rule's web request evaluation. Because of this, any label matching that you use against the labels from a geo match statement must be deﬁned in a separate rule from the rule that contains the geo match statement. If you want to inspect only region values, you can write a geo match rule with Count action and with a single country code match, followed by a label match rule for the region labels. You are required to supply a country code for the geo match rule to evaluate, even for this approach. You can reduce logging and count metrics by specifying a country that's very unlikely to be a source of traﬃc to your site. CloudFront distributions and the CloudFront geo restriction feature For CloudFront distributions, if you use the CloudFront geo restriction feature, be aware that the feature doesn't forward blocked requests to AWS WAF. It does forward allowed requests to AWS WAF. If you want to block requests based on the geography plus other criteria that you can specify in AWS WAF, use the AWS WAF geo match statement and don't use the CloudFront geo restriction feature. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 1 WCU. Settings – This statement uses the following settings: • Country codes – An array of country codes to compare for a geo match. These must be two- character country codes from the alpha-2 country ISO codes of the ISO 3166 international standard, for example, ["US","CN"]. • (Optional) Forwarded IP conﬁguration – By default, AWS WAF uses the IP address in the web request origin to determine country of origin. Alternatively, you can conﬁgure the rule to use a forwarded IP in an HTTP header like X-Forwarded-For instead. AWS WAF uses the ﬁrst IP address in the header. With this conﬁguration, you also specify a fallback behavior to apply to a web request with a malformed IP address in the header. The fallback behavior sets the matching result for the request, to match or no match. For more information, see Using forwarded IP addresses. Using match rule statements 81 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Where to ﬁnd this rule statement • Rule builder on the console – For Request option, choose Originates from a country in. • API – GeoMatchStatement Examples You can use the geo match statement to manage requests from speciﬁc countries or regions. For example, if you want to block requests from certain countries, but still allow requests from a speciﬁc set of IP addresses in those countries, you could create a rule with the action set to Block and the following nested statements, shown in pseudocode: • AND statement • Geo match statement listing the countries that you want to block • NOT statement • IP set statement that speciﬁes the IP addresses that you want to allow through Or, if you want to block some regions in certain countries, but still allow requests from other regions in those countries, you could ﬁrst deﬁne a geo match rule with the action set to Count. Then, deﬁne a label match rule that matches against the added geo match labels and handles the requests as you need. The following pseudo code describes an example of this approach: 1. Geo match statement listing the countries with regions that you want to block, but with the action set to Count. This labels every web request regardless of match status, and it also gives you count metrics for the countries of interest. 2. AND statement with Block action • Label
waf-dg-040	waf-dg.pdf	40	other regions in those countries, you could ﬁrst deﬁne a geo match rule with the action set to Count. Then, deﬁne a label match rule that matches against the added geo match labels and handles the requests as you need. The following pseudo code describes an example of this approach: 1. Geo match statement listing the countries with regions that you want to block, but with the action set to Count. This labels every web request regardless of match status, and it also gives you count metrics for the countries of interest. 2. AND statement with Block action • Label match statement that speciﬁes the labels for the countries that you want to block • NOT statement • Label match statement that speciﬁes the labels of the regions in those countries that you want to allow through The following JSON listing shows an implementation of the two rules described in the prior pseudocode. These rules block all traﬃc from the United States except for traﬃc from Oregon and Washington. The geo match statement adds country and region labels to all requests that it Using match rule statements 82 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide inspects. The label match rule runs after the geo match rule, so it can match against the country and region labels that the geo match rule has just added. The geo match statement uses a forwarded IP address, so the label matching also speciﬁes forwarded IP labels. { "Name": "geoMatchForLabels", "Priority": 10, "Statement": { "GeoMatchStatement": { "CountryCodes": [ "US" ], "ForwardedIPConfig": { "HeaderName": "X-Forwarded-For", "FallbackBehavior": "MATCH" } } }, "Action": { "Count": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "geoMatchForLabels" } }, { "Name": "blockUSButNotOROrWA", "Priority": 11, "Statement": { "AndStatement": { "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:forwardedip:geo:country:US" } }, { "NotStatement": { "Statement": { "OrStatement": { Using match rule statements 83 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:forwardedip:geo:region:US-OR" } }, { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:forwardedip:geo:region:US-WA" } } ] } } } } ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "blockUSButNotOROrWA" } } As another example, you can combine geo matching with rate-based rules to prioritize resources for users in a particular country or region. You create a diﬀerent rate-based statement for each geo match or label match statement that you use to diﬀerentiate your users. Set a higher rate limit for users in the preferred country or region and set a lower rate limit for other users. The following JSON listing shows a geo match rule followed by rate-based rules that limit the rate of traﬃc from the United States. The rules allow traﬃc from Oregon to come in at a higher rate than traﬃc from anywhere else in the country. { "Name": "geoMatchForLabels", "Priority": 190, Using match rule statements 84 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Statement": { "GeoMatchStatement": { "CountryCodes": [ "US" ] } }, "Action": { "Count": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "geoMatchForLabels" } }, { "Name": "rateLimitOregon", "Priority": 195, "Statement": { "RateBasedStatement": { "Limit": 3000, "AggregateKeyType": "IP", "ScopeDownStatement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:clientip:geo:region:US-OR" } } } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "rateLimitOregon" } }, { "Name": "rateLimitUSNotOR", "Priority": 200, "Statement": { Using match rule statements 85 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "RateBasedStatement": { "Limit": 100, "AggregateKeyType": "IP", "ScopeDownStatement": { "AndStatement": { "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:clientip:geo:country:US" } }, { "NotStatement": { "Statement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:clientip:geo:region:US-OR" } } } } ] } } } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "rateLimitUSNotOR" } } IP set match rule statement This section explains what an IP set match statement is and how it works. The IP set match statement inspects the IP address of a web request against a set of IP addresses and address ranges. Use this to allow or block web requests based on the IP addresses that the Using match rule statements 86 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide requests originate from. By default, AWS WAF uses the IP address from the web request origin, but you can conﬁgure the rule to use an HTTP header like X-Forwarded-For instead. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. An IP set can hold up to 10,000 IP addresses or IP address ranges to check. Note Each IP set match rule references an IP set, which you create and
waf-dg-041	waf-dg.pdf	41	match rule statements 86 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide requests originate from. By default, AWS WAF uses the IP address from the web request origin, but you can conﬁgure the rule to use an HTTP header like X-Forwarded-For instead. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. An IP set can hold up to 10,000 IP addresses or IP address ranges to check. Note Each IP set match rule references an IP set, which you create and maintain independent of your rules. You can use a single IP set in multiple rules, and when you update the referenced set, AWS WAF automatically updates all rules that reference it. For information about creating and managing an IP set, see Creating and managing an IP set in AWS WAF. When you add or update the rules in your rule group or web ACL, choose the option IP set and select the name of the IP set that you want to use. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 1 WCU for most. If you conﬁgure the statement to use forwarded IP addresses and specify a position of ANY, increase the WCU usage by 4. This statement uses the following settings: • IP set speciﬁcation – Choose the IP set that you want to use from the list or create a new one. • (Optional) Forwarded IP conﬁguration – An alternate forwarded IP header name to use in place of the request origin. You specify whether to match against the ﬁrst, last, or any address in the header. You also specify a fallback behavior to apply to a web request with a malformed IP address in the speciﬁed header. The fallback behavior sets the matching result for the request, to match or no match. For more information, see Using forwarded IP addresses. Using match rule statements 87 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Where to ﬁnd this rule statement Where to ﬁnd this rule statement • Rule builder on the console – For Request option, choose Originates from an IP address in. • Add my own rules and rule groups page on the console – Choose the IP set option. • API – IPSetReferenceStatement Label match rule statement This section explains what a label match statement is and how it works. The label match statement inspects the labels that are on the web request against a string speciﬁcation. The labels that are available to a rule for inspection are those that have already been added to the web request by other rules in the same web ACL evaluation. Labels don't persist outside of the web ACL evaluation, but you can access label metrics in CloudWatch and you can see summaries of label information for any web ACL in the AWS WAF console. For more information, see Label metrics and dimensions and Monitoring and tuning your AWS WAF protections. You can also see labels in the logs. For information, see Log ﬁelds for web ACL traﬃc. Note A label match statement can only see labels from rules that are evaluated earlier in the web ACL. For information about how AWS WAF evaluates the rules and rule groups in a web ACL, see Setting rule priority in a web ACL. For more information about adding and matching labels, see Web request labeling in AWS WAF. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 1 WCU This statement uses the following settings: Using match rule statements 88 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Match scope – Set this to Label to match against the label name and, optionally, the preceding namespaces and preﬁx. Set this to Namespace to match against some or all of the namespace speciﬁcations and, optionally, the preceding preﬁx. • Key – The string that you want to match against. If you specify a namespace match scope, this should only specify namespaces and optionally the preﬁx, with an ending colon. If you specify a label match scope, this must include the label name and can optionally include preceding namespaces and preﬁx. For more information about these settings, see AWS WAF rules that match labels and AWS WAF label match examples. Where to ﬁnd this rule statement • Rule builder on the console – For Request option, choose Has label. • API – LabelMatchStatement Regex match rule statement This section explains what a regex match statement is and how it works. A regex match statement instructs AWS WAF to match a request component against a single regular expression (regex). A web request matches the statement if the request component
waf-dg-042	waf-dg.pdf	42	must include the label name and can optionally include preceding namespaces and preﬁx. For more information about these settings, see AWS WAF rules that match labels and AWS WAF label match examples. Where to ﬁnd this rule statement • Rule builder on the console – For Request option, choose Has label. • API – LabelMatchStatement Regex match rule statement This section explains what a regex match statement is and how it works. A regex match statement instructs AWS WAF to match a request component against a single regular expression (regex). A web request matches the statement if the request component matches the regex that you specify. This statement type is a good alternative to the Regex pattern set match rule statement for situations where you want to combine your matching criteria using mathematical logic. For example, if you want a request component to match against some regex patterns and to not match against others, you can combine the regex match statements using the AND rule statement and the NOT rule statement. 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. Rule statement characteristics Nestable – You can nest this statement type. Using match rule statements 89 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide WCUs – 3 WCUs, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose Matches regular expression. • API – RegexMatchStatement Regex pattern set match rule statement This section explains what a regex pattern set match statement is and how it works. The regex pattern set match inspects the part of the web request that you specify for the regular expression patterns that you've speciﬁed inside a regex pattern set. Using match rule statements 90 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 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. Note Each regex pattern set match rule references a regex pattern set, which you create and maintain independent of your rules. You can use a single regex pattern set in multiple rules, and when you update the referenced set, AWS WAF automatically updates all rules that reference it. For information about creating and managing a regex pattern set, see Creating and managing a regex pattern set in AWS WAF. A regex pattern set match statement instructs AWS WAF to search for any of the patterns in the set inside the request component that you choose. A web request will match the pattern set rule statement if the request component matches any of the patterns in the set. If you want to combine your regex pattern matches using logic, for example to match against some regular expressions and not match against others, consider using Regex match rule statement. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 25 WCUs, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Using match rule statements 91 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer
waf-dg-043	waf-dg.pdf	43	You can nest this statement type. WCUs – 25 WCUs, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Using match rule statements 91 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. This statement requires the following settings: • Regex pattern set speciﬁcation – Choose the regex pattern set that you want to use from the list or create a new one. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose String match condition > Matches pattern from regular expression set. • API – RegexPatternSetReferenceStatement Size constraint rule statement This section explains what a size constraint statement is and how it works. A size constraint statement compares the number of bytes that AWS WAF receives for a web request component to a number that you provide, and matches according to your comparison criteria. Using match rule statements 92 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note This statement uses the size of the component that AWS WAF receives for inspection. For body, header, and cookie components, this size could be less than the original size that was sent to the protected resource. For more information, see Oversize web request components in AWS WAF. The comparison criteria is an operator such as greater than (>) or less than (<). For example, you can match on requests that have a query string with a size that's greater than 100 bytes. If you inspect the URI path, any / in the path counts as one character. For example, the URI path / logo.jpg is nine characters long. Note This statement only inspects the size of the web request component. It doesn't inspect the contents of the component. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 1 WCU, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. For information about web request components, see Adjusting rule statement settings in AWS WAF. A size constraint statement inspects only the size of the component after any transformations have been applied. It does not inspect the contents of the component. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting its size. For example, you could compress white space or Using match rule statements 93 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide decode HTML entities. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Additionally, this statement requires the following settings: • Size match condition – This indicates the numerical comparison operator to use to compare the size that you provide with the request component that you've chosen. Choose the operator from the list. • Size – The size setting, in bytes, to use in the comparison. Note For body, header, and cookie components, use a size less than the max size that AWS WAF can inspect. A larger number will never result in a match. For more information, see Oversize web request components in AWS WAF. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, under Size match condition, choose the condition that you want to use. • API – SizeConstraintStatement SQL injection attack rule statement This section explains what a SQL injection rule statement is and
waf-dg-044	waf-dg.pdf	44	Size – The size setting, in bytes, to use in the comparison. Note For body, header, and cookie components, use a size less than the max size that AWS WAF can inspect. A larger number will never result in a match. For more information, see Oversize web request components in AWS WAF. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, under Size match condition, choose the condition that you want to use. • API – SizeConstraintStatement SQL injection attack rule statement This section explains what a SQL injection rule statement is and how it works. An SQL injection rule statement inspects for malicious SQL code. Attackers insert malicious SQL code into web requests in order to do things like modify your database or extract data from it. Rule statement characteristics Nestable – You can nest this statement type. WCUs – The base cost depends on the sensitivity level setting for the rule statement: Low costs 20 and High costs 30. Using match rule statements 94 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Additionally, this statement requires the following setting: • Sensitivity level – This setting tunes the sensitivity of the SQL injection match criteria. The options are LOW and HIGH. The default setting is LOW. The HIGH setting detects more SQL injection attacks, and is the recommended setting. Due to the higher sensitivity, this setting generates more false positives, especially if your web requests typically contain unusual strings. During your web ACL testing and tuning, you might need to do more work to mitigate false positives. For information, see Testing and tuning your AWS WAF protections. The lower setting provides less stringent SQL injection detection, which also results in fewer false positives. LOW can be a better choice for resources that have other protections against SQL injection attacks or that have a low tolerance for false positives. Using match rule statements 95 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose Attack match condition > Contains SQL injection attacks. • API – SqliMatchStatement String match rule statement This section explains what a string match statement is and how it works. A string match statement indicates the string that you want AWS WAF to search for in a request, where in the request to search, and how. For example, you can look for a speciﬁc string at the start of any query string in the request or as an exact match for the request's User-agent header. Usually, the string consists of printable ASCII characters, but you can use any character from hexadecimal 0x00 to 0xFF (decimal 0 to 255). Rule statement characteristics Nestable – You can nest this statement type. WCUs – The base cost depends on the type of match that you use. • Exactly matches string – 2 • Starts with string – 2 • Ends with string – 2 • Contains string – 10 • Contains word – 10 If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Using match rule statements 96 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web
waf-dg-045	waf-dg.pdf	45	the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Using match rule statements 96 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Additionally, this statement requires the following settings: • String to match – This is the string that you want AWS WAF to compare to the speciﬁed request component. Usually, the string consists of printable ASCII characters, but you can use any character from hexadecimal 0x00 to 0xFF (decimal 0 to 255). • String match condition – This indicates the search type that you want AWS WAF to perform. • Exactly matches string – The string and the value of the request component are identical. • Starts with string – The string appears at the beginning of the request component. • Ends with string – The string appears at the end of the request component. • Contains string – The string appears anywhere in the request component. • Contains word – The string that you specify must appear in the request component. For this option, the string that you specify must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). One of the following must be true for the request to match: • The string exactly matches the value of the request component, such as the value of a header. • The string is at the beginning of the request component and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. Using match rule statements 97 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • The string is at the end of the request component and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. • The string is in the middle of the request component and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose String match condition, and then ﬁll in the strings that you want to match against. • API – ByteMatchStatement Cross-site scripting attack rule statement This section explains what an XSS (cross-site scripting) attack statement is and how it works. An XSS attack statement inspects for malicious scripts in a web request component. In an XSS attack, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client- site scripts into other legitimate web browsers. Rule statement characteristics Nestable – You can nest this statement type. WCUs – 40 WCUs, as a base cost. If you use the request component All query parameters, add 10 WCUs. If you use the request component JSON body, double the base cost WCUs. For each Text transformation that you apply, add 10 WCUs. This statement type operates on a web request component, and requires the following request component settings: • Request component – The part of the web request to inspect, for example, a query string or the body. Warning If you inspect the request components Body, JSON body, Headers, or Cookies, read about the limitations on how much content AWS WAF can inspect at Oversize web request components in AWS WAF. Using match rule statements 98 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose Attack match condition > Contains XSS injection attacks. • API – XssMatchStatement Using logical rule
waf-dg-046	waf-dg.pdf	46	information about web request components, see Adjusting rule statement settings in AWS WAF. • Optional text transformations – Transformations that you want AWS WAF to perform on the request component before inspecting it. For example, you could transform to lowercase or normalize white space. If you specify more than one transformation, AWS WAF processes them in the order listed. For information, see Using text transformations in AWS WAF. Where to ﬁnd this rule statement • Rule builder on the console – For Match type, choose Attack match condition > Contains XSS injection attacks. • API – XssMatchStatement Using logical rule statements in AWS WAF This section explains what a logical rule statement is and how it works. Use logical rules statements to combine other statements or negate their results. Every logical rule statement takes at least one nested statement. To logically combine or negate rule statement results, you nest the statements under logical rule statements. Logical rules statements are nestable. You can nest them inside other logical rule statements and use them in scope-down statements. For information about scope-down statements, see Using scope-down statements in AWS WAF. Note The visual editor on the console supports one level of rule statement nesting, which works for many needs. To nest more levels, edit the JSON representation of the rule on the console or use the APIs. This table describes the logical rule statements and provides guidelines for calculating web ACL capacity units (WCU) usage for each. For information about WCUs, see Web ACL capacity units (WCUs) in AWS WAF. Using logical rule statements 99 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Logical Statement Description WCUs AND logic NOT logic OR logic Combines nested statements with AND logic. Based on nested statements Negates the results of a nested statement. Based on nested statement Combines nested statements with OR logic. Based on nested statements AND rule statement The AND rule statement combines nested statements with a logical AND operation, so all nested statements must match for the AND statement to match. This requires at least two nested statements. Rule statement characteristics Nestable – You can nest this statement type. WCUs – Depends on the nested statements. Where to ﬁnd this rule statement • Rule builder on the console – For If a request, choose matches all the statements (AND), and then ﬁll in the nested statements. • API – AndStatement Examples The following listing shows the use of AND and NOT logical rule statements to eliminate false positives from the matches for an SQL injection attack statement. For this example, suppose we can write a single byte match statement to match the requests that are resulting in false positives. The AND statement matches for requests that do not match the byte match statement and that do match the SQL injection attack statement. { Using logical rule statements 100 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Name": "SQLiExcludeFalsePositives", "Priority": 0, "Statement": { "AndStatement": { "Statements": [ { "NotStatement": { "Statement": { "ByteMatchStatement": { "SearchString": "string identifying a false positive", "FieldToMatch": { "Body": { "OversizeHandling": "MATCH" } }, "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ], "PositionalConstraint": "CONTAINS" } } } }, { "SqliMatchStatement": { "FieldToMatch": { "Body": { "OversizeHandling": "MATCH" } }, "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ] } } ] } }, Using logical rule statements 101 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "SQLiExcludeFalsePositives" } } Using the console rule visual editor, you can nest a non-logical statement or a NOT statement under an OR or AND statement. The nesting of the NOT statement is shown in the prior example. Using the console rule visual editor, you can nest most nestable statements under a logical rule statement, such as the one shown in the prior example. You can't use the visual editor to nest OR or AND statements. To conﬁgure this type of nesting, you need to provide your rule statement in JSON. For example, the following JSON rule listing includes an OR statement nested inside an AND statement. { "Name": "match_rule", "Priority": 0, "Statement": { "AndStatement": { "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:category:monitoring" } }, { "NotStatement": { "Statement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:name:pingdom" } } } }, { "OrStatement": { Using logical rule statements 102 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Statements": [ { "GeoMatchStatement": { "CountryCodes": [ "JM", "JP" ] } }, { "ByteMatchStatement": { "SearchString": "JCountryString", "FieldToMatch": { "Body": {} }, "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ], "PositionalConstraint": "CONTAINS" } } ] } } ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true,
waf-dg-047	waf-dg.pdf	47	{ "AndStatement": { "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:category:monitoring" } }, { "NotStatement": { "Statement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:name:pingdom" } } } }, { "OrStatement": { Using logical rule statements 102 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Statements": [ { "GeoMatchStatement": { "CountryCodes": [ "JM", "JP" ] } }, { "ByteMatchStatement": { "SearchString": "JCountryString", "FieldToMatch": { "Body": {} }, "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ], "PositionalConstraint": "CONTAINS" } } ] } } ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "match_rule" } } Using logical rule statements 103 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide NOT rule statement The NOT rule statement logically negates the results of a single nested statement, so the nested statements must not match for the NOT statement to match, and vice versa. This requires one nested statement. For example, if you want to block requests that don't originate in a speciﬁc country, create a NOT statement with action set to block, and nest a geographic match statement that speciﬁes the country. Rule statement characteristics Nestable – You can nest this statement type. WCUs – Depends on the nested statement. Where to ﬁnd this rule statement • Rule builder on the console – For If a request, choose doesn't match the statement (NOT), and then ﬁll in the nested statement. • API – NotStatement OR rule statement The OR rule statement combines nested statements with OR logic, so one of the nested statements must match for the OR statement to match. This requires at least two nested statements. For example, if you want to block requests that come from a speciﬁc country or that contain a speciﬁc query string, you could create an OR statement and nest in it a geo match statement for the country and a string match statement for the query string. If instead you want to block requests that don't come from a speciﬁc country or that contain a speciﬁc query string, you would modify the previous OR statement to nest the geo match statement one level lower, inside a NOT statement. This level of nesting requires you to use the JSON formatting, because the console supports only one level of nesting. Rule statement characteristics Nestable – You can nest this statement type. Using logical rule statements 104 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide WCUs – Depends on the nested statements. Where to ﬁnd this rule statement • Rule builder on the console – For If a request, choose matches at least one of the statements (OR), and then ﬁll in the nested statements. • API – OrStatement Examples The following listing shows the use of OR to combine two other statements. The OR statement is a match if either of the nested statements match. { "Name": "neitherOfTwo", "Priority": 1, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "neitherOfTwo" }, "Statement": { "OrStatement": { "Statements": [ { "GeoMatchStatement": { "CountryCodes": [ "CA" ] } }, { "IPSetReferenceStatement": { "ARN": "arn:aws:wafv2:us-east-1:111111111111:regional/ipset/test-ip- set-22222222/33333333-4444-5555-6666-777777777777" } } ] } Using logical rule statements 105 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide } } Using the console rule visual editor, you can nest most nestable statements under a logical rule statement, but you can't use the visual editor to nest OR or AND statements. To conﬁgure this type of nesting, you need to provide your rule statement in JSON. For example, the following JSON rule listing includes an OR statement nested inside an AND statement. { "Name": "match_rule", "Priority": 0, "Statement": { "AndStatement": { "Statements": [ { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:category:monitoring" } }, { "NotStatement": { "Statement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:bot-control:bot:name:pingdom" } } } }, { "OrStatement": { "Statements": [ { "GeoMatchStatement": { "CountryCodes": [ "JM", "JP" ] } }, { "ByteMatchStatement": { Using logical rule statements 106 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "SearchString": "JCountryString", "FieldToMatch": { "Body": {} }, "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ], "PositionalConstraint": "CONTAINS" } } ] } } ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "match_rule" } } Using rate-based rule statements in AWS WAF This section explains what a rate-based rule statement is and how it works. A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule aggregates requests according to your criteria, and counts and rate limits the aggregate groupings, based on the rule's evaluation window, request limit, and action settings. Note You can also rate limit web requests using the targeted protection level of the Bot Control AWS
waf-dg-048	waf-dg.pdf	48	}, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "match_rule" } } Using rate-based rule statements in AWS WAF This section explains what a rate-based rule statement is and how it works. A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule aggregates requests according to your criteria, and counts and rate limits the aggregate groupings, based on the rule's evaluation window, request limit, and action settings. Note You can also rate limit web requests using the targeted protection level of the Bot Control AWS Managed Rules rule group. Using this managed rule group incurs additional fees. Using rate-based rule statements 107 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For more information, see Options for rate limiting in rate-based rules and targeted Bot Control rules. AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and each gets its own tracking and management by AWS WAF. If you deﬁne a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF. Not nestable – You can't nest this statement type inside other statements. You can include it directly in a web ACL or rule group. Scope-down statement – This rule type can take a scope-down statement, to narrow the scope of the requests that the rule tracks and rate limits. The scope-down statement can be optional or required, depending on your other rule conﬁguration settings. The details are covered in this section. For general information about scope-down statements, see Using scope-down statements in AWS WAF. WCUs – 2, as a base cost. For each custom aggregation key that you specify, add 30 WCUs. If you use a scope-down statement in the rule, calculate and add the WCUs for that. Where to ﬁnd this rule statement • Rule builder in your web ACL, on the console – Under Rule, for Type, choose Rate-based rule. • API – RateBasedStatement Topics • Rate-based rule high-level settings in AWS WAF • Rate-based rule caveats in AWS WAF • Aggregating rate-based rules in AWS WAF • Rate-based rule aggregation instances and counts • Applying rate limiting to requests in AWS WAF • Rate-based rule examples in AWS WAF • Listing IP addresses that are being rate limited by rate-based rules Using rate-based rule statements 108 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rate-based rule high-level settings in AWS WAF A rate-based rule statement uses the following high level settings: • Evaluation window – The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60 (1 minute), 120 (2 minutes), 300 (5 minutes), and 600 (10 minutes), and 300 (5 minutes) is the default. This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate frequently, with timing that's independent of the evaluation window setting. • Rate limit – The maximum number of requests matching your criteria that AWS WAF should just track for the speciﬁed evaluation window. The lowest limit setting allowed is 10. When this limit is breached, AWS WAF applies the rule action setting to additional requests matching your criteria. AWS WAF applies rate limiting near the limit that you set, but does not guarantee an exact limit match. For more information, see Rate-based rule caveats. • Request aggregation – The aggregation criteria to use on the web requests that the rate-based rule counts and rate limits. The rate limit that you set applies to each aggregation instance. For details, see Aggregating rate-based rules and Aggregation instances and counts. • Action – The action to take on requests that the rule rate limits. You can use any rule action except Allow. This is set at the rule level as usual, but has some restrictions and behaviors that are speciﬁc to rate-based rules. For general information about rule actions, see Using rule actions in AWS WAF. For information speciﬁc to rate limiting, see Applying rate limiting to requests in AWS WAF in this section. • Scope of inspection and rate limiting – You can narrow the scope of the requests that the rate-based statement tracks and
waf-dg-049	waf-dg.pdf	49	Aggregation instances and counts. • Action – The action to take on requests that the rule rate limits. You can use any rule action except Allow. This is set at the rule level as usual, but has some restrictions and behaviors that are speciﬁc to rate-based rules. For general information about rule actions, see Using rule actions in AWS WAF. For information speciﬁc to rate limiting, see Applying rate limiting to requests in AWS WAF in this section. • Scope of inspection and rate limiting – You can narrow the scope of the requests that the rate-based statement tracks and rate limits by adding a scope-down statement. If you specify a scope-down statement, the rule only aggregates, counts, and rate limits requests that match the scope-down statement. If you choose the request aggregation option Count all, then the scope- down statement is required. For more information about scope-down statements, see Using scope-down statements. • (Optional) Forwarded IP conﬁguration – This is only used if you specify IP address in header in your request aggregation, either alone or as part of the custom keys settings. AWS WAF retrieves the ﬁrst IP address in the speciﬁed header and uses that as the aggregation value. A Using rate-based rule statements 109 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide common header for this purpose is X-Forwarded-For, but you can specify any header. For more information, see Using forwarded IP addresses. Rate-based rule caveats in AWS WAF This section lists the caveats for using rate-based rules. AWS WAF rate limiting is designed to control high request rates and protect your application's availability in the most eﬃcient and eﬀective way possible. It's not intended for precise request- rate limiting. • AWS WAF estimates the current request rate using an algorithm that gives more importance to more recent requests. Because of this, AWS WAF will apply rate limiting near the limit that you set, but does not guarantee an exact limit match. • Each time that AWS WAF estimates the rate of requests, AWS WAF looks back at the number of requests that came in during the conﬁgured evaluation window. Due to this and other factors such as propagation delays, it's possible for requests to be coming in at too high a rate for up to several minutes before AWS WAF detects and rate limits them. Similarly. the request rate can be below the limit for a period of time before AWS WAF detects the decrease and discontinues the rate limiting action. Usually, this delay is below 30 seconds. • If you change any of the rate limit settings in a rule that's in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute. The rate limit settings are the evaluation window, rate limit, request aggregation settings, forwarded IP conﬁguration, and scope of inspection. Aggregating rate-based rules in AWS WAF This section explains your options for aggregating requests. By default, a rate-based rule aggregates and rate limits requests based on the request IP address. You can conﬁgure the rule to use various other aggregation keys and key combinations. For example, you can aggregate based on a forwarded IP address, on the HTTP method, or on a query argument. You can also specify aggregation key combinations, such as IP address and HTTP method, or the values of two diﬀerent cookies. Using rate-based rule statements 110 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note All of the request components that you specify in the aggregation key must be present in a web request for the request to be evaluated or rate limited by the rule. You can conﬁgure your rate-based rule with the following aggregation options. • Source IP address – Aggregate using only the IP address from the web request origin. The source IP address might not contain the address of the originating client. If a web request goes through one or more proxies or load balancers, this will contain the address of the last proxy. • IP address in header – Aggregate using only a client address in an HTTP header. This is also referred to as a forwarded IP address. With this conﬁguration, you also specify a fallback behavior to apply to a web request with a malformed IP address in the header. The fallback behavior sets the matching result for the request, to match or no match. For no match, the rate-based rule doesn't count or rate limit the request. For match, the rate-based rule groups the request together with other requests that have a malformed IP address in the speciﬁed header. Use caution with this option, because headers can be handled inconsistently by proxies and they can also be modiﬁed to bypass inspection. For
waf-dg-050	waf-dg.pdf	50	a forwarded IP address. With this conﬁguration, you also specify a fallback behavior to apply to a web request with a malformed IP address in the header. The fallback behavior sets the matching result for the request, to match or no match. For no match, the rate-based rule doesn't count or rate limit the request. For match, the rate-based rule groups the request together with other requests that have a malformed IP address in the speciﬁed header. Use caution with this option, because headers can be handled inconsistently by proxies and they can also be modiﬁed to bypass inspection. For additional information and best practices, see Using forwarded IP addresses in AWS WAF. • Count all – Count and rate limit all requests that match the rule's scope-down statement. This option requires a scope-down statement. This is typically used to rate limit a speciﬁc set of requests, such as all requests with a speciﬁc label or all requests from a speciﬁc geographic area. • Custom keys – Aggregate using one or more custom aggregation keys. To combine either of the IP address options with other aggregation keys, deﬁne them here under custom keys. Custom aggregation keys are a subset of the web request component options described at Request components in AWS WAF. The key options are the following. Except where noted, you can use an option multiple times, for example, two headers or three label namespaces. • Label namespace – Use a label namespace as an aggregation key. Each distinct fully qualiﬁed label name that has the speciﬁed label namespace contributes to the aggregation instance. If Using rate-based rule statements 111 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide you use just one label namespace as your custom key, then each label name fully deﬁnes an aggregation instance. The rate-based rule uses only labels that have been added to the request by rules that are evaluated beforehand in the web ACL. For information about label namespaces and names, see Label syntax and naming requirements in AWS WAF. • Header – Use a named header as an aggregation key. Each distinct value in the header contributes to the aggregation instance. Header takes an optional text transformation. See Using text transformations in AWS WAF. • Cookie – Use a named cookie as an aggregation key. Each distinct value in the cookie contributes to the aggregation instance. Cookie takes an optional text transformation. See Using text transformations in AWS WAF. • Query argument – Use a single query argument in the request as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. Query argument takes an optional text transformation. See Using text transformations in AWS WAF. • Query string – Use the entire query string in the request as an aggregate key. Each distinct query string contributes to the aggregation instance. You can use this key type once. Query string takes an optional text transformation. See Using text transformations in AWS WAF. • URI path – Use the URI path in the request as an aggregate key. Each distinct URI path contributes to the aggregation instance. You can use this key type once. URI path takes an optional text transformation. See Using text transformations in AWS WAF. • URI path – Use the URI path in the request as an aggregate key. Each distinct URI path contributes to the aggregation instance. You can use this key type once. URI path takes an optional text transformation. See Using text transformations in AWS WAF. • JA3 ﬁngerprint – Use the JA3 ﬁngerprint in the request as an aggregate key. Each distinct JA3 ﬁngerprint contributes to the aggregation instance. You can use this key type once. • JA4 ﬁngerprint – Use the JA4 ﬁngerprint in the request as an aggregate key. Each distinct JA4 112 ﬁngerprint contributes to the aggregation instance. You can use this key type once. Using rate-based rule statements AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • HTTP method – Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. You can use this key type once. • IP address – Aggregate using the IP address from the web request origin in combination with other keys. This might not contain the address of the originating client. If a web request goes through one or more proxies or load balancers, this will contain the address of the last proxy. • IP address in header – Aggregate using the client address in an HTTP header in combination with other keys. This is also referred to as a forwarded IP address. Use caution with this option, as headers can be handled inconsistently by proxies and they can be modiﬁed to bypass inspection. For additional
waf-dg-051	waf-dg.pdf	51	Aggregate using the IP address from the web request origin in combination with other keys. This might not contain the address of the originating client. If a web request goes through one or more proxies or load balancers, this will contain the address of the last proxy. • IP address in header – Aggregate using the client address in an HTTP header in combination with other keys. This is also referred to as a forwarded IP address. Use caution with this option, as headers can be handled inconsistently by proxies and they can be modiﬁed to bypass inspection. For additional information and best practices, see Using forwarded IP addresses in AWS WAF. Rate-based rule aggregation instances and counts This section explains how a rate-based rule evaluates web requests. When a rate-based rule evaluates web requests using your aggregation criteria, each unique set of values that the rule ﬁnds for the speciﬁed aggregation keys deﬁnes a unique aggregation instance. • Multiple keys – If you've deﬁned multiple custom keys, the value for each key contributes to the aggregation instance deﬁnition. Each unique combination of values deﬁnes an aggregation instance. • Single key – If you've chosen a single key, either in the custom keys or by selecting one of the singleton IP address choices, then each unique value for the key deﬁnes an aggregation instance. • Count all - no keys – If you've selected the aggregation option Count all, then all requests that the rule evaluates belong to a single aggregation instance for the rule. This choice requires a scope-down statement. A rate-based rule counts web requests separately for each aggregation instance that it identiﬁes. For example, assume a rate-based rule evaluates web requests with the following IP address and HTTP method values: • IP address 10.1.1.1, HTTP method POST Using rate-based rule statements 113 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • IP address 10.1.1.1, HTTP method GET • IP address 127.0.0.0, HTTP method POST • IP address 10.1.1.1, HTTP method GET The rule creates diﬀerent aggregation instances according to your aggregation criteria. • If the aggregation criteria is just the IP address, then each individual IP address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1: count 3 • IP address 127.0.0.0: count 1 • If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following: • HTTP method POST: count 2 • HTTP method GET: count 2 • If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1, HTTP method POST: count 1 • IP address 10.1.1.1, HTTP method GET: count 2 • IP address 127.0.0.0, HTTP method POST: count 1 Applying rate limiting to requests in AWS WAF This section explains how rate limiting behavior works for rate-based rules. The criteria that AWS WAF uses to rate limit requests for a rate-based rule is the same criteria that AWS WAF uses to aggregate requests for the rule. If you deﬁne a scope-down statement for the rule, AWS WAF only aggregates, counts, and rate limits requests that match the scope-down statement. The match criteria that causes a rate-based rule to apply its rule action settings to a speciﬁc web request are as follows: • The web request matches the rule's scope-down statement, if one is deﬁned. Using rate-based rule statements 114 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • The web request belongs to an aggregation instance whose request count is currently over the rule's limit. How AWS WAF applies the rule action When a rate-based rule applies rate limiting to a request, it applies the rule action and, if you've deﬁned any custom handling or labeling in your action speciﬁcation, the rule applies those. This request handling is the same as the way a match rule applies its action settings to matching web requests. A rate-based rule only applies labels or performs other actions on requests that it is actively rate limiting. You can use any rule action except Allow. For general information about rule actions, see Using rule actions in AWS WAF. The following list describes how rate limiting works for each of the actions. • Block – AWS WAF blocks the request and applies any custom blocking behavior that you've deﬁned. • Count – AWS WAF counts the request, applies any custom headers or labels that you've deﬁned, and continues the web ACL evaluation of the
waf-dg-052	waf-dg.pdf	52	action settings to matching web requests. A rate-based rule only applies labels or performs other actions on requests that it is actively rate limiting. You can use any rule action except Allow. For general information about rule actions, see Using rule actions in AWS WAF. The following list describes how rate limiting works for each of the actions. • Block – AWS WAF blocks the request and applies any custom blocking behavior that you've deﬁned. • Count – AWS WAF counts the request, applies any custom headers or labels that you've deﬁned, and continues the web ACL evaluation of the request. This action doesn't limit the rate of requests. It just counts the requests that are over the limit. • CAPTCHA or Challenge – AWS WAF handles the request either like a Block or like a Count, depending on the state of the request's token. This action doesn't limit the rate of requests that have valid tokens. It limits the rate of requests that are over the limit and are also missing valid tokens. • If the request doesn't have a valid, unexpired token, the action blocks the request and sends the CAPTCHA puzzle or the browser challenge back to the client. If the end user or client browser responds successfully, the client receives a valid token and it automatically resends the original request. If rate limiting for the aggregation instance is still in eﬀect, this new request with the valid, unexpired token will have the action applied to it as described in the next bullet point. • If the request has a valid, unexpired token, the CAPTCHA or Challenge action veriﬁes the token and takes no action on the request, similar to the Count action. The rate-based rule returns the request evaluation back to the web ACL without taking any terminating action, and the web ACL continues its evaluation of the request. Using rate-based rule statements 115 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide For additional information, see CAPTCHA and Challenge in AWS WAF. If you rate limit only the IP address or forwarded IP address When you conﬁgure the rule to rate limit only IP address for forwarded IP address, you can retrieve the list of IP addresses that the rule is currently rate limiting. If you're using a scope-down statement, the requests that are rate limited are only those in the IP list that match the scope- down statement. For information about retrieving the IP address list, see Listing IP addresses that are being rate limited by rate-based rules. Rate-based rule examples in AWS WAF This section describes example conﬁgurations for a variety of common rate-based rules use cases. Each example provides a description of the use case and then shows the solution in JSON listings for the custom conﬁgured rules. Note The JSON listings shown in these examples were created in the console by conﬁguring the rule and then editing it using the Rule JSON editor. Topics • Rate limit the requests to a login page • Rate limit the requests to a login page from any IP address, user agent pair • Rate limit the requests that are missing a speciﬁc header • Rate limit the requests with speciﬁc labels • Rate limit the requests for labels that have a speciﬁed label namespace Rate limit the requests to a login page To limit the number of requests to the login page on your website without aﬀecting traﬃc to the rest of your site, you could create a rate-based rule with a scope-down statement that matches requests to your login page and with the request aggregation set to Count all. Using rate-based rule statements 116 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The rate-based rule will count all requests for the login page in a single aggregation instance and apply the rule action when the requests exceed the limit. The following JSON listing shows an example of this rule conﬁguration. The count all aggregation option is listed in the JSON as the setting CONSTANT. This example matches login pages that start with /login. { "Name": "test-rbr", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" }, "Statement": { "RateBasedStatement": { "Limit": 1000, "EvaluationWindowSec": 300, "AggregateKeyType": "CONSTANT", "ScopeDownStatement": { "ByteMatchStatement": { "FieldToMatch": { "UriPath": {} }, "PositionalConstraint": "STARTS_WITH", "SearchString": "/login", "TextTransformations": [ { "Type": "NONE", "Priority": 0 } ] } } } } } Using rate-based rule statements 117 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rate limit the requests to a login page from any IP address, user agent pair To limit the number of requests to the login page on your website for IP address, user agent pairs that exceed your limit, set the request aggregation to
waf-dg-053	waf-dg.pdf	53	true, "MetricName": "test-rbr" }, "Statement": { "RateBasedStatement": { "Limit": 1000, "EvaluationWindowSec": 300, "AggregateKeyType": "CONSTANT", "ScopeDownStatement": { "ByteMatchStatement": { "FieldToMatch": { "UriPath": {} }, "PositionalConstraint": "STARTS_WITH", "SearchString": "/login", "TextTransformations": [ { "Type": "NONE", "Priority": 0 } ] } } } } } Using rate-based rule statements 117 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rate limit the requests to a login page from any IP address, user agent pair To limit the number of requests to the login page on your website for IP address, user agent pairs that exceed your limit, set the request aggregation to Custom keys and provide the aggregation criteria. The following JSON listing shows an example of this rule conﬁguration. In this example, we've set the limit to 100 requests in any ﬁve minute period per IP address, user agent pair. { "Name": "test-rbr", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" }, "Statement": { "RateBasedStatement": { "Limit": 100, "EvaluationWindowSec": 300, "AggregateKeyType": "CUSTOM_KEYS", "CustomKeys": [ { "Header": { "Name": "User-Agent", "TextTransformations": [ { "Priority": 0, "Type": "NONE" } ] } }, { "IP": {} } ], "ScopeDownStatement": { "ByteMatchStatement": { Using rate-based rule statements 118 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "FieldToMatch": { "UriPath": {} }, "PositionalConstraint": "STARTS_WITH", "SearchString": "/login", "TextTransformations": [ { "Type": "NONE", "Priority": 0 } ] } } } } } Rate limit the requests that are missing a speciﬁc header To limit the number of requests that are missing a speciﬁc header, you can use the Count all aggregation option with a scope-down statement. Conﬁgure the scope-down statement with a logical NOT statement containing a statement that returns true only if the header exists and has a value. The following JSON listing shows an example of this rule conﬁguration. { "Name": "test-rbr", "Priority": 0, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" }, "Statement": { "RateBasedStatement": { "Limit": 1000, "AggregateKeyType": "CONSTANT", "EvaluationWindowSec": 300, "ScopeDownStatement": { Using rate-based rule statements 119 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "NotStatement": { "Statement": { "SizeConstraintStatement": { "FieldToMatch": { "SingleHeader": { "Name": "user-agent" } }, "ComparisonOperator": "GT", "Size": 0, "TextTransformations": [ { "Type": "NONE", "Priority": 0 } ] } } } } } } } Rate limit the requests with speciﬁc labels To limit the number of requests of various categories, you can combine rate limiting with any rule or rule group that add labels to requests. To do this, you conﬁgure your web ACL as follows: • Add the rules or rule groups that add labels, and conﬁgure them so that they don't block or allow the requests that you want to rate limit. If you use managed rule groups, you might need to override some rule group rule actions to Count to achieve this behavior. • Add a rate-based rule to your web ACL with a priority number setting that is higher than the labeling rules and rule groups. AWS WAF evaluates rules in numeric order, starting from the lowest, so your rate-based rule will run after the labeling rules. Conﬁgure your rate limiting on the labels using a combination of label matching in the rule's scope-down statement and label aggregation. The following example uses the Amazon IP reputation list AWS Managed Rules rule group. The rule group rule AWSManagedIPDDoSList detects and labels requests whose IPs are known to be actively engaging in DDoS activities. The rule's action is conﬁgured to Count in the rule group Using rate-based rule statements 120 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide deﬁnition. For more information about the rule group, see the section called “Amazon IP reputation list”. The following web ACL JSON listing uses the IP reputation rule group followed by a label-matching rate-based rule. The rate-based rule uses a scope-down statement to ﬁlter for requests that have been marked by the rule group rule. The rate-based rule statement aggregates and rate limits the ﬁltered requests by their IP addresses. { "Name": "test-web-acl", "Id": ... "ARN": ... "DefaultAction": { "Allow": {} }, "Description": "", "Rules": [ { "Name": "AWS-AWSManagedRulesAmazonIpReputationList", "Priority": 0, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesAmazonIpReputationList" } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesAmazonIpReputationList" } }, { "Name": "test-rbr", "Priority": 1, "Statement": { "RateBasedStatement": { "Limit": 100, "EvaluationWindowSec": 300, "AggregateKeyType": "IP", Using rate-based rule statements 121 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "ScopeDownStatement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:amazon-ip-list:AWSManagedIPDDoSList" } } } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" } } ], "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-web-acl" }, "Capacity": 28, "ManagedByFirewallManager": false, "RetrofittedByFirewallManager": false, "LabelNamespace": "awswaf:0000000000:webacl:test-web-acl:" } Rate limit the requests for
waf-dg-054	waf-dg.pdf	54	"AWSManagedRulesAmazonIpReputationList" } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesAmazonIpReputationList" } }, { "Name": "test-rbr", "Priority": 1, "Statement": { "RateBasedStatement": { "Limit": 100, "EvaluationWindowSec": 300, "AggregateKeyType": "IP", Using rate-based rule statements 121 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "ScopeDownStatement": { "LabelMatchStatement": { "Scope": "LABEL", "Key": "awswaf:managed:aws:amazon-ip-list:AWSManagedIPDDoSList" } } } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" } } ], "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-web-acl" }, "Capacity": 28, "ManagedByFirewallManager": false, "RetrofittedByFirewallManager": false, "LabelNamespace": "awswaf:0000000000:webacl:test-web-acl:" } Rate limit the requests for labels that have a speciﬁed label namespace Note The common level rules in the Bot Control managed rule group add labels for bots of various categories, but they only block requests from unveriﬁed bots. For information about these rules, see Bot Control rules listing. If you use the Bot Control managed rule group, you can add rate limiting for requests from individual veriﬁed bots. To do this, you add a rate-based rule that runs after the Bot Control rule group and aggregates requests by their bot name labels. You specify the Label namespace aggregation key and set the namespace key to awswaf:managed:aws:bot- Using rate-based rule statements 122 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide control:bot:name:. Each unique label with the speciﬁed namespace will deﬁne an aggregation instance. For example, the labels awswaf:managed:aws:bot-control:bot:name:axios and awswaf:managed:aws:bot-control:bot:name:curl each deﬁne an aggregation instance. The following web ACL JSON listing shows this conﬁguration. The rule in this example limits requests for any single bot aggregation instance to 1,000 in a two minute period. { "Name": "test-web-acl", "Id": ... "ARN": ... "DefaultAction": { "Allow": {} }, "Description": "", "Rules": [ { "Name": "AWS-AWSManagedRulesBotControlRuleSet", "Priority": 0, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesBotControlRuleSet", "ManagedRuleGroupConfigs": [ { "AWSManagedRulesBotControlRuleSet": { "InspectionLevel": "COMMON" } } ] } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesBotControlRuleSet" } }, { "Name": "test-rbr", Using rate-based rule statements 123 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide "Priority": 1, "Statement": { "RateBasedStatement": { "Limit": 1000, "EvaluationWindowSec": 120, "AggregateKeyType": "CUSTOM_KEYS", "CustomKeys": [ { "LabelNamespace": { "Namespace": "awswaf:managed:aws:bot-control:bot:name:" } } ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-rbr" } } ], "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "test-web-acl" }, "Capacity": 82, "ManagedByFirewallManager": false, "RetrofittedByFirewallManager": false, "LabelNamespace": "awswaf:0000000000:webacl:test-web-acl:" } Listing IP addresses that are being rate limited by rate-based rules This section explains how to access the list of IP addresses that are currently rate-limited by a rate- based rule by using the CLI, the API, or any of the SDKs. Using rate-based rule statements 124 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If your rate-based rule only aggregates on IP address or forwarded IP address, you can retrieve the list of IP addresses that the rule is currently rate limiting. AWS WAF stores these IP addresses in the rule's managed keys list. Note This option is only available if you aggregate on only the IP address or only an IP address in a header. If you use the custom keys request aggregation, you can't retrieve a list of rate limited IP addresses, even if you use one of the IP address speciﬁcations in your custom keys. A rate-based rule applies its rule action to requests from the rule's managed keys list that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule action is Block by default, but it can be any valid rule action except for Allow. The maximum number of IP addresses that AWS WAF can rate limit using a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, AWS WAF limits those with the highest rates. You can access a rate-based rule's managed keys list using the CLI, the API, or any of the SDKs. This topic covers access using the CLI and APIs. The console doesn't provide access to the list at this time. For the AWS WAF API, the command is GetRateBasedStatementManagedKeys. For the AWS WAF CLI, the command is get-rate-based-statement-managed-keys. The following shows the syntax for retrieving the list of rate limited IP addresses for a rate-based rule that's being used in a web ACL on an Amazon CloudFront distribution. aws wafv2 get-rate-based-statement-managed-keys --scope=CLOUDFRONT --region=us-east-1 --web-acl-name=WebACLName --web-acl-id=WebACLId --rule-name=RuleName The following shows the syntax for a regional application, an Amazon API Gateway REST API, an Application Load Balancer, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, AWS Amplify, or an AWS Veriﬁed Access instance. aws wafv2 get-rate-based-statement-managed-keys --scope=REGIONAL --region=region --web- acl-name=WebACLName
waf-dg-055	waf-dg.pdf	55	the command is GetRateBasedStatementManagedKeys. For the AWS WAF CLI, the command is get-rate-based-statement-managed-keys. The following shows the syntax for retrieving the list of rate limited IP addresses for a rate-based rule that's being used in a web ACL on an Amazon CloudFront distribution. aws wafv2 get-rate-based-statement-managed-keys --scope=CLOUDFRONT --region=us-east-1 --web-acl-name=WebACLName --web-acl-id=WebACLId --rule-name=RuleName The following shows the syntax for a regional application, an Amazon API Gateway REST API, an Application Load Balancer, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, AWS Amplify, or an AWS Veriﬁed Access instance. aws wafv2 get-rate-based-statement-managed-keys --scope=REGIONAL --region=region --web- acl-name=WebACLName --web-acl-id=WebACLId --rule-name=RuleName Using rate-based rule statements 125 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you deﬁne a rate-based rule inside a rule group, and then use the rule group in a web ACL, AWS WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, AWS WAF monitors web requests and manages keys for this second usage completely independent of your ﬁrst. For a rate-based rule that you've deﬁned inside a rule group, you need to provide the name of the rule group reference statement in your request, in addition to the web ACL name and the name of the rate-based rule inside the rule group. The following shows the syntax for a regional application where the rate-based rule is deﬁned inside a rule group, and the rule group is used in a web ACL. aws wafv2 get-rate-based-statement-managed-keys --scope=REGIONAL --region=region --web- acl-name=WebACLName --web-acl-id=WebACLId --rule-group-rule-name=RuleGroupRuleName -- rule-name=RuleName Using rule group rule statements in AWS WAF Note Rule group rule statements are not nestable. This section describes the rule group rule statements that you can use in your web ACL. Rule group web ACL capacity units (WCUs) are set by the rule group owner at the time of creation. For information about WCUs, see Web ACL capacity units (WCUs) in AWS WAF. Rule group statement Description WCUs Using managed rule group statements Runs the rules that are deﬁned in the speciﬁed managed rule group. Deﬁned by the rule group, plus any additional WCUs for a scope-down statement. You can narrow the scope of requests that the rule group evaluates by adding a scope- down statement. Using rule group rule statements 126 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule group statement Description WCUs You can't nest a managed rule group statement inside any other statement type. Using rule group statements Runs the rules that are deﬁned in a rule group that You deﬁne the WCU limit for the rule group when you you manage. create it. You can't add a scope-dow n statement to a rule group reference statement for your own rule group. You can't nest a rule group statement inside any other statement type Using managed rule group statements in AWS WAF This section explains how managed rule group rule statements work. The managed rule group rule statement adds a reference in your web ACL rules list to a managed rule group. You don't see this option under your rule statements on the console, but when you work with the JSON format of your web ACL, any managed rule groups that you've added show up under the web ACL rules as this type. A managed rule group is either an AWS Managed Rules rule group, most of which are free for AWS WAF customers, or an AWS Marketplace managed rule group. You automatically subscribe to the paid AWS Managed Rules rule groups when you add them to your web ACL. You can subscribe to AWS Marketplace managed rule groups through AWS Marketplace. For more information, see Using managed rule groups in AWS WAF. When you add a rule group to a web ACL, you can override the actions of rules in the group to Count or to another rule action. For more information, see Overriding rule group actions in AWS WAF. Using rule group rule statements 127 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You can narrow the scope of the requests that AWS WAF evaluates with the rule group. To do this, you add a scope-down statement inside the rule group statement. For information about scope- down statements, see Using scope-down statements in AWS WAF. This can help you manage how the rule group aﬀects your traﬃc and can help you contain costs associated with traﬃc volume when you use the rule group. For information and examples for using scope-down statements with the AWS WAF Bot Control managed rule group, see AWS
waf-dg-056	waf-dg.pdf	56	AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You can narrow the scope of the requests that AWS WAF evaluates with the rule group. To do this, you add a scope-down statement inside the rule group statement. For information about scope- down statements, see Using scope-down statements in AWS WAF. This can help you manage how the rule group aﬀects your traﬃc and can help you contain costs associated with traﬃc volume when you use the rule group. For information and examples for using scope-down statements with the AWS WAF Bot Control managed rule group, see AWS WAF Bot Control. Rule statement characteristics Not nestable – You can't nest this statement type inside other statements, and you can't include it in a rule group. You can include it directly in a web ACL. (Optional) Scope-down statement – This rule type takes an optional scope-down statement, to narrow the scope of the requests that the rule group evaluates. For more information, see Using scope-down statements in AWS WAF. WCUs – Set for the rule group at creation. Where to ﬁnd this rule statement • Console – During the process of creating a web ACL, on the Add rules and rule groups page, choose Add managed rule groups, and then ﬁnd and select the rule group that you want to use. • API – ManagedRuleGroupStatement Using rule group statements in AWS WAF This section explains how rule group rule statements work. The rule group rule statement adds a reference to your web ACL rules list to a rule group that you manage. You don't see this option under your rule statements on the console, but when you work with the JSON format of your web ACL, any of your own rule groups that you've added show up under the web ACL rules as this type. For information about using your own rule groups, see Managing your own rule groups. When you add a rule group to a web ACL, you can override the actions of rules in the group to Count or to another rule action. For more information, see Overriding rule group actions in AWS WAF. Using rule group rule statements 128 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule statement characteristics Not nestable – You can't nest this statement type inside other statements, and you can't include it in a rule group. You can include it directly in a web ACL. WCUs – Set for the rule group at creation. Where to ﬁnd this rule statement • Console – During the process of creating a web ACL, on the Add rules and rule groups page, choose Add my own rules and rule groups, Rule group, and then add the rule group that you want to use. • API – RuleGroupReferenceStatement AWS WAF rule groups This section explains what a rule group is and how it works. A rule group is a reusable set of rules that you can add to a web ACL. For more information about web ACLs, see Using web ACLs in AWS WAF. Rule groups fall into the following main categories: • Your own rule groups, which you create and maintain. • Managed rule groups that AWS Managed Rules teams create and maintain for you. • Managed rule groups that AWS Marketplace sellers create and maintain for you. • Rule groups that are owned and managed by other services like AWS Firewall Manager and Shield Advanced. Diﬀerences between rule groups and web ACLs Rule groups and web ACLs both contain rules, which are deﬁned in the same manner in both places. Rule groups diﬀer from web ACLs in the following ways: • Rule groups can't contain rule group reference statements. • You can reuse a single rule group in multiple web ACLs by adding a rule group reference statement to each web ACL. You can't reuse a web ACL. AWS WAF rule groups 129 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Rule groups don't have default actions. In a web ACL, you set a default action for each rule or rule group that you include. Each individual rule inside a rule group or web ACL has an action deﬁned. • You don't directly associate a rule group with an AWS resource. To protect resources using a rule group, you use the rule group in a web ACL. • Web ACLs have a system-deﬁned maximum capacity of 5,000 web ACL capacity units (WCUs). Each rule group has a WCU setting that must be set at creation. You can use this setting to calculate the additional capacity requirements that using a rule group would add to your web ACL. For more information about WCUs, see Web ACL capacity units (WCUs) in AWS WAF. For information about rules,
waf-dg-057	waf-dg.pdf	57	has an action deﬁned. • You don't directly associate a rule group with an AWS resource. To protect resources using a rule group, you use the rule group in a web ACL. • Web ACLs have a system-deﬁned maximum capacity of 5,000 web ACL capacity units (WCUs). Each rule group has a WCU setting that must be set at creation. You can use this setting to calculate the additional capacity requirements that using a rule group would add to your web ACL. For more information about WCUs, see Web ACL capacity units (WCUs) in AWS WAF. For information about rules, see AWS WAF rules. This section provides guidance for creating and managing your own rule groups, describes the managed rule groups that are available to you, and provides guidance for using managed rule groups. Topics • Using managed rule groups in AWS WAF • Managing your own rule groups • AWS Marketplace rule groups • Recognizing rule groups provided by other services Using managed rule groups in AWS WAF This section explains what managed rule groups are and how they work. Managed rule groups are collections of predeﬁned, ready-to-use rules that AWS and AWS Marketplace sellers write and maintain for you. Basic AWS WAF pricing applies to your use of any managed rule group. For AWS WAF pricing information, see AWS WAF Pricing. • The AWS Managed Rules rule groups for AWS WAF Bot Control, AWS WAF Fraud Control account takeover prevention (ATP), and AWS WAF Fraud Control account creation fraud prevention (ACFP) are available for additional fees, beyond the basic AWS WAF charges. For pricing details, see AWS WAF Pricing. • All other AWS Managed Rules rule groups are available to AWS WAF customers at no additional cost. Using managed rule groups 130 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • AWS Marketplace rule groups are available by subscription through AWS Marketplace. Each of these rule groups is owned and managed by the AWS Marketplace seller. For pricing information to use an AWS Marketplace rule group, contact the AWS Marketplace seller. Some managed rule groups are designed to help protect speciﬁc types of web applications like WordPress, Joomla, or PHP. Others oﬀer broad protection against known threats or common web application vulnerabilities, including some of the ones listed in the OWASP Top 10. If you're subject to regulatory compliance like PCI or HIPAA, you might be able to use managed rule groups to satisfy web application ﬁrewall requirements. Automatic updates Keeping up to date on the constantly changing threat landscape can be time consuming and expensive. Managed rule groups can save you time when you implement and use AWS WAF. Many AWS and AWS Marketplace sellers automatically update managed rule groups and provide new versions of rule groups when new vulnerabilities and threats emerge. In some cases, AWS is notiﬁed of new vulnerabilities before public disclosure, due to its participation in a number of private disclosure communities. In those cases, AWS can update the AWS Managed Rules rule groups and deploy them for you even before a new threat is widely known. Restricted access to rules in a managed rule group Each managed rule group provides a comprehensive description of the types of attacks and vulnerabilities that it's designed to protect against. To protect the intellectual property of the rule group providers, you can't view all of the details for the individual rules within a rule group. This restriction also helps to keep malicious users from designing threats that speciﬁcally circumvent published rules. Topics • Using versioned managed rule groups in AWS WAF • Working with managed rule groups • AWS Managed Rules for AWS WAF Using versioned managed rule groups in AWS WAF This section explains how versioning is handled for managed rule groups. Using managed rule groups 131 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Many managed rule group providers use versioning to update a rule group's options and capabilities. Usually, a speciﬁc version of a managed rule group is static. Occasionally, a provider might need to update some or all of the static versions of a managed rule group, for example, to respond to an emerging security threat. When you use a versioned managed rule group in your web ACL, you can select the default version and let the provider manage which static version you use, or you can select a speciﬁc static version. Can't ﬁnd the version you want? If you don't see a version in a rule group's version listing, the version is probably scheduled for expiration or already expired. After a version is scheduled for expiration, AWS WAF no longer lets you to choose it for the rule group. SNS notiﬁcations for AWS Managed Rules rule groups The AWS Managed Rules rule groups all provide
waf-dg-058	waf-dg.pdf	58	When you use a versioned managed rule group in your web ACL, you can select the default version and let the provider manage which static version you use, or you can select a speciﬁc static version. Can't ﬁnd the version you want? If you don't see a version in a rule group's version listing, the version is probably scheduled for expiration or already expired. After a version is scheduled for expiration, AWS WAF no longer lets you to choose it for the rule group. SNS notiﬁcations for AWS Managed Rules rule groups The AWS Managed Rules rule groups all provide versioning and SNS update notiﬁcations except for the IP reputation rule groups. The AWS Managed Rules rule groups that provide notiﬁcations all use the same SNS topic Amazon Resource Name (ARN). To sign up for SNS notiﬁcations, see Getting notiﬁed of new versions and updates. Topics • Version life cycle for managed rule groups • Version expiration for managed rule groups • Best practices for handling managed rule group versions Version life cycle for managed rule groups Providers handle the following life cycle stages of a managed rule group static version: • Release and updates – A managed rule group provider announces upcoming and new static versions of their managed rule groups through notiﬁcations to an Amazon Simple Notiﬁcation Service (Amazon SNS) topic. Providers might also use the topic to communicate other important information about their rule groups, such as urgent required updates. You can subscribe to the rule group's topic and conﬁgure how you want to receive notiﬁcations. For more information see Getting notiﬁed of new versions and updates. • Expiration scheduling – A managed rule group provider schedules older versions of a rule group for expiration. A version that's scheduled to expire cannot be added to your web ACL rules. After Using managed rule groups 132 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide expiration is scheduled for a version, AWS WAF tracks the expiration with a countdown metric in Amazon CloudWatch. • Version expiration – If you have a web ACL conﬁgured to use an expired version of a managed rule group, then during web ACL evaluation, AWS WAF uses the rule group's default version. Additionally, AWS WAF blocks any updates to the web ACL that don't either remove the rule group or change its version to an unexpired one. If you use AWS Marketplace managed rule groups, ask the provider for any additional information about version life cycles. Version expiration for managed rule groups This section explains how version expiration works for a versioned managed rule group. If you use a speciﬁc version of a rule group, make sure that you don't keep using a version past its expiration date. You can monitor version expiration through the rule group's SNS notiﬁcations and through Amazon CloudWatch metrics. If a version that you're using in a web ACL is expired, AWS WAF blocks any updates to the web ACL that don't include moving the rule group to an unexpired version. You can update the rule group to an available version or remove it from your web ACL. Expiration handling for a managed rule group depends on the rule group provider. For AWS Managed Rules rule groups, an expired version is automatically changed to the rule group's default version. For AWS Marketplace rule groups, ask the provider how they handle expiration. When the provider creates a new version of the rule group, it sets the version's forecasted lifetime. While the version isn't scheduled to expire, the Amazon CloudWatch metric value is set to the forecasted lifetime setting, and in CloudWatch, you'll see a ﬂat value for the metric. After the provider schedules the metric to expire, the metric value diminishes each day until it reaches zero on the day of expiration. For information about monitoring expiration, see Tracking version expiration. Best practices for handling managed rule group versions Follow this best practice guidance for handling versioning when you use a versioned managed rule group. When you use a managed rule group in your web ACL, you can choose to use a speciﬁc, static version of the rule group, or you can choose to use the default version: Using managed rule groups 133 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Default version – AWS WAF always sets the default version to the static version that's currently recommended by the provider. When the provider updates their recommended static version, AWS WAF automatically updates the default version setting for the rule group in your web ACL. When you use the default version of a managed rule group, do the following as best practice: • Subscribe to notiﬁcations – Subscribe to notiﬁcations for changes to the rule group and keep an eye on those. Most
waf-dg-059	waf-dg.pdf	59	version: Using managed rule groups 133 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Default version – AWS WAF always sets the default version to the static version that's currently recommended by the provider. When the provider updates their recommended static version, AWS WAF automatically updates the default version setting for the rule group in your web ACL. When you use the default version of a managed rule group, do the following as best practice: • Subscribe to notiﬁcations – Subscribe to notiﬁcations for changes to the rule group and keep an eye on those. Most providers send advanced notiﬁcation of new static versions and of default version changes. These let you check the eﬀects of a new static version before AWS switches the default version to it. For more information see Getting notiﬁed of new versions and updates. • Review the eﬀects of static version settings and make adjustments as needed before your default is set to it – Before your default is set to a new static version, review the eﬀects of the static version on the monitoring and management of your web requests. The new static version might have new rules to review. Look for false positives or other unexpected behavior, in case you need to modify how you use the rule group. You can set rules to count, for example, to stop them from blocking traﬃc while you ﬁgure out how you want to handle the new behavior. For more information, see Testing and tuning your AWS WAF protections. • Static version – If you choose to use a static version, you must manually update the version setting when you're ready to adopt a new version of the rule group. When you use a static version of a managed rule group, do the following as best practice: • Keep your version up to date – Keep your managed rule group as close as you can to the latest version. When a new version is released, test it, adjust settings as needed, and implement it in a timely manner. For information about testing, see Testing and tuning your AWS WAF protections. • Subscribe to notiﬁcations – Subscribe to notiﬁcations for changes to the rule group, so you know when your provider releases new static versions. Most providers give advanced notiﬁcation of version changes. Additionally, your provider might need to update the static version that you're using to close a security loophole or for other urgent reasons. You'll know what's happening if you're subscribed to the provider's notiﬁcations. For more information, see Getting notiﬁed of new versions and updates. • Avoid version expiration – Don't allow a static version to expire while you're using it. Provider handling of expired versions can vary and might include forcing an upgrade to an available version or other changes that can have unexpected consequences. Track the AWS WAF expiry metric and set an alarm that gives you a suﬃcient number of days to successfully upgrade to a supported version. For more information, see Tracking version expiration. Using managed rule groups 134 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Working with managed rule groups This section provides guidance for accessing and managing your managed rule groups. When you add a managed rule group to your web ACL, you can choose the same conﬁguration options as you can your own rule groups, plus additional settings. Through the console, you access managed rule group information during the process of adding and editing the rules in your web ACLs. Through the APIs and the command line interface (CLI), you can directly request managed rule group information. When you use a managed rule group in your web ACL, you can edit the following settings: • Version – This is available only if the rule group is versioned. For more information, see Using versioned managed rule groups in AWS WAF. • Override rule actions – You can override the actions for rules in the rule group to any action. Setting them to Count is useful for testing a rule group before using it to manage your web requests. For more information, see Rule group rule action overrides. • Scope-down statement – You can add a scope-down statement, to ﬁlter out web requests that you don't want to evaluate with the rule group. For more information, see Using scope-down statements in AWS WAF. • Override rule group action – You can override the action that results from the rule group evaluation, and set it to Count only. This option isn't commonly used. It doesn't alter how AWS WAF evaluates the rules in the rule group. For more information, see Rule group return action override to Count. To edit the managed rule group settings in your web ACL • Console • (Option)
waf-dg-060	waf-dg.pdf	60	– You can add a scope-down statement, to ﬁlter out web requests that you don't want to evaluate with the rule group. For more information, see Using scope-down statements in AWS WAF. • Override rule group action – You can override the action that results from the rule group evaluation, and set it to Count only. This option isn't commonly used. It doesn't alter how AWS WAF evaluates the rules in the rule group. For more information, see Rule group return action override to Count. To edit the managed rule group settings in your web ACL • Console • (Option) When you add the managed rules group to your web ACL, you can choose Edit to view and edit the settings. • (Option) After you've added the managed rule group into your web ACL, from the Web ACLs page, choose the web ACL you just created. This takes you to the web ACL edit page. • Choose Rules. • Select the rule group, then choose Edit to view and edit the settings. Using managed rule groups 135 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • APIs and CLI – Outside of the console, you can manage the managed rule group settings when you create and update the web ACL. Retrieving the list of managed rule groups You can retrieve the list of managed rule groups that are available for you to use in your web ACLs. The list includes the following: • All AWS Managed Rules rule groups. • The AWS Marketplace rule groups that you have subscribed to. Note For information about subscribing to AWS Marketplace rule groups, see AWS Marketplace rule groups. When you retrieve the list of managed rule groups, the list you get back depends on the interface that you're using: • Console – Through the console, you can see all managed rule groups, including the AWS Marketplace rule groups that you haven't subscribed to yet. For the ones that you haven't subscribed to yet, the interface provides links that you can follow to subscribe. • APIs and CLI – Outside of the console, your request returns only the rule groups that are available for you to use. To retrieve the list of managed rule groups • Console – During the process of creating a web ACL, on the Add rules and rule groups page, choose Add managed rule groups. At the top level, the provider names are listed. Expand each provider listing to see the list of managed rule groups. For versioned rule groups, the information shown at this level is for the default version. When you add a managed rule group to your web ACL, the console lists it based on the naming scheme <Vendor Name>-<Managed Rule Group Name>. • API – • ListAvailableManagedRuleGroups • CLI – Using managed rule groups 136 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • aws wafv2 list-available-managed-rule-groups --scope=<CLOUDFRONT\| REGIONAL> Retrieving the rules in a managed rule group You can retrieve a list of the rules in a managed rule group. The API and CLI calls return the rules speciﬁcations that you can reference in the JSON model or through AWS CloudFormation. To retrieve the list of rules in a managed rule group • Console • (Option) When you add the managed rules group to your web ACL, you can choose Edit to view the rules. • (Option) After you've added the managed rule group into your web ACL, from the Web ACLs page, choose the web ACL you just created. This takes you to the web ACL edit page. • Choose Rules. • Select the rule group you want to see a rules list for, then choose Edit. AWS WAF shows the list of rules in the rule group. • API – DescribeManagedRuleGroup • CLI – aws wafv2 describe-managed-rule-group --scope=<CLOUDFRONT\|REGIONAL> --vendor-name <vendor> --name <managedrule_name> Retrieving the available versions for a managed rule group The available versions of a managed rule group are versions that haven't yet been scheduled to expire. The list indicates which version is the current default version for the rule group. To retrieve a list of the available versions of a managed rule group • Console • (Option) When you add the managed rule group to your web ACL, choose Edit to see the rule group's information. Expand the Version dropdown to see the list of available versions. • (Option) After you've added the managed rule group into your web ACL, choose Edit on the web ACL, and then select and edit the rule group rule. Expand the Version dropdown to see the list of available versions. • API – Using managed rule groups 137 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • ListAvailableManagedRuleGroupVersions • CLI – • aws wafv2 list-available-managed-rule-group-versions -- scope=<CLOUDFRONT\|REGIONAL>
waf-dg-061	waf-dg.pdf	61	(Option) When you add the managed rule group to your web ACL, choose Edit to see the rule group's information. Expand the Version dropdown to see the list of available versions. • (Option) After you've added the managed rule group into your web ACL, choose Edit on the web ACL, and then select and edit the rule group rule. Expand the Version dropdown to see the list of available versions. • API – Using managed rule groups 137 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • ListAvailableManagedRuleGroupVersions • CLI – • aws wafv2 list-available-managed-rule-group-versions -- scope=<CLOUDFRONT\|REGIONAL> --vendor-name <vendor> --name <managedrule_name> Adding a managed rule group to a web ACL through the console This section explains how to add a managed rule group to a web ACL through the console. This guidance applies to all AWS Managed Rules rule groups and to the AWS Marketplace rule groups that you're subscribed to. Production traﬃc risk Before you deploy changes in your web ACL for production traﬃc, test and tune them in a staging or testing environment until you are comfortable with the potential impact to your traﬃc. Then test and tune your updated rules in count mode with your production traﬃc before enabling them. For guidance, see Testing and tuning your AWS WAF protections. Note Using more than 1,500 WCUs in a web ACL incurs costs beyond the basic web ACL price. For more information, see Web ACL capacity units (WCUs) in AWS WAF and AWS WAF Pricing. To add a managed rule group to a web ACL through the console 1. Sign in to the AWS Management Console and open the AWS WAF console at https:// console.aws.amazon.com/wafv2/. 2. Choose Web ACLs in the navigation pane. 3. 4. 5. In the Web ACLs page, from the list of web ACLs, select the one that you want to add the rule group to. This takes you to the page for the single web ACL. In your web ACL's page, choose the Rules tab. In the Rules pane, choose Add rules, then choose Add managed rule groups. Using managed rule groups 138 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide 6. 7. In the Add managed rule groups page, expand the selection for your rule group vendor, to see the list of available rule groups. For each rule group that you want to add, choose Add to web ACL. If you want to change the web ACL's conﬁguration for the rule group, choose Edit, make your changes, and then choose Save rule. For information about the options, see the versioning guidance at Using versioned managed rule groups in AWS WAF and the guidance for using a managed rule group in a web ACL at Using managed rule group statements in AWS WAF. 8. At the bottom of the Add managed rule groups page, choose Add rules. 9. In the Set rule priority page, adjust the order that the rules run as needed, then choose Save. For more information, see Setting rule priority in a web ACL. In your web ACL's page, the managed rule groups that you've added are listed under the Rules tab. Test and tune any changes to your AWS WAF protections before you use them for production traﬃc. For information, see Testing and tuning your AWS WAF protections. Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in eﬀect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Getting notiﬁed of new versions and updates to a managed rule group This section explains how to receive Amazon SNS notiﬁcations of new versions and updates. Using managed rule groups 139 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide A managed rule group provider uses SNS notiﬁcations to announce rule group changes, like upcoming new versions and urgent security updates. How to
waf-dg-062	waf-dg.pdf	62	in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Getting notiﬁed of new versions and updates to a managed rule group This section explains how to receive Amazon SNS notiﬁcations of new versions and updates. Using managed rule groups 139 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide A managed rule group provider uses SNS notiﬁcations to announce rule group changes, like upcoming new versions and urgent security updates. How to subscribe to SNS notiﬁcations To subscribe to notiﬁcations for a rule group, you create an Amazon SNS subscription for the rule group's Amazon SNS topic ARN in the US East (N. Virginia) Region us-east-1. For information about how to subscribe, see the Amazon Simple Notiﬁcation Service Developer Guide. Note Create your subscription for the SNS topic only in the us-east-1 Region. The versioned AWS Managed Rules rule groups all use the same SNS topic Amazon Resource Name (ARN). For more information about AWS Managed Rules rule group notiﬁcations, see Deployment notiﬁcations. Where to ﬁnd the Amazon SNS topic ARN for a managed rule group AWS Managed Rules rule groups use a single SNS topic ARN, so you can retrieve the topic ARN from one of the rule groups and subscribe to it to get notiﬁcations for all of the AWS Managed Rules rule groups that provide SNS notiﬁcations. • Console • (Option) When you add the managed rule group to your web ACL, choose Edit to see the rule group's information, which includes the rule group's Amazon SNS topic ARN. • (Option) After you've added the managed rule group into your web ACL, choose Edit on the web ACL, and then select and edit the rule group rule to see the rule group's Amazon SNS topic ARN. • API – DescribeManagedRuleGroup • CLI – aws wafv2 describe-managed-rule-group --scope=<CLOUDFRONT\|REGIONAL> --vendor-name <vendor> --name <managedrule_name> For general information about Amazon SNS notiﬁcation formats and how to ﬁlter the notiﬁcations that you receive, see Parsing message formats and Amazon SNS subscription ﬁlter policies in the Amazon Simple Notiﬁcation Service Developer Guide. Using managed rule groups 140 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Tracking a rule group's version expiration This section explains how to monitor expiration scheduling for a managed rule group through Amazon CloudWatch. If you use a speciﬁc version of a rule group, make sure that you don't keep using a version past its expiration date. Tip Sign up for Amazon SNS notiﬁcations for managed rule groups, and keep current with managed rule group versions. You'll beneﬁt from the most up-to-date protections from the rule group and stay ahead of expiration. For information, see Getting notiﬁed of new versions and updates. To monitor expiration scheduling for a managed rule group through Amazon CloudWatch 1. In CloudWatch, locate the expiry metrics from AWS WAF for your managed rule group. The metrics have the following metric names and dimensions: • Metric name: DaysToExpiry • Metric dimensions: Region, ManagedRuleGroup, Vendor, and Version If you have a managed rule group in your web ACL that's evaluating traﬃc, you will get a metric for it. The metric isn't available for rule groups that you don't use. 2. Set an alarm on the metrics that you're interested in, so that you're notiﬁed in time to switch to a newer version of the rule group. For information about using Amazon CloudWatch metrics and conﬁguring alarms, see the Amazon CloudWatch User Guide. Example managed rule group conﬁgurations in JSON and YAML This section provides example managed rule group conﬁgurations. The API and CLI calls return a list of all rules in the managed rule group that you can reference in the JSON model or through AWS CloudFormation. JSON Using managed rule groups 141 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You can reference and modify managed rule groups within a rule statement using JSON. The following listing shows the AWS Managed Rules rule group, AWSManagedRulesCommonRuleSet, in JSON format. The RuleActionOverrides speciﬁcation lists a rule whose action has been overridden to Count. { "Name": "AWS-AWSManagedRulesCommonRuleSet", "Priority": 0, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesCommonRuleSet", "RuleActionOverrides": [ { "ActionToUse": { "Count": {} }, "Name": "NoUserAgent_HEADER" } ], "ExcludedRules": [] } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesCommonRuleSet" } } YAML Using managed rule groups 142 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You can reference and modify managed rule groups within a rule statement using the AWS CloudFormation YAML template. The following listing shows the AWS Managed Rules rule group, AWSManagedRulesCommonRuleSet, in AWS CloudFormation template. The RuleActionOverrides speciﬁcation lists a rule whose
waf-dg-063	waf-dg.pdf	63	"Name": "AWS-AWSManagedRulesCommonRuleSet", "Priority": 0, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesCommonRuleSet", "RuleActionOverrides": [ { "ActionToUse": { "Count": {} }, "Name": "NoUserAgent_HEADER" } ], "ExcludedRules": [] } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesCommonRuleSet" } } YAML Using managed rule groups 142 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide You can reference and modify managed rule groups within a rule statement using the AWS CloudFormation YAML template. The following listing shows the AWS Managed Rules rule group, AWSManagedRulesCommonRuleSet, in AWS CloudFormation template. The RuleActionOverrides speciﬁcation lists a rule whose action has been overridden to Count. Name: AWS-AWSManagedRulesCommonRuleSet Priority: 0 Statement: ManagedRuleGroupStatement: VendorName: AWS Name: AWSManagedRulesCommonRuleSet RuleActionOverrides: - ActionToUse: Count: {} Name: NoUserAgent_HEADER ExcludedRules: [] OverrideAction: None: {} VisibilityConfig: SampledRequestsEnabled: true CloudWatchMetricsEnabled: true MetricName: AWS-AWSManagedRulesCommonRuleSet AWS Managed Rules for AWS WAF This section explains what AWS Managed Rules for AWS WAF is. AWS Managed Rules for AWS WAF is a managed service that provides protection against application vulnerabilities or other unwanted traﬃc. You have the option of selecting one or more rule groups from AWS Managed Rules for each web ACL, up to the maximum web ACL capacity unit (WCU) limit. Mitigating false positives and testing rule group changes Before using any managed rule group in production, test it in a non-production environment according to the guidance at Testing and tuning your AWS WAF protections. Follow the testing and tuning guidance when you add a rule group to your web ACL, to test a new version of a rule group, and whenever a rule group isn't handling your web traﬃc as you need it to. Shared security responsibilities Using managed rule groups 143 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS Managed Rules are designed to protect you from common web threats. When used in accordance with the documentation, AWS Managed Rules rule groups add another layer of security for your applications. However, AWS Managed Rules rule groups aren't intended as a replacement for your security responsibilities, which are determined by the AWS resources that you select. Refer to the Shared Responsibility Model to ensure that your resources in AWS are properly protected. Important AWS Managed Rules are designed to protect you from common web threats. When used in accordance with the documentation, AWS Managed Rules rule groups add another layer of security for your applications. However, AWS Managed Rules rule groups aren't intended as a replacement for your security responsibilities, which are determined by the AWS resources that you select. Refer to the Shared Responsibility Model to ensure that your resources in AWS are properly protected. AWS Managed Rules rule groups list This section provides a list of available AWS Managed Rules rule groups. This section describes the most recent versions of the AWS Managed Rules rule groups. You see these on the console when you add a managed rule group to your web ACL. Through the API, you can retrieve this list along with the AWS Marketplace rule groups that you're subscribed to by calling ListAvailableManagedRuleGroups. Note For information about retrieving an AWS Managed Rules rule group's versions, see Retrieving the available versions for a managed rule group. All AWS Managed Rules rule groups support labeling, and the rule listings in this section include label speciﬁcations. You can retrieve the labels for a managed rule group through the API by calling DescribeManagedRuleGroup. The labels are listed in the AvailableLabels property in the response. For information about labeling, see Web request labeling in AWS WAF. Test and tune any changes to your AWS WAF protections before you use them for production traﬃc. For information, see Testing and tuning your AWS WAF protections. Using managed rule groups 144 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide AWS Managed Rules rule groups • Baseline rule groups • Core rule set (CRS) managed rule group • Admin protection managed rule group • Known bad inputs managed rule group • Use-case speciﬁc rule groups • SQL database managed rule group • Linux operating system managed rule group • POSIX operating system managed rule group • Windows operating system managed rule group • PHP application managed rule group • WordPress application managed rule group • IP reputation rule groups • Amazon IP reputation list managed rule group • Anonymous IP list managed rule group • AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group • Considerations for using this rule group • Labels added by this rule group • Token labels • ACFP labels • Account creation fraud prevention rules listing • AWS WAF Fraud Control account takeover prevention (ATP) rule group • Considerations for using this rule group • Labels added by this rule group • Token labels • ATP labels • Account takeover
waf-dg-064	waf-dg.pdf	64	group • WordPress application managed rule group • IP reputation rule groups • Amazon IP reputation list managed rule group • Anonymous IP list managed rule group • AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group • Considerations for using this rule group • Labels added by this rule group • Token labels • ACFP labels • Account creation fraud prevention rules listing • AWS WAF Fraud Control account takeover prevention (ATP) rule group • Considerations for using this rule group • Labels added by this rule group • Token labels • ATP labels • Account takeover prevention rules listing • AWS WAF Bot Control rule group • Protection levels Using managed rule groups • Considerations for using this rule group 145 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Labels added by this rule group • Token labels • Bot Control labels • Bot Control rules listing Baseline rule groups Baseline managed rule groups provide general protection against a wide variety of common threats. Choose one or more of these rule groups to establish baseline protection for your resources. Core rule set (CRS) managed rule group VendorName: AWS, Name: AWSManagedRulesCommonRuleSet, WCU: 700 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The core rule set (CRS) rule group contains rules that are generally applicable to web applications. This provides protection against exploitation of a wide range of vulnerabilities, including some of the high risk and commonly occurring vulnerabilities described in OWASP publications such as OWASP Top 10. Consider using this rule group for any AWS WAF use case. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Using managed rule groups 146 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label NoUserAgent_HEADER UserAgent_BadBots_HEADER SizeRestrictions_QUERYSTRING SizeRestrictions_Cookie_HEADER Inspects for requests that are missing the HTTP User-Agent header. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:NoUserAgent_Header Inspects for common User-Agent header values that indicate that the request is a bad bot. Example patterns include nessus, and nmap. For bot management, see also AWS WAF Bot Control rule group. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:BadBots_Header Inspects for URI query strings that are over 2,048 bytes. Rule action: Block Label: awswaf:managed:aws:core- rule-set:SizeRestrictions_Quer yString Inspects for cookie headers that are over 10,240 bytes. Rule action: Block Using managed rule groups 147 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SizeRestrictions_BODY SizeRestrictions_URIPATH Label: awswaf:managed:aws:core- rule-set:SizeRestrictions_Cook ie_Header Inspects for request bodies that are over 8 KB (8,192 bytes). Rule action: Block Label: awswaf:managed:aws:core-rul e-set:SizeRestrictions_Body Inspects for URI paths that are over 1,024 bytes. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:SizeRestrictions_URIPath Using managed rule groups 148 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label EC2MetaDataSSRF_BODY Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request body. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:EC2MetaDataSSRF_Body Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request cookie. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:EC2MetaDataSSRF_Cookie EC2MetaDataSSRF_COOKIE Using managed rule groups 149 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label EC2MetaDataSSRF_URIPATH EC2MetaDataSSRF_QUERYARGUMENTS GenericLFI_QUERYARGUMENTS Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request URI path. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:EC2MetaDataSSRF_URIPath Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request query arguments. Rule action: Block Label: awswaf:managed:aws:core- rule-set:EC2MetaDataSSRF_Query Arguments Inspects for the presence of Local File Inclusion (LFI) exploits in the query arguments . Examples include path traversal attempts
waf-dg-065	waf-dg.pdf	65	attempts to exﬁltrate Amazon EC2 metadata from the request cookie. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:EC2MetaDataSSRF_Cookie EC2MetaDataSSRF_COOKIE Using managed rule groups 149 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label EC2MetaDataSSRF_URIPATH EC2MetaDataSSRF_QUERYARGUMENTS GenericLFI_QUERYARGUMENTS Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request URI path. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:EC2MetaDataSSRF_URIPath Inspects for attempts to exﬁltrate Amazon EC2 metadata from the request query arguments. Rule action: Block Label: awswaf:managed:aws:core- rule-set:EC2MetaDataSSRF_Query Arguments Inspects for the presence of Local File Inclusion (LFI) exploits in the query arguments . Examples include path traversal attempts using techniques like ../../. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericLFI_QueryArguments Using managed rule groups 150 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label GenericLFI_URIPATH Inspects for the presence of Local File Inclusion (LFI) exploits in the URI path. Examples include path traversal attempts using techniques like ../../. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericLFI_URIPath Using managed rule groups 151 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label GenericLFI_BODY Inspects for the presence of Local File Inclusion (LFI) exploits in the request body. Examples include path traversal attempts using techniques like ../../. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericLFI_Body Using managed rule groups 152 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label RestrictedExtensions_URIPATH RestrictedExtensions_QUERYA RGUMENTS GenericRFI_QUERYARGUMENTS Inspects for requests whose URI paths contain system ﬁle extensions that are unsafe to read or run. Example patterns include extensions like .log and .ini. Rule action: Block Label: awswaf:managed:aws:core- rule-set:RestrictedExtensions_ URIPath Inspects for requests whose query arguments contain system ﬁle extensions that are un safe to read or run. Example patterns include extensions like .log and .ini. Rule action: Block Label: awswaf:managed:aws:core- rule-set:RestrictedExtensions_ QueryArguments Inspects the values of all query parameter s for attempts to exploit RFI (Remote File Inclusion) in web applications by embedding URLs that contain IPv4 addresses. Examples include patterns like http://, https://, ftp://, ftps://, and file://, with an IPv4 host header in the exploit attempt. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericRFI_QueryArguments Using managed rule groups 153 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label GenericRFI_BODY Inspects the request body for attempts to exploit RFI (Remote File Inclusion) in web applications by embedding URLs that contain IPv4 addresses. Examples include patterns like http://, https://, ftp://, ftps://, and file://, with an IPv4 host header in the exploit attempt. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericRFI_Body Using managed rule groups 154 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label GenericRFI_URIPATH CrossSiteScripting_COOKIE Inspects the URI path for attempts to exploit RFI (Remote File Inclusion) in web applicati ons by embedding URLs that contain IPv4 addresses. Examples include patterns like http://, https://, ftp://, ftps://, and file://, with an IPv4 host header in the exploit attempt. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:GenericRFI_URIPath Inspects the values of cookie headers for common cross-site scripting (XSS) patterns using the built-in AWS WAF Cross-site scripting attack rule statement. Example patterns include scripts like <script>a lert("hello")</script> . Note The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:CrossSiteScripting_Cookie Using managed rule groups 155 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label CrossSiteScripting_QUERYARG UMENTS Inspects the values of query arguments for common cross-site scripting (XSS) patterns using the built-in AWS WAF Cross-site scripting attack rule statement. Example patterns include scripts like <script>a lert("hello")</script> . Note The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Rule action:
waf-dg-066	waf-dg.pdf	66	The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Rule action: Block Label: awswaf:managed:aws:core-rul e-set:CrossSiteScripting_Cookie Using managed rule groups 155 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label CrossSiteScripting_QUERYARG UMENTS Inspects the values of query arguments for common cross-site scripting (XSS) patterns using the built-in AWS WAF Cross-site scripting attack rule statement. Example patterns include scripts like <script>a lert("hello")</script> . Note The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Rule action: Block Label: awswaf:managed:aws:core- rule-set:CrossSiteScripting_Qu eryArguments Using managed rule groups 156 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label CrossSiteScripting_BODY Inspects the request body for common cross- site scripting (XSS) patterns using the built- in AWS WAF Cross-site scripting attack rule statement. Example patterns include scripts like <script>alert("hello")</scr ipt> . Note The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Using managed rule groups 157 Rule action: Block AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label CrossSiteScripting_URIPATH Label: awswaf:managed:aws:core-rul e-set:CrossSiteScripting_Body Inspects the value of the URI path for common cross-site scripting (XSS) patterns using the built-in AWS WAF Cross-site scripting attack rule statement. Example patterns include scripts like <script>a lert("hello")</script> . Note The rule match details in the AWS WAF logs is not populated for version 2.0 of this rule group. Rule action: Block Label: awswaf:managed:aws:core- rule-set:CrossSiteScripting_UR IPath Admin protection managed rule group VendorName: AWS, Name: AWSManagedRulesAdminProtectionRuleSet, WCU: 100 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. Using managed rule groups 158 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you need more information than you ﬁnd here, contact the AWS Support Center. The Admin protection rule group contains rules that allow you to block external access to exposed administrative pages. This might be useful if you run third-party software or want to reduce the risk of a malicious actor gaining administrative access to your application. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label AdminProtection_URIPATH Inspects for URI paths that are generally reserved for administration of a web server or application. Example patterns include sqlmanager . Rule action: Block Label: awswaf:managed:aws:admin- protection:AdminProtection_UR IPath Known bad inputs managed rule group VendorName: AWS, Name: AWSManagedRulesKnownBadInputsRuleSet, WCU: 200 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. Using managed rule groups 159 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you need more information than you ﬁnd here, contact the AWS Support Center. The Known bad inputs rule group contains rules to block request patterns that are known to be invalid and are associated with exploitation or discovery of vulnerabilities. This can help reduce the risk of a malicious actor discovering a vulnerable application. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For
waf-dg-067	waf-dg.pdf	67	and AWS Shield Advanced Developer Guide If you need more information than you ﬁnd here, contact the AWS Support Center. The Known bad inputs rule group contains rules to block request patterns that are known to be invalid and are associated with exploitation or discovery of vulnerabilities. This can help reduce the risk of a malicious actor discovering a vulnerable application. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label JavaDeserializationRCE_HEADER Inspects the keys and values of HTTP request headers for patterns indicating Java deseriali zation Remote Command Execution (RCE) attempts, such as the Spring Core and Cloud Function RCE vulnerabilities (CVE-202 2-22963, CVE-2022-22965). Example patterns include (java.lang.Runtime . ).getRuntime().exec("whoami") Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Using managed rule groups 160 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Label: awswaf:managed:aws:known- bad-inputs:JavaDeserializatio nRCE_Header Using managed rule groups 161 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label JavaDeserializationRCE_BODY Inspects the request body for patterns indicating Java deserialization Remote Command Execution (RCE) attempts, such as the Spring Core and Cloud Function RCE vulnerabilities (CVE-2022-22963, CVE-2022-22965). Example patterns include (java.lang.Runtime).getRunt ime().exec("whoami") . Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:known- bad-inputs:JavaDeserializatio nRCE_Body Using managed rule groups 162 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label JavaDeserializationRCE_URIPATH JavaDeserializationRCE_QUER YSTRING Inspects the request URI for patterns indicatin g Java deserialization Remote Command Execution (RCE) attempts, such as the Spring Core and Cloud Function RCE vulnerabi lities (CVE-2022-22963, CVE-2022-22965). Example patterns include (java.lan g.Runtime).getRuntime().exe c("whoami") . Rule action: Block Label: awswaf:managed:aws:known- bad-inputs:JavaDeserializatio nRCE_URIPath Inspects the request query string for patterns indicating Java deserialization Remote Command Execution (RCE) attempts, such as the Spring Core and Cloud Function RCE vulnerabilities (CVE-2022-22963, CVE-2022-22965). Example patterns include (java.lang.Runtime).getRunt ime().exec("whoami") . Rule action: Block Label: awswaf:managed:aws:known- bad-inputs:JavaDeserializatio nRCE_QueryString Using managed rule groups 163 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Host_localhost_HEADER PROPFIND_METHOD ExploitablePaths_URIPATH Inspects the host header in the request for pa tterns indicating localhost. Example patterns include localhost . Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Host_Localhost_Header Inspects the HTTP method in the request for PROPFIND, which is a method similar to HEAD, but with the extra intention to exﬁltrat e XML objects. Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Propfind_Method Inspects the URI path for attempts to access exploitable web application paths. Example patterns include paths like web-inf. Rule action: Block Label: awswaf:managed:aws:known- bad-inputs:ExploitablePaths_U RIPath Using managed rule groups 164 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Log4JRCE_HEADER Inspects the keys and values of request headers for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021- 45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Log4JRCE_Header Using managed rule groups 165 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Log4JRCE_QUERYSTRING Inspects the query string for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Log4JRCE_QueryString Using managed rule groups 166 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Log4JRCE_BODY Description and label Inspects the body for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Warning
waf-dg-068	waf-dg.pdf	68	165 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Log4JRCE_QUERYSTRING Inspects the query string for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Log4JRCE_QueryString Using managed rule groups 166 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Log4JRCE_BODY Description and label Inspects the body for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Log4JRCE_Body Using managed rule groups 167 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Log4JRCE_URIPATH Inspects the URI path for the presence of the Log4j vulnerability (CVE-2021-44228, CVE-2021-45046, CVE-2021-45105) and protects against Remote Code Execution (RCE) attempts. Example patterns include ${jndi:ldap://example.com/} . Rule action: Block Label: awswaf:managed:aws:known-ba d-inputs:Log4JRCE_URIPath Use-case speciﬁc rule groups Use-case speciﬁc rule groups provide incremental protection for many diverse AWS WAF use cases. Choose the rule groups that apply to your application. SQL database managed rule group VendorName: AWS, Name: AWSManagedRulesSQLiRuleSet, WCU: 200 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The SQL database rule group contains rules to block request patterns associated with exploitation of SQL databases, like SQL injection attacks. This can help prevent remote injection of unauthorized queries. Evaluate this rule group for use if your application interfaces with an SQL database. Using managed rule groups 168 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label SQLi_QUERYARGUMENTS SQLiExtendedPatterns_QUERYA RGUMENTS SQLi_BODY Uses the built-in AWS WAF SQL injection attack rule statement, with sensitivity level set to Low, to inspect the values of all query parameters for patterns that match malicious SQL code. Rule action: Block Label: awswaf:managed:aws:sql-data base:SQLi_QueryArguments Inspects the values of all query parameters for patterns that match malicious SQL code. The patterns this rule inspects for aren't covered by the rule SQLi_QUERYARGUMENT S . Rule action: Block Label: awswaf:managed:aws:sql- database:SQLiExtendedPatterns_Q ueryArguments Uses the built-in AWS WAF SQL injection attack rule statement, with sensitivity level set to Low, to inspect the request body for pa tterns that match malicious SQL code. Using managed rule groups 169 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:sql-data base:SQLi_Body Using managed rule groups 170 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SQLiExtendedPatterns_BODY Inspects the request body for patterns that match malicious SQL code. The patterns this rule inspects for aren't covered by the rule SQLi_BODY . Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront,
waf-dg-069	waf-dg.pdf	69	For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:sql-data base:SQLi_Body Using managed rule groups 170 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SQLiExtendedPatterns_BODY Inspects the request body for patterns that match malicious SQL code. The patterns this rule inspects for aren't covered by the rule SQLi_BODY . Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:sql-data base:SQLiExtendedPatterns_Body Using managed rule groups 171 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name SQLi_COOKIE Description and label Uses the built-in AWS WAF SQL injection attack rule statement, with sensitivity level set to Low, to inspect the request cookie headers for patterns that match malicious SQL code. Rule action: Block Label: awswaf:managed:aws:sql-data base:SQLi_Cookie Linux operating system managed rule group VendorName: AWS, Name: AWSManagedRulesLinuxRuleSet, WCU: 200 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The Linux operating system rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to Linux, including Linux-speciﬁc Local File Inclusion (LFI) attacks. This can help prevent attacks that expose ﬁle contents or run code for which the attacker should not have had access. You should evaluate this rule group if any part of your application runs on Linux. You should use this rule group in conjunction with the POSIX operating system rule group. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon Using managed rule groups 172 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name LFI_URIPATH LFI_QUERYSTRING LFI_HEADER Description and label Inspects the request path for attempts to exploit Local File Inclusion (LFI) vulnerabi lities in web applications. Example patterns include ﬁles like /proc/version , which could provide operating system information to attackers. Rule action: Block Label: awswaf:managed:aws:linux-os :LFI_URIPath Inspects the values of querystring for attempts to exploit Local File Inclusion (LFI) vulnerabilities in web applications. Example patterns include ﬁles like /proc/version , which could provide operating system information to attackers. Rule action: Block Label: awswaf:managed:aws:linux-os :LFI_QueryString Inspects request headers for attempts to exploit Local File Inclusion (LFI) vulnerabi lities in web applications. Example pattern s include ﬁles like /proc/version , which could provide operating system information to attackers. Using managed rule groups 173 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:linux-os :LFI_Header POSIX operating system managed rule group VendorName: AWS, Name: AWSManagedRulesUnixRuleSet, WCU: 100 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The POSIX operating system rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to POSIX and POSIX-like operating systems, including Local File Inclusion (LFI) attacks. This can help prevent attacks that expose ﬁle contents or run code
waf-dg-070	waf-dg.pdf	70	the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The POSIX operating system rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to POSIX and POSIX-like operating systems, including Local File Inclusion (LFI) attacks. This can help prevent attacks that expose ﬁle contents or run code for which the attacker should not have had access. You should evaluate this rule group if any part Using managed rule groups 174 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide of your application runs on a POSIX or POSIX-like operating system, including Linux, AIX, HP-UX, macOS, Solaris, FreeBSD, and OpenBSD. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label UNIXShellCommandsVariables_ QUERYSTRING UNIXShellCommandsVariables_BODY Inspects the values of the query string for at tempts to exploit command injection, LFI, and path traversal vulnerabilities in web applicati ons that run on Unix systems. Examples include patterns like echo $HOME and echo $PATH . Rule action: Block Label: awswaf:managed:aws:posix- os:UNIXShellCommandsVariables _QueryString Inspects the request body for attempts to exploit command injection, LFI, and path traversal vulnerabilities in web applications that run on Unix systems. Examples include patterns like echo $HOME and echo $PATH. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. Using managed rule groups 175 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:posix- os:UNIXShellCommandsVariables _Body Using managed rule groups 176 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label UNIXShellCommandsVariables_ HEADER Inspects all request headers for attempts to exploit command injection, LFI, and path traversal vulnerabilities in web applications that run on Unix systems. Examples include patterns like echo $HOME and echo $PATH. Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:posix- os:UNIXShellCommandsVariables _Header Windows operating system managed rule group VendorName: AWS, Name: AWSManagedRulesWindowsRuleSet, WCU: 200 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. Using managed rule groups 177 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The Windows operating system rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to Windows, like remote execution of PowerShell commands. This can help prevent exploitation of vulnerabilities that permit an attacker to run unauthorized commands or run malicious code. Evaluate this rule group if any part of your application runs on a Windows operating system. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label WindowsShellCommands_COOKIE WindowsShellCommands_QUERYA RGUMENTS Inspects the request cookie headers for WindowsShell command injection attempts in web applications. The match patterns represent WindowsShell commands. Example patterns include \|\|nslookup and ;cmd. Rule action: Block Label: awswaf:managed:aws:windows- os:WindowsShellCommands_Cookie Inspects the values of all query parameter s for
waf-dg-071	waf-dg.pdf	71	group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label WindowsShellCommands_COOKIE WindowsShellCommands_QUERYA RGUMENTS Inspects the request cookie headers for WindowsShell command injection attempts in web applications. The match patterns represent WindowsShell commands. Example patterns include \|\|nslookup and ;cmd. Rule action: Block Label: awswaf:managed:aws:windows- os:WindowsShellCommands_Cookie Inspects the values of all query parameter s for WindowsShell command injection attempts in web applications. The match patterns represent WindowsShell commands. Example patterns include \|\|nslookup and ;cmd. Using managed rule groups 178 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Rule action: Block WindowsShellCommands_BODY Label: awswaf:managed:aws:windows- os:WindowsShellCommands_Que ryArguments Inspects the request body for WindowsSh ell command injection attempts in web applications. The match patterns represent WindowsShell commands. Example patterns include \|\|nslookup and ;cmd. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:windows- os:WindowsShellCommands_Body Using managed rule groups 179 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label PowerShellCommands_COOKIE PowerShellCommands_QUERYARG UMENTS Inspects the request cookie headers for PowerShell command injection attempts in web applications. The match patterns represent PowerShell commands. For example, Invoke-Expression . Rule action: Block Label: awswaf:managed:aws:windows- os:PowerShellCommands_Cookie Inspects the values of all query parameters for PowerShell command injection attempts in web applications. The match patterns represent PowerShell commands. For example, Invoke-Expression . Rule action: Block Label: awswaf:managed:aws:windows- os:PowerShellCommands_Query Arguments Using managed rule groups 180 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label PowerShellCommands_BODY Inspects the request body for PowerShell command injection attempts in web applicati ons. The match patterns represent PowerShel l commands. For example, Invoke-Ex pression . Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:windows- os:PowerShellCommands_Body PHP application managed rule group VendorName: AWS, Name: AWSManagedRulesPHPRuleSet, WCU: 100 Using managed rule groups 181 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The PHP application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to the use of the PHP programming language, including injection of unsafe PHP functions. This can help prevent exploitation of vulnerabilities that permit an attacker to remotely run code or commands for which they are not authorized. Evaluate this rule group if PHP is installed on any server with which your application interfaces. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label PHPHighRiskMethodsVariables _HEADER Inspects all headers for PHP script code injection attempts. Example patterns includ e functions like fsockopen and the $_GET superglobal variable. Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For Using
waf-dg-072	waf-dg.pdf	72	that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label PHPHighRiskMethodsVariables _HEADER Inspects all headers for PHP script code injection attempts. Example patterns includ e functions like fsockopen and the $_GET superglobal variable. Warning This rule only inspects the ﬁrst 8 KB of the request headers or the ﬁrst 200 headers, whichever limit is reached ﬁrst, and it uses the Continue option for oversize content handling. For Using managed rule groups 182 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label PHPHighRiskMethodsVariables _QUERYSTRING more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:php- app:PHPHighRiskMethodsVariables _Header Inspects everything after the ﬁrst ? in the request URL, looking for PHP script code injection attempts. Example patterns includ e functions like fsockopen and the $_GET superglobal variable. Rule action: Block Label: awswaf:managed:aws:php- app:PHPHighRiskMethodsVariables _QueryString Using managed rule groups 183 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label PHPHighRiskMethodsVariables_BODY Inspects the values of the request body for PHP script code injection attempts. Example patterns include functions like fsockopen and the $_GET superglobal variable. Warning This rule only inspects the request body up to the body size limit for the web ACL and resource type. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB. For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB and you can increase the limit up to 64 KB in your web ACL conﬁguration. This rule uses the Continue option for oversize content handling. For more information, see Oversize web request components in AWS WAF. Rule action: Block Label: awswaf:managed:aws:php- app:PHPHighRiskMethodsVariables _Body WordPress application managed rule group VendorName: AWS, Name: AWSManagedRulesWordPressRuleSet, WCU: 100 Using managed rule groups 184 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The WordPress application rule group contains rules that block request patterns associated with the exploitation of vulnerabilities speciﬁc to WordPress sites. You should evaluate this rule group if you are running WordPress. This rule group should be used in conjunction with the SQL database and PHP application rule groups. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label WordPressExploitableCommand s_QUERYSTRING Inspects the request query string for high risk WordPress commands that can be exploited in vulnerable installations or plugins. Examples patterns include commands like do-reset-wordpress . Rule action: Block Label: awswaf:managed:aws:wordpres s-app:WordPressExploitableC ommands_QUERYSTRING WordPressExploitablePaths_U RIPATH Using managed rule groups 185 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Inspects the request URI path for WordPress ﬁles like xmlrpc.php , which are known to have easily exploitable vulnerabilities. Rule action: Block Label: awswaf:managed:aws:wordpres s-app:WordPressExploitableP aths_URIPATH IP reputation rule groups IP reputation rule groups block requests based on their source IP address. Note These rules use the source IP address from the web request origin. If you have traﬃc that goes through one or more proxies or load balancers, the web request origin will contain the address of the last proxy, and not the originating address of the client. Choose one or more of these rule groups if you want to reduce your exposure to bot traﬃc or exploitation attempts, or if you are enforcing geographic restrictions on your content. For bot management, see also AWS WAF Bot Control rule group. The rule groups in this category don't provide versioning or SNS update notiﬁcations. Amazon IP reputation list managed rule group VendorName: AWS, Name: AWSManagedRulesAmazonIpReputationList, WCU: 25 Note The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you
waf-dg-073	waf-dg.pdf	73	want to reduce your exposure to bot traﬃc or exploitation attempts, or if you are enforcing geographic restrictions on your content. For bot management, see also AWS WAF Bot Control rule group. The rule groups in this category don't provide versioning or SNS update notiﬁcations. Amazon IP reputation list managed rule group VendorName: AWS, Name: AWSManagedRulesAmazonIpReputationList, WCU: 25 Note The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Using managed rule groups 186 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The Amazon IP reputation list rule group contains rules that are based on Amazon internal threat intelligence. This is useful if you would like to block IP addresses typically associated with bots or other threats. Blocking these IP addresses can help mitigate bots and reduce the risk of a malicious actor discovering a vulnerable application. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label AWSManagedIPReputationList AWSManagedReconnaissanceList Inspects for IP addresses that have been identiﬁed as actively engaging in malicious activities. AWS WAF collects the IP address list from various sources, including MadPot, a threat intelligence tool that Amazon uses to protect customers from cybercrime. For more information about MadPot, see https:// www.aboutamazon.com/news/aws/amazon- madpot-stops-cybersecurity-crime. Rule action: Block Label: awswaf:managed:aws:amazon- ip-list:AWSManagedIPReputati onList Inspects for connections from IP addresses that are performing reconnaissance against AWS resources. Rule action: Block Label: awswaf:managed:aws:amazon- ip-list:AWSManagedReconnaiss anceList Using managed rule groups 187 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label AWSManagedIPDDoSList Inspects for IP addresses that have been identiﬁed as actively engaging in DDoS activities. Rule action: Count Label: awswaf:managed:aws:amazon-i p-list:AWSManagedIPDDoSList Anonymous IP list managed rule group VendorName: AWS, Name: AWSManagedRulesAnonymousIpList, WCU: 50 Note The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The Anonymous IP list rule group contains rules to block requests from services that permit the obfuscation of viewer identity. These include requests from VPNs, proxies, Tor nodes, and web hosting providers. This rule group is useful if you want to ﬁlter out viewers that might be trying to hide their identity from your application. Blocking the IP addresses of these services can help mitigate bots and evasion of geographic restrictions. This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Rule name Description and label AnonymousIPList Using managed rule groups 188 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label HostingProviderIPList Inspects for a list of IP addresses of sources known to anonymize client information, like TOR nodes, temporary proxies, and other masking services. Rule action: Block Label: awswaf:managed:aws:anonymou s-ip-list:AnonymousIPList Inspects for a list of IP addresses from web hosting and cloud providers, which are less likely to source end-user traﬃc. The IP list does not include AWS IP addresses. Rule action: Block Label: awswaf:managed:aws:anonymou s-ip-list:HostingProviderIPList AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group This section explains what the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group does. VendorName: AWS, Name: AWSManagedRulesACFPRuleSet, WCU: 50 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Using managed rule groups 189 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule
waf-dg-074	waf-dg.pdf	74	in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Using managed rule groups 189 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group labels and manages requests that might be part of fraudulent account creation attempts. The rule group does this by inspecting account creation requests that clients send to your application's registration and account creation endpoints. The ACFP rule group inspects account creation attempts in various ways, to give you visibility and control over potentially malicious interactions. The rule group uses request tokens to gather information about the client browser and about the level of human interactivity in the creation of the account creation request. The rule group detects and manages bulk account creation attempts by aggregating requests by IP address and client session, and aggregating by the provided account information such as the physical address and phone number. Additionally, the rule group detects and blocks the creation of new accounts using credentials that have been compromised, which helps protect the security posture of your application and of your new users. Considerations for using this rule group This rule group requires custom conﬁguration, which includes the speciﬁcation of your application's account registration and account creation paths. Except where noted, the rules in this rule group inspect all requests that your clients send to these two endpoints. To conﬁgure and implement this rule group, see the guidance at AWS WAF Fraud Control account creation fraud prevention (ACFP). Note You are charged additional fees when you use this managed rule group. For more information, see AWS WAF Pricing. This rule group is part of the intelligent threat mitigation protections in AWS WAF. For information, see Intelligent threat mitigation in AWS WAF. To keep your costs down and to be sure you're managing your web traﬃc as you want, use this rule group in accordance with the guidance at Best practices for intelligent threat mitigation in AWS WAF. This rule group isn't available for use with Amazon Cognito user pools. You can't associate a web ACL that uses this rule group with a user pool, and you can't add this rule group to a web ACL that's already associated with a user pool. Using managed rule groups 190 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Labels added by this rule group This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Token labels This rule group uses AWS WAF token management to inspect and label web requests according to the status of their AWS WAF tokens. AWS WAF uses tokens for client session tracking and veriﬁcation. For information about tokens and token management, see Token use in AWS WAF intelligent threat mitigation. For information about the label components described here, see Label syntax and naming requirements in AWS WAF. Client session label The label awswaf:managed:token:id:identifier contains a unique identiﬁer that AWS WAF token management uses to identify the client session. The identiﬁer can change if the client acquires a new token, for example after discarding the token it was using. Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Browser ﬁngerprint label The label awswaf:managed:token:fingerprint:fingerprint-identifier contains a robust browser ﬁngerprint identiﬁer that AWS WAF token management computes from various client browser signals. This identiﬁer stays the same across multiple token acquisition attempts. The ﬁngerprint identiﬁer is not unique to a single client. Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Using managed rule groups 191 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Token status labels: Label namespace preﬁxes Token status labels report on the status of the token and of the challenge and CAPTCHA information that it contains. Each token status label begins with one of the following namespace preﬁxes: • awswaf:managed:token: – Used to report the general status of the token and to report on the status of the token's challenge information. • awswaf:managed:captcha: – Used to report on the status of the token's CAPTCHA information. Token status labels: Label names Following the preﬁx, the rest of the label provides detailed token status information: •
waf-dg-075	waf-dg.pdf	75	and AWS Shield Advanced Developer Guide Token status labels: Label namespace preﬁxes Token status labels report on the status of the token and of the challenge and CAPTCHA information that it contains. Each token status label begins with one of the following namespace preﬁxes: • awswaf:managed:token: – Used to report the general status of the token and to report on the status of the token's challenge information. • awswaf:managed:captcha: – Used to report on the status of the token's CAPTCHA information. Token status labels: Label names Following the preﬁx, the rest of the label provides detailed token status information: • accepted – The request token is present and contains the following: • A valid challenge or CAPTCHA solution. • An unexpired challenge or CAPTCHA timestamp. • A domain speciﬁcation that's valid for the web ACL. Example: The label awswaf:managed:token:accepted indicates that the web requests's token has a valid challenge solution, an unexpired challenge timestamp, and a valid domain. • rejected – The request token is present but doesn't meet the acceptance criteria. Along with the rejected label, token management adds a custom label namespace and name to indicate the reason. • rejected:not_solved – The token is missing the challenge or CAPTCHA solution. • rejected:expired – The token's challenge or CAPTCHA timestamp has expired, according to your web ACL's conﬁgured token immunity times. • rejected:domain_mismatch – The token's domain isn't a match for your web ACL's token domain conﬁguration. • rejected:invalid – AWS WAF couldn't read the indicated token. Example: The labels awswaf:managed:captcha:rejected and awswaf:managed:captcha:rejected:expired together indicate that the request didn't Using managed rule groups 192 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide have a valid CAPTCHA solve because the CAPTCHA timestamp in the token has exceeded the CAPTCHA token immunity time that's conﬁgured in the web ACL. • absent – The request doesn't have the token or the token manager couldn't read it. Example: The label awswaf:managed:captcha:absent indicates that the request doesn't have the token. ACFP labels This rule group generates labels with the namespace preﬁx awswaf:managed:aws:acfp: followed by the custom namespace and label name. The rule group might add more than one label to a request. You can retrieve all labels for a rule group through the API by calling DescribeManagedRuleGroup. The labels are listed in the AvailableLabels property in the response. Account creation fraud prevention rules listing This section lists the ACFP rules in AWSManagedRulesACFPRuleSet and the labels that the rule group's rules add to web requests. All of the rules in this rule group require a web request token, except for the ﬁrst two UnsupportedCognitoIDP and AllRequests. For a description of the information that the token provides, see AWS WAF token characteristics. Except where noted, the rules in this rule group inspect all requests that your clients send to the account registration and account creation page paths that you provide in the rule group conﬁguration. For information about conﬁguring this rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP). Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. Using managed rule groups 193 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you need more information than you ﬁnd here, contact the AWS Support Center. Rule name Description and label UnsupportedCognitoIDP AllRequests Inspects for web traﬃc going to an Amazon Cognito user pool. ACFP isn't available for use with Amazon Cognito user pools, and this rule helps to ensure that the other ACFP rule group rules are not used to evaluate user pool traﬃc. Rule action: Block Labels: awswaf:managed:aws :acfp:unsupported:cognito_idp and awswaf:managed:aws:acfp:Uns upportedCognitoIDP Applies the rule action to requests that access the registration page path. You conﬁgure the registration page path when you conﬁgure the rule group. By default, this rule applies the Challenge to requests. By applying this action, the rule ensures that the client acquires a challenge token before any requests are evaluated by the rest of the rules in the rule group. Ensure that your end users load the registrat ion page path before they submit an account creation request. Tokens are added to requests by the client application integration SDKs and by the rule actions CAPTCHA and Challenge. For the Using managed rule groups 194 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label most eﬃcient token acquisition, we highly recommend that you use the application integration SDKs.
waf-dg-076	waf-dg.pdf	76	action, the rule ensures that the client acquires a challenge token before any requests are evaluated by the rest of the rules in the rule group. Ensure that your end users load the registrat ion page path before they submit an account creation request. Tokens are added to requests by the client application integration SDKs and by the rule actions CAPTCHA and Challenge. For the Using managed rule groups 194 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label most eﬃcient token acquisition, we highly recommend that you use the application integration SDKs. For more information, see Client application integrations in AWS WAF. Rule action: Challenge Labels: None Using managed rule groups 195 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name RiskScoreHigh Description and label Inspects for account creation requests with IP addresses or other factors that are considere d to be highly suspicious. This evaluation is usually based on multiple contributing factors, which you can see in risk_scor e labels that the rule group adds to the request. Rule action: Block Labels: awswaf:managed:aws:acfp:ris k_score:high and awswaf:ma naged:aws:acfp:RiskScoreHigh The rule might also apply medium or low risk score labels to the request. If AWS WAF doesn't succeed at evaluating the risk score for the web request, the rule adds the label awswaf:managed:aws :acfp:risk_score:evaluation _failed Additionally, the rule adds labels with the namespace awswaf:managed:aws :acfp:risk_score:contributor: that include risk score evaluation status and results for speciﬁc risk score contributors, such as IP reputation and stolen credentials evaluations. Using managed rule groups 196 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SignalCredentialCompromised Searches the stolen credential database for the credentials that were submitted in the account creation request. This rule ensures that new clients initialize their accounts with positive security posture. Note You can add a custom blocking response, to describe the problem to your end user and tell them how to proceed. For information, see ACFP example: Custom response for compromised credentials. Rule action: Block Labels: awswaf:managed:aws:acfp:sig nal:credential_compromised and awswaf:managed:aws:acfp:Sig nalCredentialCompromised The rule group applies the following related label, but takes no action on it, because not all requests in account creation will have credentials: awswaf:managed:aws :acfp:signal:missing_credential Using managed rule groups 197 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SignalClientHumanInteractiv ityAbsentLow Inspects the account creation request's token for data that indicates abnormal human interactivity with the application. Human interactivity is detected through interactions such as mouse movements and key presses. If the page has an HTML form, human interacti vity includes interactions with the form. Note This rule only inspects requests to the account creation path and is only evaluated if you've implemented the application integration SDKs. The SDK implementations passively capture human interactivity and stores the information in the request token. For more information, see AWS WAF token characteristics and Client application integrations in AWS WAF. Rule action: CAPTCHA Labels: None. The rule determines a match based on varying factors, so there is no ind ividual label that applies for every possible match scenario. The rule group can apply one or more of the following labels to requests: Using managed rule groups 198 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label AutomatedBrowser BrowserInconsistency awswaf:managed:aws:acfp:sig nal:client:human_interactiv ity: low\|medium\|high awswaf:managed:aws:acfp:Sig nalClientHumanInteractivity Absent Low\|Medium\|High awswaf:managed:aws:acfp:sig nal:client:human_interactiv ity:insufficient_data awswaf:managed:aws:acfp:sig nal:form_detected . Inspects for indicators that the client browser might be automated. Rule action: Block Labels: awswaf:managed:aws:acfp:sig nal:automated_browser and awswaf:managed:aws:acfp:Aut omatedBrowser Inspects the request's token for inconsist ent browser interrogation data. For more i nformation, see AWS WAF token character istics. Rule action: CAPTCHA Labels: awswaf:managed:aws :acfp:signal:browser_incons istency and awswaf:managed:aws :acfp:BrowserInconsistency Using managed rule groups 199 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricIpHigh Inspects for high volumes of account creation requests sent from individual IP addresses. A high volume is more than 20 requests in a 10 minute window. Note The thresholds that this rule applies can vary slightly due to latency. For the high volume, a few requests might make it through beyond the limit before the rule action is applied. Rule action: CAPTCHA Labels: awswaf:managed:aws:acfp:agg regate:volumetric:ip:creati on:high and awswaf:managed:aws :acfp:VolumetricIpHigh The rule applies the following labels to requests with medium volumes (more than 15 requests per 10 minute window) and low volumes (more than 10 requests per 10 minute window), but takes no action on them: awswaf:managed:aws:acfp:agg regate:volumetric:ip:creati on:medium and awswaf:managed:aws :acfp:aggregate:volumetric: ip:creation:low . Using managed rule groups 200 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricSessionHigh Inspects for high volumes of account creation requests sent from individual client sessions. A high volume is more than 10 requests
waf-dg-077	waf-dg.pdf	77	action is applied. Rule action: CAPTCHA Labels: awswaf:managed:aws:acfp:agg regate:volumetric:ip:creati on:high and awswaf:managed:aws :acfp:VolumetricIpHigh The rule applies the following labels to requests with medium volumes (more than 15 requests per 10 minute window) and low volumes (more than 10 requests per 10 minute window), but takes no action on them: awswaf:managed:aws:acfp:agg regate:volumetric:ip:creati on:medium and awswaf:managed:aws :acfp:aggregate:volumetric: ip:creation:low . Using managed rule groups 200 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricSessionHigh Inspects for high volumes of account creation requests sent from individual client sessions. A high volume is more than 10 requests in a 30 minute window. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:acfp:agg regate:volumetric:session:c and awswaf:ma reation:high naged:aws:acfp:VolumetricSe ssionHigh The rule group applies the following labels to requests with medium volumes (more than 5 requests per 30 minute window) and low volumes (more than 1 request per 30 minute window), but takes no action on them: awswaf:managed:aws:acfp:agg regate:volumetric:session:c reation:medium and awswaf:ma naged:aws:acfp:aggregate:vo lumetric:session:creation:low . Using managed rule groups 201 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label AttributeUsernameTraversalHigh Inspects for a high rate of account creation requests from a single client session that use diﬀerent usernames. The threshold for a high evaluation is more than 10 requests in 30 minutes. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:acfp:agg regate:attribute:username_t and raversal:creation:high awswaf:managed:aws:acfp:Att ributeUsernameTraversalHigh The rule group applies the following labels to requests with medium volumes (more than 5 requests per 30 minute window) and low volumes (more than 1 request per 30 min ute window) of username traversal requests, but takes no action on them: awswaf:ma naged:aws:acfp:aggregate:at tribute:username_traversal: creation:medium and awswaf:ma naged:aws:acfp:aggregate:at Using managed rule groups 202 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label tribute:username_traversal: . creation:low Using managed rule groups 203 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricPhoneNumberHigh Inspects for high volumes of account creation requests that use the same phone number. The threshold for a high evaluation is more t han 10 requests in 30 minutes. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws :acfp:aggregate:volumetric: phone_number:high and awswaf:ma naged:aws:acfp:VolumetricPh oneNumberHigh The rule group applies the following labels to requests with medium volumes (more than 5 requests per 30 minute window) and low volumes (more than 1 request per 30 minute window), but takes no action on them: awswaf:ma naged:aws:acfp:aggregate:vo lumetric:phone_number:medium and awswaf:managed:aws:acfp:agg regate:volumetric:phone_num ber:low . Using managed rule groups 204 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricAddressHigh Inspects for high volumes of account creation requests that use the same physical address. The threshold for a high evaluation is more than 100 requests per 30 minute window. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws :acfp:aggregate:volumetric: and awswaf:ma address:high naged:aws:acfp:VolumetricAd dressHigh Using managed rule groups 205 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricAddressLow Inspects for low and medium volumes of account creation requests that use the same p hysical address. The threshold for a medium evaluation is more than 50 requests per 30 minute window, and for a low evaluation is more than 10 requests per 30 minute window. The rule applies the action for either medium or low volumes. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: CAPTCHA Labels: awswaf:managed:aws:acfp:agg regate:volumetric:address: medium and awswaf:managed:aws low\| :acfp:VolumetricAddress Low\|Mediu m Using managed rule groups 206 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricIPSuccessfulResponse Inspects for a high volume of successful account creation requests for a single IP add ress. This rule aggregates success responses from the protected resource to account creation requests. The threshold for a high evaluation is more than 10 requests per 10 minute window. This rule helps protect against bulk account creation attempts. It has a lower threshold than the rule VolumetricIpHigh , which counts just the requests. If you've conﬁgured the rule group
waf-dg-078	waf-dg.pdf	78	low\| :acfp:VolumetricAddress Low\|Mediu m Using managed rule groups 206 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricIPSuccessfulResponse Inspects for a high volume of successful account creation requests for a single IP add ress. This rule aggregates success responses from the protected resource to account creation requests. The threshold for a high evaluation is more than 10 requests per 10 minute window. This rule helps protect against bulk account creation attempts. It has a lower threshold than the rule VolumetricIpHigh , which counts just the requests. If you've conﬁgured the rule group to inspect the response body or JSON components, AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of these component types for success or failure indicators. This rule applies the rule action and labeling to new web requests from an IP address, based on the success and failure responses from the protected resource to recent login attempts from the same IP address. You deﬁne how to count successes and failures when you conﬁgure the rule group. Note AWS WAF only evaluates this rule in web ACLs that protect Amazon CloudFront distributions. Using managed rule groups 207 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Note The thresholds that this rule applies can vary slightly due to latency. It's possible for the client to send more successful account creation attempts than are allowed before the rule starts matching on subsequent attempts. Rule action: Block Labels: awswaf:managed:aws :acfp:aggregate:volumetric: ip:successful_creation_resp onse:high and awswaf:managed:aws :acfp:VolumetricIPSuccessfu lResponse The rule group also applies the following related labels to requests, without any associated action. All counts are for a 10- minute window. awswaf:managed:aws :acfp:aggregate:volumetric: ip:successful_creation_resp onse:medium for more than 5 successfu l requests, awswaf:managed:aws :acfp:aggregate:volumetric: ip:successful_creation_resp onse:low for more than 1 successfu l request, awswaf:managed:aws :acfp:aggregate:volumetric: ip:failed_creation_response :high for more than 10 failed requests, Using managed rule groups 208 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label awswaf:managed:aws:acfp:agg regate:volumetric:ip:failed _creation_response:medium more than 5 failed requests, and awswaf:ma for naged:aws:acfp:aggregate:vo lumetric:ip:failed_creation _response:low request. for more than 1 failed Using managed rule groups 209 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricSessionSuccessful Response Inspects for a low volume of success responses from the protected resource to account creation requests that are being sent from a single client session. This helps to protect against bulk account creation attempts. The threshold for a low evaluation is more than 1 request per 30 minute window. This helps protect against bulk account creation attempts. This rule uses a lower threshold than the rule Volumetri cSessionHigh requests. , which tracks only the If you've conﬁgured the rule group to inspect the response body or JSON components, AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of these component types for success or failure indicators. This rule applies the rule action and labeling to new web requests from a client session, based on the success and failure responses from the protected resource to recent login attempts from the same client session. You deﬁne how to count successes and failures when you conﬁgure the rule group. Note AWS WAF only evaluates this rule in web ACLs that protect Amazon CloudFront distributions. Using managed rule groups 210 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label Note The thresholds that this rule applies can vary slightly due to latency. It's possible for the client to send more failed account creation attempts than are allowed before the rule starts matching on subsequent attempts. Rule action: Block Labels: awswaf:managed:aws :acfp:aggregate:volumetric: session:successful_creation and awswaf:ma _response:low naged:aws:acfp:VolumetricSe ssionSuccessfulResponse The rule group also applies the following related labels to requests. All counts are for a 30-minute window. awswaf:ma naged:aws:acfp:aggregate:vo lumetric:session:successful _creation_response:high than 10 successful requests, awswaf:ma for more naged:aws:acfp:aggregate:vo lumetric:session:successful _creation_response:medium more than 5 successful requests, awswaf:ma for naged:aws:acfp:aggregate:vo lumetric:session:failed_cre ation_response:high 10 failed requests, awswaf:managed:aws for more than :acfp:aggregate:volumetric: Using managed rule groups 211 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label session:failed_creation_res ponse:medium requests, and awswaf:managed:aws for more than 5 failed :acfp:aggregate:volumetric: session:failed_creation_res ponse:low for more than 1 failed request. VolumetricSessionTokenReuseIp Inspects account creation requests for the use of a single token among more than 5 distinct IP addresses. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:acfp:agg regate:volumetric:session:c reation:token_reuse:ip awswaf:managed:aws:acfp:Vol and umetricSessionTokenReuseIp AWS WAF Fraud Control account takeover prevention (ATP) rule group This section explains what the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group does. VendorName: AWS, Name: AWSManagedRulesATPRuleSet,
waf-dg-079	waf-dg.pdf	79	5 failed :acfp:aggregate:volumetric: session:failed_creation_res ponse:low for more than 1 failed request. VolumetricSessionTokenReuseIp Inspects account creation requests for the use of a single token among more than 5 distinct IP addresses. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:acfp:agg regate:volumetric:session:c reation:token_reuse:ip awswaf:managed:aws:acfp:Vol and umetricSessionTokenReuseIp AWS WAF Fraud Control account takeover prevention (ATP) rule group This section explains what the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group does. VendorName: AWS, Name: AWSManagedRulesATPRuleSet, WCU: 50 Using managed rule groups 212 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The AWS WAF Fraud Control account takeover prevention (ATP) managed rule group labels and manages requests that might be part of malicious account takeover attempts. The rule group does this by inspecting login attempts that clients send to your application's login endpoint. • Request inspection – ATP gives you visibility and control over anomalous login attempts and login attempts that use stolen credentials, to prevent account takeovers that might lead to fraudulent activity. ATP checks email and password combinations against its stolen credential database, which is updated regularly as new leaked credentials are found on the dark web. ATP aggregates data by IP address and client session, to detect and block clients that send too many requests of a suspicious nature. • Response inspection – For CloudFront distributions, in addition to inspecting incoming login requests, the ATP rule group inspects your application's responses to login attempts, to track success and failure rates. Using this information, ATP can temporarily block client sessions or IP addresses that have too many login failures. AWS WAF performs response inspection asynchronously, so this doesn't increase latency in your web traﬃc. Considerations for using this rule group This rule group requires speciﬁc conﬁguration. To conﬁgure and implement this rule group, see the guidance at AWS WAF Fraud Control account takeover prevention (ATP). This rule group is part of the intelligent threat mitigation protections in AWS WAF. For information, see Intelligent threat mitigation in AWS WAF. Using managed rule groups 213 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note You are charged additional fees when you use this managed rule group. For more information, see AWS WAF Pricing. To keep your costs down and to be sure you're managing your web traﬃc as you want, use this rule group in accordance with the guidance at Best practices for intelligent threat mitigation in AWS WAF. This rule group isn't available for use with Amazon Cognito user pools. You can't associate a web ACL that uses this rule group with a user pool, and you can't add this rule group to a web ACL that's already associated with a user pool. Labels added by this rule group This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Token labels This rule group uses AWS WAF token management to inspect and label web requests according to the status of their AWS WAF tokens. AWS WAF uses tokens for client session tracking and veriﬁcation. For information about tokens and token management, see Token use in AWS WAF intelligent threat mitigation. For information about the label components described here, see Label syntax and naming requirements in AWS WAF. Client session label The label awswaf:managed:token:id:identifier contains a unique identiﬁer that AWS WAF token management uses to identify the client session. The identiﬁer can change if the client acquires a new token, for example after discarding the token it was using. Using managed rule groups 214 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Browser ﬁngerprint label The label awswaf:managed:token:fingerprint:fingerprint-identifier contains a robust browser ﬁngerprint identiﬁer that AWS WAF token management computes from various client browser signals. This identiﬁer stays the same across multiple token acquisition attempts. The ﬁngerprint identiﬁer is not
waf-dg-080	waf-dg.pdf	80	contains a unique identiﬁer that AWS WAF token management uses to identify the client session. The identiﬁer can change if the client acquires a new token, for example after discarding the token it was using. Using managed rule groups 214 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Browser ﬁngerprint label The label awswaf:managed:token:fingerprint:fingerprint-identifier contains a robust browser ﬁngerprint identiﬁer that AWS WAF token management computes from various client browser signals. This identiﬁer stays the same across multiple token acquisition attempts. The ﬁngerprint identiﬁer is not unique to a single client. Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Token status labels: Label namespace preﬁxes Token status labels report on the status of the token and of the challenge and CAPTCHA information that it contains. Each token status label begins with one of the following namespace preﬁxes: • awswaf:managed:token: – Used to report the general status of the token and to report on the status of the token's challenge information. • awswaf:managed:captcha: – Used to report on the status of the token's CAPTCHA information. Token status labels: Label names Following the preﬁx, the rest of the label provides detailed token status information: • accepted – The request token is present and contains the following: • A valid challenge or CAPTCHA solution. • An unexpired challenge or CAPTCHA timestamp. • A domain speciﬁcation that's valid for the web ACL. Using managed rule groups 215 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Example: The label awswaf:managed:token:accepted indicates that the web requests's token has a valid challenge solution, an unexpired challenge timestamp, and a valid domain. • rejected – The request token is present but doesn't meet the acceptance criteria. Along with the rejected label, token management adds a custom label namespace and name to indicate the reason. • rejected:not_solved – The token is missing the challenge or CAPTCHA solution. • rejected:expired – The token's challenge or CAPTCHA timestamp has expired, according to your web ACL's conﬁgured token immunity times. • rejected:domain_mismatch – The token's domain isn't a match for your web ACL's token domain conﬁguration. • rejected:invalid – AWS WAF couldn't read the indicated token. Example: The labels awswaf:managed:captcha:rejected and awswaf:managed:captcha:rejected:expired together indicate that the request didn't have a valid CAPTCHA solve because the CAPTCHA timestamp in the token has exceeded the CAPTCHA token immunity time that's conﬁgured in the web ACL. • absent – The request doesn't have the token or the token manager couldn't read it. Example: The label awswaf:managed:captcha:absent indicates that the request doesn't have the token. ATP labels The ATP managed rule group generates labels with the namespace preﬁx awswaf:managed:aws:atp: followed by the custom namespace and label name. The rule group might add any of the following labels in addition to the labels that are noted in the rules listing: • awswaf:managed:aws:atp:signal:credential_compromised – Indicates that the credentials that were submitted in the request are in the stolen credential database. • awswaf:managed:aws:atp:aggregate:attribute:suspicious_tls_fingerprint – Available only for protected Amazon CloudFront distributions. Indicates that a client session has sent multiple requests that used a suspicious TLS ﬁngerprint. Using managed rule groups 216 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • awswaf:managed:aws:atp:aggregate:volumetric:session:token_reuse:ip – Indicates the use of a single token among more than 5 distinct IP addresses. The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the label is applied. You can retrieve all labels for a rule group through the API by calling DescribeManagedRuleGroup. The labels are listed in the AvailableLabels property in the response. Account takeover prevention rules listing This section lists the ATP rules in AWSManagedRulesATPRuleSet and the labels that the rule group's rules add to web requests. Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Rule name Description and label UnsupportedCognitoIDP Inspects for web traﬃc going to an Amazon Cognito user pool. ATP isn't available for use with Amazon Cognito user pools, and this rule helps to ensure that the other ATP rule group rules are not used to evaluate user pool traﬃc. Rule action: Block Labels: awswaf:managed:aws:atp:unsu pported:cognito_idp and awswaf:ma Using managed rule groups 217 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer
waf-dg-081	waf-dg.pdf	81	to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Rule name Description and label UnsupportedCognitoIDP Inspects for web traﬃc going to an Amazon Cognito user pool. ATP isn't available for use with Amazon Cognito user pools, and this rule helps to ensure that the other ATP rule group rules are not used to evaluate user pool traﬃc. Rule action: Block Labels: awswaf:managed:aws:atp:unsu pported:cognito_idp and awswaf:ma Using managed rule groups 217 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricIpHigh naged:aws:atp:UnsupportedCo gnitoIDP Inspects for high volumes of requests sent from individual IP addresses. A high volume is more than 20 requests in a 10 minute window. Note The thresholds that this rule applies can vary slightly due to latency. For the high volume, a few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:atp:aggr egate:volumetric:ip:high and awswaf:managed:aws:atp:Volu metricIpHigh The rule group applies the following labels to requests with medium volumes (more than 15 requests per 10 minute window) and low volumes (more than 10 requests per 10 minute window), but takes no action on them: awswaf:managed:aws:atp:aggr and egate:volumetric:ip:medium awswaf:managed:aws:atp:aggr egate:volumetric:ip:low . Using managed rule groups 218 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricSession Inspects for high volumes of requests sent from individual client sessions. The threshold is more than 20 requests per 30 minute window. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Note The thresholds that this rule applies can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule action: Block Labels: awswaf:managed:aws:atp:aggr egate:volumetric:session and awswaf:managed:aws:atp:Volu metricSession Using managed rule groups 219 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label AttributeCompromisedCredentials AttributeUsernameTraversal AttributePasswordTraversal Inspects for multiple requests from the same client session that use stolen credentials. Rule action: Block Labels: awswaf:managed:aws :atp:aggregate:attribute:co and mpromised_credentials awswaf:managed:aws:atp:Attr ibuteCompromisedCredentials Inspects for multiple requests from the same client session that use username traversal. Rule action: Block Labels: awswaf:managed:aws:atp:aggr egate:attribute:username_tr aversal and awswaf:managed:aws :atp:AttributeUsernameTraversal Inspects for multiple requests with the same username that use password traversal. Rule action: Block Labels: awswaf:managed:aws:atp:aggr egate:attribute:password_tr aversal and awswaf:managed:aws :atp:AttributePasswordTraversal Using managed rule groups 220 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label AttributeLongSession TokenRejected Inspects for multiple requests from the same client session that use long lasting sessions. The threshold is more than 6 hours of traﬃc that has at least one login request every 30 minutes. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: Block Labels: awswaf:managed:aws:atp:aggr egate:attribute:long_session and awswaf:managed:aws:atp:Attr ibuteLongSession Inspects for requests with tokens that are rejected by AWS WAF token management. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: Block Labels: None. To check for token rejected, use a label match rule to match on the label: awswaf:managed:token:rejected . Using managed rule groups 221 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label SignalMissingCredential Inspects for requests with credentials that are missing the username or password. Rule action: Block Labels: awswaf:managed:aws:atp:sign al:missing_credential and awswaf:managed:aws:atp:Sign alMissingCredential Using managed rule groups 222 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricIpFailedLoginResp onseHigh Inspects for IP addresses that have recently been the source of too high a rate of failed login attempts. A high volume is more than 10 failed login requests from an IP address in a 10 minute window. If you've conﬁgured the rule group to inspect the response body or JSON components, AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of these component types for success or failure indicators. This rule applies the rule action and labeling to new web requests from an IP address, based on the success and failure responses from the protected resource to recent login attempts from the same IP address. You deﬁne how to count successes and failures when you conﬁgure the
waf-dg-082	waf-dg.pdf	82	A high volume is more than 10 failed login requests from an IP address in a 10 minute window. If you've conﬁgured the rule group to inspect the response body or JSON components, AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of these component types for success or failure indicators. This rule applies the rule action and labeling to new web requests from an IP address, based on the success and failure responses from the protected resource to recent login attempts from the same IP address. You deﬁne how to count successes and failures when you conﬁgure the rule group. Note AWS WAF only evaluates this rule in web ACLs that protect Amazon CloudFront distributions. Note The thresholds that this rule applies can vary slightly due to latency. It's possible for the client to send more failed login attempts than are allowed Using managed rule groups 223 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label before the rule starts matching on su bsequent attempts. Rule action: Block Labels: awswaf:managed:aws :atp:aggregate:volumetric:i p:failed_login_response:high and awswaf:managed:aws:atp:Volu metricIpFailedLoginResponseHigh The rule group also applies the following related labels to requests, without any associated action. All counts are for a 10- minute window. awswaf:managed:aws :atp:aggregate:volumetric:i p:failed_login_response:med ium for more than 5 failed requests, awswaf:managed:aws:atp:aggr egate:volumetric:ip:failed_ login_response:low 1 failed request, awswaf:managed:aws for more than :atp:aggregate:volumetric:i p:successful_login_response :high for more than 10 successful requests, awswaf:managed:aws:atp:aggr egate:volumetric:ip:success ful_login_response:medium than 5 successful requests, and awswaf:ma for more naged:aws:atp:aggregate:vol umetric:ip:successful_login _response:low l request. for more than 1 successfu Using managed rule groups 224 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label VolumetricSessionFailedLogi nResponseHigh Inspects for client sessions that have recently been the source of too high a rate of failed login attempts. A high volume is more than 10 failed login requests from a client session in a 30 minute window. If you've conﬁgured the rule group to inspect the response body or JSON components, AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of these component types for success or failure indicators. This rule applies the rule action and labeling to new web requests from a client session, based on the success and failure responses from the protected resource to recent login attempts from the same client session. You deﬁne how to count successes and failures when you conﬁgure the rule group. Note AWS WAF only evaluates this rule in web ACLs that protect Amazon CloudFront distributions. Note The thresholds that this rule applies can vary slightly due to latency. It's possible for the client to send more failed login attempts than are allowed Using managed rule groups 225 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label before the rule starts matching on sub sequent attempts. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: Block Labels: awswaf:managed:aws :atp:aggregate:volumetric:s ession:failed_login_respons e:high and awswaf:managed:aws :atp:VolumetricSessionFaile dLoginResponseHigh The rule group also applies the following related labels to requests, without any associated action. All counts are for a 30- minute window. awswaf:managed:aws :atp:aggregate:volumetric:s ession:failed_login_respons e:medium for more than 5 failed requests, awswaf:managed:aws:atp:aggr egate:volumetric:session:fa iled_login_response:low more than 1 failed request, awswaf:ma for naged:aws:atp:aggregate:vol umetric:session:successful_ login_response:high successful requests, awswaf:managed:aws for more than 10 Using managed rule groups 226 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description and label :atp:aggregate:volumetric:s ession:successful_login_res ponse:medium l requests, and awswaf:managed:aws for more than 5 successfu :atp:aggregate:volumetric:s ession:successful_login_res ponse:low for more than 1 successful request. AWS WAF Bot Control rule group This section explains what the Bot Control managed rule group does. VendorName: AWS, Name: AWSManagedRulesBotControlRuleSet, WCU: 50 Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The Bot Control managed rule group provides rules that manage requests from bots. Bots can consume excess resources, skew business metrics, cause downtime, and perform malicious activities. Protection levels The Bot Control managed rule group provides two levels of protection that you can choose from: • Common – Detects a variety of self-identifying bots, such as web scraping frameworks, search engines, and automated browsers. Bot
waf-dg-083	waf-dg.pdf	83	provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. The Bot Control managed rule group provides rules that manage requests from bots. Bots can consume excess resources, skew business metrics, cause downtime, and perform malicious activities. Protection levels The Bot Control managed rule group provides two levels of protection that you can choose from: • Common – Detects a variety of self-identifying bots, such as web scraping frameworks, search engines, and automated browsers. Bot Control protections at this level identify common bots Using managed rule groups 227 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide using traditional bot detection techniques, such as static request data analysis. The rules label traﬃc from these bots and block the ones that they cannot verify. • Targeted – Includes the common-level protections and adds targeted detection for sophisticated bots that do not self identify. Targeted protections mitigate bot activity using a combination of rate limiting and CAPTCHA and background browser challenges. • TGT_ – Rules that provide targeted protection have names that begin with TGT_. All targeted protections use detection techniques such as browser interrogation, ﬁngerprinting, and behavior heuristics to identify bad bot traﬃc. • TGT_ML_ – Targeted protection rules that use machine learning have names that begin with TGT_ML_. These rules use automated, machine-learning analysis of website traﬃc statistics to detect anomalous behavior indicative of distributed, coordinated bot activity. AWS WAF analyzes statistics about your website traﬃc such as timestamps, browser characteristics, and previous URL visited, to improve the Bot Control machine learning model. Machine learning capabilities are enabled by default, but you can disable them in your rule group conﬁguration. When machine learning is disabled, AWS WAF does not evaluate these rules. The targeted protection level and the AWS WAF rate-based rule statement both provide rate limiting. For a comparison of the two options, see Options for rate limiting in rate-based rules and targeted Bot Control rules. Considerations for using this rule group This rule group is part of the intelligent threat mitigation protections in AWS WAF. For information, see Intelligent threat mitigation in AWS WAF. Note You are charged additional fees when you use this managed rule group. For more information, see AWS WAF Pricing. To keep your costs down and to be sure you're managing your web traﬃc as you want, use this rule group in accordance with the guidance at Best practices for intelligent threat mitigation in AWS WAF. We periodically update our machine learning (ML) models for the targeted protection level ML- based rules, to improve bot predictions. The ML-based rules have names that start with TGT_ML_. Using managed rule groups 228 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide If you notice a sudden and substantial change in the bot predictions made by these rules, contact us through your account manager or open a case at AWS Support Center. Labels added by this rule group This managed rule group adds labels to the web requests that it evaluates, which are available to rules that run after this rule group in your web ACL. AWS WAF also records the labels to Amazon CloudWatch metrics. For general information about labels and label metrics, see Web request labeling and Label metrics and dimensions. Token labels This rule group uses AWS WAF token management to inspect and label web requests according to the status of their AWS WAF tokens. AWS WAF uses tokens for client session tracking and veriﬁcation. For information about tokens and token management, see Token use in AWS WAF intelligent threat mitigation. For information about the label components described here, see Label syntax and naming requirements in AWS WAF. Client session label The label awswaf:managed:token:id:identifier contains a unique identiﬁer that AWS WAF token management uses to identify the client session. The identiﬁer can change if the client acquires a new token, for example after discarding the token it was using. Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Browser ﬁngerprint label The label awswaf:managed:token:fingerprint:fingerprint-identifier contains a robust browser ﬁngerprint identiﬁer that AWS WAF token management computes from various client browser signals. This identiﬁer stays the same across multiple token acquisition attempts. The ﬁngerprint identiﬁer is not unique to a single client. Using managed rule groups 229 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Token status labels: Label namespace preﬁxes Token status labels report on the status of the token and of the challenge and CAPTCHA information that it contains. Each token status label begins with one of the following namespace preﬁxes: • awswaf:managed:token: – Used to report the
waf-dg-084	waf-dg.pdf	84	token management computes from various client browser signals. This identiﬁer stays the same across multiple token acquisition attempts. The ﬁngerprint identiﬁer is not unique to a single client. Using managed rule groups 229 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note AWS WAF doesn't report Amazon CloudWatch metrics for this label. Token status labels: Label namespace preﬁxes Token status labels report on the status of the token and of the challenge and CAPTCHA information that it contains. Each token status label begins with one of the following namespace preﬁxes: • awswaf:managed:token: – Used to report the general status of the token and to report on the status of the token's challenge information. • awswaf:managed:captcha: – Used to report on the status of the token's CAPTCHA information. Token status labels: Label names Following the preﬁx, the rest of the label provides detailed token status information: • accepted – The request token is present and contains the following: • A valid challenge or CAPTCHA solution. • An unexpired challenge or CAPTCHA timestamp. • A domain speciﬁcation that's valid for the web ACL. Example: The label awswaf:managed:token:accepted indicates that the web requests's token has a valid challenge solution, an unexpired challenge timestamp, and a valid domain. • rejected – The request token is present but doesn't meet the acceptance criteria. Along with the rejected label, token management adds a custom label namespace and name to indicate the reason. • rejected:not_solved – The token is missing the challenge or CAPTCHA solution. • rejected:expired – The token's challenge or CAPTCHA timestamp has expired, according to your web ACL's conﬁgured token immunity times. • rejected:domain_mismatch – The token's domain isn't a match for your web ACL's token domain conﬁguration. Using managed rule groups 230 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • rejected:invalid – AWS WAF couldn't read the indicated token. Example: The labels awswaf:managed:captcha:rejected and awswaf:managed:captcha:rejected:expired together indicate that the request didn't have a valid CAPTCHA solve because the CAPTCHA timestamp in the token has exceeded the CAPTCHA token immunity time that's conﬁgured in the web ACL. • absent – The request doesn't have the token or the token manager couldn't read it. Example: The label awswaf:managed:captcha:absent indicates that the request doesn't have the token. Bot Control labels The Bot Control managed rule group generates labels with the namespace preﬁx awswaf:managed:aws:bot-control: followed by the custom namespace and label name. The rule group might add more than one label to a request. Each label reﬂects the Bot Control rule ﬁndings: • awswaf:managed:aws:bot-control:bot: – Information about the bot associated with the request. • awswaf:managed:aws:bot-control:bot:name:<name> – The bot name, if one is available, for example, the custom namespaces bot:name:slurp, bot:name:googlebot, and bot:name:pocket_parser. • awswaf:managed:aws:bot-control:bot:category:<category> – The category of bot, as deﬁned by AWS WAF, for example, bot:category:search_engine and bot:category:content_fetcher. • awswaf:managed:aws:bot-control:bot:organization:<organization> – The bot's publisher, for example, bot:organization:google. • awswaf:managed:aws:bot-control:bot:verified – Used to indicate a bot that identiﬁes itself and that Bot Control has been able to verify. This is used for common desirable bots, and can be useful when combined with category labels like bot:category:search_engine or name labels like bot:name:googlebot. Using managed rule groups 231 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Note Bot Control uses the IP address from the web request origin to help determine whether a bot is veriﬁed. You can’t conﬁgure it to use the AWS WAF forwarded IP conﬁguration, to inspect a diﬀerent IP address source. If you have veriﬁed bots that route through a proxy or load balancer, you can add a rule that runs before the Bot Control rule group to help with this. Conﬁgure your new rule to use the forwarded IP address and explicitly allow requests from the veriﬁed bots. For information about using forwarded IP addresses, see Using forwarded IP addresses in AWS WAF. • awswaf:managed:aws:bot-control:bot:user_triggered:verified – Used to indicate a bot that is similar to a veriﬁed bot, but that might be directly invoked by end users. This category of bot is treated by the Bot Control rules like an unveriﬁed bot. • awswaf:managed:aws:bot-control:bot:developer_platform:verified – Used to indicate a bot that is similar to a veriﬁed bot, but that is used by developer platforms for scripting, for example Google Apps Script. This category of bot is treated by the Bot Control rules like an unveriﬁed bot. • awswaf:managed:aws:bot-control:bot:unverified – Used to indicate a bot that identiﬁes itself, so it can be named and categorized, but that doesn't publish information that can be used to independently verify its identify. These types of bot signatures can be falsiﬁed, and so are treated as unveriﬁed. • awswaf:managed:aws:bot-control:targeted:<additional-details> – Used for labels that are speciﬁc to the Bot Control targeted protections. • awswaf:managed:aws:bot-control:signal:<signal-details> and awswaf:managed:aws:bot-control:targeted:signal:<signal-details> – Used to provide additional information about the request in some situations. The
waf-dg-085	waf-dg.pdf	85	for scripting, for example Google Apps Script. This category of bot is treated by the Bot Control rules like an unveriﬁed bot. • awswaf:managed:aws:bot-control:bot:unverified – Used to indicate a bot that identiﬁes itself, so it can be named and categorized, but that doesn't publish information that can be used to independently verify its identify. These types of bot signatures can be falsiﬁed, and so are treated as unveriﬁed. • awswaf:managed:aws:bot-control:targeted:<additional-details> – Used for labels that are speciﬁc to the Bot Control targeted protections. • awswaf:managed:aws:bot-control:signal:<signal-details> and awswaf:managed:aws:bot-control:targeted:signal:<signal-details> – Used to provide additional information about the request in some situations. The following are examples of signal labels. This is not an exhaustive list: • awswaf:managed:aws:bot-control:signal:cloud_service_provider:<CSP> – Indicates a cloud service provider (CSP) for the request. Examples of CSPs include aws for Amazon Web Services infrastructure, gcp for Google Cloud Platform (GCP) infrastructure, azure for Microsoft Azure cloud services, and oracle for Oracle Cloud services. • awswaf:managed:aws:bot- control:targeted:signal:browser_automation_extension – Indicates the detection of a browser extension that assists in automation, such as Selenium IDE. Using managed rule groups 232 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide This label is added whenever a user has this type of extension installed, even if they're not actively using it. If you implement a label match rule for this, be aware of this possibility of false positives in your rule logic and action settings. For example, you might use a CAPTCHA action instead of Block or you might combine this label match with other label matches, to increase your conﬁdence that automation is in use. • awswaf:managed:aws:bot-control:signal:automated_browser – Indicates that the request contains indicators that the client browser might be automated. • awswaf:managed:aws:bot-control:targeted:signal:automated_browser – Indicates that the request's AWS WAF token contains indicators that the client browser might be automated. You can retrieve all labels for a rule group through the API by calling DescribeManagedRuleGroup. The labels are listed in the AvailableLabels property in the response. The Bot Control managed rule group applies labels to a set of veriﬁable bots that are commonly allowed. The rule group doesn't block these veriﬁed bots. If you want, you can block them, or a subset of them by writing a custom rule that uses the labels applied by the Bot Control managed rule group. For more information about this and examples, see AWS WAF Bot Control. Bot Control rules listing This section lists the Bot Control rules. Note This documentation covers the most recent static version release of this managed rule group. We report version changes in the changelog log at AWS Managed Rules changelog. For information about other versions, use the API command DescribeManagedRuleGroup. The information that we publish for the rules in the AWS Managed Rules rule groups is intended to provide you with what you need to use the rules without giving bad actors what they need to circumvent the rules. If you need more information than you ﬁnd here, contact the AWS Support Center. Using managed rule groups 233 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryAdvertising CategoryArchiver Inspects for bots that are used for advertisi ng purposes. For example, you might use third-party advertising services that need to programmatically access your website. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot-cont rol:bot:category:advertising and awswaf:managed:aws:bot-cont rol:CategoryAdvertising For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Inspects for bots that are used for archiving purposes. These bots crawl the web and capture content for the purposes of creating archives. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:archiver and awswaf:managed:aws:bot-cont rol:CategoryArchiver For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus Using managed rule groups 234 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryContentFetcher the label awswaf:managed:aws:bot- control:bot:verified . Inspects for bots that visit the application's website on behalf of a user, to fetch content like RSS feeds or to verify or validate your content. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:content_fe tcher and awswaf:managed:aws:bot- control:CategoryContentFetcher For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 235 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryEmailClient Inspects for bots that check links within emails that point to the application's website. This can include bots run by businesses and email providers, to verify links in emails and ﬂag suspicious emails. Rule action, applied
waf-dg-086	waf-dg.pdf	86	applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:content_fe tcher and awswaf:managed:aws:bot- control:CategoryContentFetcher For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 235 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryEmailClient Inspects for bots that check links within emails that point to the application's website. This can include bots run by businesses and email providers, to verify links in emails and ﬂag suspicious emails. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:email_clie nt and awswaf:managed:aws:bot- control:CategoryEmailClient For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 236 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryHttpLibrary CategoryLinkChecker Inspects for requests that are generated by bots from the HTTP libraries of various programming languages. These may include API requests that you choose to allow or monitor. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:http_libra ry and awswaf:managed:aws:bot- control:CategoryHttpLibrary For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Inspects for bots that check for broken links. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:link_check er and awswaf:managed:aws:bot- control:CategoryLinkChecker For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 237 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryMiscellaneous Inspects for miscellaneous bots that don't match other categories. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:miscellane ous and awswaf:managed:aws:bot- control:CategoryMiscellaneous For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 238 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryMonitoring Inspects for bots that are used for monitorin g purposes. For example, you might use bot monitoring services that periodically ping your application website to monitor things like performance and uptime. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:monitoring and awswaf:managed:aws:bot-cont rol:CategoryMonitoring For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 239 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategoryScrapingFramework Inspects for bots from web scraping frameworks, which are used to automate crawling and extracting content from websites. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:scraping_f ramework and awswaf:managed:aws :bot-control:CategoryScrapi ngFramework For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 240 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategorySearchEngine Inspects for search engine bots, which crawl websites to index content and make the information available for search engine results. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:search_eng ine and awswaf:managed:aws:bot- control:CategorySearchEngine For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 241 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategorySecurity Inspects for bots that scan web applications for vulnerabilities or that perform security audits. For example, you might use a third- party security vendor that scans, monitors, or audits your web application’s security. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:security and awswaf:managed:aws:bot-cont rol:CategorySecurity For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 242 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name CategorySeo Description Inspects for bots that are used for search engine optimization. For example, you might use search engine tools that crawl your site to help you improve your search engine rankings. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- and control:bot:category:seo awswaf:managed:aws:bot-cont rol:CategorySeo For veriﬁed bots,
waf-dg-087	waf-dg.pdf	87	awswaf:managed:aws:bot-cont rol:CategorySecurity For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 242 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name CategorySeo Description Inspects for bots that are used for search engine optimization. For example, you might use search engine tools that crawl your site to help you improve your search engine rankings. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- and control:bot:category:seo awswaf:managed:aws:bot-cont rol:CategorySeo For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 243 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description CategorySocialMedia Inspects for bots that are used by social media platforms to provide content summaries when users share your content. Rule action, applied only to unveriﬁed bots: B lock Labels: awswaf:managed:aws:bot- control:bot:category:social_med ia and awswaf:managed:aws:bot- control:CategorySocialMedia For veriﬁed bots, the rule group does not match this rule and takes no action, but it adds the bot name and category labeling plus the label awswaf:managed:aws:bot- control:bot:verified . Using managed rule groups 244 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name CategoryAI Description Inspects for artiﬁcial intelligence (AI) bots. Note This rule applies the action to all matches, regardless of whether the bots are veriﬁed or unveriﬁed. Rule action: Block Labels: awswaf:managed:aws:bot- and control:bot:category:ai awswaf:managed:aws:bot-cont rol:CategoryAI For veriﬁed bots, the rule group matches this rule and takes an action. It additionally adds the bot name and category labeling, the rule labeling, plus the label awswaf:ma naged:aws:bot-control:bot:v erified . Using managed rule groups 245 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description SignalAutomatedBrowser SignalKnownBotDataCenter Inspects requests that are not from veriﬁed bots for indicators that the client browser might be automated. Automated browsers can be used for testing or scraping. For example, you might use these types of browsers to monitor or verify your application website. Rule action: Block Labels: awswaf:managed:aws:bot-cont rol:signal:automated_browser and awswaf:managed:aws:bot-cont rol:SignalAutomatedBrowser For veriﬁed bots, the rule group does not match this rule and does not apply any signal or rule labels. Inspects requests that are not from veriﬁed bots for indicators of data centers that are typically used by bots. Rule action: Block Labels: awswaf:managed:aws:bot- control:signal:known_bot_data_c enter and awswaf:managed:aws:bot- control:SignalKnownBotDataCente r For veriﬁed bots, the rule group does not match this rule and does not apply any signal or rule labels. Using managed rule groups 246 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description SignalNonBrowserUserAgent Inspects requests that are not from veriﬁed bots for user agent strings that don't seem to be from a web browser. This category can include API requests. Rule action: Block Labels: awswaf:managed:aws:bot- control:signal:non_browser_user _agent and awswaf:managed:aws :bot-control:SignalNonBrows erUserAgent For veriﬁed bots, the rule group does not match this rule and does not apply any signal or rule labels. Using managed rule groups 247 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_VolumetricIpTokenAbsent Inspects requests that are not from veriﬁed bots with 5 or more requests from a single client in the last 5 minutes that don't include a valid challenge token. For information about tokens, see Token use in AWS WAF intelligent threat mitigation. Note It's possible for this rule to match on a request that has a token if requests from the same client have recently been missing tokens. The threshold that this rule applies can vary slightly due to latency. This rule handles missing tokens diﬀerent ly from the token labeling: awswaf:ma . The token naged:token:absent labeling labels individual requests that don't have a token. This rule maintains a count of requests that are missing their token for each client IP, and it matches against clients that go over the limit. Rule action: Challenge Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:ip:token_absent and awswaf:managed:aws:bot-cont rol:TGT_VolumetricIpTokenAbsent Using managed rule groups 248 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_TokenAbsent Inspects requests that are not from veriﬁed bots that don't include a valid challenge token. For information about tokens, see Token use in AWS WAF intelligent threat mitigation. Rule action: Count Labels: awswaf:managed:aws:bot-cont rol:TGT_TokenAbsent Using managed rule groups 249 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_VolumetricSession Inspects for an abnormally high number of requests that are not from veriﬁed bots that come from a single client session in a 5 minute window. The evaluation is based on a comparison to standard volumetric baselines that AWS WAF maintains using historic traﬃc patterns. This inspection only
waf-dg-088	waf-dg.pdf	88	that are not from veriﬁed bots that don't include a valid challenge token. For information about tokens, see Token use in AWS WAF intelligent threat mitigation. Rule action: Count Labels: awswaf:managed:aws:bot-cont rol:TGT_TokenAbsent Using managed rule groups 249 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_VolumetricSession Inspects for an abnormally high number of requests that are not from veriﬁed bots that come from a single client session in a 5 minute window. The evaluation is based on a comparison to standard volumetric baselines that AWS WAF maintains using historic traﬃc patterns. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Note This rule can take 5 minutes to go into eﬀect after you enable it. Bot Control identiﬁes anomalous behavior in your web traﬃc by comparing the current traﬃc to traﬃc baselines that AWS WAF computes. Rule action: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:session:high and awswaf:ma naged:aws:bot-control:TGT_V olumetricSession The rule group applies the following labels to medium volume and lower volume Using managed rule groups 250 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description requests that are above a minimum threshold . For these levels, the rule takes no action, regardless of whether the client is veriﬁed: awswaf:managed:aws:bot-cont rol:targeted:aggregate:volu metric:session:medium awswaf:managed:aws:bot-cont and rol:targeted:aggregate:volu metric:session:low . Using managed rule groups 251 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_VolumetricSessionMaximum Inspects for an abnormally high number of requests that are not from veriﬁed bots that come from a single client session in a 5 minute window. The evaluation is based on a comparison to standard volumetric baselines that AWS WAF maintains using historic traﬃc patterns. This rule indicates the maximum conﬁdence in the assessment. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Note This rule can take 5 minutes to go into eﬀect after you enable it. Bot Control identiﬁes anomalous behavior in your web traﬃc by comparing the current traﬃc to traﬃc baselines that AWS WAF computes. Rule action: Block Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:session:maximum and awswaf:managed:aws:bot-cont Using managed rule groups 252 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_SignalAutomatedBrowser rol:TGT_VolumetricSessionMa ximum Inspects the tokens of requests that are not from veriﬁed bots for indicators that the client browser might be automated. For more i nformation, see AWS WAF token character istics. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:signal:automat ed_browser and awswaf:managed:aws :bot-control:TGT_SignalAuto matedBrowser Using managed rule groups 253 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_SignalBrowserAutomation Extension Inspects requests that are not from veriﬁed bots that indicate the presence of a browser extension that assists in automation, such as Selenium IDE. This rule matches whenever a user has this type of extension installed, even if they're not actively using it. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:signal:browser _automation_extension and awswaf:managed:aws:bot-cont rol:TGT_SignalBrowserAutoma tionExtension Using managed rule groups 254 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_SignalBrowserInconsistency Inspects requests that are not from veriﬁed bots for inconsistent browser interrogation data. For more information, see AWS WAF token characteristics. This inspection only applies when the web request has a token. Tokens are added to requests by the application integration SDKs and by the rule actions CAPTCHA and Challenge. For more information, see Token use in AWS WAF intelligent threat mitigation. Rule action: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:signal:browser _inconsistency and awswaf:ma naged:aws:bot-control:TGT_S ignalBrowserInconsistency Using managed rule groups 255 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_ML_CoordinatedActivityL ow , TGT_ML_CoordinatedActivityM edium , TGT_ML_Coordinated ActivityHigh Inspects requests that are not from veriﬁed bots for anomalous behavior that’s consisten t with distributed, coordinated bot activity. The rule levels indicate the level of conﬁdenc e that a group of requests are participants in a coordinated attack. Note These rules only run if the rule group is conﬁgured to use
waf-dg-089	waf-dg.pdf	89	information, see Token use in AWS WAF intelligent threat mitigation. Rule action: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:signal:browser _inconsistency and awswaf:ma naged:aws:bot-control:TGT_S ignalBrowserInconsistency Using managed rule groups 255 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_ML_CoordinatedActivityL ow , TGT_ML_CoordinatedActivityM edium , TGT_ML_Coordinated ActivityHigh Inspects requests that are not from veriﬁed bots for anomalous behavior that’s consisten t with distributed, coordinated bot activity. The rule levels indicate the level of conﬁdenc e that a group of requests are participants in a coordinated attack. Note These rules only run if the rule group is conﬁgured to use machine learning (ML). For information about conﬁguri ng this choice, see Adding the AWS WAF Bot Control managed rule group to your web ACL. Note The thresholds that these rules apply can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. AWS WAF performs this inspection through machine learning analysis of website traﬃc statistics. AWS WAF analyzes web traﬃc every few minutes and optimizes the analysis for the detection of low intensity, long-dura tion bots that are distributed across many IP addresses. Using managed rule groups 256 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description These rules might match on a very small number of requests before determining that a coordinated attack is not underway. So if you see just a match or two, the results might be false positives. If you see a lot of matches coming out of these rules however, then you're probably experiencing a coordinated attack. Note These rules can take up to 24 hours to go into eﬀect after you enable the Bot Control targeted rules with the ML option. Bot Control identiﬁe s anomalous behavior in your web traﬃc by comparing the current traﬃc to traﬃc baselines that AWS WAF ha s computed. AWS WAF only computes the baselines while you're using the Bot Control targeted rules with t he ML option, and it can take up to 24 hours to establish meaningful baselines. We periodically update our machine learning models for these rules, to improve bot predictions. If you notice a sudden and substantial change in the bot predictions that these rules make, contact your account manager or open a case at AWS Support Center. Rule actions: Using managed rule groups 257 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description • Low: Challenge • Medium: CAPTCHA • High: CAPTCHA Labels: awswaf:managed:aws:bot- control:targeted:aggregate:coor low\|medium\| dinated_activity: high and awswaf:managed:aws:bot- control:TGT_ML_CoordinatedActiv ity Low\|Medium\|High Using managed rule groups 258 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_TokenReuseIpLow , TGT_Token ReuseIpMedium , TGT_TokenReuseIpHi gh Inspects requests that are not from veriﬁed bots for the use of a single token among multiple IPs in the last 5 minutes. Each level has a limit on the number of distinct IPs: • Low: more than 3 • Medium: more than 4 • High: more than 8 Note The thresholds that these rules apply can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule actions: • Low: Count • Medium: CAPTCHA • High: Block Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:session:token_reuse: ip: low\|medium\|high and awswaf:ma naged:aws:bot-control:TGT_T okenReuseIp Low\|Medium\|High Using managed rule groups 259 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_TokenReuseCountryLow , TGT_TokenReuseCountryMedium , Inspects requests that are not from veriﬁed bots for the use of a single token across TGT_TokenReuseCountryHigh multiple countries in the last 5 minutes. Each level has a limit on the number of distinct countries: • Low: more than 1 • Medium: more than 2 • High: more than 3 Note The thresholds that these rules apply can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule actions: • Low: Count • Medium: CAPTCHA • High: Block Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:session:token_reuse: country: low\|medium\|high and awswaf:managed:aws:bot-cont rol:TGT_TokenReuseCountry Low\| Medium\|High Using managed rule groups 260 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule name Description TGT_TokenReuseAsnLow , TGT_Token ReuseAsnMedium , TGT_Token Inspects requests that are not from veriﬁed bots for the use of a single token across ReuseAsnHigh multiple networking autonomous system numbers (ASNs) in the last 5 minutes. Each level has a limit on the number of distinct ASNs: • Low: more than 1 • Medium: more than 2 • High: more than 3 Note The thresholds that these rules apply can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule actions: • Low: Count • Medium: CAPTCHA • High: Block
waf-dg-090	waf-dg.pdf	90	TGT_TokenReuseAsnLow , TGT_Token ReuseAsnMedium , TGT_Token Inspects requests that are not from veriﬁed bots for the use of a single token across ReuseAsnHigh multiple networking autonomous system numbers (ASNs) in the last 5 minutes. Each level has a limit on the number of distinct ASNs: • Low: more than 1 • Medium: more than 2 • High: more than 3 Note The thresholds that these rules apply can vary slightly due to latency. A few requests might make it through beyond the limit before the rule action is applied. Rule actions: • Low: Count • Medium: CAPTCHA • High: Block Labels: awswaf:managed:aws:bot- control:targeted:aggregate:volu metric:session:token_reuse: asn: low\|medium\|high and awswaf:ma naged:aws:bot-control:TGT_T okenReuseAsn Low\|Medium\|High Using managed rule groups 261 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Deployments for versioned AWS Managed Rules rule groups This section introduces how AWS deploys updates to AWS Managed Rules rule groups. AWS deploys changes to its versioned AWS Managed Rules rule groups in three standard deployments: release candidate, static version, and default version. Additionally, AWS might sometimes need to release an exception deployment or roll back a default version deployment. Note This section applies only to AWS Managed Rules rule groups that are versioned. The only rule groups that aren't versioned are the IP reputation rule groups. Topics • Notiﬁcations for AWS Managed Rules rule groups deployments • Overview of the standard deployments for AWS Managed Rules • Typical version states for AWS Managed Rules • Release candidate deployments for AWS Managed Rules • Static version deployments for AWS Managed Rules • Default version deployments for AWS Managed Rules • Exception deployments for AWS Managed Rules • Default deployment rollbacks for AWS Managed Rules Notiﬁcations for AWS Managed Rules rule groups deployments This section explains how Amazon SNS notiﬁcations work with AWS Managed Rules rule groups. The versioned AWS Managed Rules rule groups all provide SNS update notiﬁcations for deployments and they all use the same SNS topic Amazon Resource Name (ARN). The only rule groups that aren't versioned are the IP reputation rule groups. For deployments that aﬀect your protections, such as changes to the default version, AWS provides SNS notiﬁcations to inform you of planned deployments and to let you know when a deployment is starting. For deployments that don't aﬀect your protections, such as release candidate and static version deployments, AWS might notify you after the deployment has started or even after it's completed. At the completion of the deployment of a new static version, AWS updates this guide, Using managed rule groups 262 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide in the changelog at AWS Managed Rules changelog and in the document history page at Document history. To receive all updates that AWS provides for the AWS Managed Rules rule groups, subscribe to the RSS feed from any HTML page of this guide, and subscribe to the SNS topic for the AWS Managed Rules rule groups. For information about subscribing to the SNS notiﬁcations, see Getting notiﬁed of new versions and updates to a managed rule group. Contents of the SNS notiﬁcations The ﬁelds in the Amazon SNS notiﬁcations always include the Subject, Message, and MessageAttributes. Additional ﬁelds depend on the type of message and which managed rule group the notiﬁcation is for. The following shows an example notiﬁcation listing for AWSManagedRulesCommonRuleSet. { "Type": "Notification", "MessageId": "4286b830-a463-5e61-bd15-e1ae72303868", "TopicArn": "arn:aws:sns:us-west-2:123456789012:MyTopic", "Subject": "New version available for rule group AWSManagedRulesCommonRuleSet", "Message": "Welcome to AWSManagedRulesCommonRuleSet version 1.5! We've updated the regex specification in this version to improve protection coverage, adding protections against insecure deserialization. For details about this change, see http://updatedPublicDocs.html. Look for more exciting updates in the future! ", "Timestamp": "2021-08-24T11:12:19.810Z", "SignatureVersion": "1", "Signature": "EXAMPLEHXgJm...", "SigningCertURL": "https://sns.us-west-2.amazonaws.com/SimpleNotificationService- f3ecfb7224c7233fe7bb5f59f96de52f.pem", "SubscribeURL": "https://sns.us-west-2.amazonaws.com/? Action=ConfirmSubscription&TopicArn=arn:aws:sns:us- west-2:123456789012:MyTopic&Token=2336412f37...", "MessageAttributes": { "major_version": { "Type": "String", "Value": "v1" }, "managed_rule_group": { "Type": "String", "Value": "AWSManagedRulesCommonRuleSet" } } Using managed rule groups 263 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide } Overview of the standard deployments for AWS Managed Rules AWS rolls out new AWS Managed Rules functionality using three standard deployment stages: release candidate, static version, and default version. The following diagram depicts these standard deployments. Each is described in more detail in the sections that follow. Using managed rule groups 264 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Typical version states for AWS Managed Rules Normally, a versioned managed rule group has a number of unexpired static versions, and the default version points to the static version that AWS recommends. The following ﬁgure shows an example of the typical set of static versions and default version setting. The production action for most rules in a static version is Block, but it might be set to something diﬀerent. For detailed information about rule action settings, see the rule
waf-dg-091	waf-dg.pdf	91	in the sections that follow. Using managed rule groups 264 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Typical version states for AWS Managed Rules Normally, a versioned managed rule group has a number of unexpired static versions, and the default version points to the static version that AWS recommends. The following ﬁgure shows an example of the typical set of static versions and default version setting. The production action for most rules in a static version is Block, but it might be set to something diﬀerent. For detailed information about rule action settings, see the rule listings for each rule group at AWS Managed Rules rule groups list. Release candidate deployments for AWS Managed Rules This section explains how a temporary release candidate deployment works. When AWS has a candidate set of rule changes for a managed rule group, it tests them in a temporary release candidate deployment. AWS evaluates the candidate rules in count mode against production traﬃc, and performs ﬁnal tuning activities, including mitigating false positives. AWS tests release candidate rules in this way for all customers who use the default version of the rule group. Release candidate deployments don't apply to customers who use a static version of the rule group. If you use the default version, a release candidate deployment won't alter how your web traﬃc is managed by the rule group. You might notice the following while the candidate rules are being tested: • Default version name change from Default (using Version_X.Y) to Default (using Version_X.Y_PLUS_RC_COUNT). Using managed rule groups 265 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Additional count metrics in Amazon CloudWatch with RC_COUNT in their names. These are generated by the release candidate rules. AWS tests a release candidate for about a week, then removes it and resets the default version to the current recommended static version. AWS performs the following steps for a release candidate deployment: 1. Create the release candidate – AWS adds a release candidate based on the current recommended static version, which is the version that the default is pointing to. The name of the release candidate is the static version name appended with _PLUS_RC_COUNT. For example, if the current recommended static version is Version_2.1, then the release candidate would be named Version_2.1_PLUS_RC_COUNT. The release candidate contains the following rules: • Rules copied exactly from the current recommended static version, with no changes to rule conﬁgurations. • Candidate new rules with rule action set to Count and with names that end with _RC_COUNT. Most candidate rules provide proposed improvements to rules that exist already in the rule group. The name for each of these rules is the existing rule's name appended with _RC_COUNT. 2. Set the default version to the release candidate and test – AWS sets the default version to point to the new release candidate, to perform testing against your production traﬃc. Testing usually takes about a week. You'll see the default version's name change from the one that indicates only the static version, such as Default (using Version_1.4), to one that indicates the static version plus the release candidate rules, such as Default (using Version_1.4_PLUS_RC_COUNT). This naming scheme lets you identify which static version you're using to manage your web traﬃc. The following diagram shows the state of the example rule group versions at this point. Using managed rule groups 266 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide The release candidate rules are always conﬁgured with Count action, so they don't alter how the rule group manages web traﬃc. The release candidate rules generate Amazon CloudWatch count metrics that AWS uses to verify behavior and to identify false positives. AWS makes adjustments as needed, to tune the behavior of the release candidate count rules. The release candidate version isn't a static version, and it's not available for you to choose from the list of static rule group versions. You can only see the name of the release candidate version in the default version speciﬁcation. 3. Return the default version to the recommended static version – After testing the release candidate rules, AWS sets the default version back to the current recommended static version. The default version name setting drops the _PLUS_RC_COUNT ending, and the rule group stops Using managed rule groups 267 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide generating CloudWatch count metrics for the release candidate rules. This is a silent change, and is not the same as a deployment of a default version rollback. The following diagram shows the state of the example rule group versions after the testing of the release candidate is complete. Timing and notiﬁcations AWS deploys release candidate versions on an as-needed basis, to test improvements to a rule group. • SNS
waf-dg-092	waf-dg.pdf	92	version. The default version name setting drops the _PLUS_RC_COUNT ending, and the rule group stops Using managed rule groups 267 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide generating CloudWatch count metrics for the release candidate rules. This is a silent change, and is not the same as a deployment of a default version rollback. The following diagram shows the state of the example rule group versions after the testing of the release candidate is complete. Timing and notiﬁcations AWS deploys release candidate versions on an as-needed basis, to test improvements to a rule group. • SNS – AWS sends an SNS notiﬁcation at the start of the deployment. The notiﬁcation indicates the estimated time that the release candidate will be tested. When testing is complete, AWS silently returns the default to the static version setting, without a second notiﬁcation. • Change log – AWS doesn't update the change log or other parts of this guide for this type of deployment. Static version deployments for AWS Managed Rules When AWS determines that a release candidate provides valuable changes to the rule group, AWS deploys a new static version for the rule group based on the release candidate. This deployment doesn't change the default version of the rule group. The new static version contains the following rules from the release candidate: Using managed rule groups 268 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide • Rules from the prior static version that don't have a replacement candidate among the release candidate rules. • Release candidate rules, with the following changes: • AWS changes the rule name by removing the release candidate suﬃx _RC_COUNT. • AWS changes the rule actions from Count to their production rule actions. For release candidate rules that are replacements of prior existing rules, this replaces the functionality of the prior rules in the new static version. The following diagram depicts the creation of the new static version from the release candidate. After deployment, the new static version is available for you to test and to use in your protections if you want to. You can review new and updated rule actions and descriptions in the rule group's rule listings at AWS Managed Rules rule groups list. Using managed rule groups 269 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide A static version is immutable after deployment, and only changes when AWS expires it. For information about version life cycles, see Using versioned managed rule groups in AWS WAF. Timing and notiﬁcations AWS deploys a new static version as needed, in order to deploy improvements to rule group functionality. The deployment of a static version doesn't impact the default version setting. • SNS – AWS sends an SNS notiﬁcation when the deployment completes. • Change log – After the deployment is complete everywhere that AWS WAF is available, AWS updates the rule group deﬁnition in this guide as needed, and then announces the release in the AWS Managed Rules rule group change log and in the documentation history page. Default version deployments for AWS Managed Rules When AWS determines that a new static version provides improved protections for the rule group compared to the current default, AWS updates the default version to the new static version. AWS might release multiple static versions before promoting one to the rule group's default version. The following diagram shows the state of the example rule group versions after AWS moves the default version setting to the new static version. Before deploying this change to the default version, AWS provides notiﬁcations so that you can test and prepare for the upcoming changes. If you use the default version, you can take no action Using managed rule groups 270 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide and remain on it through the update. If instead you want to delay switching to the new version, before the planned start of the default version deployment, you can explicitly conﬁgure your rule group to use the static version that the default is set to. Timing and notiﬁcations AWS updates the default version when it recommends a diﬀerent static version for the rule group than the one that's currently in use. • SNS – AWS sends an SNS notiﬁcation at least one week prior to the targeted deployment day and then another on the deployment day, at the start of the deployment. Each notiﬁcation includes the rule group name, the static version that the default version is being updated to, the deployment date, and the scheduled timing of the deployment for each AWS Region where the update is being performed. • Change log – AWS doesn't update the change log or other parts of this guide for this type of deployment. Exception deployments for AWS
waf-dg-093	waf-dg.pdf	93	the one that's currently in use. • SNS – AWS sends an SNS notiﬁcation at least one week prior to the targeted deployment day and then another on the deployment day, at the start of the deployment. Each notiﬁcation includes the rule group name, the static version that the default version is being updated to, the deployment date, and the scheduled timing of the deployment for each AWS Region where the update is being performed. • Change log – AWS doesn't update the change log or other parts of this guide for this type of deployment. Exception deployments for AWS Managed Rules AWS might bypass the standard deployment stages in order to quickly deploy updates that address critical security risks. An exception deployment might involve any of the standard deployment types, and it might be rolled out quickly across the AWS Regions. AWS provides as much advance notiﬁcation as possible for exception deployments. Timing and notiﬁcations AWS performs exception deployments only when required. • SNS – AWS sends an SNS notiﬁcation as far ahead of the targeted deployment day as possible and then another one at the start of the deployment. Each notiﬁcation includes the rule group name, the change that's being made, and the deployment date. • Change log – If the deployment is for a static version, after the deployment is complete everywhere that AWS WAF is available, AWS updates the rule group deﬁnition in this guide as needed, and then announces the release in the AWS Managed Rules rule group change log and in the documentation history page. Using managed rule groups 271 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Default deployment rollbacks for AWS Managed Rules Under certain conditions, AWS might roll back the default version to its prior setting. A rollback usually takes less than ten minutes for all AWS Regions. AWS performs a rollback only to mitigate a signiﬁcant issue in a static version, such as an unacceptably high level of false positives. After the rollback of the default version setting, AWS expedites both the expiration of the static version that has the issue and the release of a new static version to address the issue. Timing and notiﬁcations AWS performs default version rollbacks only when required. • SNS – AWS sends a single SNS notiﬁcation at the time of the rollback. The notiﬁcation includes the rule group name, the version that the default version is being set to, and the deployment date. This deployment type is very quick, so the notiﬁcation doesn't provide timing information for Regions. • Change log – AWS doesn't update the change log or other parts of this guide for this type of deployment. AWS Managed Rules changelog This section lists changes to the AWS Managed Rules for AWS WAF since their release in November, 2019. Note This changelog reports changes to the rules and rule groups in AWS Managed Rules for AWS WAF. For the IP reputation rule groups, this changelog reports changes to the rules and rule group, and it reports signiﬁcant changes to the sources of the IP address lists that the rules use. It does not report changes to the IP address lists themselves, due to the dynamic nature of those lists. If you have questions about the IP address lists, contact your account manager or open a case at AWS Support Center. Using managed rule groups 272 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule group and rules Description Date Core rule set (CRS) managed rule group Released static version 1.17 of this rule group. 2025-03-03 • CrossSiteScripting Improved detection signature _BODY s for the cross site scripting • CrossSiteScripting rules. _COOKIE • CrossSiteScripting _QUERYARGUMENTS • CrossSiteScripting _URIPATH SQL database managed rule group Released static version 1.3 of this rule group. 2025-01-24 Added double URL_DECOD E_UNI text transformation to the listed rules. • • • • SQLi_COOKIE SQLi_URIPATH SQLi_QUERYARGUMENTS SQLi_BODY Linux operating system managed rule group Released static version 2.6 of this rule group. 2025-01-24 Added signatures to improve detection. LFI_HEADER LFI_URIPATH • • • LFI_QUERYSTRING Using managed rule groups 273 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule group and rules Description Date AWS WAF Bot Control rule group Released static version 3.1 of this rule group. 2024-11-07 New bot name label in Added the New York Times the Bot Control labels: label to the list of bot name awswaf:managed:aws labels. :bot-control:bot:: name:nytimes Core rule set (CRS) managed rule group Released static version 1.16 of this rule group. 2024-10-16 • CrossSiteScripting Improved detection signature _BODY s for the cross site scripting • CrossSiteScripting rules. _COOKIE • CrossSiteScripting _QUERYARGUMENTS • CrossSiteScripting _URIPATH Using managed rule groups 274 AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide Rule group and rules

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.