0xallam
9b31e9fd29
The JSONL trace sink was never read — TUI consumes ``Tracer`` state directly (chat_messages, agents, tool_executions, vulnerability_reports, LLM stats), and SQLiteSession owns the conversation history. The whole ``StrixTracingProcessor`` → ``_emit_event`` → ``append_jsonl_record`` pipeline was producing files nothing opens. Deleted: - ``strix/telemetry/strix_processor.py`` (the SDK ``TracingProcessor``). - ``strix/telemetry/utils.py`` — ``TelemetrySanitizer`` (no remaining callers), ``append_jsonl_record``, ``get_events_write_lock``, ``reset_events_write_locks``. - ``strix/telemetry/flags.py`` — ``is_telemetry_enabled`` / ``is_posthog_enabled`` collapsed into a 4-line check inside ``posthog._is_enabled`` (its only caller). - ``Tracer._emit_event`` and every event-emit call inside the tracer (``run.started``, ``run.configured``, ``run.completed``, ``finding.created``, ``finding.reviewed``, ``chat.message``). - ``Tracer._enrich_actor`` (only used by ``_emit_event``). - ``Tracer._sanitize_data`` + ``_sanitizer`` field (PII scrub only ran on JSONL events). - ``Tracer.events_file_path`` property and the ``_events_file_path`` / ``_telemetry_enabled`` / ``_run_completed_emitted`` / ``_next_execution_id`` fields. - ``Tracer._calculate_duration`` (one caller in posthog — inlined). - ``add_trace_processor(StrixTracingProcessor(run_dir))`` from ``entry.py``. The ``Tracer`` class is now ~275 LoC of pure runtime state for the TUI + vulnerability artifact writer (markdown / CSV / pentest report). Conversation history goes to ``SQLiteSession``; SDK trace events are not persisted. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
423 lines
16 KiB
Python
423 lines
16 KiB
Python
import logging
|
|
from collections.abc import Callable
|
|
from datetime import UTC, datetime
|
|
from pathlib import Path
|
|
from typing import Any, Optional
|
|
from uuid import uuid4
|
|
|
|
from strix.telemetry import posthog
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
_global_tracer: Optional["Tracer"] = None
|
|
|
|
|
|
def get_global_tracer() -> Optional["Tracer"]:
|
|
return _global_tracer
|
|
|
|
|
|
def set_global_tracer(tracer: "Tracer") -> None:
|
|
global _global_tracer # noqa: PLW0603
|
|
_global_tracer = tracer
|
|
|
|
|
|
class Tracer:
|
|
"""Per-scan in-memory state the TUI renders + per-scan artifact writer.
|
|
|
|
Holds live state the TUI reads (chat messages, agent tree, tool
|
|
executions, vulnerability reports, LLM usage). Writes vulnerability
|
|
markdown + CSV + final pentest report to ``strix_runs/<scan>/``.
|
|
|
|
Conversation history goes to the SDK's ``SQLiteSession`` instead;
|
|
SDK trace events are not persisted here.
|
|
"""
|
|
|
|
def __init__(self, run_name: str | None = None):
|
|
self.run_name = run_name
|
|
self.run_id = run_name or f"run-{uuid4().hex[:8]}"
|
|
self.start_time = datetime.now(UTC).isoformat()
|
|
self.end_time: str | None = None
|
|
|
|
self.agents: dict[str, dict[str, Any]] = {}
|
|
self.tool_executions: dict[int, dict[str, Any]] = {}
|
|
self.chat_messages: list[dict[str, Any]] = []
|
|
|
|
self.vulnerability_reports: list[dict[str, Any]] = []
|
|
self.final_scan_result: str | None = None
|
|
|
|
# LLM usage roll-up across all agents in this run.
|
|
self._llm_stats: dict[str, Any] = {
|
|
"input_tokens": 0,
|
|
"output_tokens": 0,
|
|
"cached_tokens": 0,
|
|
"cost": 0.0,
|
|
"requests": 0,
|
|
}
|
|
|
|
self.scan_results: dict[str, Any] | None = None
|
|
self.scan_config: dict[str, Any] | None = None
|
|
self.run_metadata: dict[str, Any] = {
|
|
"run_id": self.run_id,
|
|
"run_name": self.run_name,
|
|
"start_time": self.start_time,
|
|
"end_time": None,
|
|
"targets": [],
|
|
"status": "running",
|
|
}
|
|
self._run_dir: Path | None = None
|
|
self._next_message_id = 1
|
|
self._saved_vuln_ids: set[str] = set()
|
|
|
|
self.caido_url: str | None = None
|
|
self.vulnerability_found_callback: Callable[[dict[str, Any]], None] | None = None
|
|
|
|
def set_run_name(self, run_name: str) -> None:
|
|
self.run_name = run_name
|
|
self.run_id = run_name
|
|
self.run_metadata["run_name"] = run_name
|
|
self.run_metadata["run_id"] = run_name
|
|
self._run_dir = None
|
|
|
|
def get_run_dir(self) -> Path:
|
|
if self._run_dir is None:
|
|
runs_dir = Path.cwd() / "strix_runs"
|
|
runs_dir.mkdir(exist_ok=True)
|
|
|
|
run_dir_name = self.run_name if self.run_name else self.run_id
|
|
self._run_dir = runs_dir / run_dir_name
|
|
self._run_dir.mkdir(exist_ok=True)
|
|
|
|
return self._run_dir
|
|
|
|
def add_vulnerability_report(
|
|
self,
|
|
title: str,
|
|
severity: str,
|
|
description: str | None = None,
|
|
impact: str | None = None,
|
|
target: str | None = None,
|
|
technical_analysis: str | None = None,
|
|
poc_description: str | None = None,
|
|
poc_script_code: str | None = None,
|
|
remediation_steps: str | None = None,
|
|
cvss: float | None = None,
|
|
cvss_breakdown: dict[str, str] | None = None,
|
|
endpoint: str | None = None,
|
|
method: str | None = None,
|
|
cve: str | None = None,
|
|
cwe: str | None = None,
|
|
code_locations: list[dict[str, Any]] | None = None,
|
|
) -> str:
|
|
report_id = f"vuln-{len(self.vulnerability_reports) + 1:04d}"
|
|
|
|
report: dict[str, Any] = {
|
|
"id": report_id,
|
|
"title": title.strip(),
|
|
"severity": severity.lower().strip(),
|
|
"timestamp": datetime.now(UTC).strftime("%Y-%m-%d %H:%M:%S UTC"),
|
|
}
|
|
|
|
if description:
|
|
report["description"] = description.strip()
|
|
if impact:
|
|
report["impact"] = impact.strip()
|
|
if target:
|
|
report["target"] = target.strip()
|
|
if technical_analysis:
|
|
report["technical_analysis"] = technical_analysis.strip()
|
|
if poc_description:
|
|
report["poc_description"] = poc_description.strip()
|
|
if poc_script_code:
|
|
report["poc_script_code"] = poc_script_code.strip()
|
|
if remediation_steps:
|
|
report["remediation_steps"] = remediation_steps.strip()
|
|
if cvss is not None:
|
|
report["cvss"] = cvss
|
|
if cvss_breakdown:
|
|
report["cvss_breakdown"] = cvss_breakdown
|
|
if endpoint:
|
|
report["endpoint"] = endpoint.strip()
|
|
if method:
|
|
report["method"] = method.strip()
|
|
if cve:
|
|
report["cve"] = cve.strip()
|
|
if cwe:
|
|
report["cwe"] = cwe.strip()
|
|
if code_locations:
|
|
report["code_locations"] = code_locations
|
|
|
|
self.vulnerability_reports.append(report)
|
|
logger.info(f"Added vulnerability report: {report_id} - {title}")
|
|
posthog.finding(severity)
|
|
|
|
if self.vulnerability_found_callback:
|
|
self.vulnerability_found_callback(report)
|
|
|
|
self.save_run_data()
|
|
return report_id
|
|
|
|
def get_existing_vulnerabilities(self) -> list[dict[str, Any]]:
|
|
return list(self.vulnerability_reports)
|
|
|
|
def update_scan_final_fields(
|
|
self,
|
|
executive_summary: str,
|
|
methodology: str,
|
|
technical_analysis: str,
|
|
recommendations: str,
|
|
) -> None:
|
|
self.scan_results = {
|
|
"scan_completed": True,
|
|
"executive_summary": executive_summary.strip(),
|
|
"methodology": methodology.strip(),
|
|
"technical_analysis": technical_analysis.strip(),
|
|
"recommendations": recommendations.strip(),
|
|
"success": True,
|
|
}
|
|
|
|
self.final_scan_result = f"""# Executive Summary
|
|
|
|
{executive_summary.strip()}
|
|
|
|
# Methodology
|
|
|
|
{methodology.strip()}
|
|
|
|
# Technical Analysis
|
|
|
|
{technical_analysis.strip()}
|
|
|
|
# Recommendations
|
|
|
|
{recommendations.strip()}
|
|
"""
|
|
|
|
logger.info("Updated scan final fields")
|
|
self.save_run_data(mark_complete=True)
|
|
posthog.end(self, exit_reason="finished_by_tool")
|
|
|
|
def log_chat_message(
|
|
self,
|
|
content: str,
|
|
role: str,
|
|
agent_id: str | None = None,
|
|
metadata: dict[str, Any] | None = None,
|
|
) -> int:
|
|
message_id = self._next_message_id
|
|
self._next_message_id += 1
|
|
|
|
self.chat_messages.append(
|
|
{
|
|
"message_id": message_id,
|
|
"content": content,
|
|
"role": role,
|
|
"agent_id": agent_id,
|
|
"timestamp": datetime.now(UTC).isoformat(),
|
|
"metadata": metadata or {},
|
|
}
|
|
)
|
|
return message_id
|
|
|
|
def set_scan_config(self, config: dict[str, Any]) -> None:
|
|
self.scan_config = config
|
|
self.run_metadata.update(
|
|
{
|
|
"targets": config.get("targets", []),
|
|
"user_instructions": config.get("user_instructions", ""),
|
|
"max_iterations": config.get("max_iterations", 200),
|
|
}
|
|
)
|
|
|
|
def save_run_data(self, mark_complete: bool = False) -> None:
|
|
try:
|
|
run_dir = self.get_run_dir()
|
|
if mark_complete:
|
|
if self.end_time is None:
|
|
self.end_time = datetime.now(UTC).isoformat()
|
|
self.run_metadata["end_time"] = self.end_time
|
|
self.run_metadata["status"] = "completed"
|
|
|
|
if self.final_scan_result:
|
|
penetration_test_report_file = run_dir / "penetration_test_report.md"
|
|
with penetration_test_report_file.open("w", encoding="utf-8") as f:
|
|
f.write("# Security Penetration Test Report\n\n")
|
|
f.write(
|
|
f"**Generated:** {datetime.now(UTC).strftime('%Y-%m-%d %H:%M:%S UTC')}\n\n"
|
|
)
|
|
f.write(f"{self.final_scan_result}\n")
|
|
logger.info(
|
|
"Saved final penetration test report to: %s",
|
|
penetration_test_report_file,
|
|
)
|
|
|
|
if self.vulnerability_reports:
|
|
vuln_dir = run_dir / "vulnerabilities"
|
|
vuln_dir.mkdir(exist_ok=True)
|
|
|
|
new_reports = [
|
|
report
|
|
for report in self.vulnerability_reports
|
|
if report["id"] not in self._saved_vuln_ids
|
|
]
|
|
|
|
severity_order = {"critical": 0, "high": 1, "medium": 2, "low": 3, "info": 4}
|
|
sorted_reports = sorted(
|
|
self.vulnerability_reports,
|
|
key=lambda report: (
|
|
severity_order.get(report["severity"], 5),
|
|
report["timestamp"],
|
|
),
|
|
)
|
|
|
|
for report in new_reports:
|
|
vuln_file = vuln_dir / f"{report['id']}.md"
|
|
with vuln_file.open("w", encoding="utf-8") as f:
|
|
f.write(f"# {report.get('title', 'Untitled Vulnerability')}\n\n")
|
|
f.write(f"**ID:** {report.get('id', 'unknown')}\n")
|
|
f.write(f"**Severity:** {report.get('severity', 'unknown').upper()}\n")
|
|
f.write(f"**Found:** {report.get('timestamp', 'unknown')}\n")
|
|
|
|
metadata_fields: list[tuple[str, Any]] = [
|
|
("Target", report.get("target")),
|
|
("Endpoint", report.get("endpoint")),
|
|
("Method", report.get("method")),
|
|
("CVE", report.get("cve")),
|
|
("CWE", report.get("cwe")),
|
|
]
|
|
cvss_score = report.get("cvss")
|
|
if cvss_score is not None:
|
|
metadata_fields.append(("CVSS", cvss_score))
|
|
|
|
for label, value in metadata_fields:
|
|
if value:
|
|
f.write(f"**{label}:** {value}\n")
|
|
|
|
f.write("\n## Description\n\n")
|
|
description = report.get("description") or "No description provided."
|
|
f.write(f"{description}\n\n")
|
|
|
|
if report.get("impact"):
|
|
f.write("## Impact\n\n")
|
|
f.write(f"{report['impact']}\n\n")
|
|
|
|
if report.get("technical_analysis"):
|
|
f.write("## Technical Analysis\n\n")
|
|
f.write(f"{report['technical_analysis']}\n\n")
|
|
|
|
if report.get("poc_description") or report.get("poc_script_code"):
|
|
f.write("## Proof of Concept\n\n")
|
|
if report.get("poc_description"):
|
|
f.write(f"{report['poc_description']}\n\n")
|
|
if report.get("poc_script_code"):
|
|
f.write("```\n")
|
|
f.write(f"{report['poc_script_code']}\n")
|
|
f.write("```\n\n")
|
|
|
|
if report.get("code_locations"):
|
|
f.write("## Code Analysis\n\n")
|
|
for i, loc in enumerate(report["code_locations"]):
|
|
prefix = f"**Location {i + 1}:**"
|
|
file_ref = loc.get("file", "unknown")
|
|
line_ref = ""
|
|
if loc.get("start_line") is not None:
|
|
if loc.get("end_line") and loc["end_line"] != loc["start_line"]:
|
|
line_ref = f" (lines {loc['start_line']}-{loc['end_line']})"
|
|
else:
|
|
line_ref = f" (line {loc['start_line']})"
|
|
f.write(f"{prefix} `{file_ref}`{line_ref}\n")
|
|
if loc.get("label"):
|
|
f.write(f" {loc['label']}\n")
|
|
if loc.get("snippet"):
|
|
f.write(f" ```\n {loc['snippet']}\n ```\n")
|
|
if loc.get("fix_before") or loc.get("fix_after"):
|
|
f.write("\n **Suggested Fix:**\n")
|
|
f.write("```diff\n")
|
|
if loc.get("fix_before"):
|
|
for line in loc["fix_before"].splitlines():
|
|
f.write(f"- {line}\n")
|
|
if loc.get("fix_after"):
|
|
for line in loc["fix_after"].splitlines():
|
|
f.write(f"+ {line}\n")
|
|
f.write("```\n")
|
|
f.write("\n")
|
|
|
|
if report.get("remediation_steps"):
|
|
f.write("## Remediation\n\n")
|
|
f.write(f"{report['remediation_steps']}\n\n")
|
|
|
|
self._saved_vuln_ids.add(report["id"])
|
|
|
|
vuln_csv_file = run_dir / "vulnerabilities.csv"
|
|
with vuln_csv_file.open("w", encoding="utf-8", newline="") as f:
|
|
import csv
|
|
|
|
fieldnames = ["id", "title", "severity", "timestamp", "file"]
|
|
writer = csv.DictWriter(f, fieldnames=fieldnames)
|
|
writer.writeheader()
|
|
|
|
for report in sorted_reports:
|
|
writer.writerow(
|
|
{
|
|
"id": report["id"],
|
|
"title": report["title"],
|
|
"severity": report["severity"].upper(),
|
|
"timestamp": report["timestamp"],
|
|
"file": f"vulnerabilities/{report['id']}.md",
|
|
}
|
|
)
|
|
|
|
if new_reports:
|
|
logger.info(
|
|
"Saved %d new vulnerability report(s) to: %s",
|
|
len(new_reports),
|
|
vuln_dir,
|
|
)
|
|
logger.info("Updated vulnerability index: %s", vuln_csv_file)
|
|
|
|
logger.info("📊 Essential scan data saved to: %s", run_dir)
|
|
|
|
except (OSError, RuntimeError):
|
|
logger.exception("Failed to save scan data")
|
|
|
|
def get_real_tool_count(self) -> int:
|
|
return sum(
|
|
1
|
|
for exec_data in list(self.tool_executions.values())
|
|
if exec_data.get("tool_name") not in ["scan_start_info", "subagent_start_info"]
|
|
)
|
|
|
|
def get_total_llm_stats(self) -> dict[str, Any]:
|
|
"""Snapshot the run's aggregated LLM usage."""
|
|
stats = self._llm_stats
|
|
total = {
|
|
"input_tokens": int(stats["input_tokens"]),
|
|
"output_tokens": int(stats["output_tokens"]),
|
|
"cached_tokens": int(stats["cached_tokens"]),
|
|
"cost": round(float(stats["cost"]), 4),
|
|
"requests": int(stats["requests"]),
|
|
}
|
|
return {
|
|
"total": total,
|
|
"total_tokens": total["input_tokens"] + total["output_tokens"],
|
|
}
|
|
|
|
def record_llm_usage(
|
|
self,
|
|
*,
|
|
input_tokens: int = 0,
|
|
output_tokens: int = 0,
|
|
cached_tokens: int = 0,
|
|
cost: float = 0.0,
|
|
requests: int = 1,
|
|
) -> None:
|
|
"""Accumulate LLM usage from the orchestration hooks."""
|
|
self._llm_stats["input_tokens"] += input_tokens
|
|
self._llm_stats["output_tokens"] += output_tokens
|
|
self._llm_stats["cached_tokens"] += cached_tokens
|
|
self._llm_stats["cost"] += cost
|
|
self._llm_stats["requests"] += requests
|
|
|
|
def cleanup(self) -> None:
|
|
self.save_run_data(mark_complete=True)
|