feat(gcp): add cloudstorage_bucket_versioning_enabled check

2026-07-24 04:51:51 +00:00 · 2025-10-24 09:29:15 +02:00
parent 77576983d1
commit f12cc5cd6a
5 changed files with 235 additions and 0 deletions
@@ -0,0 +1,36 @@
+{
+  "Provider": "gcp",
+  "CheckID": "cloudstorage_bucket_versioning_enabled",
+  "CheckTitle": "Cloud Storage buckets have Object Versioning enabled",
+  "CheckType": [],
+  "ServiceName": "cloudstorage",
+  "SubServiceName": "",
+  "ResourceIdTemplate": "",
+  "Severity": "medium",
+  "ResourceType": "storage.googleapis.com/Bucket",
+  "Description": "**Google Cloud Storage buckets** are evaluated to ensure that **Object Versioning** is enabled. Object Versioning preserves older versions of objects, allowing data recovery, maintaining audit trails, and protecting against accidental deletions or overwrites.",
+  "Risk": "Buckets without Object Versioning enabled cannot recover previous object versions, which increases the risk of permanent data loss from accidental deletion or modification.",
+  "RelatedUrl": "",
+  "AdditionalURLs": [
+    "https://www.trendmicro.com/cloudoneconformity/knowledge-base/gcp/CloudStorage/enable-versioning.html",
+    "https://cloud.google.com/storage/docs/object-versioning"
+  ],
+  "Remediation": {
+    "Code": {
+      "CLI": "gcloud storage buckets update gs://<BUCKET_NAME> --versioning",
+      "NativeIaC": "",
+      "Other": "1) Open Google Cloud Console → Storage → Buckets → <BUCKET_NAME>\n2) Tab 'Configuration'\n3) Under 'Object versioning', click 'Enable Object Versioning'\n4) Save changes",
+      "Terraform": "```hcl\n# Example: enable Object Versioning on a Cloud Storage bucket\nresource \"google_storage_bucket\" \"example\" {\n  name     = var.bucket_name\n  location = var.location\n\n  versioning {\n    enabled = true\n  }\n}\n```"
+    },
+    "Recommendation": {
+      "Text": "Enable Object Versioning on Cloud Storage buckets to preserve previous object versions and improve data recoverability and auditability.",
+      "Url": "https://hub.prowler.com/check/cloudstorage_bucket_versioning_enabled"
+    }
+  },
+  "Categories": [
+    "resilience"
+  ],
+  "DependsOn": [],
+  "RelatedTo": [],
+  "Notes": "Buckets missing the 'versioning' block are treated as having Object Versioning disabled."
+}
@@ -0,0 +1,30 @@
+from prowler.lib.check.models import Check, Check_Report_GCP
+from prowler.providers.gcp.services.cloudstorage.cloudstorage_client import (
+    cloudstorage_client,
+)
+
+
+class cloudstorage_bucket_versioning_enabled(Check):
+    """
+    Ensure Cloud Storage buckets have Object Versioning enabled.
+
+    Reports PASS if a bucket has versioning enabled, otherwise FAIL.
+    """
+
+    def execute(self) -> list[Check_Report_GCP]:
+        findings = []
+        for bucket in cloudstorage_client.buckets:
+            report = Check_Report_GCP(metadata=self.metadata(), resource=bucket)
+            report.status = "FAIL"
+            report.status_extended = (
+                f"Bucket {bucket.name} does not have Object Versioning enabled."
+            )
+
+            if bucket.versioning_enabled:
+                report.status = "PASS"
+                report.status_extended = (
+                    f"Bucket {bucket.name} has Object Versioning enabled."
+                )
+                
+            findings.append(report)
+        return findings
@@ -39,6 +39,10 @@ class CloudStorage(GCPService):
                            if isinstance(rules, list):
                                lifecycle_rules = rules

+                        versioning_enabled = (
+                            bucket.get("versioning", {}).get("enabled", False)
+                        )
+
                        self.buckets.append(
                            Bucket(
                                name=bucket["name"],
@@ -51,6 +55,7 @@ class CloudStorage(GCPService):
                                retention_policy=bucket.get("retentionPolicy"),
                                project_id=project_id,
                                lifecycle_rules=lifecycle_rules,
+                                versioning_enabled=versioning_enabled,
                            )
                        )

@@ -72,3 +77,4 @@ class Bucket(BaseModel):
    project_id: str
    retention_policy: Optional[dict] = None
    lifecycle_rules: Optional[list[dict]] = None
