mirror of
https://github.com/ghndrx/prowler.git
synced 2026-02-10 14:55:00 +00:00
333 lines
12 KiB
Python
333 lines
12 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
|
|
import os
|
|
import sys
|
|
|
|
from colorama import Fore, Style
|
|
|
|
from prowler.lib.banner import print_banner
|
|
from prowler.lib.check.check import (
|
|
bulk_load_checks_metadata,
|
|
bulk_load_compliance_frameworks,
|
|
exclude_checks_to_run,
|
|
exclude_services_to_run,
|
|
execute_checks,
|
|
list_categories,
|
|
list_checks_json,
|
|
list_services,
|
|
parse_checks_from_folder,
|
|
print_categories,
|
|
print_checks,
|
|
print_compliance_frameworks,
|
|
print_compliance_requirements,
|
|
print_services,
|
|
remove_custom_checks_module,
|
|
)
|
|
from prowler.lib.check.checks_loader import load_checks_to_execute
|
|
from prowler.lib.check.compliance import update_checks_metadata_with_compliance
|
|
from prowler.lib.check.custom_checks_metadata import (
|
|
parse_custom_checks_metadata_file,
|
|
update_checks_metadata,
|
|
)
|
|
from prowler.lib.cli.parser import ProwlerArgumentParser
|
|
from prowler.lib.logger import logger, set_logging_config
|
|
from prowler.lib.outputs.compliance import display_compliance_table
|
|
from prowler.lib.outputs.html import add_html_footer, fill_html_overview_statistics
|
|
from prowler.lib.outputs.json import close_json
|
|
from prowler.lib.outputs.outputs import extract_findings_statistics
|
|
from prowler.lib.outputs.slack import send_slack_message
|
|
from prowler.lib.outputs.summary_table import display_summary_table
|
|
from prowler.providers.aws.aws_provider import get_available_aws_service_regions
|
|
from prowler.providers.aws.lib.s3.s3 import send_to_s3_bucket
|
|
from prowler.providers.aws.lib.security_hub.security_hub import (
|
|
batch_send_to_security_hub,
|
|
prepare_security_hub_findings,
|
|
resolve_security_hub_previous_findings,
|
|
verify_security_hub_integration_enabled_per_region,
|
|
)
|
|
from prowler.providers.common.allowlist import set_provider_allowlist
|
|
from prowler.providers.common.audit_info import (
|
|
set_provider_audit_info,
|
|
set_provider_execution_parameters,
|
|
)
|
|
from prowler.providers.common.outputs import set_provider_output_options
|
|
from prowler.providers.common.quick_inventory import run_provider_quick_inventory
|
|
|
|
|
|
def prowler():
|
|
# Parse Arguments
|
|
parser = ProwlerArgumentParser()
|
|
args = parser.parse()
|
|
|
|
# Save Arguments
|
|
provider = args.provider
|
|
checks = args.checks
|
|
excluded_checks = args.excluded_checks
|
|
excluded_services = args.excluded_services
|
|
services = args.services
|
|
categories = args.categories
|
|
checks_file = args.checks_file
|
|
checks_folder = args.checks_folder
|
|
severities = args.severity
|
|
compliance_framework = args.compliance
|
|
custom_checks_metadata_file = args.custom_checks_metadata_file
|
|
|
|
if not args.no_banner:
|
|
print_banner(args)
|
|
|
|
# We treat the compliance framework as another output format
|
|
if compliance_framework:
|
|
args.output_modes.extend(compliance_framework)
|
|
|
|
# Set Logger configuration
|
|
set_logging_config(args.log_level, args.log_file, args.only_logs)
|
|
|
|
if args.list_services:
|
|
print_services(list_services(provider))
|
|
sys.exit()
|
|
|
|
# Load checks metadata
|
|
logger.debug("Loading checks metadata from .metadata.json files")
|
|
bulk_checks_metadata = bulk_load_checks_metadata(provider)
|
|
|
|
if args.list_categories:
|
|
print_categories(list_categories(bulk_checks_metadata))
|
|
sys.exit()
|
|
|
|
bulk_compliance_frameworks = {}
|
|
# Load compliance frameworks
|
|
logger.debug("Loading compliance frameworks from .json files")
|
|
|
|
bulk_compliance_frameworks = bulk_load_compliance_frameworks(provider)
|
|
# Complete checks metadata with the compliance framework specification
|
|
bulk_checks_metadata = update_checks_metadata_with_compliance(
|
|
bulk_compliance_frameworks, bulk_checks_metadata
|
|
)
|
|
# Update checks metadata if the --custom-checks-metadata-file is present
|
|
custom_checks_metadata = None
|
|
if custom_checks_metadata_file:
|
|
custom_checks_metadata = parse_custom_checks_metadata_file(
|
|
provider, custom_checks_metadata_file
|
|
)
|
|
bulk_checks_metadata = update_checks_metadata(
|
|
bulk_checks_metadata, custom_checks_metadata
|
|
)
|
|
|
|
if args.list_compliance:
|
|
print_compliance_frameworks(bulk_compliance_frameworks)
|
|
sys.exit()
|
|
if args.list_compliance_requirements:
|
|
print_compliance_requirements(
|
|
bulk_compliance_frameworks, args.list_compliance_requirements
|
|
)
|
|
sys.exit()
|
|
|
|
# Load checks to execute
|
|
checks_to_execute = load_checks_to_execute(
|
|
bulk_checks_metadata,
|
|
bulk_compliance_frameworks,
|
|
checks_file,
|
|
checks,
|
|
services,
|
|
severities,
|
|
compliance_framework,
|
|
categories,
|
|
provider,
|
|
)
|
|
|
|
# if --list-checks-json, dump a json file and exit
|
|
if args.list_checks_json:
|
|
print(list_checks_json(provider, sorted(checks_to_execute)))
|
|
sys.exit()
|
|
|
|
# If -l/--list-checks passed as argument, print checks to execute and quit
|
|
if args.list_checks:
|
|
print_checks(provider, sorted(checks_to_execute), bulk_checks_metadata)
|
|
sys.exit()
|
|
|
|
# Set the audit info based on the selected provider
|
|
audit_info = set_provider_audit_info(provider, args.__dict__)
|
|
|
|
# Import custom checks from folder
|
|
if checks_folder:
|
|
parse_checks_from_folder(audit_info, checks_folder, provider)
|
|
|
|
# Exclude checks if -e/--excluded-checks
|
|
if excluded_checks:
|
|
checks_to_execute = exclude_checks_to_run(checks_to_execute, excluded_checks)
|
|
|
|
# Exclude services if --excluded-services
|
|
if excluded_services:
|
|
checks_to_execute = exclude_services_to_run(
|
|
checks_to_execute, excluded_services, provider
|
|
)
|
|
|
|
# Once the audit_info is set and we have the eventual checks based on the resource identifier,
|
|
# it is time to check what Prowler's checks are going to be executed
|
|
if audit_info.audit_resources:
|
|
checks_from_resources = set_provider_execution_parameters(provider, audit_info)
|
|
checks_to_execute = checks_to_execute.intersection(checks_from_resources)
|
|
|
|
# Sort final check list
|
|
checks_to_execute = sorted(checks_to_execute)
|
|
|
|
# Parse Allowlist
|
|
allowlist_file = set_provider_allowlist(provider, audit_info, args)
|
|
|
|
# Set output options based on the selected provider
|
|
audit_output_options = set_provider_output_options(
|
|
provider, args, audit_info, allowlist_file, bulk_checks_metadata
|
|
)
|
|
|
|
# Run the quick inventory for the provider if available
|
|
if hasattr(args, "quick_inventory") and args.quick_inventory:
|
|
run_provider_quick_inventory(provider, audit_info, args)
|
|
sys.exit()
|
|
|
|
# Execute checks
|
|
findings = []
|
|
if len(checks_to_execute):
|
|
findings = execute_checks(
|
|
checks_to_execute,
|
|
provider,
|
|
audit_info,
|
|
audit_output_options,
|
|
custom_checks_metadata,
|
|
)
|
|
else:
|
|
logger.error(
|
|
"There are no checks to execute. Please, check your input arguments"
|
|
)
|
|
|
|
# Extract findings stats
|
|
stats = extract_findings_statistics(findings)
|
|
|
|
if args.slack:
|
|
if "SLACK_API_TOKEN" in os.environ and "SLACK_CHANNEL_ID" in os.environ:
|
|
_ = send_slack_message(
|
|
os.environ["SLACK_API_TOKEN"],
|
|
os.environ["SLACK_CHANNEL_ID"],
|
|
stats,
|
|
provider,
|
|
audit_info,
|
|
)
|
|
else:
|
|
logger.critical(
|
|
"Slack integration needs SLACK_API_TOKEN and SLACK_CHANNEL_ID environment variables (see more in https://docs.prowler.cloud/en/latest/tutorials/integrations/#slack)."
|
|
)
|
|
sys.exit(1)
|
|
|
|
if args.output_modes:
|
|
for mode in args.output_modes:
|
|
# Close json file if exists
|
|
if "json" in mode:
|
|
close_json(
|
|
audit_output_options.output_filename, args.output_directory, mode
|
|
)
|
|
if mode == "html":
|
|
add_html_footer(
|
|
audit_output_options.output_filename, args.output_directory
|
|
)
|
|
fill_html_overview_statistics(
|
|
stats, audit_output_options.output_filename, args.output_directory
|
|
)
|
|
# Send output to S3 if needed (-B / -D)
|
|
if provider == "aws" and (
|
|
args.output_bucket or args.output_bucket_no_assume
|
|
):
|
|
output_bucket = args.output_bucket
|
|
bucket_session = audit_info.audit_session
|
|
# Check if -D was input
|
|
if args.output_bucket_no_assume:
|
|
output_bucket = args.output_bucket_no_assume
|
|
bucket_session = audit_info.original_session
|
|
send_to_s3_bucket(
|
|
audit_output_options.output_filename,
|
|
args.output_directory,
|
|
mode,
|
|
output_bucket,
|
|
bucket_session,
|
|
)
|
|
|
|
# AWS Security Hub Integration
|
|
if provider == "aws" and args.security_hub:
|
|
print(
|
|
f"{Style.BRIGHT}\nSending findings to AWS Security Hub, please wait...{Style.RESET_ALL}"
|
|
)
|
|
# Verify where AWS Security Hub is enabled
|
|
aws_security_enabled_regions = []
|
|
security_hub_regions = (
|
|
get_available_aws_service_regions("securityhub", audit_info)
|
|
if not audit_info.audited_regions
|
|
else audit_info.audited_regions
|
|
)
|
|
for region in security_hub_regions:
|
|
# Save the regions where AWS Security Hub is enabled
|
|
if verify_security_hub_integration_enabled_per_region(
|
|
audit_info.audited_partition,
|
|
region,
|
|
audit_info.audit_session,
|
|
audit_info.audited_account,
|
|
):
|
|
aws_security_enabled_regions.append(region)
|
|
|
|
# Prepare the findings to be sent to Security Hub
|
|
security_hub_findings_per_region = prepare_security_hub_findings(
|
|
findings, audit_info, audit_output_options, aws_security_enabled_regions
|
|
)
|
|
|
|
# Send the findings to Security Hub
|
|
findings_sent_to_security_hub = batch_send_to_security_hub(
|
|
security_hub_findings_per_region, audit_info.audit_session
|
|
)
|
|
|
|
print(
|
|
f"{Style.BRIGHT}{Fore.GREEN}\n{findings_sent_to_security_hub} findings sent to AWS Security Hub!{Style.RESET_ALL}"
|
|
)
|
|
|
|
# Resolve previous fails of Security Hub
|
|
if not args.skip_sh_update:
|
|
print(
|
|
f"{Style.BRIGHT}\nArchiving previous findings in AWS Security Hub, please wait...{Style.RESET_ALL}"
|
|
)
|
|
findings_archived_in_security_hub = resolve_security_hub_previous_findings(
|
|
security_hub_findings_per_region,
|
|
audit_info,
|
|
)
|
|
print(
|
|
f"{Style.BRIGHT}{Fore.GREEN}\n{findings_archived_in_security_hub} findings archived in AWS Security Hub!{Style.RESET_ALL}"
|
|
)
|
|
|
|
# Display summary table
|
|
if not args.only_logs:
|
|
display_summary_table(
|
|
findings,
|
|
audit_info,
|
|
audit_output_options,
|
|
provider,
|
|
)
|
|
|
|
if compliance_framework and findings:
|
|
for compliance in compliance_framework:
|
|
# Display compliance table
|
|
display_compliance_table(
|
|
findings,
|
|
bulk_checks_metadata,
|
|
compliance,
|
|
audit_output_options.output_filename,
|
|
audit_output_options.output_directory,
|
|
)
|
|
|
|
# If custom checks were passed, remove the modules
|
|
if checks_folder:
|
|
remove_custom_checks_module(checks_folder, provider)
|
|
|
|
# If there are failed findings exit code 3, except if -z is input
|
|
if not args.ignore_exit_code_3 and stats["total_fail"] > 0:
|
|
sys.exit(3)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
prowler()
|