feat(waf): add new check waf_global_rulegroup_not_empty (#5467)

Co-authored-by: Sergio <sergio@prowler.com>
2026-07-24 21:11:53 +00:00 · 2024-10-21 21:53:06 +02:00
parent 2ef9e27ee3
commit ffa29f2f6e
4 changed files with 246 additions and 0 deletions
@@ -0,0 +1,187 @@
+from unittest import mock
+from unittest.mock import patch
+
+import botocore
+from moto import mock_aws
+
+from tests.providers.aws.utils import (
+    AWS_ACCOUNT_NUMBER,
+    AWS_REGION_US_EAST_1,
+    set_mocked_aws_provider,
+)
+
+RULE_GROUP_ID = "test-rulegroup-id"
+RULE_ID = "my-rule-id"
+
+# Original botocore _make_api_call function
+orig = botocore.client.BaseClient._make_api_call
+
+
+# Mocked botocore _make_api_call function
+def mock_make_api_call_compliant_rule_group(self, operation_name, kwarg):
+    unused_operations = ["ListWebACLs", "GetRule"]
+    if operation_name in unused_operations:
+        return {}
+    if operation_name == "ListRules":
+        return {
+            "Rules": [
+                {
+                    "RuleId": RULE_ID,
+                    "Name": "my-rule",
+                },
+            ]
+        }
+    if operation_name == "GetRule":
+        return {
+            "Rule": {
+                "RuleId": RULE_ID,
+                "Name": "my-rule",
+                "Predicates": [
+                    {
+                        "Negated": False,
+                        "Type": "IPMatch",
+                        "DataId": "my-data-id",
+                    }
+                ],
+            }
+        }
+    if operation_name == "ListRuleGroups":
+        return {
+            "RuleGroups": [
+                {
+                    "RuleGroupId": RULE_GROUP_ID,
+                    "Name": RULE_GROUP_ID,
+                },
+            ]
+        }
+    if operation_name == "ListActivatedRulesInRuleGroup":
+        return {
+            "ActivatedRules": [
+                {
+                    "RuleId": RULE_ID,
+                },
+            ]
+        }
+    return orig(self, operation_name, kwarg)
+
+
+def mock_make_api_call_non_compliant_rule_group(self, operation_name, kwarg):
+    unused_operations = ["ListRules", "GetRule", "ListWebACLs", "GetRule"]
+    if operation_name in unused_operations:
+        return {}
+    if operation_name == "ListRuleGroups":
+        return {
+            "RuleGroups": [
+                {
+                    "RuleGroupId": RULE_GROUP_ID,
+                    "Name": RULE_GROUP_ID,
+                },
+            ]
+        }
+    if operation_name == "ListActivatedRulesInRuleGroup":
+        return {"Rules": []}
+    return orig(self, operation_name, kwarg)
+
+
+class Test_waf_global_rulegroup_not_empty:
+    @mock_aws
+    def test_no_rule_groups(self):
+        from prowler.providers.aws.services.waf.waf_service import WAF
+
+        aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1])
+
+        with mock.patch(
+            "prowler.providers.common.provider.Provider.get_global_provider",
+            return_value=aws_provider,
+        ):
+            with mock.patch(
+                "prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty.waf_client",
+                new=WAF(aws_provider),
+            ):
+                # Test Check
+                from prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty import (
+                    waf_global_rulegroup_not_empty,
+                )
+
+                check = waf_global_rulegroup_not_empty()
+                result = check.execute()
+
+                assert len(result) == 0
+
+    @patch(
+        "botocore.client.BaseClient._make_api_call",
+        new=mock_make_api_call_compliant_rule_group,
+    )
+    @mock_aws
+    def test_waf_rules_with_condition(self):
+        from prowler.providers.aws.services.waf.waf_service import WAF
+
+        aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1])
+
+        with mock.patch(
+            "prowler.providers.common.provider.Provider.get_global_provider",
+            return_value=aws_provider,
+        ):
+            with mock.patch(
+                "prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty.waf_client",
+                new=WAF(aws_provider),
+            ):
+                # Test Check
+                from prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty import (
+                    waf_global_rulegroup_not_empty,
+                )
+
+                check = waf_global_rulegroup_not_empty()
+                result = check.execute()
+
+                assert len(result) == 1
+                assert result[0].status == "PASS"
+                assert (
+                    result[0].status_extended
+                    == f"AWS WAF Global Rule Group {RULE_GROUP_ID} is not empty."
+                )
+                assert result[0].resource_id == RULE_GROUP_ID
+                assert (
+                    result[0].resource_arn
+                    == f"arn:aws:waf:{AWS_REGION_US_EAST_1}:{AWS_ACCOUNT_NUMBER}:rulegroup/{RULE_GROUP_ID}"
+                )
+                assert result[0].region == AWS_REGION_US_EAST_1
+
+    @patch(
+        "botocore.client.BaseClient._make_api_call",
+        new=mock_make_api_call_non_compliant_rule_group,
+    )
+    @mock_aws
+    def test_waf_rules_without_condition(self):
+        from prowler.providers.aws.services.waf.waf_service import WAF
+
+        aws_provider = set_mocked_aws_provider([AWS_REGION_US_EAST_1])
+
+        with mock.patch(
+            "prowler.providers.common.provider.Provider.get_global_provider",
+            return_value=aws_provider,
+        ):
+            with mock.patch(
+                "prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty.waf_client",
+                new=WAF(aws_provider),
+            ):
+                # Test Check
+                from prowler.providers.aws.services.waf.waf_global_rulegroup_not_empty.waf_global_rulegroup_not_empty import (
+                    waf_global_rulegroup_not_empty,
+                )
+
+                check = waf_global_rulegroup_not_empty()
+                result = check.execute()
+
+                assert len(result) == 1
+                assert result[0].status == "FAIL"
+                assert (
+                    result[0].status_extended
+                    == f"AWS WAF Global Rule Group {RULE_GROUP_ID} does not have any rules."
+                )
+                assert result[0].resource_id == RULE_GROUP_ID
+                assert (
+                    result[0].resource_arn
+                    == f"arn:aws:waf:{AWS_REGION_US_EAST_1}:{AWS_ACCOUNT_NUMBER}:rulegroup/{RULE_GROUP_ID}"
+                )
+                assert result[0].region == AWS_REGION_US_EAST_1