+    versioning_enabled: Optional[bool] = None 
@@ -0,0 +1,163 @@
+from unittest import mock
+
+from tests.providers.gcp.gcp_fixtures import (
+    GCP_PROJECT_ID,
+    GCP_US_CENTER1_LOCATION,
+    set_mocked_gcp_provider,
+)
+
+
+class TestCloudStorageBucketVersioningEnabled:
+    def test_bucket_without_versioning(self):
+        cloudstorage_client = mock.MagicMock()
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_gcp_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled.cloudstorage_client",
+                new=cloudstorage_client,
+            ),
+        ):
+            from prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled import (
+                cloudstorage_bucket_versioning_enabled,
+            )
+            from prowler.providers.gcp.services.cloudstorage.cloudstorage_service import (
+                Bucket,
+            )
+
+            cloudstorage_client.project_ids = [GCP_PROJECT_ID]
+            cloudstorage_client.region = GCP_US_CENTER1_LOCATION
+
+            cloudstorage_client.buckets = [
+                Bucket(
+                    name="no-versioning",
+                    id="no-versioning",
+                    region=GCP_US_CENTER1_LOCATION,
+                    uniform_bucket_level_access=True,
+                    public=False,
+                    retention_policy=None,
+                    project_id=GCP_PROJECT_ID,
+                    lifecycle_rules=[],
+                    versioning_enabled=False,
+                )
+            ]
+
+            check = cloudstorage_bucket_versioning_enabled()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "FAIL"
+            assert (
+                result[0].status_extended
+                == f"Bucket {cloudstorage_client.buckets[0].name} does not have Object Versioning enabled."
+            )
+            assert result[0].resource_id == "no-versioning"
+            assert result[0].resource_name == "no-versioning"
+            assert result[0].location == GCP_US_CENTER1_LOCATION
+            assert result[0].project_id == GCP_PROJECT_ID
+
+    def test_bucket_with_versioning_enabled(self):
+        cloudstorage_client = mock.MagicMock()
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_gcp_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled.cloudstorage_client",
+                new=cloudstorage_client,
+            ),
+        ):
+            from prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled import (
+                cloudstorage_bucket_versioning_enabled,
+            )
+            from prowler.providers.gcp.services.cloudstorage.cloudstorage_service import (
+                Bucket,
+            )
+
+            cloudstorage_client.project_ids = [GCP_PROJECT_ID]
+            cloudstorage_client.region = GCP_US_CENTER1_LOCATION
+
+            cloudstorage_client.buckets = [
+                Bucket(
+                    name="with-versioning",
+                    id="with-versioning",
+                    region=GCP_US_CENTER1_LOCATION,
+                    uniform_bucket_level_access=True,
+                    public=False,
+                    retention_policy=None,
+                    project_id=GCP_PROJECT_ID,
+                    lifecycle_rules=[],
+                    versioning_enabled=True,
+                )
+            ]
+
+            check = cloudstorage_bucket_versioning_enabled()
+            result = check.execute()
+
+            assert len(result) == 1
+            assert result[0].status == "PASS"
+            assert (
+                result[0].status_extended
+                == f"Bucket {cloudstorage_client.buckets[0].name} has Object Versioning enabled."
+            )
+            assert result[0].resource_id == "with-versioning"
+            assert result[0].resource_name == "with-versioning"
+            assert result[0].location == GCP_US_CENTER1_LOCATION
+            assert result[0].project_id == GCP_PROJECT_ID
+
+    def test_bucket_without_versioning_configured_treated_as_disabled(self):
+
+            cloudstorage_client = mock.MagicMock()
+
+            with (
+                mock.patch(
+                    "prowler.providers.common.provider.Provider.get_global_provider",
+                    return_value=set_mocked_gcp_provider(),
+                ),
+                mock.patch(
+                    "prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled.cloudstorage_client",
+                    new=cloudstorage_client,
+                ),
+            ):
+                from prowler.providers.gcp.services.cloudstorage.cloudstorage_bucket_versioning_enabled.cloudstorage_bucket_versioning_enabled import (
+                    cloudstorage_bucket_versioning_enabled,
+                )
+                from prowler.providers.gcp.services.cloudstorage.cloudstorage_service import (
+                    Bucket,
+                )
+
+                cloudstorage_client.project_ids = [GCP_PROJECT_ID]
+                cloudstorage_client.region = GCP_US_CENTER1_LOCATION
+
+                cloudstorage_client.buckets = [
+                    Bucket(
+                        name="no-versioning-config",
+                        id="no-versioning-config",
+                        region=GCP_US_CENTER1_LOCATION,
+                        uniform_bucket_level_access=True,
+                        public=False,
+                        retention_policy=None,
+                        project_id=GCP_PROJECT_ID,
+                        lifecycle_rules=[],
+                        versioning_enabled=False,
+                    )
+                ]
+
+                check = cloudstorage_bucket_versioning_enabled()
+                result = check.execute()
+
+                assert len(result) == 1
+                assert result[0].status == "FAIL"
+                assert (
+                    result[0].status_extended
+                    == f"Bucket {cloudstorage_client.buckets[0].name} does not have Object Versioning enabled."
+                )
+                assert result[0].resource_id == "no-versioning-config"
+                assert result[0].resource_name == "no-versioning-config"
+                assert result[0].location == GCP_US_CENTER1_LOCATION
+                assert result[0].project_id == GCP_PROJECT_ID