feat(repository): add new check repository_default_branch_disallows_force_push (#6197)

Co-authored-by: MrCloudSec <hello@mistercloudsec.com>

prowler/CHANGELOG.md

@@ -12,6 +12,7 @@ All notable changes to the **Prowler SDK** are documented in this file.
 - Add `repository_default_branch_requires_multiple_approvals` check for GitHub provider. [(#6160)](https://github.com/prowler-cloud/prowler/pull/6160)
 - Add `repository_default_branch_protection_enabled` check for GitHub provider. [(#6161)](https://github.com/prowler-cloud/prowler/pull/6161)
 - Add `repository_default_branch_requires_linear_history` check for GitHub provider. [(#6162)](https://github.com/prowler-cloud/prowler/pull/6162)
+- Add `repository_default_branch_disallows_force_push` check for GitHub provider. [(#6197)](https://github.com/prowler-cloud/prowler/pull/6197)
 - Add `organization_members_mfa_required` check for GitHub provider. [(#6304)](https://github.com/prowler-cloud/prowler/pull/6304)
 - Add GitHub provider documentation and CIS v1.0.0 compliance. [(#6116)](https://github.com/prowler-cloud/prowler/pull/6116)
 

prowler/providers/github/services/repository/repository_default_branch_disallows_force_push/repository_default_branch_disallows_force_push.metadata.json

@@ -0,0 +1,30 @@
+{
+  "Provider": "github",
+  "CheckID": "repository_default_branch_disallows_force_push",
+  "CheckTitle": "Check if repository denies force push",
+  "CheckType": [],
+  "ServiceName": "repository",
+  "SubServiceName": "",
+  "ResourceIdTemplate": "",
+  "Severity": "high",
+  "ResourceType": "GithubRepository",
+  "Description": "Ensure that the repository denies force push to protected branches.",
+  "Risk": "Permitting force pushes to branches can lead to accidental or intentional overwrites of the commit history, resulting in potential data loss, code inconsistencies, or the introduction of malicious changes. This compromises the stability and security of the repository.",
+  "RelatedUrl": "https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#allow-force-pushes",
+  "Remediation": {
+    "Code": {
+      "CLI": "",
+      "NativeIaC": "",
+      "Other": "",
+      "Terraform": ""
+    },
+    "Recommendation": {
+      "Text": "Disable force pushes on protected branches to preserve the commit history and ensure the integrity of the repository. This measure helps prevent unintentional data loss and protects the repository from malicious changes.",
+      "Url": "https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule"
+    }
+  },
+  "Categories": [],
+  "DependsOn": [],
+  "RelatedTo": [],
+  "Notes": ""
+}

prowler/providers/github/services/repository/repository_default_branch_disallows_force_push/repository_default_branch_disallows_force_push.py

@@ -0,0 +1,42 @@
+from typing import List
+
+from prowler.lib.check.models import Check, CheckReportGithub
+from prowler.providers.github.services.repository.repository_client import (
+    repository_client,
+)
+
+
+class repository_default_branch_disallows_force_push(Check):
+    """Check if a repository denies force push
+
+    This class verifies whether each repository denies force push.
+    """
+
+    def execute(self) -> List[CheckReportGithub]:
+        """Execute the Github Repository Denies Force Push check
+
+        Iterates over all repositories and checks if they deny force push.
+
+        Returns:
+            List[CheckReportGithub]: A list of reports for each repository
+        """
+        findings = []
+        for repo in repository_client.repositories.values():
+            if repo.allow_force_pushes is not None:
+                report = CheckReportGithub(
+                    metadata=self.metadata(), resource=repo, repository=repo.name
+                )
+                report.status = "FAIL"
+                report.status_extended = (
+                    f"Repository {repo.name} does allow force push."
+                )
+
+                if not repo.allow_force_pushes:
+                    report.status = "PASS"
+                    report.status_extended = (
+                        f"Repository {repo.name} does deny force push."
+                    )
+
+                findings.append(report)
+
+        return findings

prowler/providers/github/services/repository/repository_service.py

@@ -34,6 +34,7 @@ class Repository(GithubService):
                     approval_cnt = 0
                     branch_protection = False
                     required_linear_history = False
+                    allow_force_pushes = True
                     try:
                         branch = repo.get_branch(default_branch)
                         if branch.protected:
@@ -50,14 +51,21 @@ class Repository(GithubService):
                                 required_linear_history = (
                                     protection.required_linear_history
                                 )
+                                allow_force_pushes = protection.allow_force_pushes
                                 branch_protection = True
                     except Exception as error:
                         # If the branch is not found, it is not protected
-                        if "404" not in str(error):
+                        if "404" in str(error):
+                            logger.warning(
+                                f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
+                            )
+                        # Any other error, we cannot know if the branch is protected or not
+                        else:
                             require_pr = None
                             approval_cnt = None
                             branch_protection = None
                             required_linear_history = None
+                            allow_force_pushes = None
                             logger.error(
                                 f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
                             )
@@ -72,6 +80,7 @@ class Repository(GithubService):
                         require_pull_request=require_pr,
                         approval_count=approval_cnt,
                         required_linear_history=required_linear_history,
+                        allow_force_pushes=allow_force_pushes,
                         default_branch_protection=branch_protection,
                     )
 
@@ -94,4 +103,5 @@ class Repo(BaseModel):
     securitymd: Optional[bool]
     require_pull_request: Optional[bool]
     required_linear_history: Optional[bool]
+    allow_force_pushes: Optional[bool]
     approval_count: Optional[int]

tests/providers/github/services/repository/repository_default_branch_disallows_force_push/repository_default_branch_disallows_force_push_test.py

@@ -0,0 +1,110 @@
+from unittest import mock
+
+from prowler.providers.github.services.repository.repository_service import Repo
+from tests.providers.github.github_fixtures import set_mocked_github_provider
+
+
+class Test_repository_default_branch_disallows_force_push_test:
+    def test_no_repositories(self):
+        repository_client = mock.MagicMock
+        repository_client.repositories = {}
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push import (
+                repository_default_branch_disallows_force_push,
+            )
+
+            check = repository_default_branch_disallows_force_push()
+            result = check.execute()
+            assert len(result) == 0
+
+    def test_allow_force_push_enabled(self):
+        repository_client = mock.MagicMock
+        repo_name = "repo1"
+        default_branch = "main"
+        repository_client.repositories = {
+            1: Repo(
+                id=1,
+                name=repo_name,
+                full_name="account-name/repo1",
+                default_branch=default_branch,
+                allow_force_pushes=True,
+                private=False,
+                securitymd=False,
+            ),
+        }
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push import (
+                repository_default_branch_disallows_force_push,
+            )
+
+            check = repository_default_branch_disallows_force_push()
+            result = check.execute()
+            assert len(result) == 1
+            assert result[0].resource_id == 1
+            assert result[0].resource_name == "repo1"
+            assert result[0].status == "FAIL"
+            assert (
+                result[0].status_extended
+                == f"Repository {repo_name} does allow force push."
+            )
+
+    def test_allow_force_push_disabled(self):
+        repository_client = mock.MagicMock
+        repo_name = "repo1"
+        default_branch = "main"
+        repository_client.repositories = {
+            1: Repo(
+                id=1,
+                name=repo_name,
+                full_name="account-name/repo1",
+                private=False,
+                default_branch=default_branch,
+                allow_force_pushes=False,
+                securitymd=True,
+            ),
+        }
+
+        with (
+            mock.patch(
+                "prowler.providers.common.provider.Provider.get_global_provider",
+                return_value=set_mocked_github_provider(),
+            ),
+            mock.patch(
+                "prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push.repository_client",
+                new=repository_client,
+            ),
+        ):
+            from prowler.providers.github.services.repository.repository_default_branch_disallows_force_push.repository_default_branch_disallows_force_push import (
+                repository_default_branch_disallows_force_push,
+            )
+
+            check = repository_default_branch_disallows_force_push()
+            result = check.execute()
+            assert len(result) == 1
+            assert result[0].resource_id == 1
+            assert result[0].resource_name == "repo1"
+            assert result[0].status == "PASS"
+            assert (
+                result[0].status_extended
+                == f"Repository {repo_name} does deny force push."
+            )

tests/providers/github/services/repository/repository_service_test.py

@@ -19,6 +19,7 @@ def mock_list_repositories(_):
             securitymd=True,
             require_pull_request=True,
             required_linear_history=True,
+            allow_force_pushes=True,
             approval_count=2,
         ),
     }
@@ -47,4 +48,5 @@ class Test_Repository_Service:
         assert repository_service.repositories[1].securitymd
         assert repository_service.repositories[1].required_linear_history
         assert repository_service.repositories[1].require_pull_request
+        assert repository_service.repositories[1].allow_force_pushes
         assert repository_service.repositories[1].approval_count == 2