mirror of
https://github.com/ghndrx/prowler.git
synced 2026-02-10 14:55:00 +00:00
613 lines
23 KiB
Python
613 lines
23 KiB
Python
import functools
|
|
import importlib
|
|
import json
|
|
import os
|
|
import re
|
|
import shutil
|
|
import sys
|
|
import traceback
|
|
from pkgutil import walk_packages
|
|
from types import ModuleType
|
|
from typing import Any
|
|
|
|
from alive_progress import alive_bar
|
|
from colorama import Fore, Style
|
|
|
|
from prowler.config.config import orange_color
|
|
from prowler.lib.check.compliance_models import load_compliance_framework
|
|
from prowler.lib.check.models import Check, load_check_metadata
|
|
from prowler.lib.logger import logger
|
|
|
|
try:
|
|
lib = os.environ["PROWLER_REPORT_LIB_PATH"]
|
|
outputs_module = importlib.import_module(lib)
|
|
report = getattr(outputs_module, "report")
|
|
except KeyError:
|
|
from prowler.lib.outputs.outputs import report
|
|
except Exception:
|
|
sys.exit(1)
|
|
|
|
import prowler
|
|
from prowler.lib.utils.utils import open_file, parse_json_file
|
|
from prowler.providers.common.models import Audit_Metadata
|
|
from prowler.providers.common.outputs import Provider_Output_Options
|
|
|
|
|
|
# Load all checks metadata
|
|
def bulk_load_checks_metadata(provider: str) -> dict:
|
|
bulk_check_metadata = {}
|
|
checks = recover_checks_from_provider(provider)
|
|
# Build list of check's metadata files
|
|
for check_info in checks:
|
|
# Build check path name
|
|
check_name = check_info[0]
|
|
check_path = check_info[1]
|
|
# Append metadata file extension
|
|
metadata_file = f"{check_path}/{check_name}.metadata.json"
|
|
# Load metadata
|
|
check_metadata = load_check_metadata(metadata_file)
|
|
bulk_check_metadata[check_metadata.CheckID] = check_metadata
|
|
|
|
return bulk_check_metadata
|
|
|
|
|
|
# Bulk load all compliance frameworks specification
|
|
def bulk_load_compliance_frameworks(provider: str) -> dict:
|
|
"""Bulk load all compliance frameworks specification into a dict"""
|
|
try:
|
|
bulk_compliance_frameworks = {}
|
|
available_compliance_framework_modules = list_compliance_modules()
|
|
for compliance_framework in available_compliance_framework_modules:
|
|
if provider in compliance_framework.name:
|
|
compliance_specification_dir_path = (
|
|
f"{compliance_framework.module_finder.path}/{provider}"
|
|
)
|
|
|
|
# for compliance_framework in available_compliance_framework_modules:
|
|
for filename in os.listdir(compliance_specification_dir_path):
|
|
file_path = os.path.join(
|
|
compliance_specification_dir_path, filename
|
|
)
|
|
# Check if it is a file and ti size is greater than 0
|
|
if os.path.isfile(file_path) and os.stat(file_path).st_size > 0:
|
|
# Open Compliance file in JSON
|
|
# cis_v1.4_aws.json --> cis_v1.4_aws
|
|
compliance_framework_name = filename.split(".json")[0]
|
|
# Store the compliance info
|
|
bulk_compliance_frameworks[
|
|
compliance_framework_name
|
|
] = load_compliance_framework(file_path)
|
|
except Exception as e:
|
|
logger.error(f"{e.__class__.__name__}[{e.__traceback__.tb_lineno}] -- {e}")
|
|
|
|
return bulk_compliance_frameworks
|
|
|
|
|
|
# Exclude checks to run
|
|
def exclude_checks_to_run(checks_to_execute: set, excluded_checks: list) -> set:
|
|
for check in excluded_checks:
|
|
checks_to_execute.discard(check)
|
|
return checks_to_execute
|
|
|
|
|
|
# Exclude services to run
|
|
def exclude_services_to_run(
|
|
checks_to_execute: set, excluded_services: list, provider: str
|
|
) -> set:
|
|
excluded_services = [
|
|
"awslambda" if service == "lambda" else service for service in excluded_services
|
|
]
|
|
# Recover checks from the input services
|
|
for service in excluded_services:
|
|
modules = recover_checks_from_provider(provider, service)
|
|
if not modules:
|
|
logger.error(f"Service '{service}' was not found for the AWS provider")
|
|
else:
|
|
for check_module in modules:
|
|
# Recover check name and module name from import path
|
|
# Format: "providers.{provider}.services.{service}.{check_name}.{check_name}"
|
|
check_name = check_module[0].split(".")[-1]
|
|
# Exclude checks from the input services
|
|
checks_to_execute.discard(check_name)
|
|
return checks_to_execute
|
|
|
|
|
|
# Load checks from checklist.json
|
|
def parse_checks_from_file(input_file: str, provider: str) -> set:
|
|
checks_to_execute = set()
|
|
with open_file(input_file) as f:
|
|
json_file = parse_json_file(f)
|
|
|
|
for check_name in json_file[provider]:
|
|
checks_to_execute.add(check_name)
|
|
|
|
return checks_to_execute
|
|
|
|
|
|
# Load checks from custom folder
|
|
def parse_checks_from_folder(audit_info, input_folder: str, provider: str) -> int:
|
|
try:
|
|
imported_checks = 0
|
|
# Check if input folder is a S3 URI
|
|
if provider == "aws" and re.search(
|
|
"^s3://([^/]+)/(.*?([^/]+))/$", input_folder
|
|
):
|
|
bucket = input_folder.split("/")[2]
|
|
key = ("/").join(input_folder.split("/")[3:])
|
|
s3_resource = audit_info.audit_session.resource("s3")
|
|
bucket = s3_resource.Bucket(bucket)
|
|
for obj in bucket.objects.filter(Prefix=key):
|
|
if not os.path.exists(os.path.dirname(obj.key)):
|
|
os.makedirs(os.path.dirname(obj.key))
|
|
if obj.key[-1] == "/":
|
|
continue
|
|
bucket.download_file(obj.key, obj.key)
|
|
input_folder = key
|
|
# Import custom checks by moving the checks folders to the corresponding services
|
|
with os.scandir(input_folder) as checks:
|
|
for check in checks:
|
|
if check.is_dir():
|
|
check_module = input_folder + "/" + check.name
|
|
# Copy checks to specific provider/service folder
|
|
check_service = check.name.split("_")[0]
|
|
prowler_dir = prowler.__path__
|
|
prowler_module = f"{prowler_dir[0]}/providers/{provider}/services/{check_service}/{check.name}"
|
|
if os.path.exists(prowler_module):
|
|
shutil.rmtree(prowler_module)
|
|
shutil.copytree(check_module, prowler_module)
|
|
imported_checks += 1
|
|
return imported_checks
|
|
except Exception as error:
|
|
logger.critical(
|
|
f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}] -- {error}"
|
|
)
|
|
sys.exit(1)
|
|
|
|
|
|
# Load checks from custom folder
|
|
def remove_custom_checks_module(input_folder: str, provider: str):
|
|
# Check if input folder is a S3 URI
|
|
s3_uri = False
|
|
if provider == "aws" and re.search("^s3://([^/]+)/(.*?([^/]+))/$", input_folder):
|
|
input_folder = ("/").join(input_folder.split("/")[3:])
|
|
s3_uri = True
|
|
|
|
with os.scandir(input_folder) as checks:
|
|
for check in checks:
|
|
if check.is_dir():
|
|
# Remove imported checks
|
|
check_service = check.name.split("_")[0]
|
|
prowler_dir = prowler.__path__
|
|
prowler_module = f"{prowler_dir[0]}/providers/{provider}/services/{check_service}/{check.name}"
|
|
if os.path.exists(prowler_module):
|
|
shutil.rmtree(prowler_module)
|
|
# test if the service only had the loaded custom checks to delete the folder
|
|
prowler_service_module = prowler_module.rsplit("/", 1)[0]
|
|
if not os.listdir(prowler_service_module):
|
|
shutil.rmtree(prowler_service_module)
|
|
# If S3 URI, remove the downloaded folders
|
|
if s3_uri and os.path.exists(input_folder):
|
|
shutil.rmtree(input_folder)
|
|
|
|
|
|
def list_services(provider: str) -> set():
|
|
available_services = set()
|
|
checks_tuple = recover_checks_from_provider(provider)
|
|
for _, check_path in checks_tuple:
|
|
# Format: /absolute_path/prowler/providers/{provider}/services/{service_name}/{check_name}
|
|
if os.name == "nt":
|
|
service_name = check_path.split("\\")[-2]
|
|
else:
|
|
service_name = check_path.split("/")[-2]
|
|
available_services.add(service_name)
|
|
return sorted(available_services)
|
|
|
|
|
|
def list_categories(bulk_checks_metadata: dict) -> set():
|
|
available_categories = set()
|
|
for check in bulk_checks_metadata.values():
|
|
for cat in check.Categories:
|
|
if cat:
|
|
available_categories.add(cat)
|
|
return available_categories
|
|
|
|
|
|
def print_categories(categories: set):
|
|
categories_num = len(categories)
|
|
plural_string = f"\nThere are {Fore.YELLOW}{categories_num}{Style.RESET_ALL} available categories.\n"
|
|
singular_string = f"\nThere is {Fore.YELLOW}{categories_num}{Style.RESET_ALL} available category.\n"
|
|
|
|
message = plural_string if categories_num > 1 else singular_string
|
|
for category in categories:
|
|
print(f"- {category}")
|
|
|
|
print(message)
|
|
|
|
|
|
def print_services(service_list: set):
|
|
services_num = len(service_list)
|
|
plural_string = f"\nThere are {Fore.YELLOW}{services_num}{Style.RESET_ALL} available services.\n"
|
|
singular_string = (
|
|
f"\nThere is {Fore.YELLOW}{services_num}{Style.RESET_ALL} available service.\n"
|
|
)
|
|
|
|
message = plural_string if services_num > 1 else singular_string
|
|
|
|
for service in service_list:
|
|
print(f"- {service}")
|
|
|
|
print(message)
|
|
|
|
|
|
def print_compliance_frameworks(
|
|
bulk_compliance_frameworks: dict,
|
|
):
|
|
frameworks_num = len(bulk_compliance_frameworks.keys())
|
|
plural_string = f"\nThere are {Fore.YELLOW}{frameworks_num}{Style.RESET_ALL} available Compliance Frameworks.\n"
|
|
singular_string = f"\nThere is {Fore.YELLOW}{frameworks_num}{Style.RESET_ALL} available Compliance Framework.\n"
|
|
message = plural_string if frameworks_num > 1 else singular_string
|
|
|
|
for framework in bulk_compliance_frameworks.keys():
|
|
print(f"- {framework}")
|
|
|
|
print(message)
|
|
|
|
|
|
def print_compliance_requirements(
|
|
bulk_compliance_frameworks: dict, compliance_frameworks: list
|
|
):
|
|
for compliance_framework in compliance_frameworks:
|
|
for key in bulk_compliance_frameworks.keys():
|
|
framework = bulk_compliance_frameworks[key].Framework
|
|
provider = bulk_compliance_frameworks[key].Provider
|
|
version = bulk_compliance_frameworks[key].Version
|
|
requirements = bulk_compliance_frameworks[key].Requirements
|
|
# We can list the compliance requirements for a given framework using the
|
|
# bulk_compliance_frameworks keys since they are the compliance specification file name
|
|
if compliance_framework == key:
|
|
print(
|
|
f"Listing {framework} {version} {provider} Compliance Requirements:\n"
|
|
)
|
|
for requirement in requirements:
|
|
checks = ""
|
|
for check in requirement.Checks:
|
|
checks += f" {Fore.YELLOW}\t\t{check}\n{Style.RESET_ALL}"
|
|
print(
|
|
f"Requirement Id: {Fore.MAGENTA}{requirement.Id}{Style.RESET_ALL}\n\t- Description: {requirement.Description}\n\t- Checks:\n{checks}"
|
|
)
|
|
|
|
|
|
def list_checks_json(provider: str, check_list: set):
|
|
try:
|
|
output = {provider: check_list}
|
|
return json.dumps(output, indent=2, default=str)
|
|
except Exception as e:
|
|
logger.critical(f"{e.__class__.__name__}[{e.__traceback__.tb_lineno}]: {e}")
|
|
sys.exit(1)
|
|
|
|
|
|
def print_checks(
|
|
provider: str,
|
|
check_list: set,
|
|
bulk_checks_metadata: dict,
|
|
):
|
|
for check in check_list:
|
|
try:
|
|
print(
|
|
f"[{bulk_checks_metadata[check].CheckID}] {bulk_checks_metadata[check].CheckTitle} - {Fore.MAGENTA}{bulk_checks_metadata[check].ServiceName} {Fore.YELLOW}[{bulk_checks_metadata[check].Severity}]{Style.RESET_ALL}"
|
|
)
|
|
except KeyError as error:
|
|
logger.critical(
|
|
f"Check {error} was not found for the {provider.upper()} provider"
|
|
)
|
|
sys.exit(1)
|
|
|
|
checks_num = len(check_list)
|
|
plural_string = (
|
|
f"\nThere are {Fore.YELLOW}{checks_num}{Style.RESET_ALL} available checks.\n"
|
|
)
|
|
singular_string = (
|
|
f"\nThere is {Fore.YELLOW}{checks_num}{Style.RESET_ALL} available check.\n"
|
|
)
|
|
|
|
message = plural_string if checks_num > 1 else singular_string
|
|
print(message)
|
|
|
|
|
|
# Parse checks from compliance frameworks specification
|
|
def parse_checks_from_compliance_framework(
|
|
compliance_frameworks: list, bulk_compliance_frameworks: dict
|
|
) -> list:
|
|
"""Parse checks from compliance frameworks specification"""
|
|
checks_to_execute = set()
|
|
try:
|
|
for framework in compliance_frameworks:
|
|
# compliance_framework_json["Requirements"][*]["Checks"]
|
|
compliance_framework_checks_list = [
|
|
requirement.Checks
|
|
for requirement in bulk_compliance_frameworks[framework].Requirements
|
|
]
|
|
# Reduce nested list into a list
|
|
# Pythonic functional magic
|
|
compliance_framework_checks = functools.reduce(
|
|
lambda x, y: x + y, compliance_framework_checks_list
|
|
)
|
|
# Then union this list of checks with the initial one
|
|
checks_to_execute = checks_to_execute.union(compliance_framework_checks)
|
|
except Exception as e:
|
|
logger.error(f"{e.__class__.__name__}[{e.__traceback__.tb_lineno}] -- {e}")
|
|
|
|
return checks_to_execute
|
|
|
|
|
|
def recover_checks_from_provider(provider: str, service: str = None) -> list[tuple]:
|
|
"""
|
|
Recover all checks from the selected provider and service
|
|
|
|
Returns a list of tuples with the following format (check_name, check_path)
|
|
"""
|
|
try:
|
|
checks = []
|
|
modules = list_modules(provider, service)
|
|
for module_name in modules:
|
|
# Format: "prowler.providers.{provider}.services.{service}.{check_name}.{check_name}"
|
|
check_module_name = module_name.name
|
|
# We need to exclude common shared libraries in services
|
|
if check_module_name.count(".") == 6 and "lib" not in check_module_name:
|
|
check_path = module_name.module_finder.path
|
|
# Check name is the last part of the check_module_name
|
|
check_name = check_module_name.split(".")[-1]
|
|
check_info = (check_name, check_path)
|
|
checks.append(check_info)
|
|
except ModuleNotFoundError:
|
|
logger.critical(f"Service {service} was not found for the {provider} provider.")
|
|
sys.exit(1)
|
|
except Exception as e:
|
|
logger.critical(f"{e.__class__.__name__}[{e.__traceback__.tb_lineno}]: {e}")
|
|
sys.exit(1)
|
|
else:
|
|
return checks
|
|
|
|
|
|
def list_compliance_modules():
|
|
"""
|
|
list_compliance_modules returns the available compliance frameworks and returns their path
|
|
"""
|
|
# This module path requires the full path includig "prowler."
|
|
module_path = "prowler.compliance"
|
|
return walk_packages(
|
|
importlib.import_module(module_path).__path__,
|
|
importlib.import_module(module_path).__name__ + ".",
|
|
)
|
|
|
|
|
|
# List all available modules in the selected provider and service
|
|
def list_modules(provider: str, service: str):
|
|
# This module path requires the full path includig "prowler."
|
|
module_path = f"prowler.providers.{provider}.services"
|
|
if service:
|
|
module_path += f".{service}"
|
|
return walk_packages(
|
|
importlib.import_module(module_path).__path__,
|
|
importlib.import_module(module_path).__name__ + ".",
|
|
)
|
|
|
|
|
|
# Import an input check using its path
|
|
def import_check(check_path: str) -> ModuleType:
|
|
lib = importlib.import_module(f"{check_path}")
|
|
return lib
|
|
|
|
|
|
def run_check(check: Check, output_options: Provider_Output_Options) -> list:
|
|
findings = []
|
|
if output_options.verbose:
|
|
print(
|
|
f"\nCheck ID: {check.CheckID} - {Fore.MAGENTA}{check.ServiceName}{Fore.YELLOW} [{check.Severity}]{Style.RESET_ALL}"
|
|
)
|
|
logger.debug(f"Executing check: {check.CheckID}")
|
|
try:
|
|
findings = check.execute()
|
|
except Exception as error:
|
|
if not output_options.only_logs:
|
|
print(
|
|
f"Something went wrong in {check.CheckID}, please use --log-level ERROR"
|
|
)
|
|
logger.error(
|
|
f"{check.CheckID} -- {error.__class__.__name__}[{traceback.extract_tb(error.__traceback__)[-1].lineno}]: {error}"
|
|
)
|
|
finally:
|
|
return findings
|
|
|
|
|
|
def execute_checks(
|
|
checks_to_execute: list,
|
|
provider: str,
|
|
audit_info: Any,
|
|
audit_output_options: Provider_Output_Options,
|
|
) -> list:
|
|
# List to store all the check's findings
|
|
all_findings = []
|
|
# Services and checks executed for the Audit Status
|
|
services_executed = set()
|
|
checks_executed = set()
|
|
|
|
# Initialize the Audit Metadata
|
|
audit_info.audit_metadata = Audit_Metadata(
|
|
services_scanned=0,
|
|
expected_checks=checks_to_execute,
|
|
completed_checks=0,
|
|
audit_progress=0,
|
|
)
|
|
|
|
if os.name != "nt":
|
|
try:
|
|
from resource import RLIMIT_NOFILE, getrlimit
|
|
|
|
# Check ulimit for the maximum system open files
|
|
soft, _ = getrlimit(RLIMIT_NOFILE)
|
|
if soft < 4096:
|
|
logger.warning(
|
|
f"Your session file descriptors limit ({soft} open files) is below 4096. We recommend to increase it to avoid errors. Solve it running this command `ulimit -n 4096`. For more info visit https://docs.prowler.cloud/en/latest/troubleshooting/"
|
|
)
|
|
except Exception as error:
|
|
logger.error("Unable to retrieve ulimit default settings")
|
|
logger.error(
|
|
f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
|
|
)
|
|
|
|
# Execution with the --only-logs flag
|
|
if audit_output_options.only_logs:
|
|
for check_name in checks_to_execute:
|
|
# Recover service from check name
|
|
service = check_name.split("_")[0]
|
|
try:
|
|
check_findings = execute(
|
|
service,
|
|
check_name,
|
|
provider,
|
|
audit_output_options,
|
|
audit_info,
|
|
services_executed,
|
|
checks_executed,
|
|
)
|
|
all_findings.extend(check_findings)
|
|
|
|
# If check does not exists in the provider or is from another provider
|
|
except ModuleNotFoundError:
|
|
logger.critical(
|
|
f"Check '{check_name}' was not found for the {provider.upper()} provider"
|
|
)
|
|
sys.exit(1)
|
|
except Exception as error:
|
|
logger.error(
|
|
f"{check_name} - {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
|
|
)
|
|
else:
|
|
# Default execution
|
|
checks_num = len(checks_to_execute)
|
|
plural_string = "checks"
|
|
singular_string = "check"
|
|
|
|
check_noun = plural_string if checks_num > 1 else singular_string
|
|
print(
|
|
f"{Style.BRIGHT}Executing {checks_num} {check_noun}, please wait...{Style.RESET_ALL}\n"
|
|
)
|
|
with alive_bar(
|
|
total=len(checks_to_execute),
|
|
ctrl_c=False,
|
|
bar="blocks",
|
|
spinner="classic",
|
|
stats=False,
|
|
enrich_print=False,
|
|
) as bar:
|
|
for check_name in checks_to_execute:
|
|
# Recover service from check name
|
|
service = check_name.split("_")[0]
|
|
bar.title = (
|
|
f"-> Scanning {orange_color}{service}{Style.RESET_ALL} service"
|
|
)
|
|
try:
|
|
check_findings = execute(
|
|
service,
|
|
check_name,
|
|
provider,
|
|
audit_output_options,
|
|
audit_info,
|
|
services_executed,
|
|
checks_executed,
|
|
)
|
|
all_findings.extend(check_findings)
|
|
bar()
|
|
|
|
# If check does not exists in the provider or is from another provider
|
|
except ModuleNotFoundError:
|
|
logger.critical(
|
|
f"Check '{check_name}' was not found for the {provider.upper()} provider"
|
|
)
|
|
bar.title = f"-> {Fore.RED}Scan was aborted!{Style.RESET_ALL}"
|
|
sys.exit(1)
|
|
except Exception as error:
|
|
logger.error(
|
|
f"{check_name} - {error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
|
|
)
|
|
bar.title = f"-> {Fore.GREEN}Scan completed!{Style.RESET_ALL}"
|
|
return all_findings
|
|
|
|
|
|
def execute(
|
|
service: str,
|
|
check_name: str,
|
|
provider: str,
|
|
audit_output_options: Provider_Output_Options,
|
|
audit_info: Any,
|
|
services_executed: set,
|
|
checks_executed: set,
|
|
):
|
|
# Import check module
|
|
check_module_path = (
|
|
f"prowler.providers.{provider}.services.{service}.{check_name}.{check_name}"
|
|
)
|
|
lib = import_check(check_module_path)
|
|
# Recover functions from check
|
|
check_to_execute = getattr(lib, check_name)
|
|
c = check_to_execute()
|
|
|
|
# Run check
|
|
check_findings = run_check(c, audit_output_options)
|
|
|
|
# Update Audit Status
|
|
services_executed.add(service)
|
|
checks_executed.add(check_name)
|
|
audit_info.audit_metadata = update_audit_metadata(
|
|
audit_info.audit_metadata, services_executed, checks_executed
|
|
)
|
|
|
|
# Report the check's findings
|
|
report(check_findings, audit_output_options, audit_info)
|
|
|
|
return check_findings
|
|
|
|
|
|
def update_audit_metadata(
|
|
audit_metadata: Audit_Metadata, services_executed: set, checks_executed: set
|
|
) -> Audit_Metadata:
|
|
"""update_audit_metadata returns the audit_metadata updated with the new status
|
|
|
|
Updates the given audit_metadata using the length of the services_executed and checks_executed
|
|
"""
|
|
try:
|
|
audit_metadata.services_scanned = len(services_executed)
|
|
audit_metadata.completed_checks = len(checks_executed)
|
|
audit_metadata.audit_progress = (
|
|
100 * len(checks_executed) / len(audit_metadata.expected_checks)
|
|
)
|
|
|
|
return audit_metadata
|
|
|
|
except Exception as error:
|
|
logger.error(
|
|
f"{error.__class__.__name__}[{error.__traceback__.tb_lineno}]: {error}"
|
|
)
|
|
|
|
|
|
def recover_checks_from_service(service_list: list, provider: str) -> list:
|
|
checks = set()
|
|
service_list = [
|
|
"awslambda" if service == "lambda" else service for service in service_list
|
|
]
|
|
for service in service_list:
|
|
modules = recover_checks_from_provider(provider, service)
|
|
if not modules:
|
|
logger.error(f"Service '{service}' does not have checks.")
|
|
|
|
else:
|
|
for check_module in modules:
|
|
# Recover check name and module name from import path
|
|
# Format: "providers.{provider}.services.{service}.{check_name}.{check_name}"
|
|
check_name = check_module[0].split(".")[-1]
|
|
# If the service is present in the group list passed as parameters
|
|
# if service_name in group_list: checks_from_arn.add(check_name)
|
|
checks.add(check_name)
|
|
return checks
|