feat(defender): add new check defender_domain_dkim_enabled (#7485)

Co-authored-by: HugoPBrito <hugopbrit@gmail.com>
Co-authored-by: MrCloudSec <hello@mistercloudsec.com>
This commit is contained in:
Daniel Barranquero
2025-04-22 17:15:33 +02:00
committed by GitHub
parent 0edf199282
commit a671b092ee
8 changed files with 270 additions and 0 deletions
@@ -0,0 +1,119 @@
from unittest import mock
from tests.providers.m365.m365_fixtures import DOMAIN, set_mocked_m365_provider
class Test_defender_domain_dkim_enabled:
def test_dkim_enabled(self):
defender_client = mock.MagicMock()
defender_client.audited_tenant = "audited_tenant"
defender_client.audited_domain = DOMAIN
with (
mock.patch(
"prowler.providers.common.provider.Provider.get_global_provider",
return_value=set_mocked_m365_provider(),
),
mock.patch(
"prowler.providers.m365.lib.powershell.m365_powershell.M365PowerShell.connect_exchange_online"
),
mock.patch(
"prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled.defender_client",
new=defender_client,
),
):
from prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled import (
defender_domain_dkim_enabled,
)
from prowler.providers.m365.services.defender.defender_service import (
DkimConfig,
)
defender_client.dkim_configurations = [
DkimConfig(dkim_signing_enabled=True, id="domain1")
]
check = defender_domain_dkim_enabled()
result = check.execute()
assert len(result) == 1
assert result[0].status == "PASS"
assert (
result[0].status_extended
== "DKIM is enabled for domain with ID domain1."
)
assert result[0].resource == defender_client.dkim_configurations[0].dict()
assert result[0].resource_name == "DKIM Configuration"
assert result[0].resource_id == "domain1"
assert result[0].location == "global"
def test_dkim_disabled(self):
defender_client = mock.MagicMock()
defender_client.audited_tenant = "audited_tenant"
defender_client.audited_domain = DOMAIN
with (
mock.patch(
"prowler.providers.common.provider.Provider.get_global_provider",
return_value=set_mocked_m365_provider(),
),
mock.patch(
"prowler.providers.m365.lib.powershell.m365_powershell.M365PowerShell.connect_exchange_online"
),
mock.patch(
"prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled.defender_client",
new=defender_client,
),
):
from prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled import (
defender_domain_dkim_enabled,
)
from prowler.providers.m365.services.defender.defender_service import (
DkimConfig,
)
defender_client.dkim_configurations = [
DkimConfig(dkim_signing_enabled=False, id="domain2")
]
check = defender_domain_dkim_enabled()
result = check.execute()
assert len(result) == 1
assert result[0].status == "FAIL"
assert (
result[0].status_extended
== "DKIM is not enabled for domain with ID domain2."
)
assert result[0].resource == defender_client.dkim_configurations[0].dict()
assert result[0].resource_name == "DKIM Configuration"
assert result[0].resource_id == "domain2"
assert result[0].location == "global"
def test_no_dkim_configurations(self):
defender_client = mock.MagicMock()
defender_client.audited_tenant = "audited_tenant"
defender_client.audited_domain = DOMAIN
with (
mock.patch(
"prowler.providers.common.provider.Provider.get_global_provider",
return_value=set_mocked_m365_provider(),
),
mock.patch(
"prowler.providers.m365.lib.powershell.m365_powershell.M365PowerShell.connect_exchange_online"
),
mock.patch(
"prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled.defender_client",
new=defender_client,
),
):
from prowler.providers.m365.services.defender.defender_domain_dkim_enabled.defender_domain_dkim_enabled import (
defender_domain_dkim_enabled,
)
defender_client.dkim_configurations = []
check = defender_domain_dkim_enabled()
result = check.execute()
assert len(result) == 0
@@ -6,6 +6,7 @@ from prowler.providers.m365.services.defender.defender_service import (
AntiphishingPolicy,
AntiphishingRule,
Defender,
DkimConfig,
MalwarePolicy,
OutboundSpamPolicy,
OutboundSpamRule,
@@ -68,6 +69,13 @@ def mock_defender_get_antiphising_rules(_):
}
def mock_defender_get_dkim_config(_):
return [
DkimConfig(dkim_signing_enabled=True, id="domain1"),
DkimConfig(dkim_signing_enabled=False, id="domain2"),
]
def mock_defender_get_outbound_spam_filter_policy(_):
return {
"Policy1": OutboundSpamPolicy(
@@ -210,6 +218,28 @@ class Test_Defender_Service:
assert antiphishing_rules["Policy2"].state == "Disabled"
defender_client.powershell.close()
@patch(
"prowler.providers.m365.services.defender.defender_service.Defender._get_dkim_config",
new=mock_defender_get_dkim_config,
)
def test_get_dkim_config(self):
with (
mock.patch(
"prowler.providers.m365.lib.powershell.m365_powershell.M365PowerShell.connect_exchange_online"
),
):
defender_client = Defender(
set_mocked_m365_provider(
identity=M365IdentityInfo(tenant_domain=DOMAIN)
)
)
dkim_configs = defender_client.dkim_configurations
assert dkim_configs[0].dkim_signing_enabled is True
assert dkim_configs[0].id == "domain1"
assert dkim_configs[1].dkim_signing_enabled is False
assert dkim_configs[1].id == "domain2"
defender_client.powershell.close()
@patch(
"prowler.providers.m365.services.defender.defender_service.Defender._get_outbound_spam_filter_policy",
new=mock_defender_get_outbound_spam_filter_policy,