Skip to content

armgit / ARES

Public Imported from GitHub
0

ARES - authorized red-team engagement automation with dashboard, campaign scope, module orchestration, OPSEC controls, encrypted vault, and reporting.

fix(modules): honest success/partial status gating (audit run-1 H14) (#69)

kraii_7b9dbbebeb67
diff --git a/ares/modules/ad/adcs.py b/ares/modules/ad/adcs.py
index f6054c8..3361913 100644
--- a/ares/modules/ad/adcs.py
+++ b/ares/modules/ad/adcs.py
@@ -281,7 +281,7 @@ class ADCSModule(BaseModule[ADCSParams, ModuleResult]):
raw["event_ids_audited"] = [4886, 4887, 4888, 39, 40]
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/ad/asreproast.py b/ares/modules/ad/asreproast.py
index d5b1c6d..a36616a 100644
--- a/ares/modules/ad/asreproast.py
+++ b/ares/modules/ad/asreproast.py
@@ -420,7 +420,7 @@ class ASREPRoastModule(BaseModule[ASREPRoastParams, ModuleResult]):
raw["preauth_policy_assessed"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/dcsync.py b/ares/modules/ad/dcsync.py
index e4b9b98..e4805c8 100644
--- a/ares/modules/ad/dcsync.py
+++ b/ares/modules/ad/dcsync.py
@@ -239,7 +239,7 @@ class DCSyncModule(BaseModule[DCSyncParams, ModuleResult]):
raw["event_ids_audited"] = [4662, 5145]
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/enum_acl.py b/ares/modules/ad/enum_acl.py
index e19fb79..12f5290 100644
--- a/ares/modules/ad/enum_acl.py
+++ b/ares/modules/ad/enum_acl.py
@@ -170,7 +170,7 @@ class ADEnumACLModule(BaseModule[DomainAuthParams, ModuleResult]):
raw["dacl_writedacl_identified"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/enum_computers.py b/ares/modules/ad/enum_computers.py
index d6ba8e0..f4de458 100644
--- a/ares/modules/ad/enum_computers.py
+++ b/ares/modules/ad/enum_computers.py
@@ -216,7 +216,7 @@ class ADEnumComputersModule(BaseModule[DomainAuthParams, ModuleResult]):
raw["domain_controllers_identified"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/enum_spn.py b/ares/modules/ad/enum_spn.py
index f08a0c2..80e648e 100644
--- a/ares/modules/ad/enum_spn.py
+++ b/ares/modules/ad/enum_spn.py
@@ -192,7 +192,7 @@ class ADEnumSPNModule(BaseModule[DomainAuthParams, ModuleResult]):
raw["kerberoastable_surface_mapped"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/enum_users.py b/ares/modules/ad/enum_users.py
index bcae4ac..fd475d1 100644
--- a/ares/modules/ad/enum_users.py
+++ b/ares/modules/ad/enum_users.py
@@ -203,7 +203,7 @@ class ADEnumUsersModule(BaseModule[DomainAuthParams, ModuleResult]):
raw["asrep_roastable_users_identified"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/kerberoast.py b/ares/modules/ad/kerberoast.py
index fb6139f..6682c84 100644
--- a/ares/modules/ad/kerberoast.py
+++ b/ares/modules/ad/kerberoast.py
@@ -458,7 +458,7 @@ class KerberoastModule(BaseModule[KerberoastParams, ModuleResult]):
raw["event_ids_audited"] = [4769, 4768]
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw,
module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
diff --git a/ares/modules/ad/laps_enum.py b/ares/modules/ad/laps_enum.py
index 1600358..1cf8d16 100644
--- a/ares/modules/ad/laps_enum.py
+++ b/ares/modules/ad/laps_enum.py
@@ -188,7 +188,7 @@ class LAPSEnumModule(BaseModule[LAPSEnumParams, ModuleResult]):
raw["event_ids_audited"] = [4662]
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/cloud/aws.py b/ares/modules/cloud/aws.py
index 257a86a..69e7609 100644
--- a/ares/modules/cloud/aws.py
+++ b/ares/modules/cloud/aws.py
@@ -201,7 +201,7 @@ class AWSEnumModule(BaseModule):
raw["iam_privilege_boundary_evaluated"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/cloud/azure.py b/ares/modules/cloud/azure.py
index 4c3869f..ea1496f 100644
--- a/ares/modules/cloud/azure.py
+++ b/ares/modules/cloud/azure.py
@@ -221,7 +221,7 @@ class AzureModule(BaseModule):
raw["keyvault_access_policies_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/cloud/azure_ad.py b/ares/modules/cloud/azure_ad.py
index 60e3d05..ebe2445 100644
--- a/ares/modules/cloud/azure_ad.py
+++ b/ares/modules/cloud/azure_ad.py
@@ -239,7 +239,7 @@ class AzureADModule(BaseModule):
raw["app_role_assignments_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/cloud/gcp.py b/ares/modules/cloud/gcp.py
index 0a9c5ed..27a5d3d 100644
--- a/ares/modules/cloud/gcp.py
+++ b/ares/modules/cloud/gcp.py
@@ -226,7 +226,7 @@ class GCPModule(BaseModule):
raw["gcp_iam_policy_bindings_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/credential/reuse.py b/ares/modules/credential/reuse.py
index 8f1472b..cbe6486 100644
--- a/ares/modules/credential/reuse.py
+++ b/ares/modules/credential/reuse.py
@@ -239,7 +239,7 @@ class CredentialReuseModule(BaseModule[CredentialReuseParams, ModuleResult]):
raw["credential_reuse_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/linux/container.py b/ares/modules/linux/container.py
index 7707095..417a1ae 100644
--- a/ares/modules/linux/container.py
+++ b/ares/modules/linux/container.py
@@ -166,7 +166,7 @@ class ContainerEscapeModule(BaseModule[ContainerEscapeParams, ModuleResult]):
raw["container_escape_vectors_mapped"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/linux/ld_preload.py b/ares/modules/linux/ld_preload.py
index c9de649..6d7ed72 100644
--- a/ares/modules/linux/ld_preload.py
+++ b/ares/modules/linux/ld_preload.py
@@ -236,7 +236,7 @@ class LDPreloadModule(BaseModule[LDPreloadParams, ModuleResult]):
raw["ld_so_preload_integrity_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/linux/nfs_escape.py b/ares/modules/linux/nfs_escape.py
index 808aeea..2c016dd 100644
--- a/ares/modules/linux/nfs_escape.py
+++ b/ares/modules/linux/nfs_escape.py
@@ -290,7 +290,7 @@ class NFSEscapeModule(BaseModule[NFSEscapeParams, ModuleResult]):
raw["nfs_privesc_vectors_mapped"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/linux/privesc.py b/ares/modules/linux/privesc.py
index 1889a2a..5d70377 100644
--- a/ares/modules/linux/privesc.py
+++ b/ares/modules/linux/privesc.py
@@ -218,7 +218,7 @@ class LinuxPrivescModule(BaseModule[LinuxPrivescParams, ModuleResult]):
raw["suid_capabilities_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings,
raw=raw,
module_id=self.MODULE_ID,
diff --git a/ares/modules/linux/service_hijack.py b/ares/modules/linux/service_hijack.py
index d90d123..82c0662 100644
--- a/ares/modules/linux/service_hijack.py
+++ b/ares/modules/linux/service_hijack.py
@@ -271,7 +271,7 @@ class ServiceHijackModule(BaseModule[ServiceHijackParams, ModuleResult]):
raw["service_binary_writable_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/persistence/scheduled_task.py b/ares/modules/persistence/scheduled_task.py
index 88d5452..ecb2292 100644
--- a/ares/modules/persistence/scheduled_task.py
+++ b/ares/modules/persistence/scheduled_task.py
@@ -345,7 +345,7 @@ class ScheduledTaskPersistence(BaseModule):
raw["hidden_task_registry_detection_evaluated"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
@@ -630,7 +630,7 @@ class RegistryRunKeyPersistence(BaseModule):
raw["evidence_integrity"] = [e.record_hash for e in evidence_chain]
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/ares/modules/persistence/wmi_subscription.py b/ares/modules/persistence/wmi_subscription.py
index 89395e3..9492140 100644
--- a/ares/modules/persistence/wmi_subscription.py
+++ b/ares/modules/persistence/wmi_subscription.py
@@ -247,7 +247,7 @@ class WMISubscriptionModule(BaseModule):
raw["sysmon_wmi_events_19_20_21_audited"] = True
raw["wmi_permanent_event_consumer_evaluated"] = True
- return ModuleResult(status="success" if (findings or raw) else "partial",
+ return ModuleResult(status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""))
diff --git a/ares/modules/recon/fingerprint.py b/ares/modules/recon/fingerprint.py
index 11f544f..4dce426 100644
--- a/ares/modules/recon/fingerprint.py
+++ b/ares/modules/recon/fingerprint.py
@@ -189,7 +189,7 @@ class FingerprintModule(BaseModule):
raw["endpoint_fingerprint_audited"] = True
return ModuleResult(
- status="success" if (findings or raw) else "partial",
+ status="success" if (findings or any(raw.get(_k) for _k in self.OUTPUTS)) else "partial", # AUDIT run-1 H14
findings=findings, raw=raw, module_id=self.MODULE_ID,
execution_id=getattr(ctx, "execution_id", ""),
)
diff --git a/tests/unit/modules/test_module_status_honesty_h14.py b/tests/unit/modules/test_module_status_honesty_h14.py
new file mode 100644
index 0000000..3a2822f
--- /dev/null
+++ b/tests/unit/modules/test_module_status_honesty_h14.py
@@ -0,0 +1,86 @@
+"""AUDIT run-1 H14: module status must be gated on observed output, not on the
+always-truthy ``raw`` dict.
+
+Before the fix, modules computed ``status="success" if (findings or raw) else
+"partial"``. Because ``raw`` is a dict that always carries loot scaffolding and
+``*_audited`` flags, it is unconditionally truthy, so every module reported
+"success" even when it observed zero hashes / accounts / credentials. The fix
+gates on the module's declared ``OUTPUTS`` keys instead.
+
+dcsync is used as the representative module (its declared output is
+``ntlm_hashes``); the same one-line pattern was applied across all affected
+modules, so a single anchored regression is sufficient to lock the behaviour.
+"""
+
+from unittest.mock import AsyncMock, patch
+
+import pytest
+
+from ares.core.campaign import Campaign, NoiseProfile, ScopeEntry
+from ares.core.config import AresSettings
+from ares.core.context import ExecutionContext
+from ares.core.noise import NoiseController
+from ares.modules.ad.dcsync import DCSyncModule
+
+
+def _make_module() -> tuple[DCSyncModule, Campaign]:
+ settings = AresSettings(
+ ares_secret_key="test-secret-key-32chars-minimum!!",
+ ares_encryption_key="test-encryption-key-32chars-min!!",
+ )
+ campaign = Campaign(
+ name="DCSync-Status-Test",
+ client="Unit-Testing",
+ scope=[ScopeEntry(cidr="10.0.0.0/8")],
+ noise_profile=NoiseProfile.NORMAL,
+ )
+ noise = NoiseController(campaign)
+ mod = DCSyncModule(settings=settings, campaign=campaign, noise=noise)
+ return mod, campaign
+
+
+def _ctx(campaign: Campaign) -> ExecutionContext:
+ settings = AresSettings(
+ ares_secret_key="test-secret-key-32chars-minimum!!",
+ ares_encryption_key="test-encryption-key-32chars-min!!",
+ )
+ return ExecutionContext(
+ execution_id="test-exec-dcsync-h14",
+ campaign_id=campaign.id,
+ target="10.0.0.5",
+ params={"target_user": "krbtgt"},
+ settings=settings,
+ campaign=campaign,
+ noise=NoiseController(campaign),
+ dry_run=False,
+ )
+
+
+async def _run_with(mod, campaign, run_return):
+ with patch.object(
+ mod,
+ "_extract_ad_params",
+ return_value={"dc": "10.0.0.5", "domain": "corp.local",
+ "username": "svc_repl", "password": "x"},
+ ):
+ with patch.object(mod, "run", AsyncMock(return_value=run_return)):
+ return await mod.execute(_ctx(campaign))
+
+
+async def test_status_is_partial_when_no_hashes_observed():
+ """No findings and an empty ntlm_hashes list must yield 'partial'."""
+ mod, campaign = _make_module()
+ result = await _run_with(mod, campaign, ([], {"ntlm_hashes": [], "target": "krbtgt"}))
+ assert result.status == "partial"
+
+
+async def test_status_is_success_when_hashes_observed():
+ """A populated ntlm_hashes output must yield 'success' even without findings."""
+ mod, campaign = _make_module()
+ result = await _run_with(
+ mod, campaign,
+ ([], {"ntlm_hashes": [{"username": "krbtgt", "nt_hash": "a" * 32}], "target": "krbtgt"}),
+ )
+ assert result.status == "success"
diff --git a/tests/unit/test_staged_modules.py b/tests/unit/test_staged_modules.py
index 965ea64..7c5fa07 100644
--- a/tests/unit/test_staged_modules.py
+++ b/tests/unit/test_staged_modules.py
@@ -255,7 +255,11 @@ class TestGhostForgeModule:
from ares.modules.ad.laps_enum import LAPSEnumModule
mod, _ = _make_module(LAPSEnumModule)
async def fake_run(*args, **kwargs):
- return [], {"found": 1, "entries": [{"computer": "WS01", "version": "v2"}], "loot": []}
+ # laps_enum's declared OUTPUTS key is laps_passwords (set from the
+ # enumerated entries by the real run); include it so a successful
+ # enum is reported as success under output-gated status. (H14)
+ entries = [{"computer": "WS01", "version": "v2"}]
+ return [], {"found": 1, "entries": entries, "laps_passwords": entries, "loot": []}
monkeypatch.setattr(mod, "run", fake_run)
ctx = _mock_ctx(params={
"dc": "10.0.0.1", "domain": "LAB.LOCAL", "username": "operator",