mirror of
https://github.com/ghndrx/prowler.git
synced 2026-02-10 23:05:05 +00:00
227 lines
8.2 KiB
Python
227 lines
8.2 KiB
Python
from os import path
|
|
|
|
import botocore
|
|
from boto3 import session
|
|
from mock import MagicMock, patch
|
|
|
|
from prowler.config.config import timestamp_utc
|
|
from prowler.lib.check.models import Check_Report, load_check_metadata
|
|
from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info
|
|
|
|
# from prowler.providers.aws.lib.audit_info.models import AWS_Audit_Info
|
|
from prowler.providers.aws.lib.security_hub.security_hub import (
|
|
batch_send_to_security_hub,
|
|
prepare_security_hub_findings,
|
|
verify_security_hub_integration_enabled_per_region,
|
|
)
|
|
from prowler.providers.common.models import Audit_Metadata
|
|
|
|
AWS_ACCOUNT_ID = "123456789012"
|
|
AWS_REGION_1 = "eu-west-1"
|
|
AWS_REGION_2 = "eu-west-2"
|
|
|
|
# Mocking Security Hub Get Findings
|
|
make_api_call = botocore.client.BaseClient._make_api_call
|
|
|
|
|
|
def mock_make_api_call(self, operation_name, kwarg):
|
|
if operation_name == "BatchImportFindings":
|
|
return {
|
|
"FailedCount": 0,
|
|
"SuccessCount": 1,
|
|
}
|
|
if operation_name == "DescribeHub":
|
|
return {
|
|
"HubArn": f"arn:aws:securityhub:{AWS_REGION_1}:{AWS_ACCOUNT_ID}:hub/default",
|
|
"SubscribedAt": "2023-02-07T09:45:43.742Z",
|
|
"AutoEnableControls": True,
|
|
"ControlFindingGenerator": "STANDARD_CONTROL",
|
|
}
|
|
|
|
if operation_name == "ListEnabledProductsForImport":
|
|
return {
|
|
"ProductSubscriptions": [
|
|
f"arn:aws:securityhub:{AWS_REGION_1}:{AWS_ACCOUNT_ID}:product-subscription/prowler/prowler",
|
|
]
|
|
}
|
|
|
|
return make_api_call(self, operation_name, kwarg)
|
|
|
|
|
|
class Test_SecurityHub:
|
|
def set_mocked_audit_info(self):
|
|
return AWS_Audit_Info(
|
|
session_config=None,
|
|
original_session=None,
|
|
audit_session=None,
|
|
audited_account=AWS_ACCOUNT_ID,
|
|
audited_account_arn=f"arn:aws:iam::{AWS_ACCOUNT_ID}:root",
|
|
audited_identity_arn="test-arn",
|
|
audited_user_id="test",
|
|
audited_partition="aws",
|
|
profile="default",
|
|
profile_region="eu-west-1",
|
|
credentials=None,
|
|
assumed_role_info=None,
|
|
audited_regions=["eu-west-2", "eu-west-1"],
|
|
organizations_metadata=None,
|
|
audit_resources=None,
|
|
mfa_enabled=False,
|
|
audit_metadata=Audit_Metadata(
|
|
services_scanned=0,
|
|
expected_checks=[],
|
|
completed_checks=0,
|
|
audit_progress=0,
|
|
),
|
|
)
|
|
|
|
def generate_finding(self, status, region):
|
|
finding = Check_Report(
|
|
load_check_metadata(
|
|
f"{path.dirname(path.realpath(__file__))}/fixtures/metadata.json"
|
|
).json()
|
|
)
|
|
finding.status = status
|
|
finding.status_extended = "test"
|
|
finding.resource_id = "test"
|
|
finding.resource_arn = "test"
|
|
finding.region = region
|
|
|
|
return finding
|
|
|
|
def set_mocked_output_options(self, is_quiet):
|
|
output_options = MagicMock
|
|
output_options.bulk_checks_metadata = {}
|
|
output_options.is_quiet = is_quiet
|
|
|
|
return output_options
|
|
|
|
def set_mocked_session(self, region):
|
|
# Create mock session
|
|
return session.Session(
|
|
region_name=region,
|
|
)
|
|
|
|
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
|
|
def test_verify_security_hub_integration_enabled_per_region(self):
|
|
session = self.set_mocked_session(AWS_REGION_1)
|
|
assert verify_security_hub_integration_enabled_per_region(AWS_REGION_1, session)
|
|
|
|
def test_prepare_security_hub_findings_enabled_region_not_quiet(self):
|
|
enabled_regions = [AWS_REGION_1]
|
|
output_options = self.set_mocked_output_options(is_quiet=False)
|
|
findings = [self.generate_finding("PASS", AWS_REGION_1)]
|
|
audit_info = self.set_mocked_audit_info()
|
|
|
|
assert prepare_security_hub_findings(
|
|
findings,
|
|
audit_info,
|
|
output_options,
|
|
enabled_regions,
|
|
) == {
|
|
AWS_REGION_1: [
|
|
{
|
|
"SchemaVersion": "2018-10-08",
|
|
"Id": f"prowler-iam_user_accesskey_unused-{AWS_ACCOUNT_ID}-{AWS_REGION_1}-ee26b0dd4",
|
|
"ProductArn": f"arn:aws:securityhub:{AWS_REGION_1}::product/prowler/prowler",
|
|
"RecordState": "ACTIVE",
|
|
"ProductFields": {
|
|
"ProviderName": "Prowler",
|
|
"ProviderVersion": "3.9.0",
|
|
"ProwlerResourceName": "test",
|
|
},
|
|
"GeneratorId": "prowler-iam_user_accesskey_unused",
|
|
"AwsAccountId": f"{AWS_ACCOUNT_ID}",
|
|
"Types": ["Software and Configuration Checks"],
|
|
"FirstObservedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
|
|
"UpdatedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
|
|
"CreatedAt": timestamp_utc.strftime("%Y-%m-%dT%H:%M:%SZ"),
|
|
"Severity": {"Label": "LOW"},
|
|
"Title": "Ensure Access Keys unused are disabled",
|
|
"Description": "test",
|
|
"Resources": [
|
|
{
|
|
"Type": "AwsIamAccessAnalyzer",
|
|
"Id": "test",
|
|
"Partition": "aws",
|
|
"Region": f"{AWS_REGION_1}",
|
|
}
|
|
],
|
|
"Compliance": {
|
|
"Status": "PASSED",
|
|
"RelatedRequirements": [],
|
|
"AssociatedStandards": [],
|
|
},
|
|
"Remediation": {
|
|
"Recommendation": {
|
|
"Text": "Run sudo yum update and cross your fingers and toes.",
|
|
"Url": "https://myfp.com/recommendations/dangerous_things_and_how_to_fix_them.html",
|
|
}
|
|
},
|
|
}
|
|
],
|
|
AWS_REGION_2: [],
|
|
}
|
|
|
|
def test_prepare_security_hub_findings_quiet_INFO_finding(self):
|
|
enabled_regions = [AWS_REGION_1]
|
|
output_options = self.set_mocked_output_options(is_quiet=False)
|
|
findings = [self.generate_finding("INFO", AWS_REGION_1)]
|
|
audit_info = self.set_mocked_audit_info()
|
|
|
|
assert prepare_security_hub_findings(
|
|
findings,
|
|
audit_info,
|
|
output_options,
|
|
enabled_regions,
|
|
) == {AWS_REGION_1: [], AWS_REGION_2: []}
|
|
|
|
def test_prepare_security_hub_findings_disabled_region(self):
|
|
enabled_regions = [AWS_REGION_1]
|
|
output_options = self.set_mocked_output_options(is_quiet=False)
|
|
findings = [self.generate_finding("PASS", AWS_REGION_2)]
|
|
audit_info = self.set_mocked_audit_info()
|
|
|
|
assert prepare_security_hub_findings(
|
|
findings,
|
|
audit_info,
|
|
output_options,
|
|
enabled_regions,
|
|
) == {AWS_REGION_1: [], AWS_REGION_2: []}
|
|
|
|
def test_prepare_security_hub_findings_quiet(self):
|
|
enabled_regions = [AWS_REGION_1]
|
|
output_options = self.set_mocked_output_options(is_quiet=True)
|
|
findings = [self.generate_finding("PASS", AWS_REGION_1)]
|
|
audit_info = self.set_mocked_audit_info()
|
|
|
|
assert prepare_security_hub_findings(
|
|
findings,
|
|
audit_info,
|
|
output_options,
|
|
enabled_regions,
|
|
) == {AWS_REGION_1: [], AWS_REGION_2: []}
|
|
|
|
@patch("botocore.client.BaseClient._make_api_call", new=mock_make_api_call)
|
|
def test_batch_send_to_security_hub_one_finding(self):
|
|
enabled_regions = [AWS_REGION_1]
|
|
output_options = self.set_mocked_output_options(is_quiet=False)
|
|
findings = [self.generate_finding("PASS", AWS_REGION_1)]
|
|
audit_info = self.set_mocked_audit_info()
|
|
session = self.set_mocked_session(AWS_REGION_1)
|
|
|
|
security_hub_findings = prepare_security_hub_findings(
|
|
findings,
|
|
audit_info,
|
|
output_options,
|
|
enabled_regions,
|
|
)
|
|
|
|
assert (
|
|
batch_send_to_security_hub(
|
|
security_hub_findings,
|
|
session,
|
|
)
|
|
== 1
|
|
)
|