9ff0f04ba3
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!
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
"""Audit logging with request context and integrity hashing."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
from datetime import datetime, timezone
|
|
from uuid import UUID
|
|
|
|
from sqlalchemy.orm import Session
|
|
|
|
from app.middleware.request_context import request_ip, request_user_agent
|
|
from app.models.audit import AuditLog
|
|
|
|
|
|
def _integrity_payload(entry: AuditLog) -> str:
|
|
ts = entry.timestamp
|
|
if ts is None:
|
|
ts = datetime.now(timezone.utc)
|
|
user_part = str(entry.user_id) if entry.user_id else ""
|
|
entity_type = entry.entity_type or ""
|
|
entity_id = entry.entity_id or ""
|
|
return f"{user_part}:{entry.action}:{entity_type}:{entity_id}:{ts.isoformat()}"
|
|
|
|
|
|
def compute_integrity_hash(entry: AuditLog) -> str:
|
|
"""Return the SHA-256 hex digest for an audit log entry."""
|
|
return hashlib.sha256(_integrity_payload(entry).encode()).hexdigest()
|
|
|
|
|
|
def verify_audit_integrity(entry: AuditLog) -> bool:
|
|
"""Return whether the stored hash matches the entry's current fields."""
|
|
if not entry.integrity_hash:
|
|
return False
|
|
return entry.integrity_hash == compute_integrity_hash(entry)
|
|
|
|
|
|
def log_action(
|
|
db: Session,
|
|
user_id: UUID | None,
|
|
action: str,
|
|
entity_type: str | None = None,
|
|
entity_id: str | None = None,
|
|
details: dict | None = None,
|
|
*,
|
|
ip_address: str | None = None,
|
|
user_agent: str | None = None,
|
|
session_id: str | None = None,
|
|
) -> AuditLog:
|
|
"""Record an audit event. Does not commit — the caller owns the transaction."""
|
|
ip = ip_address if ip_address is not None else request_ip.get("")
|
|
ua = user_agent if user_agent is not None else request_user_agent.get("")
|
|
|
|
entry = AuditLog(
|
|
user_id=user_id,
|
|
action=action,
|
|
entity_type=entity_type,
|
|
entity_id=str(entity_id) if entity_id else None,
|
|
details=details,
|
|
ip_address=ip or None,
|
|
user_agent=ua or None,
|
|
session_id=session_id,
|
|
)
|
|
db.add(entry)
|
|
db.flush()
|
|
entry.integrity_hash = compute_integrity_hash(entry)
|
|
return entry
|