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(reporting): escape untrusted finding text in Markdown; block IMDS in PDF render (#76)

kraii_369e7150b623
diff --git a/ares/modules/reporting/report_gen.py b/ares/modules/reporting/report_gen.py
index 88ab890..ec402ef 100644
--- a/ares/modules/reporting/report_gen.py
+++ b/ares/modules/reporting/report_gen.py
@@ -349,6 +349,24 @@ def _build_remediation_roadmap(findings: list[Any]) -> list[dict[str, Any]]:
return roadmap
+def _escape_md(text: Any, *, single_line: bool = False) -> str:
+ """Neutralize Markdown control syntax in untrusted finding text.
+
+ Finding titles/descriptions can carry attacker-influenced content (hostnames,
+ scraped banners, module output). Rendered raw into a report they could inject
+ fake headings, links (``javascript:``/``data:``), code fences or raw HTML.
+ Backslash-escaping the structural metacharacters renders them literally.
+ (AUDIT run-1 M2)
+ """
+ s = str(text)
+ if single_line:
+ s = " ".join(s.split())
+ s = s.replace("\\", "\\\\")
+ for ch in ("`", "*", "_", "[", "]", "<", ">", "|", "#"):
+ s = s.replace(ch, "\\" + ch)
+ return s
+
+
def _is_sensitive_evidence_key(key: Any) -> bool:
normalized = str(key).strip().lower()
if normalized in _SAFE_HASH_METADATA_KEYS:
@@ -572,7 +590,7 @@ def _render_markdown_report(campaign: Campaign, ctx: dict[str, Any]) -> list[str
for finding in ctx["key_findings"]:
lines.append(
"| "
- f"{finding.severity.value.upper()} | {finding.title} | "
+ f"{finding.severity.value.upper()} | {_escape_md(finding.title, single_line=True)} | "
f"`{finding.module_id}` | `{finding.mitre_technique or 'N/A'}` |"
)
else:
@@ -614,7 +632,7 @@ def _render_markdown_report(campaign: Campaign, ctx: dict[str, Any]) -> list[str
ts = finding.discovered_at.strftime("%Y-%m-%d %H:%M")
lines.append(
f"- `{ts}` [{finding.severity.value.upper()}] "
- f"{finding.title} (`{finding.module_id}`)"
+ f"{_escape_md(finding.title, single_line=True)} (`{finding.module_id}`)"
)
else:
lines.append("- No confirmed findings yet.")
@@ -622,14 +640,14 @@ def _render_markdown_report(campaign: Campaign, ctx: dict[str, Any]) -> list[str
lines += ["", "## Findings", ""]
for finding in ctx["findings"]:
lines += [
- f"### [{finding.severity.value.upper()}] {finding.title}",
+ f"### [{finding.severity.value.upper()}] {_escape_md(finding.title, single_line=True)}",
"",
f"**Module:** `{finding.module_id}`",
f"**Confidence:** `{finding.confidence * 100:.0f}%`",
f"**MITRE:** `{finding.mitre_technique or 'N/A'}`",
f"**Host:** `{finding.host or 'N/A'}`",
"",
- finding.description,
+ _escape_md(finding.description),
"",
]
if finding.evidence:
@@ -1999,12 +2017,12 @@ class ReportGenerator:
lines += ["\n---\n", "## Findings\n"]
for f in ctx["findings"]:
lines += [
- f"### [{f.severity.upper()}] {f.title}",
+ f"### [{f.severity.upper()}] {_escape_md(f.title, single_line=True)}",
f"**Module:** `{f.module_id}` · **Confidence:** `{f.confidence*100:.0f}%`"
+ (f" · **MITRE:** `{f.mitre_technique}`" if f.mitre_technique else ""),
- f"\n{f.description}\n",
+ f"\n{_escape_md(f.description)}\n",
(
- f"> 🛡 **Remediation (SLA: {REMEDIATION_SLA.get(f.severity.value, 365)}d):** {f.remediation}"
+ f"> 🛡 **Remediation (SLA: {REMEDIATION_SLA.get(f.severity.value, 365)}d):** {_escape_md(f.remediation)}"
if f.remediation
else ""
),
@@ -2114,6 +2132,10 @@ class ReportGenerator:
"--disable-background-networking",
"--disable-sync",
"--disable-crash-reporter",
+ # AUDIT run-1 M3: if the report HTML references a URL, block the
+ # headless renderer from reaching cloud instance-metadata (IMDS)
+ # when generation runs on an EC2/GCE/Azure host.
+ "--host-resolver-rules=MAP 169.254.169.254 ~NOTFOUND,MAP metadata.google.internal ~NOTFOUND",
"--disable-features=TranslateUI",
"--print-to-pdf-no-header",
"--no-pdf-header-footer",
diff --git a/mypy-baseline.txt b/mypy-baseline.txt
index 389c22b..f5f96e0 100644
--- a/mypy-baseline.txt
+++ b/mypy-baseline.txt
@@ -200,7 +200,7 @@ ares/modules/reporting/report_gen.py|error: Module has no attribute "windll" [a
ares/modules/reporting/report_gen.py|error: Name "_build_attack_path_narrative" already defined on line 247 [no-redef]
ares/modules/reporting/report_gen.py|error: Name "_build_exec_summary" already defined on line 268 [no-redef]
ares/modules/reporting/report_gen.py|error: Name "_build_mitre_map" already defined on line 227 [no-redef]
-ares/modules/reporting/report_gen.py|error: Name "lines" already defined on line 1954 [no-redef]
+ares/modules/reporting/report_gen.py|error: Name "lines" already defined on line 1972 [no-redef]
ares/modules/sdk.py|error: "type" has no attribute "DEFAULT_TIMEOUT_S" [attr-defined]
ares/modules/sdk.py|error: "type" has no attribute "MITRE_TECHNIQUES" [attr-defined]
ares/modules/sdk.py|error: "type" has no attribute "MODULE_AUTHOR" [attr-defined]
diff --git a/tests/unit/test_report_md_escape_m2.py b/tests/unit/test_report_md_escape_m2.py
new file mode 100644
index 0000000..e24a9d5
--- /dev/null
+++ b/tests/unit/test_report_md_escape_m2.py
@@ -0,0 +1,29 @@
+"""AUDIT run-1 M2: untrusted finding text must be escaped before it is rendered
+into a Markdown report, so a crafted title/description cannot inject headings,
+links, code fences, raw HTML or table columns."""
+
+from ares.modules.reporting.report_gen import _escape_md
+
+
+def test_escapes_link_and_html_and_code_markers():
+ out = _escape_md("[click](javascript:alert(1)) `code` <img src=x>")
+ # Link/code/HTML structural characters are backslash-escaped, so none remain
+ # unescaped to form a real link, fence or tag.
+ for ch in ("`", "[", "]", "<", ">"):
+ assert ch not in out.replace("\\" + ch, "")
+
+
+def test_escapes_leading_heading_and_table_pipe():
+ assert _escape_md("# Fake Heading").startswith("\\#")
+ assert "\\|" in _escape_md("col1 | col2")
+
+
+def test_single_line_collapses_newlines():
+ out = _escape_md("line1\nline2\n\nline3", single_line=True)
+ assert "\n" not in out
+ assert out == "line1 line2 line3"
+
+
+def test_plain_text_is_preserved_readably():
+ # Ordinary words and spaces are untouched; only structural chars are escaped.
+ assert _escape_md("Weak TLS on dc01") == "Weak TLS on dc01"