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: tolerate source Impacket installs in doctor

Mafifrizi2f93f01fd196
diff --git a/ares/cli/typer_main.py b/ares/cli/typer_main.py
index 475fe44..82a2a99 100644
--- a/ares/cli/typer_main.py
+++ b/ares/cli/typer_main.py
@@ -1081,6 +1081,50 @@ def _display_result(module_id: str, result: dict) -> None:
# ── doctor command ────────────────────────────────────────────────────────────
+def _parse_impacket_version(value: object) -> tuple[str, tuple[int, int]] | None:
+ """Extract an Impacket semantic version from metadata or banner text."""
+ import re
+
+ if not value:
+ return None
+ match = re.search(r"\bv?(\d+)\.(\d+)(?:\.(\d+))?\b", str(value), re.IGNORECASE)
+ if match is None:
+ return None
+ version_parts = [match.group(1), match.group(2)]
+ if match.group(3) is not None:
+ version_parts.append(match.group(3))
+ return ".".join(version_parts), (int(match.group(1)), int(match.group(2)))
+
+
+def _impacket_fallback_version(impacket_module: Any) -> str | None:
+ """Read safe Impacket source-install version hints when package metadata is absent."""
+ import importlib
+
+ for attr in ("__version__", "VERSION", "BANNER"):
+ parsed = _parse_impacket_version(getattr(impacket_module, attr, ""))
+ if parsed is not None:
+ return parsed[0]
+
+ version_obj = getattr(impacket_module, "version", None)
+ parsed = _parse_impacket_version(version_obj)
+ if parsed is not None:
+ return parsed[0]
+
+ if version_obj is None:
+ try:
+ version_obj = importlib.import_module("impacket.version")
+ except Exception:
+ version_obj = None
+
+ if version_obj is not None:
+ for attr in ("__version__", "VERSION", "BANNER"):
+ parsed = _parse_impacket_version(getattr(version_obj, attr, ""))
+ if parsed is not None:
+ return parsed[0]
+
+ return None
+
+
def _run_pdf_smoke_check(
pdf_generator: Any,
check: Callable[[str, str, str], None],
@@ -1113,7 +1157,7 @@ def doctor(
),
) -> None:
"""Check all prerequisites and configuration. Run this first."""
- import importlib, shutil, os, re
+ import importlib, shutil, os
from importlib import metadata as importlib_metadata
from pathlib import Path
@@ -1192,7 +1236,13 @@ def doctor(
ver = getattr(mod, "__version__", "")
check(label, "ok", ver)
except Exception as exc:
- if pkg in ("impacket", "paramiko"):
+ if pkg == "impacket":
+ check(
+ label,
+ "warn",
+ import_failure_detail(import_name, exc, "pip install ares-redteam[ad]"),
+ )
+ elif pkg == "paramiko":
check(
label,
"fail",
@@ -1207,21 +1257,21 @@ def doctor(
try:
ver_str = importlib_metadata.version("impacket")
except importlib_metadata.PackageNotFoundError:
- ver_str = getattr(impacket, "__version__", "")
+ ver_str = _impacket_fallback_version(impacket) or ""
- version_match = re.search(r"(\d+)\.(\d+)", ver_str)
- if version_match and [int(version_match.group(1)), int(version_match.group(2))] >= [0, 11]:
- check(f"impacket {ver_str}", "ok", ">= 0.11 required")
+ version_match = _parse_impacket_version(ver_str)
+ if version_match and version_match[1] >= (0, 11):
+ check(f"impacket {version_match[0]}", "ok", ">= 0.11 required")
elif version_match:
- check(f"impacket {ver_str}", "fail",
- f"too old ({ver_str}) — upgrade: pip install --upgrade impacket")
+ check(f"impacket {version_match[0]}", "warn",
+ f"too old ({version_match[0]}); expected >= 0.11 — upgrade: pip install --upgrade impacket")
else:
- check("impacket", "warn",
- "installed, but version could not be detected — expected >= 0.11")
+ check("impacket (AD/SMB modules)", "ok",
+ "importable; version unknown from source/local install")
except Exception as exc:
check(
"impacket",
- "fail",
+ "warn",
import_failure_detail("impacket", exc, "pip install ares-redteam[ad]"),
)
diff --git a/tests/unit/test_cli_doctor.py b/tests/unit/test_cli_doctor.py
index e246a12..4d31fae 100644
--- a/tests/unit/test_cli_doctor.py
+++ b/tests/unit/test_cli_doctor.py
@@ -14,6 +14,18 @@ import typer
VersionInfo = namedtuple("version_info", "major minor micro releaselevel serial")
+def _run_doctor(monkeypatch, tmp_path, capsys) -> str:
+ from ares.cli.typer_main import doctor
+
+ monkeypatch.chdir(tmp_path)
+ (tmp_path / ".env").write_text("ARES_SECRET_KEY=test\n", encoding="utf-8")
+ try:
+ doctor(pdf_smoke=False)
+ except typer.Exit:
+ pass
+ return capsys.readouterr().out
+
+
def test_doctor_uses_distribution_metadata_for_impacket(monkeypatch, tmp_path, capsys):
from ares.cli.typer_main import doctor
@@ -33,14 +45,124 @@ def test_doctor_uses_distribution_metadata_for_impacket(monkeypatch, tmp_path, c
monkeypatch.setitem(sys.modules, "paramiko", fake_paramiko)
monkeypatch.setitem(sys.modules, "ldap3", None)
- doctor()
+ doctor(pdf_smoke=False)
output = capsys.readouterr().out
assert "impacket 0.13.1" in output
+ assert "[WARN] impacket" not in output
assert "too old (0.0.0)" not in output
assert "ares-redteam[ad]" in output
+def test_doctor_accepts_supported_impacket_metadata_version(monkeypatch, tmp_path, capsys):
+ fake_impacket = types.ModuleType("impacket")
+
+ def fake_version(package_name: str) -> str:
+ if package_name == "impacket":
+ return "0.12.0"
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", fake_impacket)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+
+ assert "impacket 0.12.0" in output
+ assert ">= 0.11 required" in output
+ assert "[WARN] impacket" not in output
+ assert "installed, but version could not be detected" not in output
+
+
+def test_doctor_warns_for_too_old_impacket_metadata_version(monkeypatch, tmp_path, capsys):
+ fake_impacket = types.ModuleType("impacket")
+
+ def fake_version(package_name: str) -> str:
+ if package_name == "impacket":
+ return "0.10.0"
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", fake_impacket)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+
+ assert "[WARN] impacket 0.10.0" in output
+ assert ">= 0.11" in output
+ assert "installed, but version could not be detected" not in output
+
+
+def test_doctor_accepts_impacket_source_version_attribute(monkeypatch, tmp_path, capsys):
+ fake_impacket = types.ModuleType("impacket")
+ fake_impacket.__version__ = "0.12.0"
+
+ def fake_version(package_name: str) -> str:
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", fake_impacket)
+ monkeypatch.delitem(sys.modules, "impacket.version", raising=False)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+
+ assert "impacket 0.12.0" in output
+ assert "[WARN] impacket" not in output
+ assert "installed, but version could not be detected" not in output
+
+
+def test_doctor_accepts_impacket_version_banner(monkeypatch, tmp_path, capsys):
+ fake_impacket = types.ModuleType("impacket")
+ fake_version_module = types.ModuleType("impacket.version")
+ fake_version_module.BANNER = "Impacket v0.12.0"
+ fake_impacket.version = fake_version_module
+
+ def fake_version(package_name: str) -> str:
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", fake_impacket)
+ monkeypatch.setitem(sys.modules, "impacket.version", fake_version_module)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+
+ assert "impacket 0.12.0" in output
+ assert "[WARN] impacket" not in output
+ assert "installed, but version could not be detected" not in output
+
+
+def test_doctor_accepts_importable_impacket_with_unknown_version(monkeypatch, tmp_path, capsys):
+ fake_impacket = types.ModuleType("impacket")
+
+ def fake_version(package_name: str) -> str:
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", fake_impacket)
+ monkeypatch.delitem(sys.modules, "impacket.version", raising=False)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+ normalized = " ".join(output.split())
+
+ assert "[OK] impacket (AD/SMB modules)" in output
+ assert "version unknown from source/local install" in normalized
+ assert "[WARN] impacket" not in output
+ assert "installed, but version could not be detected" not in output
+
+
+def test_doctor_warns_when_impacket_import_fails(monkeypatch, tmp_path, capsys):
+ def fake_version(package_name: str) -> str:
+ raise importlib.metadata.PackageNotFoundError(package_name)
+
+ monkeypatch.setattr(importlib.metadata, "version", fake_version)
+ monkeypatch.setitem(sys.modules, "impacket", None)
+ monkeypatch.delitem(sys.modules, "impacket.version", raising=False)
+
+ output = _run_doctor(monkeypatch, tmp_path, capsys)
+
+ assert "[WARN] impacket" in output
+ assert "pip install ares-redteam[ad]" in output
+ assert "installed, but version could not be detected" not in output
+
+
def test_doctor_reports_broken_optional_import_and_continues(monkeypatch, tmp_path, capsys):
import importlib
@@ -67,7 +189,7 @@ def test_doctor_reports_broken_optional_import_and_continues(monkeypatch, tmp_pa
monkeypatch.setattr(importlib, "import_module", fake_import_module)
try:
- doctor()
+ doctor(pdf_smoke=False)
except typer.Exit:
pass
@@ -88,7 +210,7 @@ def test_doctor_guides_windows_ad_impacket_to_python_312(monkeypatch, tmp_path,
monkeypatch.setattr(sys, "version_info", VersionInfo(3, 11, 9, "final", 0))
try:
- doctor()
+ doctor(pdf_smoke=False)
except typer.Exit:
pass
@@ -150,7 +272,7 @@ def test_doctor_reports_pdf_capability(monkeypatch, tmp_path, capsys):
monkeypatch.setattr(report_gen, "ReportGenerator", FakeReportGenerator)
try:
- doctor()
+ doctor(pdf_smoke=False)
except typer.Exit:
pass
@@ -222,7 +344,7 @@ def test_doctor_reports_windows_weasyprint_native_dependency_hint(
monkeypatch.setattr(importlib, "import_module", fake_import_module)
try:
- doctor()
+ doctor(pdf_smoke=False)
except typer.Exit:
pass