kitos
394d5d9056
Enable ANN rules in ruff.toml (flake8-annotations) and resolve all 221 violations: ANN201/ANN202 — return types on 168 public/private functions: - All 28 FastAPI routers: endpoints annotated with dict/list/specific schema/ StreamingResponse/FileResponse/JSONResponse as appropriate - main.py: lifespan→AsyncGenerator[None,None], exception handlers→JSONResponse - database.py: get_db→Generator[Session,None,None], proxy methods→correct types - middleware/request_context.py: dispatch→Response with Callable call_next type ANN001/ANN002/ANN003 — 32 missing argument types: - seed_demo.py: all db parameters typed as Session - domain/unit_of_work.py: __aexit__ exc_type/exc_val/exc_tb typed with TracebackType - services: audit_service user_id→UUID|None, heatmap_service query/model/builder, notification_service test→Test, tempo_service test→Test/user→User, test_workflow_service test_id→UUID, campaign_crud **fields→object, test_crud **fields→object (4 sites) ANN401 — 16 Any usages resolved: - Domain entities (campaign/technique/threat_actor/test_entity): replaced Any with actual ORM types via TYPE_CHECKING guards to avoid circular imports - detection_rule_service: test_id/detection_rule_id/evaluator_id→UUID - score_cache: kept Any with # noqa: ANN401 (genuinely generic cache) - jira_service/tempo_service: kept Any with # noqa: ANN401 (lazy optional deps) - d3fend_import_service: _to_str(v: Any) kept with # noqa: ANN401 ANN204/ANN205/ANN206 — special/static/class methods: - database.py proxy __call__/__getattr__: *args: object/**kwargs: object - schemas/test.py model_validate: obj→object, **kwargs→object - sa_technique_repository._int_type→type All 439 unit tests pass. ruff check app/ → All checks passed! Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
132 lines
4.3 KiB
Python
132 lines
4.3 KiB
Python
"""Detection rules endpoints — listing, filtering, and template association.
|
|
|
|
Thin HTTP adapter: delegates all query and business logic to detection_rule_service.
|
|
|
|
Provides endpoints for browsing detection rules, querying rules by technique,
|
|
and managing the template ↔ detection rule associations.
|
|
"""
|
|
|
|
import uuid
|
|
from typing import Optional
|
|
|
|
from fastapi import APIRouter, Depends, Query
|
|
from pydantic import BaseModel
|
|
from sqlalchemy.orm import Session
|
|
|
|
from app.database import get_db
|
|
from app.dependencies.auth import get_current_user, require_any_role, require_role
|
|
from app.models.user import User
|
|
from app.services.detection_rule_service import (
|
|
auto_associate_rules,
|
|
evaluate_rule,
|
|
get_rules_for_template,
|
|
get_rules_for_test,
|
|
list_rules,
|
|
)
|
|
|
|
# ── Pydantic schemas for request validation ────────────────────────────
|
|
|
|
|
|
class DetectionRuleEvaluate(BaseModel):
|
|
"""Payload for evaluating a detection rule against a test."""
|
|
test_id: uuid.UUID
|
|
detection_rule_id: uuid.UUID
|
|
triggered: Optional[bool] = None
|
|
notes: Optional[str] = None
|
|
|
|
|
|
router = APIRouter(prefix="/detection-rules", tags=["detection-rules"])
|
|
|
|
|
|
# ── GET /detection-rules — List with filters ───────────────────────────
|
|
|
|
|
|
@router.get("")
|
|
def list_detection_rules(
|
|
technique: Optional[str] = Query(None, description="Filter by MITRE technique ID"),
|
|
source: Optional[str] = Query(None, description="Filter by source (sigma, elastic, splunk, custom)"),
|
|
severity: Optional[str] = Query(None),
|
|
search: Optional[str] = Query(None),
|
|
offset: int = Query(0, ge=0),
|
|
limit: int = Query(50, ge=1, le=200),
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
) -> list:
|
|
"""List detection rules with optional filters and pagination."""
|
|
return list_rules(
|
|
db,
|
|
technique=technique,
|
|
source=source,
|
|
severity=severity,
|
|
search=search,
|
|
offset=offset,
|
|
limit=limit,
|
|
)
|
|
|
|
|
|
# ── GET /detection-rules/for-template/{template_id} ────────────────────
|
|
|
|
|
|
@router.get("/for-template/{template_id}")
|
|
def get_detection_rules_for_template(
|
|
template_id: str,
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
) -> list:
|
|
"""Get detection rules associated with a test template."""
|
|
return get_rules_for_template(db, template_id)
|
|
|
|
|
|
# ── POST /detection-rules/auto-associate ────────────────────────────────
|
|
|
|
|
|
@router.post("/auto-associate")
|
|
def auto_associate_detection_rules(
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(require_role("admin")),
|
|
) -> dict:
|
|
"""Auto-associate test templates with detection rules by MITRE technique ID.
|
|
|
|
For each active template, find all active detection rules for the same
|
|
technique and create associations. Rules with severity >= high are marked
|
|
as primary.
|
|
"""
|
|
return auto_associate_rules(db)
|
|
|
|
|
|
# ── GET /detection-rules/for-test/{test_id} ──────────────────────────────
|
|
|
|
|
|
@router.get("/for-test/{test_id}")
|
|
def get_detection_rules_for_test(
|
|
test_id: str,
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(get_current_user),
|
|
) -> list:
|
|
"""Get detection rules relevant to a test, along with their evaluation results.
|
|
|
|
Finds rules by matching the test's technique_id to detection rules,
|
|
and returns any existing evaluation results.
|
|
"""
|
|
return get_rules_for_test(db, test_id)
|
|
|
|
|
|
# ── POST /detection-rules/evaluate ──────────────────────────────────────
|
|
|
|
|
|
@router.post("/evaluate")
|
|
def evaluate_detection_rule(
|
|
payload: DetectionRuleEvaluate,
|
|
db: Session = Depends(get_db),
|
|
current_user: User = Depends(require_any_role("blue_tech", "blue_lead")),
|
|
) -> dict:
|
|
"""Save or update the evaluation result for a detection rule on a test."""
|
|
return evaluate_rule(
|
|
db,
|
|
test_id=payload.test_id,
|
|
detection_rule_id=payload.detection_rule_id,
|
|
triggered=payload.triggered,
|
|
notes=payload.notes,
|
|
evaluator_id=current_user.id,
|
|
)
|