271 lines
9.2 KiB
Python
271 lines
9.2 KiB
Python
"""Reports endpoints — export coverage summaries and test results.
|
|
|
|
Endpoints
|
|
---------
|
|
GET /reports/coverage-summary — full coverage JSON report
|
|
GET /reports/coverage-csv — CSV export of coverage
|
|
GET /reports/test-results — test results report (JSON)
|
|
GET /reports/remediation-status — remediation status report (JSON)
|
|
"""
|
|
|
|
import csv
|
|
import io
|
|
from datetime import datetime
|
|
from typing import Optional
|
|
|
|
from fastapi import APIRouter, Depends, Query
|
|
from fastapi.responses import StreamingResponse
|
|
from sqlalchemy import func
|
|
from sqlalchemy.orm import Session
|
|
|
|
from app.database import get_db
|
|
from app.dependencies.auth import get_current_user
|
|
from app.models.enums import TestState
|
|
from app.models.technique import Technique
|
|
from app.models.test import Test
|
|
from app.models.user import User
|
|
|
|
router = APIRouter(prefix="/reports", tags=["reports"])
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# GET /reports/coverage-summary
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@router.get("/coverage-summary")
|
|
def coverage_summary(
|
|
tactic: Optional[str] = Query(None, description="Filter by tactic"),
|
|
platform: Optional[str] = Query(None, description="Filter by platform (in techniques)"),
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
):
|
|
"""Full coverage report as JSON — technique-by-technique with test counts."""
|
|
query = db.query(Technique)
|
|
if tactic:
|
|
query = query.filter(Technique.tactic.ilike(f"%{tactic}%"))
|
|
|
|
techniques = query.order_by(Technique.mitre_id).all()
|
|
|
|
rows = []
|
|
for t in techniques:
|
|
# Count tests per state for this technique
|
|
test_counts = (
|
|
db.query(Test.state, func.count(Test.id))
|
|
.filter(Test.technique_id == t.id)
|
|
.group_by(Test.state)
|
|
.all()
|
|
)
|
|
counts = {str(state): count for state, count in test_counts}
|
|
|
|
# Filter by platform if requested (check if technique platforms contain it)
|
|
if platform and platform.lower() not in [p.lower() for p in (t.platforms or [])]:
|
|
continue
|
|
|
|
rows.append({
|
|
"mitre_id": t.mitre_id,
|
|
"name": t.name,
|
|
"tactic": t.tactic,
|
|
"platforms": t.platforms,
|
|
"status_global": t.status_global,
|
|
"total_tests": sum(counts.values()),
|
|
"tests_by_state": counts,
|
|
})
|
|
|
|
total = len(rows)
|
|
validated = sum(1 for r in rows if r["status_global"] == "validated")
|
|
partial = sum(1 for r in rows if r["status_global"] == "partial")
|
|
not_covered = sum(1 for r in rows if r["status_global"] == "not_covered")
|
|
in_progress = sum(1 for r in rows if r["status_global"] == "in_progress")
|
|
not_evaluated = sum(1 for r in rows if r["status_global"] == "not_evaluated")
|
|
|
|
return {
|
|
"generated_at": datetime.utcnow().isoformat(),
|
|
"summary": {
|
|
"total_techniques": total,
|
|
"validated": validated,
|
|
"partial": partial,
|
|
"not_covered": not_covered,
|
|
"in_progress": in_progress,
|
|
"not_evaluated": not_evaluated,
|
|
"coverage_percentage": round((validated / total * 100) if total > 0 else 0, 1),
|
|
},
|
|
"techniques": rows,
|
|
}
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# GET /reports/coverage-csv
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@router.get("/coverage-csv")
|
|
def coverage_csv(
|
|
tactic: Optional[str] = Query(None),
|
|
platform: Optional[str] = Query(None),
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
):
|
|
"""Export coverage as a downloadable CSV."""
|
|
query = db.query(Technique)
|
|
if tactic:
|
|
query = query.filter(Technique.tactic.ilike(f"%{tactic}%"))
|
|
|
|
techniques = query.order_by(Technique.mitre_id).all()
|
|
|
|
output = io.StringIO()
|
|
writer = csv.writer(output)
|
|
writer.writerow([
|
|
"MITRE ID", "Name", "Tactic", "Platforms", "Status",
|
|
"Total Tests", "Validated", "In Progress", "Not Covered",
|
|
])
|
|
|
|
for t in techniques:
|
|
if platform and platform.lower() not in [p.lower() for p in (t.platforms or [])]:
|
|
continue
|
|
|
|
test_counts = (
|
|
db.query(Test.state, func.count(Test.id))
|
|
.filter(Test.technique_id == t.id)
|
|
.group_by(Test.state)
|
|
.all()
|
|
)
|
|
counts = {str(state): count for state, count in test_counts}
|
|
|
|
writer.writerow([
|
|
t.mitre_id,
|
|
t.name,
|
|
t.tactic,
|
|
", ".join(t.platforms or []),
|
|
t.status_global,
|
|
sum(counts.values()),
|
|
counts.get("validated", 0),
|
|
sum(counts.get(s, 0) for s in ["draft", "red_executing", "blue_evaluating", "in_review"]),
|
|
counts.get("rejected", 0),
|
|
])
|
|
|
|
output.seek(0)
|
|
return StreamingResponse(
|
|
iter([output.getvalue()]),
|
|
media_type="text/csv",
|
|
headers={"Content-Disposition": f"attachment; filename=aegis_coverage_{datetime.utcnow().strftime('%Y%m%d')}.csv"},
|
|
)
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# GET /reports/test-results
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@router.get("/test-results")
|
|
def test_results(
|
|
state: Optional[str] = Query(None),
|
|
date_from: Optional[str] = Query(None, description="ISO date string YYYY-MM-DD"),
|
|
date_to: Optional[str] = Query(None, description="ISO date string YYYY-MM-DD"),
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
):
|
|
"""Report of test results with optional filters."""
|
|
query = db.query(Test)
|
|
|
|
if state:
|
|
query = query.filter(Test.state == state)
|
|
if date_from:
|
|
try:
|
|
dt = datetime.fromisoformat(date_from)
|
|
query = query.filter(Test.created_at >= dt)
|
|
except ValueError:
|
|
pass
|
|
if date_to:
|
|
try:
|
|
dt = datetime.fromisoformat(date_to)
|
|
query = query.filter(Test.created_at <= dt)
|
|
except ValueError:
|
|
pass
|
|
|
|
tests = query.order_by(Test.created_at.desc()).all()
|
|
|
|
# Summary
|
|
total = len(tests)
|
|
by_state = {}
|
|
by_result = {}
|
|
for t in tests:
|
|
s = t.state.value if hasattr(t.state, "value") else str(t.state)
|
|
by_state[s] = by_state.get(s, 0) + 1
|
|
if t.detection_result:
|
|
r = t.detection_result.value if hasattr(t.detection_result, "value") else str(t.detection_result)
|
|
by_result[r] = by_result.get(r, 0) + 1
|
|
|
|
return {
|
|
"generated_at": datetime.utcnow().isoformat(),
|
|
"filters": {"state": state, "date_from": date_from, "date_to": date_to},
|
|
"summary": {
|
|
"total_tests": total,
|
|
"by_state": by_state,
|
|
"by_detection_result": by_result,
|
|
},
|
|
"tests": [
|
|
{
|
|
"id": str(t.id),
|
|
"name": t.name,
|
|
"technique_id": str(t.technique_id),
|
|
"state": t.state.value if hasattr(t.state, "value") else str(t.state),
|
|
"platform": t.platform,
|
|
"attack_success": t.attack_success,
|
|
"detection_result": (
|
|
t.detection_result.value if t.detection_result and hasattr(t.detection_result, "value")
|
|
else str(t.detection_result) if t.detection_result else None
|
|
),
|
|
"red_validation_status": t.red_validation_status,
|
|
"blue_validation_status": t.blue_validation_status,
|
|
"created_at": t.created_at.isoformat() if t.created_at else None,
|
|
}
|
|
for t in tests
|
|
],
|
|
}
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# GET /reports/remediation-status
|
|
# ---------------------------------------------------------------------------
|
|
|
|
|
|
@router.get("/remediation-status")
|
|
def remediation_status(
|
|
status: Optional[str] = Query(None, description="Filter by remediation status"),
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
):
|
|
"""Report of remediation status across all tests."""
|
|
query = db.query(Test).filter(Test.remediation_steps.isnot(None))
|
|
|
|
if status:
|
|
query = query.filter(Test.remediation_status == status)
|
|
|
|
tests = query.order_by(Test.created_at.desc()).all()
|
|
|
|
by_status = {}
|
|
for t in tests:
|
|
s = t.remediation_status or "unset"
|
|
by_status[s] = by_status.get(s, 0) + 1
|
|
|
|
return {
|
|
"generated_at": datetime.utcnow().isoformat(),
|
|
"summary": {
|
|
"total_with_remediation": len(tests),
|
|
"by_status": by_status,
|
|
},
|
|
"tests": [
|
|
{
|
|
"id": str(t.id),
|
|
"name": t.name,
|
|
"technique_id": str(t.technique_id),
|
|
"state": t.state.value if hasattr(t.state, "value") else str(t.state),
|
|
"remediation_status": t.remediation_status,
|
|
"remediation_steps": t.remediation_steps,
|
|
"remediation_assignee": str(t.remediation_assignee) if t.remediation_assignee else None,
|
|
}
|
|
for t in tests
|
|
],
|
|
}
|