From d0701ad0ce265c8040c3a676e4528c3e7fc206bd Mon Sep 17 00:00:00 2001 From: MrCloudSec Date: Tue, 19 Nov 2024 12:34:49 -0400 Subject: [PATCH] chore: revision --- prowler/lib/check/models.py | 28 +++++++++---------- prowler/lib/outputs/outputs.py | 2 ++ .../repository_public_has_securitymd_file.py | 20 ++++++------- .../services/repository/repository_service.py | 3 -- 4 files changed, 26 insertions(+), 27 deletions(-) diff --git a/prowler/lib/check/models.py b/prowler/lib/check/models.py index 8b4acf5733..b3801ed8d1 100644 --- a/prowler/lib/check/models.py +++ b/prowler/lib/check/models.py @@ -482,6 +482,20 @@ class Check_Report_Kubernetes(Check_Report): self.namespace = "" +@dataclass +class Check_Report_Github(Check_Report): + # TODO change class name to CheckReportGitHub + """Contains the GitHub Check's finding information.""" + + resource_name: str + resource_id: str + + def __init__(self, metadata): + super().__init__(metadata) + self.resource_name = "" + self.resource_id = "" + + # Testing Pending def load_check_metadata(metadata_file: str) -> CheckMetadata: """ @@ -502,17 +516,3 @@ def load_check_metadata(metadata_file: str) -> CheckMetadata: sys.exit(1) else: return check_metadata - - -@dataclass -class Check_Report_Github(Check_Report): - """Contains the GitHub Check's finding information.""" - - account_name: str - resource_name: str - resource_id: str - - def __init__(self, metadata): - super().__init__(metadata) - self.resource_name = "" - self.resource_id = "" diff --git a/prowler/lib/outputs/outputs.py b/prowler/lib/outputs/outputs.py index d600c851a6..5557aa2957 100644 --- a/prowler/lib/outputs/outputs.py +++ b/prowler/lib/outputs/outputs.py @@ -13,6 +13,8 @@ def stdout_report(finding, color, verbose, status, fix): details = finding.location.lower() if finding.check_metadata.Provider == "kubernetes": details = finding.namespace.lower() + if finding.check_metadata.Provider == "github": + details = "" if (verbose or fix) and (not status or finding.status in status): if finding.muted: diff --git a/prowler/providers/github/services/repository/repository_public_has_securitymd_file/repository_public_has_securitymd_file.py b/prowler/providers/github/services/repository/repository_public_has_securitymd_file/repository_public_has_securitymd_file.py index bb55aa72b1..f52f0a3fba 100644 --- a/prowler/providers/github/services/repository/repository_public_has_securitymd_file/repository_public_has_securitymd_file.py +++ b/prowler/providers/github/services/repository/repository_public_has_securitymd_file/repository_public_has_securitymd_file.py @@ -9,11 +9,11 @@ from prowler.providers.github.services.repository.repository_client import ( class repository_public_has_securitymd_file(Check): """Check if a public repository has a SECURITY.md file - This class verifies wheter each public repository has a SECURITY.md file. + This class verifies whether each public repository has a SECURITY.md file. """ def execute(self) -> List[Check_Report_Github]: - """Execute the Github Repository Public Has Securitymd File check + """Execute the Github Repository Public Has SECURITY.md File check Iterates over all public repositories and checks if they have a SECURITY.md file. @@ -22,15 +22,15 @@ class repository_public_has_securitymd_file(Check): """ findings = [] for repo in repository_client.repositories.values(): - report = Check_Report_Github(self.metadata()) - report.resource_id = repo.id - report.resource_name = repo.name - report.status = "PASS" - report.status_extended = ( - f"Repository {repo.name} does have a SECURITY.md file." - ) - if not repo.private: + report = Check_Report_Github(self.metadata()) + report.resource_id = repo.id + report.resource_name = repo.name + report.status = "PASS" + report.status_extended = ( + f"Repository {repo.name} does have a SECURITY.md file." + ) + if not repo.securitymd: report.status = "FAIL" report.status_extended = ( diff --git a/prowler/providers/github/services/repository/repository_service.py b/prowler/providers/github/services/repository/repository_service.py index 6566058c70..8ddebf3015 100644 --- a/prowler/providers/github/services/repository/repository_service.py +++ b/prowler/providers/github/services/repository/repository_service.py @@ -32,9 +32,6 @@ class Repository(GithubService): f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) - def get_repositories(self): - return self.repositories - class Repo(BaseModel): """Model for Github Repository"""