mirror of
https://github.com/usestrix/strix.git
synced 2026-08-16 17:27:26 +02:00
* fix: resolve pre-commit check failures - Change RuntimeError to TypeError for type validation in report/writer.py - Update pyupgrade to v3.21.2 for Python 3.14 compatibility * feat(cli): add --max-budget-usd flag Raises BudgetExceededError in ReportUsageHooks after each LLM call when accumulated cost reaches the limit, with clean "stopped" status and child-agent cancellation in non-interactive mode. * test: add budget enforcement unit tests 7 tests covering no-budget, under-budget, at-limit, over-limit, error message content, None report state, and exception hierarchy. Also adds pytest/pytest-asyncio to dev deps and a mypy override for tests. * fix(budget): validate positive budget and check the live cost ledger Two hardening fixes for --max-budget-usd enforcement: - Reject non-positive budgets. ReportUsageHooks now raises ValueError for max_budget_usd <= 0, and the CLI validates the flag via a custom argparse type so '--max-budget-usd 0' fails fast with a friendly message instead of silently killing the scan on the first model response. - Read the live cost. The budget check now reads ReportState.get_total_llm_cost() (the live ledger) instead of the persisted run-record snapshot, so it stays accurate even when a usage save fails after a model call. * fix(budget): stop the entire scan deterministically when the limit is hit Previously a BudgetExceededError was handled per-agent: it was swallowed in interactive mode (the loop kept waiting), a child's error escaped its detached task as an unretrieved-exception warning, the parent was never released from wait_for_message, and the stop was logged at ERROR with a traceback as if the agent had failed. Replace that with a single scan-wide signal on the coordinator: - AgentCoordinator.trigger_budget_stop() sets a flag and wakes every parked agent; wait_for_message returns as soon as the flag is set. - The run loops check coordinator.budget_stopped and raise to exit cleanly, marking themselves 'stopped'. The root's exception reaches run_strix_scan's handler, which cancels descendants and tears the scan down once; child exceptions are swallowed in their detached task. - The budget stop is logged at INFO, not as a failure. This is deterministic regardless of tree depth or which agent first sees the limit, fixing the interactive/TUI hang where a deep agent's stop never reached a parked root. Also re-raises BudgetExceededError explicitly in the stream handler so it can't be mistaken for the LiteLLM 'after shutdown' race. * fix(budget): treat a budget stop as a clean stop in the TUI Add an explicit BudgetExceededError handler in the TUI scan thread so that, if the error ever reaches it, the budget stop is logged as a graceful stop rather than surfaced as a red scan error by the broad 'except Exception'. The runner normally absorbs the error and returns cleanly, so this is defensive depth for a money-spending feature. * docs(cli): document --max-budget-usd behavior and limitations Clarify that the budget is cumulative across all agents, checked after each model response, that the scan stops cleanly (not as a failure), that the value must be > 0, and that spend can slightly overshoot due to in-flight calls and best-effort cost estimation. * Apply suggestions from code review Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
218 lines
6.6 KiB
Python
218 lines
6.6 KiB
Python
import atexit
|
|
import contextlib
|
|
import logging
|
|
import signal
|
|
import sys
|
|
import threading
|
|
import time
|
|
from typing import Any
|
|
|
|
from rich.console import Console
|
|
from rich.live import Live
|
|
from rich.panel import Panel
|
|
from rich.text import Text
|
|
|
|
from strix.config import load_settings
|
|
from strix.core.runner import run_strix_scan
|
|
from strix.report.state import ReportState, set_global_report_state
|
|
from strix.runtime import session_manager
|
|
|
|
from .utils import (
|
|
build_live_stats_text,
|
|
format_vulnerability_report,
|
|
)
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def _resolve_sandbox_image() -> str:
|
|
image = load_settings().runtime.image
|
|
if not image:
|
|
raise RuntimeError(
|
|
"strix_image is not configured. Set it in ~/.strix/cli-config.json.",
|
|
)
|
|
return image
|
|
|
|
|
|
async def run_cli(args: Any) -> None: # noqa: PLR0915
|
|
console = Console()
|
|
|
|
start_text = Text()
|
|
start_text.append("Penetration test initiated", style="bold #22c55e")
|
|
|
|
target_text = Text()
|
|
target_text.append("Target", style="dim")
|
|
target_text.append(" ")
|
|
if len(args.targets_info) == 1:
|
|
target_text.append(args.targets_info[0]["original"], style="bold white")
|
|
else:
|
|
target_text.append(f"{len(args.targets_info)} targets", style="bold white")
|
|
for target_info in args.targets_info:
|
|
target_text.append("\n ")
|
|
target_text.append(target_info["original"], style="white")
|
|
|
|
results_text = Text()
|
|
results_text.append("Output", style="dim")
|
|
results_text.append(" ")
|
|
results_text.append(f"strix_runs/{args.run_name}", style="#60a5fa")
|
|
|
|
note_text = Text()
|
|
note_text.append("\n\n", style="dim")
|
|
note_text.append("Vulnerabilities will be displayed in real-time.", style="dim")
|
|
|
|
startup_panel = Panel(
|
|
Text.assemble(
|
|
start_text,
|
|
"\n\n",
|
|
target_text,
|
|
"\n",
|
|
results_text,
|
|
note_text,
|
|
),
|
|
title="[bold white]STRIX",
|
|
title_align="left",
|
|
border_style="#22c55e",
|
|
padding=(1, 2),
|
|
)
|
|
|
|
console.print("\n")
|
|
console.print(startup_panel)
|
|
console.print()
|
|
|
|
scan_mode = getattr(args, "scan_mode", "deep")
|
|
|
|
scan_config: dict[str, Any] = {
|
|
"scan_id": args.run_name,
|
|
"targets": args.targets_info,
|
|
"user_instructions": args.instruction or "",
|
|
"run_name": args.run_name,
|
|
"diff_scope": getattr(args, "diff_scope", {"active": False}),
|
|
"scan_mode": scan_mode,
|
|
"non_interactive": bool(getattr(args, "non_interactive", False)),
|
|
"local_sources": getattr(args, "local_sources", None) or [],
|
|
"scope_mode": getattr(args, "scope_mode", "auto"),
|
|
"diff_base": getattr(args, "diff_base", None),
|
|
"resume_instruction": getattr(args, "user_explicit_instruction", None) or "",
|
|
}
|
|
|
|
report_state = ReportState(args.run_name)
|
|
report_state.hydrate_from_run_dir()
|
|
report_state.set_scan_config(scan_config)
|
|
report_state.save_run_data()
|
|
|
|
def display_vulnerability(report: dict[str, Any]) -> None:
|
|
report_id = report.get("id", "unknown")
|
|
|
|
vuln_text = format_vulnerability_report(report)
|
|
|
|
vuln_panel = Panel(
|
|
vuln_text,
|
|
title=f"[bold red]{report_id.upper()}",
|
|
title_align="left",
|
|
border_style="red",
|
|
padding=(1, 2),
|
|
)
|
|
|
|
console.print(vuln_panel)
|
|
console.print()
|
|
|
|
report_state.vulnerability_found_callback = display_vulnerability
|
|
|
|
def cleanup_on_exit() -> None:
|
|
report_state.cleanup()
|
|
|
|
def signal_handler(_signum: int, _frame: Any) -> None:
|
|
report_state.cleanup(status="interrupted")
|
|
sys.exit(1)
|
|
|
|
atexit.register(cleanup_on_exit)
|
|
signal.signal(signal.SIGINT, signal_handler)
|
|
signal.signal(signal.SIGTERM, signal_handler)
|
|
if hasattr(signal, "SIGHUP"):
|
|
signal.signal(signal.SIGHUP, signal_handler)
|
|
|
|
set_global_report_state(report_state)
|
|
|
|
def create_live_status() -> Panel:
|
|
status_text = Text()
|
|
status_text.append("Penetration test in progress", style="bold #22c55e")
|
|
status_text.append("\n\n")
|
|
|
|
stats_text = build_live_stats_text(report_state)
|
|
if stats_text:
|
|
status_text.append(stats_text)
|
|
|
|
return Panel(
|
|
status_text,
|
|
title="[bold white]STRIX",
|
|
title_align="left",
|
|
border_style="#22c55e",
|
|
padding=(1, 2),
|
|
)
|
|
|
|
try:
|
|
console.print()
|
|
|
|
with Live(
|
|
create_live_status(), console=console, refresh_per_second=2, transient=False
|
|
) as live:
|
|
stop_updates = threading.Event()
|
|
|
|
def update_status() -> None:
|
|
while not stop_updates.is_set():
|
|
try:
|
|
live.update(create_live_status())
|
|
time.sleep(2)
|
|
except Exception:
|
|
break
|
|
|
|
update_thread = threading.Thread(target=update_status, daemon=True)
|
|
update_thread.start()
|
|
|
|
try:
|
|
logger.info(
|
|
"CLI launching scan: run_name=%s targets=%d interactive=%s",
|
|
args.run_name,
|
|
len(scan_config.get("targets") or []),
|
|
bool(getattr(args, "interactive", False)),
|
|
)
|
|
await run_strix_scan(
|
|
scan_config=scan_config,
|
|
scan_id=args.run_name,
|
|
image=_resolve_sandbox_image(),
|
|
local_sources=getattr(args, "local_sources", None) or [],
|
|
interactive=bool(getattr(args, "interactive", False)),
|
|
max_budget_usd=getattr(args, "max_budget_usd", None),
|
|
)
|
|
finally:
|
|
stop_updates.set()
|
|
update_thread.join(timeout=1)
|
|
with contextlib.suppress(Exception):
|
|
await session_manager.cleanup(args.run_name)
|
|
|
|
except Exception as e:
|
|
console.print(f"[bold red]Error during penetration test:[/] {e}")
|
|
raise
|
|
|
|
if report_state.final_scan_result:
|
|
console.print()
|
|
|
|
final_report_text = Text()
|
|
final_report_text.append("Penetration test summary", style="bold #60a5fa")
|
|
|
|
final_report_panel = Panel(
|
|
Text.assemble(
|
|
final_report_text,
|
|
"\n\n",
|
|
report_state.final_scan_result,
|
|
),
|
|
title="[bold white]STRIX",
|
|
title_align="left",
|
|
border_style="#60a5fa",
|
|
padding=(1, 2),
|
|
)
|
|
|
|
console.print(final_report_panel)
|
|
console.print()
|