0xallam
441 lines
16 KiB
Python
441 lines
16 KiB
Python
"""``create_vulnerability_report`` — file a vuln finding with dedup + CVSS."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import json
|
|
import logging
|
|
import re
|
|
from pathlib import PurePosixPath
|
|
from typing import Any
|
|
|
|
from agents import RunContextWrapper, function_tool
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
_CVSS_VALID = {
|
|
"attack_vector": ["N", "A", "L", "P"],
|
|
"attack_complexity": ["L", "H"],
|
|
"privileges_required": ["N", "L", "H"],
|
|
"user_interaction": ["N", "R"],
|
|
"scope": ["U", "C"],
|
|
"confidentiality": ["N", "L", "H"],
|
|
"integrity": ["N", "L", "H"],
|
|
"availability": ["N", "L", "H"],
|
|
}
|
|
|
|
|
|
_CODE_LOCATION_FIELDS = (
|
|
"file",
|
|
"start_line",
|
|
"end_line",
|
|
"snippet",
|
|
"label",
|
|
"fix_before",
|
|
"fix_after",
|
|
)
|
|
|
|
|
|
def _validate_file_path(path: str) -> str | None:
|
|
if not path or not path.strip():
|
|
return "file path cannot be empty"
|
|
p = PurePosixPath(path)
|
|
if p.is_absolute():
|
|
return f"file path must be relative, got absolute: '{path}'"
|
|
if ".." in p.parts:
|
|
return f"file path must not contain '..': '{path}'"
|
|
return None
|
|
|
|
|
|
def _normalize_code_locations(
|
|
raw: list[dict[str, Any]] | None,
|
|
) -> list[dict[str, Any]] | None:
|
|
if not raw:
|
|
return None
|
|
cleaned: list[dict[str, Any]] = []
|
|
for loc in raw:
|
|
normalized: dict[str, Any] = {}
|
|
for field in _CODE_LOCATION_FIELDS:
|
|
if field not in loc or loc[field] is None:
|
|
continue
|
|
value = loc[field]
|
|
if field in ("start_line", "end_line"):
|
|
try:
|
|
normalized[field] = int(value)
|
|
except (TypeError, ValueError):
|
|
continue
|
|
else:
|
|
text = (
|
|
str(value).strip("\n")
|
|
if field in ("snippet", "fix_before", "fix_after")
|
|
else str(value).strip()
|
|
)
|
|
if text:
|
|
normalized[field] = text
|
|
if normalized.get("file") and normalized.get("start_line") is not None:
|
|
cleaned.append(normalized)
|
|
return cleaned or None
|
|
|
|
|
|
def _validate_code_locations(locations: list[dict[str, Any]]) -> list[str]:
|
|
errors: list[str] = []
|
|
for i, loc in enumerate(locations):
|
|
path_err = _validate_file_path(loc.get("file", ""))
|
|
if path_err:
|
|
errors.append(f"code_locations[{i}]: {path_err}")
|
|
start = loc.get("start_line")
|
|
if not isinstance(start, int) or start < 1:
|
|
errors.append(f"code_locations[{i}]: start_line must be a positive integer")
|
|
end = loc.get("end_line")
|
|
if end is None:
|
|
errors.append(f"code_locations[{i}]: end_line is required")
|
|
elif not isinstance(end, int) or end < 1:
|
|
errors.append(f"code_locations[{i}]: end_line must be a positive integer")
|
|
elif isinstance(start, int) and end < start:
|
|
errors.append(f"code_locations[{i}]: end_line ({end}) must be >= start_line ({start})")
|
|
return errors
|
|
|
|
|
|
def _extract_cve(cve: str) -> str:
|
|
match = re.search(r"CVE-\d{4}-\d{4,}", cve)
|
|
return match.group(0) if match else cve.strip()
|
|
|
|
|
|
def _validate_cve(cve: str) -> str | None:
|
|
if not re.match(r"^CVE-\d{4}-\d{4,}$", cve):
|
|
return f"invalid CVE format: '{cve}' (expected 'CVE-YYYY-NNNNN')"
|
|
return None
|
|
|
|
|
|
def _extract_cwe(cwe: str) -> str:
|
|
match = re.search(r"CWE-\d+", cwe)
|
|
return match.group(0) if match else cwe.strip()
|
|
|
|
|
|
def _validate_cwe(cwe: str) -> str | None:
|
|
if not re.match(r"^CWE-\d+$", cwe):
|
|
return f"invalid CWE format: '{cwe}' (expected 'CWE-NNN')"
|
|
return None
|
|
|
|
|
|
def _calculate_cvss(breakdown: dict[str, str]) -> tuple[float, str, str]:
|
|
try:
|
|
from cvss import CVSS3
|
|
|
|
vector = (
|
|
f"CVSS:3.1/AV:{breakdown['attack_vector']}/AC:{breakdown['attack_complexity']}/"
|
|
f"PR:{breakdown['privileges_required']}/UI:{breakdown['user_interaction']}/"
|
|
f"S:{breakdown['scope']}/C:{breakdown['confidentiality']}/"
|
|
f"I:{breakdown['integrity']}/A:{breakdown['availability']}"
|
|
)
|
|
c = CVSS3(vector)
|
|
score = c.scores()[0]
|
|
severity = c.severities()[0].lower()
|
|
except Exception:
|
|
logger.exception("Failed to calculate CVSS")
|
|
return 7.5, "high", ""
|
|
else:
|
|
return score, severity, vector
|
|
|
|
|
|
_REQUIRED_FIELDS = {
|
|
"title": "Title cannot be empty",
|
|
"description": "Description cannot be empty",
|
|
"impact": "Impact cannot be empty",
|
|
"target": "Target cannot be empty",
|
|
"technical_analysis": "Technical analysis cannot be empty",
|
|
"poc_description": "PoC description cannot be empty",
|
|
"poc_script_code": "PoC script/code is REQUIRED - provide the actual exploit/payload",
|
|
"remediation_steps": "Remediation steps cannot be empty",
|
|
}
|
|
|
|
|
|
async def _do_create( # noqa: PLR0912, PLR0915
|
|
*,
|
|
title: str,
|
|
description: str,
|
|
impact: str,
|
|
target: str,
|
|
technical_analysis: str,
|
|
poc_description: str,
|
|
poc_script_code: str,
|
|
remediation_steps: str,
|
|
cvss_breakdown: dict[str, str],
|
|
endpoint: str | None,
|
|
method: str | None,
|
|
cve: str | None,
|
|
cwe: str | None,
|
|
code_locations: list[dict[str, Any]] | None,
|
|
agent_id: str | None = None,
|
|
agent_name: str | None = None,
|
|
) -> dict[str, Any]:
|
|
errors: list[str] = []
|
|
fields = {
|
|
"title": title,
|
|
"description": description,
|
|
"impact": impact,
|
|
"target": target,
|
|
"technical_analysis": technical_analysis,
|
|
"poc_description": poc_description,
|
|
"poc_script_code": poc_script_code,
|
|
"remediation_steps": remediation_steps,
|
|
}
|
|
for name, msg in _REQUIRED_FIELDS.items():
|
|
if not str(fields.get(name) or "").strip():
|
|
errors.append(msg)
|
|
|
|
if not isinstance(cvss_breakdown, dict) or not cvss_breakdown:
|
|
errors.append("cvss_breakdown: must be an object with the 8 CVSS metrics")
|
|
cvss_breakdown = {}
|
|
else:
|
|
for name, valid in _CVSS_VALID.items():
|
|
value = cvss_breakdown.get(name)
|
|
if value not in valid:
|
|
errors.append(f"Invalid {name}: {value}. Must be one of: {valid}")
|
|
|
|
parsed_locations = _normalize_code_locations(code_locations)
|
|
if parsed_locations:
|
|
errors.extend(_validate_code_locations(parsed_locations))
|
|
if cve:
|
|
cve = _extract_cve(cve)
|
|
cve_err = _validate_cve(cve)
|
|
if cve_err:
|
|
errors.append(cve_err)
|
|
if cwe:
|
|
cwe = _extract_cwe(cwe)
|
|
cwe_err = _validate_cwe(cwe)
|
|
if cwe_err:
|
|
errors.append(cwe_err)
|
|
|
|
if errors:
|
|
return {"success": False, "message": "Validation failed", "errors": errors}
|
|
|
|
cvss_score, severity, _vector = _calculate_cvss(cvss_breakdown)
|
|
|
|
try:
|
|
from strix.telemetry.scan_store import get_global_scan_store
|
|
|
|
scan_store = get_global_scan_store()
|
|
if scan_store is None:
|
|
logger.warning("No global scan store; vulnerability report not persisted")
|
|
return {
|
|
"success": True,
|
|
"message": f"Vulnerability report '{title}' created (not persisted)",
|
|
"warning": "Report could not be persisted - scan store unavailable",
|
|
}
|
|
|
|
from strix.llm.dedupe import check_duplicate
|
|
|
|
existing = scan_store.get_existing_vulnerabilities()
|
|
candidate = {
|
|
"title": title,
|
|
"description": description,
|
|
"impact": impact,
|
|
"target": target,
|
|
"technical_analysis": technical_analysis,
|
|
"poc_description": poc_description,
|
|
"poc_script_code": poc_script_code,
|
|
"endpoint": endpoint,
|
|
"method": method,
|
|
}
|
|
dedupe = await check_duplicate(candidate, existing)
|
|
if dedupe.get("is_duplicate"):
|
|
duplicate_id = dedupe.get("duplicate_id", "")
|
|
duplicate_title = next(
|
|
(r.get("title", "Unknown") for r in existing if r.get("id") == duplicate_id),
|
|
"",
|
|
)
|
|
return {
|
|
"success": False,
|
|
"message": (
|
|
f"Potential duplicate of '{duplicate_title}' "
|
|
f"(id={duplicate_id[:8]}...). Do not re-report the same vulnerability."
|
|
),
|
|
"duplicate_of": duplicate_id,
|
|
"duplicate_title": duplicate_title,
|
|
"confidence": dedupe.get("confidence", 0.0),
|
|
"reason": dedupe.get("reason", ""),
|
|
}
|
|
|
|
report_id = scan_store.add_vulnerability_report(
|
|
title=title,
|
|
description=description,
|
|
severity=severity,
|
|
impact=impact,
|
|
target=target,
|
|
technical_analysis=technical_analysis,
|
|
poc_description=poc_description,
|
|
poc_script_code=poc_script_code,
|
|
remediation_steps=remediation_steps,
|
|
cvss=cvss_score,
|
|
cvss_breakdown=cvss_breakdown,
|
|
endpoint=endpoint,
|
|
method=method,
|
|
cve=cve,
|
|
cwe=cwe,
|
|
code_locations=parsed_locations,
|
|
agent_id=agent_id if isinstance(agent_id, str) else None,
|
|
agent_name=agent_name if isinstance(agent_name, str) else None,
|
|
)
|
|
except (ImportError, AttributeError) as e:
|
|
logger.exception("create_vulnerability_report persistence failed")
|
|
return {"success": False, "message": f"Failed to create vulnerability report: {e!s}"}
|
|
else:
|
|
logger.info(
|
|
"Vulnerability report created: id=%s severity=%s cvss=%.1f title=%s",
|
|
report_id,
|
|
severity,
|
|
cvss_score,
|
|
title,
|
|
)
|
|
return {
|
|
"success": True,
|
|
"message": f"Vulnerability report '{title}' created successfully",
|
|
"report_id": report_id,
|
|
"severity": severity,
|
|
"cvss_score": cvss_score,
|
|
}
|
|
|
|
|
|
# Generous timeout: the dedup check makes a separate LLM call, and
|
|
# large scans can have many existing reports to compare against.
|
|
# strict_mode=False because cvss_breakdown is a dict[str, str] and
|
|
# code_locations is list[dict] — both free-form for the strict schema.
|
|
@function_tool(timeout=180, strict_mode=False)
|
|
async def create_vulnerability_report(
|
|
ctx: RunContextWrapper,
|
|
title: str,
|
|
description: str,
|
|
impact: str,
|
|
target: str,
|
|
technical_analysis: str,
|
|
poc_description: str,
|
|
poc_script_code: str,
|
|
remediation_steps: str,
|
|
cvss_breakdown: dict[str, str],
|
|
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:
|
|
"""File a vulnerability report — one report per fully-verified finding.
|
|
|
|
**When to file**: you have a concrete vulnerability with a working
|
|
proof-of-concept and you're 100% sure it's a real issue.
|
|
|
|
**When NOT to file**:
|
|
|
|
- General security observations without a specific vulnerability.
|
|
- Suspicions you haven't confirmed with a PoC.
|
|
- Tracking multiple vulnerabilities at once — one report per vuln.
|
|
- Re-reporting something you (or another agent) already filed.
|
|
|
|
Automatic LLM-based **deduplication** rejects reports that describe
|
|
the same root cause on the same asset as an existing report. If you
|
|
get a ``duplicate_of`` response, do NOT retry — move on to other
|
|
areas.
|
|
|
|
**Customer-facing report rules** (the report is PDF-rendered for
|
|
delivery):
|
|
|
|
- No internal/system details: never mention paths like
|
|
``/workspace``, internal tools, agents, sandboxes, models, system
|
|
prompts, internal errors / stack traces, or tester environment.
|
|
- Tone: formal, objective, third-person, vendor-neutral, concise.
|
|
- Standard finding structure: Overview → Severity & CVSS →
|
|
Affected assets → Technical details → PoC (steps + code) →
|
|
Impact → Remediation → Evidence (in technical_analysis).
|
|
- Numbered steps allowed only in PoC and Remediation sections.
|
|
- Avoid hedging language; be precise and non-vague.
|
|
|
|
**White-box requirement**: when source is available, you MUST
|
|
populate ``code_locations`` with one entry per affected line range.
|
|
The ``fix_before`` field must be a verbatim copy of the source at
|
|
the specified line range — it's used as a literal GitHub/GitLab
|
|
PR suggestion block.
|
|
|
|
**CVSS breakdown** is an object with all 8 metrics (each a single
|
|
uppercase letter):
|
|
|
|
- ``attack_vector``: ``N`` (Network), ``A`` (Adjacent), ``L``
|
|
(Local), ``P`` (Physical)
|
|
- ``attack_complexity``: ``L`` / ``H``
|
|
- ``privileges_required``: ``N`` / ``L`` / ``H``
|
|
- ``user_interaction``: ``N`` / ``R``
|
|
- ``scope``: ``U`` (Unchanged) / ``C`` (Changed)
|
|
- ``confidentiality`` / ``integrity`` / ``availability``: ``N`` /
|
|
``L`` / ``H``
|
|
|
|
Example::
|
|
|
|
{
|
|
"attack_vector": "N",
|
|
"attack_complexity": "L",
|
|
"privileges_required": "N",
|
|
"user_interaction": "N",
|
|
"scope": "U",
|
|
"confidentiality": "H",
|
|
"integrity": "H",
|
|
"availability": "H"
|
|
}
|
|
|
|
**CVE / CWE rules**: pass the bare ID only (``CVE-2024-1234``,
|
|
``CWE-89``) — no name, no parenthetical. Be 100% certain; if
|
|
unsure, omit. Always prefer the most specific child CWE over a
|
|
broad parent (CWE-89 not CWE-74; CWE-78 not CWE-77).
|
|
|
|
Args:
|
|
title: Specific finding title (e.g.
|
|
``"SQL Injection in /api/users login parameter"``). Don't
|
|
include the CVE number in the title.
|
|
description: How the vuln was discovered + what it is.
|
|
impact: What an attacker achieves; business risk; data at risk.
|
|
target: Affected URL / domain / repository.
|
|
technical_analysis: The mechanism and root cause.
|
|
poc_description: Step-by-step reproduction.
|
|
poc_script_code: Working PoC (Python preferred).
|
|
remediation_steps: Specific, actionable fix.
|
|
cvss_breakdown: 8-metric object per the format above.
|
|
endpoint: API path / Git path (e.g. ``/api/login``).
|
|
method: HTTP method when relevant.
|
|
cve: ``CVE-YYYY-NNNNN`` if certain, else omit.
|
|
cwe: ``CWE-NNN`` (most specific child) if certain, else omit.
|
|
code_locations: Required for white-box findings. List of
|
|
objects, each with ``file`` (relative path), ``start_line``,
|
|
``end_line``, optional ``snippet``, ``label``,
|
|
``fix_before`` (verbatim source), ``fix_after`` (suggested
|
|
replacement).
|
|
"""
|
|
inner = ctx.context if isinstance(ctx.context, dict) else {}
|
|
raw_agent_id = inner.get("agent_id")
|
|
agent_id = raw_agent_id if isinstance(raw_agent_id, str) else None
|
|
agent_name = None
|
|
coordinator = inner.get("coordinator")
|
|
if agent_id is not None and coordinator is not None:
|
|
names = getattr(coordinator, "names", {})
|
|
if isinstance(names, dict):
|
|
raw_agent_name = names.get(agent_id)
|
|
agent_name = raw_agent_name if isinstance(raw_agent_name, str) else None
|
|
|
|
result = await _do_create(
|
|
title=title,
|
|
description=description,
|
|
impact=impact,
|
|
target=target,
|
|
technical_analysis=technical_analysis,
|
|
poc_description=poc_description,
|
|
poc_script_code=poc_script_code,
|
|
remediation_steps=remediation_steps,
|
|
cvss_breakdown=cvss_breakdown,
|
|
endpoint=endpoint,
|
|
method=method,
|
|
cve=cve,
|
|
cwe=cwe,
|
|
code_locations=code_locations,
|
|
agent_id=agent_id,
|
|
agent_name=agent_name,
|
|
)
|
|
return json.dumps(result, ensure_ascii=False, default=str)
|