import json import os import sys from csv import DictWriter from io import TextIOWrapper from typing import Any from colorama import Fore, Style from tabulate import tabulate from config.config import ( csv_file_suffix, html_file_suffix, html_logo_img, html_logo_url, json_asff_file_suffix, json_file_suffix, orange_color, output_file_timestamp, prowler_version, timestamp, timestamp_iso, timestamp_utc, ) from lib.check.models import Output_From_Options from lib.logger import logger from lib.outputs.models import ( Check_Output_CSV, Check_Output_CSV_ENS_RD2022, Check_Output_JSON, Check_Output_JSON_ASFF, Compliance, ProductFields, Resource, Severity, ) from lib.utils.utils import file_exists, hash_sha512, open_file from providers.aws.lib.allowlist.allowlist import is_allowlisted from providers.aws.lib.audit_info.models import AWS_Audit_Info from providers.aws.lib.security_hub.security_hub import send_to_security_hub def report(check_findings, output_options, audit_info): try: # Sort check findings check_findings.sort(key=lambda x: x.region) # Generate the required output files # csv_fields = [] file_descriptors = {} if output_options.output_modes: if isinstance(audit_info, AWS_Audit_Info): # We have to create the required output files file_descriptors = fill_file_descriptors( output_options.output_modes, output_options.output_directory, output_options.output_filename, audit_info, ) if check_findings: for finding in check_findings: # Check if finding is allowlisted if output_options.allowlist_file: if is_allowlisted( output_options.allowlist_file, audit_info.audited_account, finding.check_metadata.CheckID, finding.region, finding.resource_id, ): finding.status = "WARNING" # Print findings by stdout color = set_report_color(finding.status) if output_options.is_quiet and "FAIL" in finding.status: print( f"\t{color}{finding.status}{Style.RESET_ALL} {finding.region}: {finding.status_extended}" ) elif not output_options.is_quiet and output_options.verbose: print( f"\t{color}{finding.status}{Style.RESET_ALL} {finding.region}: {finding.status_extended}" ) if file_descriptors: if finding.check_metadata.Provider == "aws": if "ens_rd2022_aws" in output_options.output_modes: # We have to retrieve all the check's compliance requirements check_compliance = output_options.bulk_checks_metadata[ finding.check_metadata.CheckID ].Compliance for compliance in check_compliance: if ( compliance.Framework == "ENS" and compliance.Version == "RD2022" ): for requirement in compliance.Requirements: requirement_description = ( requirement.Description ) requirement_id = requirement.Id for attribute in requirement.Attributes: compliance_row = Check_Output_CSV_ENS_RD2022( Provider=finding.check_metadata.Provider, AccountId=audit_info.audited_account, Region=finding.region, AssessmentDate=timestamp.isoformat(), Requirements_Id=requirement_id, Requirements_Description=requirement_description, Requirements_Attributes_IdGrupoControl=attribute.get( "IdGrupoControl" ), Requirements_Attributes_Marco=attribute.get( "Marco" ), Requirements_Attributes_Categoria=attribute.get( "Categoria" ), Requirements_Attributes_DescripcionControl=attribute.get( "DescripcionControl" ), Requirements_Attributes_Nivel=attribute.get( "Nivel" ), Requirements_Attributes_Tipo=attribute.get( "Tipo" ), Requirements_Attributes_Dimensiones=",".join( attribute.get("Dimensiones") ), Status=finding.status, StatusExtended=finding.status_extended, ResourceId=finding.resource_id, CheckId=finding.check_metadata.CheckID, ) csv_header = generate_csv_fields( Check_Output_CSV_ENS_RD2022 ) csv_writer = DictWriter( file_descriptors["ens_rd2022_aws"], fieldnames=csv_header, delimiter=";", ) csv_writer.writerow(compliance_row.__dict__) if "csv" in file_descriptors: finding_output = Check_Output_CSV( audit_info.audited_account, audit_info.profile, finding, audit_info.organizations_metadata, ) csv_writer = DictWriter( file_descriptors["csv"], fieldnames=generate_csv_fields(Check_Output_CSV), delimiter=";", ) csv_writer.writerow(finding_output.__dict__) if "json" in file_descriptors: finding_output = Check_Output_JSON( **finding.check_metadata.dict() ) fill_json(finding_output, audit_info, finding) json.dump( finding_output.dict(), file_descriptors["json"], indent=4, ) file_descriptors["json"].write(",") if "json-asff" in file_descriptors: finding_output = Check_Output_JSON_ASFF() fill_json_asff(finding_output, audit_info, finding) json.dump( finding_output.dict(), file_descriptors["json-asff"], indent=4, ) file_descriptors["json-asff"].write(",") if "html" in file_descriptors: fill_html(file_descriptors["html"], audit_info, finding) file_descriptors["html"].write("") # Check if it is needed to send findings to security hub if output_options.security_hub_enabled: send_to_security_hub( finding.region, finding_output, audit_info.audit_session ) else: # No service resources in the whole account color = set_report_color("INFO") if not output_options.is_quiet and output_options.verbose: print(f"\t{color}INFO{Style.RESET_ALL} There are no resources") # Separator between findings and bar if output_options.is_quiet or output_options.verbose: print() if file_descriptors: # Close all file descriptors for file_descriptor in file_descriptors: file_descriptors.get(file_descriptor).close() except Exception as error: logger.error( f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) def initialize_file_descriptor( filename: str, output_mode: str, audit_info: AWS_Audit_Info, format: Any = None, ) -> TextIOWrapper: """Open/Create the output file. If needed include headers or the required format""" try: if file_exists(filename): file_descriptor = open_file( filename, "a", ) else: file_descriptor = open_file( filename, "a", ) if output_mode in ("csv", "ens_rd2022_aws"): # Format is the class model of the CSV format to print the headers csv_header = [x.upper() for x in generate_csv_fields(format)] csv_writer = DictWriter( file_descriptor, fieldnames=csv_header, delimiter=";" ) csv_writer.writeheader() if output_mode in ("json", "json-asff"): file_descriptor.write("[") if "html" in output_mode: add_html_header(file_descriptor, audit_info) except Exception as error: logger.error( f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) return file_descriptor def fill_file_descriptors(output_modes, output_directory, output_filename, audit_info): try: file_descriptors = {} if output_modes: for output_mode in output_modes: if output_mode == "csv": filename = f"{output_directory}/{output_filename}{csv_file_suffix}" file_descriptor = initialize_file_descriptor( filename, output_mode, audit_info, Check_Output_CSV, ) file_descriptors.update({output_mode: file_descriptor}) if output_mode == "json": filename = f"{output_directory}/{output_filename}{json_file_suffix}" file_descriptor = initialize_file_descriptor( filename, output_mode, audit_info ) file_descriptors.update({output_mode: file_descriptor}) if output_mode == "json-asff": filename = ( f"{output_directory}/{output_filename}{json_asff_file_suffix}" ) file_descriptor = initialize_file_descriptor( filename, output_mode, audit_info ) file_descriptors.update({output_mode: file_descriptor}) if output_mode == "html": filename = f"{output_directory}/{output_filename}{html_file_suffix}" file_descriptor = initialize_file_descriptor( filename, output_mode, audit_info ) file_descriptors.update({output_mode: file_descriptor}) if output_mode == "ens_rd2022_aws": filename = f"{output_directory}/{output_filename}_ens_rd2022_aws{csv_file_suffix}" file_descriptor = initialize_file_descriptor( filename, output_mode, audit_info, Check_Output_CSV_ENS_RD2022 ) file_descriptors.update({output_mode: file_descriptor}) except Exception as error: logger.error( f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}" ) return file_descriptors def set_report_color(status: str) -> str: """Return the color for a give result status""" color = "" if status == "PASS": color = Fore.GREEN elif status == "FAIL": color = Fore.RED elif status == "ERROR": color = Fore.BLACK elif status == "WARNING": color = orange_color elif status == "INFO": color = Fore.YELLOW else: raise Exception("Invalid Report Status. Must be PASS, FAIL, ERROR or WARNING") return color def generate_csv_fields(format: Any) -> list[str]: """Generates the CSV headers for the given class""" csv_fields = [] for field in format.__dict__.get("__annotations__").keys(): csv_fields.append(field) return csv_fields def fill_json(finding_output, audit_info, finding): finding_output.AssessmentStartTime = timestamp_iso finding_output.FindingUniqueId = "" finding_output.Profile = audit_info.profile finding_output.AccountId = audit_info.audited_account if audit_info.organizations_metadata: finding_output.OrganizationsInfo = audit_info.organizations_metadata.__dict__ finding_output.Region = finding.region finding_output.Status = finding.status finding_output.StatusExtended = finding.status_extended finding_output.ResourceId = finding.resource_id finding_output.ResourceArn = finding.resource_arn finding_output.ResourceDetails = finding.resource_details return finding_output def fill_json_asff(finding_output, audit_info, finding): # Check if there are no resources in the finding if finding.resource_id == "": finding.resource_id = "NONE_PROVIDED" finding_output.Id = f"prowler-{finding.check_metadata.CheckID}-{audit_info.audited_account}-{finding.region}-{hash_sha512(finding.resource_id)}" finding_output.ProductArn = f"arn:{audit_info.audited_partition}:securityhub:{finding.region}::product/prowler/prowler" finding_output.ProductFields = ProductFields( ProviderVersion=prowler_version, ProwlerResourceName=finding.resource_id ) finding_output.GeneratorId = "prowler-" + finding.check_metadata.CheckID finding_output.AwsAccountId = audit_info.audited_account finding_output.Types = finding.check_metadata.CheckType finding_output.FirstObservedAt = ( finding_output.UpdatedAt ) = finding_output.CreatedAt = timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ") finding_output.Severity = Severity(Label=finding.check_metadata.Severity.upper()) finding_output.Title = finding.check_metadata.CheckTitle finding_output.Description = finding.check_metadata.Description finding_output.Resources = [ Resource( Id=finding.resource_id, Type=finding.check_metadata.ResourceType, Partition=audit_info.audited_partition, Region=finding.region, ) ] # Add ED to PASS or FAIL (PASSED/FAILED) finding_output.Compliance = Compliance( Status=finding.status + "ED", RelatedRequirements=finding.check_metadata.CheckType, ) finding_output.Remediation = { "Recommendation": finding.check_metadata.Remediation.Recommendation } return finding_output def fill_html(file_descriptor, audit_info, finding): row_class = "p-3 mb-2 bg-success-custom" if finding.status == "INFO": row_class = "table-info" elif finding.status == "FAIL": row_class = "table-danger" elif finding.status == "WARNING": row_class = "table-warning" file_descriptor.write( f"""
{finding.check_metadata.Risk}
{finding.check_metadata.Remediation.Recommendation.Text}
| Status | Severity | Account ID | Region | Service | Check ID | Check Title | Check Output | Risk | Remediation | Related URL | Resource ID |
|---|