diff --git a/.env.demo b/.env.demo index 65f82fdf..f8a9a888 100644 --- a/.env.demo +++ b/.env.demo @@ -96,6 +96,22 @@ MAX_UPLOAD_SIZE=1073741824 # Allowed request headers (use * to allow all) # CORS_ALLOWED_HEADERS=* +# **Audit Logging & SIEM Integration** (see docs/ConfigurationGuide.md#audit-logging) +# Enable HTTP request audit logging middleware +AUDIT_LOGGING_ENABLED=true +# Include client IP in audit log entries (disable for GDPR-sensitive deployments) +AUDIT_LOG_INCLUDE_CLIENT_IP=true + +# Forward audit events to an external SIEM system (Syslog, Splunk, Logstash, Grafana, etc.) +# AUDIT_SIEM_ENABLED=false +# AUDIT_SIEM_TRANSPORT=syslog # syslog | http +# AUDIT_SIEM_SYSLOG_HOST=localhost +# AUDIT_SIEM_SYSLOG_PORT=514 +# AUDIT_SIEM_SYSLOG_PROTOCOL=udp # udp | tcp +# AUDIT_SIEM_HTTP_URL= # e.g. https://splunk:8088/services/collector/event +# AUDIT_SIEM_HTTP_TOKEN= # Bearer / HEC token +# AUDIT_SIEM_HTTP_CUSTOM_HEADERS= # Comma-separated Key:Value pairs + # **Rate Limiting** (see SECURITY_AUDIT.md and docs/API.md) # Protects against DoS attacks and API abuse by limiting request rates per IP/user # Enabled by default - highly recommended for production diff --git a/app/api/__init__.py b/app/api/__init__.py index ae98cbd7..bfc6d2d0 100644 --- a/app/api/__init__.py +++ b/app/api/__init__.py @@ -8,6 +8,7 @@ from fastapi import APIRouter from app.api.admin_users import router as admin_users_router from app.api.api_tokens import router as api_tokens_router +from app.api.audit_logs import router as audit_logs_router from app.api.azure import router as azure_router from app.api.backup import router as backup_router from app.api.billing import router as billing_router @@ -82,3 +83,4 @@ router.include_router(imap_accounts_router) router.include_router(integrations_router) router.include_router(notifications_router) router.include_router(scheduled_jobs_router) +router.include_router(audit_logs_router) diff --git a/app/api/audit_logs.py b/app/api/audit_logs.py new file mode 100644 index 00000000..a4ed9d10 --- /dev/null +++ b/app/api/audit_logs.py @@ -0,0 +1,115 @@ +""" +Audit log REST API endpoints. + +Provides read-only access to the comprehensive audit log for admin users. +Events are append-only — there are no update or delete endpoints. +""" + +import logging +from datetime import datetime +from typing import Any + +from fastapi import APIRouter, Depends, Query, Request +from sqlalchemy.orm import Session + +from app.auth import require_login +from app.database import get_db +from app.utils.audit_service import count_events, query_events + +logger = logging.getLogger(__name__) + +router = APIRouter() + + +@router.get("/audit-logs") +@require_login +async def list_audit_logs( + request: Request, + db: Session = Depends(get_db), + action: str | None = Query(None, description="Filter by action (exact match)"), + user: str | None = Query(None, description="Filter by username"), + resource_type: str | None = Query(None, description="Filter by resource type"), + severity: str | None = Query(None, description="Filter by severity level"), + since: datetime | None = Query(None, description="Only events at or after this ISO-8601 timestamp"), + until: datetime | None = Query(None, description="Only events at or before this ISO-8601 timestamp"), + limit: int = Query(50, ge=1, le=500, description="Max rows to return"), + offset: int = Query(0, ge=0, description="Rows to skip for pagination"), +) -> dict[str, Any]: + """Return audit log entries with optional filtering and pagination. + + Requires authentication. Returns events in reverse chronological order. + """ + entries = query_events( + db, + action=action, + user=user, + resource_type=resource_type, + severity=severity, + since=since, + until=until, + limit=limit, + offset=offset, + ) + total = count_events( + db, + action=action, + user=user, + resource_type=resource_type, + severity=severity, + since=since, + until=until, + ) + return { + "items": [_serialize(e) for e in entries], + "total": total, + "limit": limit, + "offset": offset, + } + + +@router.get("/audit-logs/actions") +@require_login +async def list_distinct_actions( + request: Request, + db: Session = Depends(get_db), +) -> list[str]: + """Return the distinct action values present in the audit log.""" + from app.models import AuditLog + + rows = db.query(AuditLog.action).distinct().order_by(AuditLog.action).all() + return [r[0] for r in rows] + + +@router.get("/audit-logs/users") +@require_login +async def list_distinct_users( + request: Request, + db: Session = Depends(get_db), +) -> list[str]: + """Return the distinct user values present in the audit log.""" + from app.models import AuditLog + + rows = db.query(AuditLog.user).distinct().order_by(AuditLog.user).all() + return [r[0] for r in rows] + + +# ------------------------------------------------------------------ +# Helpers +# ------------------------------------------------------------------ + + +def _serialize(entry) -> dict[str, Any]: + """Convert an AuditLog row to a JSON-safe dict.""" + import json as _json + + return { + "id": entry.id, + "timestamp": entry.timestamp.isoformat() if entry.timestamp else None, + "user": entry.user, + "action": entry.action, + "resource_type": entry.resource_type, + "resource_id": entry.resource_id, + "ip_address": entry.ip_address, + "details": _json.loads(entry.details) if entry.details else None, + "severity": entry.severity, + } diff --git a/app/config.py b/app/config.py index ba6eeb25..51df35e0 100644 --- a/app/config.py +++ b/app/config.py @@ -849,6 +849,49 @@ class Settings(BaseSettings): ), ) + # SIEM / External Audit Log Forwarding + # Forward audit events to external SIEM systems for centralised monitoring. + audit_siem_enabled: bool = Field( + default=False, + description="Enable forwarding of audit events to an external SIEM system.", + ) + audit_siem_transport: str = Field( + default="syslog", + description=( + "Transport used to forward audit events. " + "Options: 'syslog' (RFC 5424 over UDP/TCP), 'http' (JSON POST to a webhook URL, " + "compatible with Splunk HEC, Logstash HTTP input, Grafana Loki, etc.)." + ), + ) + audit_siem_syslog_host: str = Field( + default="localhost", + description="Hostname or IP of the syslog receiver.", + ) + audit_siem_syslog_port: int = Field( + default=514, + description="Port of the syslog receiver.", + ) + audit_siem_syslog_protocol: str = Field( + default="udp", + description="Protocol for syslog transport: 'udp' or 'tcp'.", + ) + audit_siem_http_url: str = Field( + default="", + description=( + "HTTP endpoint URL for SIEM webhook delivery. " + "Supports Splunk HEC (https://splunk:8088/services/collector/event), " + "Logstash HTTP input, Grafana Loki push API, or any JSON-accepting endpoint." + ), + ) + audit_siem_http_token: str = Field( + default="", + description="Bearer / HEC token included in the Authorization header of SIEM HTTP requests.", + ) + audit_siem_http_custom_headers: str = Field( + default="", + description="Comma-separated 'Key:Value' pairs of extra headers for SIEM HTTP requests.", + ) + # UI / Appearance ui_default_color_scheme: str = Field( default="system", diff --git a/app/models.py b/app/models.py index 0cc7b53a..8e0db27d 100644 --- a/app/models.py +++ b/app/models.py @@ -146,6 +146,27 @@ class SettingsAuditLog(Base): action = Column(String, nullable=False) # "update" or "delete" +class AuditLog(Base): + """Comprehensive audit log for compliance tracking. + + Records all significant actions: login/logout, document CRUD, settings + changes, and administrative operations. Rows are append-only; the API + and service layer never update or delete entries. + """ + + __tablename__ = "audit_logs" + + id = Column(Integer, primary_key=True, index=True) + timestamp = Column(DateTime(timezone=True), server_default=func.now(), nullable=False, index=True) + user = Column(String, nullable=False, index=True) # Username or "anonymous" / "system" + action = Column(String, nullable=False, index=True) # e.g. "login", "document.create", "settings.update" + resource_type = Column(String, nullable=True, index=True) # e.g. "document", "user", "settings" + resource_id = Column(String, nullable=True) # ID of the affected resource + ip_address = Column(String, nullable=True) # Client IP address + details = Column(Text, nullable=True) # JSON-encoded extra context + severity = Column(String(16), nullable=False, server_default="info") # info / warning / error / critical + + class SavedSearch(Base): """User-defined saved search filters for quick access to frequently used filter combinations.""" diff --git a/app/utils/audit_service.py b/app/utils/audit_service.py new file mode 100644 index 00000000..73a6af7c --- /dev/null +++ b/app/utils/audit_service.py @@ -0,0 +1,331 @@ +""" +Comprehensive audit-event service for DocuElevate. + +Provides helpers to **record** audit events (append-only database writes) +and to optionally **forward** them to external SIEM systems. + +Supported SIEM transports: +* **Syslog** – RFC 5424 structured-data messages over UDP or TCP. +* **HTTP** – JSON POST payloads compatible with Splunk HEC, Logstash + HTTP input, Grafana Loki push API, and any generic webhook endpoint. +""" + +import json +import logging +import re +import socket +import threading +from datetime import datetime, timezone +from typing import Any + +import httpx +from fastapi import Request +from sqlalchemy.orm import Session + +from app.config import settings +from app.middleware.audit_log import get_client_ip, get_username +from app.models import AuditLog + +logger = logging.getLogger(__name__) + +# --------------------------------------------------------------------------- +# Public helpers +# --------------------------------------------------------------------------- + + +def record_event( + db: Session, + *, + action: str, + user: str = "system", + resource_type: str | None = None, + resource_id: str | None = None, + ip_address: str | None = None, + details: dict[str, Any] | None = None, + severity: str = "info", +) -> AuditLog: + """Persist an audit event and optionally forward it to SIEM. + + Args: + db: Active SQLAlchemy session. + action: Short action identifier (e.g. ``"login"``, ``"document.create"``). + user: Username performing the action. + resource_type: Category of the affected resource (``"document"``, ``"user"`` …). + resource_id: Identifier of the affected resource. + ip_address: Client IP address (``None`` when not applicable). + details: Arbitrary key/value context serialised as JSON. + severity: One of ``info``, ``warning``, ``error``, ``critical``. + + Returns: + The newly created :class:`AuditLog` row. + """ + details_json = json.dumps(details, default=str) if details else None + + entry = AuditLog( + user=user, + action=action, + resource_type=resource_type, + resource_id=str(resource_id) if resource_id is not None else None, + ip_address=ip_address, + details=details_json, + severity=severity, + ) + db.add(entry) + db.commit() + db.refresh(entry) + + # Fire-and-forget SIEM forwarding in a background thread so we never + # block the request path. + if settings.audit_siem_enabled: + payload = _build_siem_payload(entry) + thread = threading.Thread(target=_forward_to_siem, args=(payload,), daemon=True) + thread.start() + + return entry + + +def record_event_from_request( + db: Session, + request: Request, + *, + action: str, + resource_type: str | None = None, + resource_id: str | None = None, + details: dict[str, Any] | None = None, + severity: str = "info", +) -> AuditLog: + """Convenience wrapper that extracts user and IP from a :class:`Request`. + + Args: + db: Active SQLAlchemy session. + request: The current HTTP request. + action: Short action identifier. + resource_type: Category of the affected resource. + resource_id: Identifier of the affected resource. + details: Arbitrary key/value context serialised as JSON. + severity: One of ``info``, ``warning``, ``error``, ``critical``. + + Returns: + The newly created :class:`AuditLog` row. + """ + return record_event( + db, + action=action, + user=get_username(request), + resource_type=resource_type, + resource_id=resource_id, + ip_address=get_client_ip(request), + details=details, + severity=severity, + ) + + +def query_events( + db: Session, + *, + action: str | None = None, + user: str | None = None, + resource_type: str | None = None, + severity: str | None = None, + since: datetime | None = None, + until: datetime | None = None, + limit: int = 200, + offset: int = 0, +) -> list[AuditLog]: + """Query audit log entries with optional filtering. + + Args: + db: Active SQLAlchemy session. + action: Filter by action string (exact match). + user: Filter by username (exact match). + resource_type: Filter by resource type (exact match). + severity: Filter by severity level (exact match). + since: Only events at or after this timestamp. + until: Only events at or before this timestamp. + limit: Maximum number of rows to return. + offset: Number of rows to skip (for pagination). + + Returns: + List of :class:`AuditLog` rows ordered by *timestamp descending*. + """ + q = db.query(AuditLog) + if action: + q = q.filter(AuditLog.action == action) + if user: + q = q.filter(AuditLog.user == user) + if resource_type: + q = q.filter(AuditLog.resource_type == resource_type) + if severity: + q = q.filter(AuditLog.severity == severity) + if since: + q = q.filter(AuditLog.timestamp >= since) + if until: + q = q.filter(AuditLog.timestamp <= until) + return q.order_by(AuditLog.timestamp.desc()).offset(offset).limit(limit).all() + + +def count_events( + db: Session, + *, + action: str | None = None, + user: str | None = None, + resource_type: str | None = None, + severity: str | None = None, + since: datetime | None = None, + until: datetime | None = None, +) -> int: + """Return the total count of events matching the given filters. + + Args: + db: Active SQLAlchemy session. + action: Filter by action string. + user: Filter by username. + resource_type: Filter by resource type. + severity: Filter by severity level. + since: Only events at or after this timestamp. + until: Only events at or before this timestamp. + + Returns: + Integer count. + """ + q = db.query(AuditLog) + if action: + q = q.filter(AuditLog.action == action) + if user: + q = q.filter(AuditLog.user == user) + if resource_type: + q = q.filter(AuditLog.resource_type == resource_type) + if severity: + q = q.filter(AuditLog.severity == severity) + if since: + q = q.filter(AuditLog.timestamp >= since) + if until: + q = q.filter(AuditLog.timestamp <= until) + return q.count() + + +# --------------------------------------------------------------------------- +# SIEM forwarding internals +# --------------------------------------------------------------------------- + +_SYSLOG_FACILITY_LOCAL0 = 16 +_SYSLOG_SEVERITY_MAP = { + "info": 6, + "warning": 4, + "error": 3, + "critical": 2, +} + + +def _build_siem_payload(entry: AuditLog) -> dict[str, Any]: + """Convert an :class:`AuditLog` row into a plain dict for SIEM delivery.""" + ts = entry.timestamp if entry.timestamp else datetime.now(timezone.utc) + return { + "id": entry.id, + "timestamp": ts.isoformat(), + "user": entry.user, + "action": entry.action, + "resource_type": entry.resource_type, + "resource_id": entry.resource_id, + "ip_address": entry.ip_address, + "details": entry.details, + "severity": entry.severity, + "source": "docuelevate", + } + + +def _forward_to_siem(payload: dict[str, Any]) -> None: + """Route a SIEM payload to the configured transport.""" + transport = settings.audit_siem_transport.lower() + try: + if transport == "syslog": + _send_syslog(payload) + elif transport == "http": + _send_http(payload) + else: + logger.warning("Unknown SIEM transport %r; skipping forwarding", transport) + except Exception: + logger.exception("Failed to forward audit event to SIEM (%s)", transport) + + +def _send_syslog(payload: dict[str, Any]) -> None: + """Send a RFC 5424 syslog message to the configured receiver.""" + severity_num = _SYSLOG_SEVERITY_MAP.get(payload.get("severity", "info"), 6) + priority = _SYSLOG_FACILITY_LOCAL0 * 8 + severity_num + ts = payload.get("timestamp", datetime.now(timezone.utc).isoformat()) + hostname = socket.gethostname() + app_name = "docuelevate" + msg_id = payload.get("action", "-") + + # Structured data (SD) element with key event fields. + sd = ( + f'[docuelevate@0 user="{payload.get("user", "-")}" ' + f'action="{payload.get("action", "-")}" ' + f'resource_type="{payload.get("resource_type", "-")}" ' + f'resource_id="{payload.get("resource_id", "-")}" ' + f'ip="{payload.get("ip_address", "-")}"]' + ) + message = json.dumps(payload, default=str) + syslog_msg = f"<{priority}>1 {ts} {hostname} {app_name} - {msg_id} {sd} {message}" + + proto = settings.audit_siem_syslog_protocol.lower() + host = settings.audit_siem_syslog_host + port = settings.audit_siem_syslog_port + + if proto == "tcp": + with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock: + sock.settimeout(5) + sock.connect((host, port)) + sock.sendall(syslog_msg.encode("utf-8")) + else: + with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sock: + sock.settimeout(5) + sock.sendto(syslog_msg.encode("utf-8"), (host, port)) + + logger.debug("Syslog audit event sent to %s:%s (%s)", host, port, proto) + + +def _send_http(payload: dict[str, Any]) -> None: + """POST a JSON audit event to the configured HTTP endpoint.""" + url = settings.audit_siem_http_url + if not url: + logger.warning("SIEM HTTP URL not configured; skipping HTTP forwarding") + return + + headers: dict[str, str] = {"Content-Type": "application/json"} + token = settings.audit_siem_http_token + if token: + headers["Authorization"] = f"Bearer {token}" + + # Parse custom headers (comma-separated "Key:Value" pairs). + # Reject headers that could override security-critical ones already set, + # and validate that header names contain only RFC 7230 token characters. + _PROTECTED_HEADERS = {"authorization", "content-type", "host"} + _VALID_HEADER_NAME = re.compile(r"^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$") + raw_custom = settings.audit_siem_http_custom_headers + if raw_custom: + for raw_pair in raw_custom.split(","): + pair = raw_pair.strip() + if ":" in pair: + k, _, v = pair.partition(":") + name = k.strip() + if not name or not _VALID_HEADER_NAME.match(name): + logger.warning("Skipping invalid SIEM custom header name: %r", name) + continue + if name.lower() in _PROTECTED_HEADERS: + logger.warning("Skipping protected SIEM custom header: %r", name) + continue + headers[name] = v.strip() + + # Wrap in Splunk HEC-style envelope when URL contains ``/services/collector``. + body: dict[str, Any] + if "/services/collector" in url: + body = {"event": payload, "sourcetype": "docuelevate:audit", "source": "docuelevate"} + else: + body = payload + + with httpx.Client(timeout=10) as client: + resp = client.post(url, json=body, headers=headers) + resp.raise_for_status() + + logger.debug("HTTP audit event forwarded to %s (status %s)", url, resp.status_code) diff --git a/app/utils/db_migrate.py b/app/utils/db_migrate.py index 69461de7..3424009d 100644 --- a/app/utils/db_migrate.py +++ b/app/utils/db_migrate.py @@ -32,6 +32,7 @@ _TABLE_ORDER = [ "processing_logs", "application_settings", "settings_audit_log", + "audit_logs", "saved_searches", "webhook_configs", "shared_links", diff --git a/app/utils/settings_service.py b/app/utils/settings_service.py index 7516f8f9..39ed812e 100644 --- a/app/utils/settings_service.py +++ b/app/utils/settings_service.py @@ -2065,6 +2065,78 @@ SETTING_METADATA = { "required": False, "restart_required": True, }, + "audit_siem_enabled": { + "category": "Security", + "description": "Enable forwarding of audit events to an external SIEM system (Syslog, Splunk, Logstash, etc.).", + "type": "boolean", + "sensitive": False, + "required": False, + "restart_required": False, + }, + "audit_siem_transport": { + "category": "Security", + "description": ( + "Transport used to forward audit events. 'syslog' sends RFC 5424 messages over UDP/TCP. " + "'http' sends JSON POST payloads to a webhook URL (Splunk HEC, Logstash, Grafana Loki, etc.)." + ), + "type": "string", + "sensitive": False, + "required": False, + "restart_required": False, + "options": ["syslog", "http"], + }, + "audit_siem_syslog_host": { + "category": "Security", + "description": "Hostname or IP of the syslog receiver.", + "type": "string", + "sensitive": False, + "required": False, + "restart_required": False, + }, + "audit_siem_syslog_port": { + "category": "Security", + "description": "Port of the syslog receiver. Default: 514.", + "type": "integer", + "sensitive": False, + "required": False, + "restart_required": False, + }, + "audit_siem_syslog_protocol": { + "category": "Security", + "description": "Protocol for syslog transport: 'udp' or 'tcp'. Default: udp.", + "type": "string", + "sensitive": False, + "required": False, + "restart_required": False, + "options": ["udp", "tcp"], + }, + "audit_siem_http_url": { + "category": "Security", + "description": ( + "HTTP endpoint URL for SIEM webhook delivery. Supports Splunk HEC, " + "Logstash HTTP input, Grafana Loki push API, or any JSON-accepting endpoint." + ), + "type": "string", + "sensitive": False, + "required": False, + "restart_required": False, + }, + "audit_siem_http_token": { + "category": "Security", + "description": "Bearer / HEC token included in the Authorization header of SIEM HTTP requests.", + "type": "string", + "sensitive": True, + "required": False, + "restart_required": False, + }, + "audit_siem_http_custom_headers": { + "category": "Security", + "description": "Comma-separated 'Key:Value' pairs of extra headers for SIEM HTTP requests.", + "type": "string", + "sensitive": False, + "required": False, + "restart_required": False, + }, # Rate Limiting "rate_limiting_enabled": { "category": "Security", diff --git a/app/views/__init__.py b/app/views/__init__.py index 5c098527..1b2b0443 100644 --- a/app/views/__init__.py +++ b/app/views/__init__.py @@ -6,6 +6,7 @@ from fastapi import APIRouter from app.views.admin_users import router as admin_users_router from app.views.api_tokens import router as api_tokens_router +from app.views.audit_logs import router as audit_logs_router from app.views.backup import router as backup_router from app.views.db_wizard import router as db_wizard_router from app.views.dropbox import router as dropbox_router @@ -60,4 +61,5 @@ router.include_router(imap_accounts_router) # Per-user IMAP ingestion accounts router.include_router(integrations_router) # Unified integrations dashboard router.include_router(notifications_router) # User notification dashboard router.include_router(scheduled_jobs_router) # Admin scheduled batch jobs +router.include_router(audit_logs_router) # Comprehensive audit log viewer router.include_router(help_router) # Built-in help / How-To docs diff --git a/app/views/audit_logs.py b/app/views/audit_logs.py new file mode 100644 index 00000000..a787fece --- /dev/null +++ b/app/views/audit_logs.py @@ -0,0 +1,46 @@ +""" +Audit log viewer UI — admin-only page with filtering and SIEM status. +""" + +import logging + +from fastapi import Depends, HTTPException, Request, status +from sqlalchemy.orm import Session + +from app.views.base import APIRouter, get_db, require_login, settings, templates +from app.views.settings import require_admin_access + +logger = logging.getLogger(__name__) +router = APIRouter() + + +@router.get("/admin/audit-logs") +@require_login +@require_admin_access +async def audit_logs_page(request: Request, db: Session = Depends(get_db)): + """Comprehensive audit log viewer with filtering controls. + + Displays a chronological log of all significant actions: logins, + document operations, settings changes, and admin actions. The + actual data is fetched client-side via the ``/api/audit-logs`` JSON + endpoint so that filters, pagination, and live refresh work without + full-page reloads. + """ + try: + siem_enabled = settings.audit_siem_enabled + siem_transport = settings.audit_siem_transport if siem_enabled else None + return templates.TemplateResponse( + "audit_logs.html", + { + "request": request, + "app_version": settings.version, + "siem_enabled": siem_enabled, + "siem_transport": siem_transport, + }, + ) + except Exception as e: + logger.error("Error loading audit logs page: %s", e) + raise HTTPException( + status_code=status.HTTP_500_INTERNAL_SERVER_ERROR, + detail="Failed to load audit logs page", + ) diff --git a/docs/ConfigurationGuide.md b/docs/ConfigurationGuide.md index 009dc5a9..131324e4 100644 --- a/docs/ConfigurationGuide.md +++ b/docs/ConfigurationGuide.md @@ -398,6 +398,61 @@ default overage buffer applied across all plans. DocuElevate supports HTTP security headers to improve browser-side security. **These headers are disabled by default** since most deployments use a reverse proxy (Traefik, Nginx, etc.) that already adds them. Enable only if deploying directly without a reverse proxy. See [Deployment Guide - Security Headers](DeploymentGuide.md#security-headers) for detailed configuration examples. +### Audit Logging + +DocuElevate provides comprehensive audit logging that records significant actions (logins, document CRUD, settings changes) to an append-only database table. Every entry captures the timestamp, user, action, resource, client IP, and optional JSON details. + +| **Variable** | **Description** | **Default** | +|--------------------------------|---------------------------------------------------------------------------------------------------|-------------| +| `AUDIT_LOGGING_ENABLED` | Enable the HTTP request audit-logging middleware. | `true` | +| `AUDIT_LOG_INCLUDE_CLIENT_IP` | Include the client IP address in audit log entries. Disable for GDPR-sensitive deployments. | `true` | + +#### SIEM Integration + +Audit events can be forwarded in real time to external SIEM systems for centralised monitoring, alerting, and long-term retention. Two transports are supported: + +* **Syslog** – RFC 5424 structured-data messages over UDP or TCP. Works with rsyslog, syslog-ng, Graylog, Datadog, etc. +* **HTTP** – JSON POST payloads compatible with Splunk HEC, Logstash HTTP input, Grafana Loki push API, and any generic webhook. + +| **Variable** | **Description** | **Default** | +|-------------------------------------|---------------------------------------------------------------------------------------------------|---------------| +| `AUDIT_SIEM_ENABLED` | Enable forwarding of audit events to an external SIEM system. | `false` | +| `AUDIT_SIEM_TRANSPORT` | Transport: `syslog` or `http`. | `syslog` | +| `AUDIT_SIEM_SYSLOG_HOST` | Hostname or IP of the syslog receiver. | `localhost` | +| `AUDIT_SIEM_SYSLOG_PORT` | Port of the syslog receiver. | `514` | +| `AUDIT_SIEM_SYSLOG_PROTOCOL` | Protocol for syslog: `udp` or `tcp`. | `udp` | +| `AUDIT_SIEM_HTTP_URL` | HTTP endpoint URL for SIEM delivery (e.g. Splunk HEC, Logstash, Loki). | *(empty)* | +| `AUDIT_SIEM_HTTP_TOKEN` | Bearer / HEC token for the SIEM HTTP endpoint. | *(empty)* | +| `AUDIT_SIEM_HTTP_CUSTOM_HEADERS` | Comma-separated `Key:Value` extra headers for SIEM HTTP requests. | *(empty)* | + +**Example – Syslog to rsyslog:** + +```bash +AUDIT_SIEM_ENABLED=true +AUDIT_SIEM_TRANSPORT=syslog +AUDIT_SIEM_SYSLOG_HOST=syslog.internal.example.com +AUDIT_SIEM_SYSLOG_PORT=514 +AUDIT_SIEM_SYSLOG_PROTOCOL=udp +``` + +**Example – Splunk HEC:** + +```bash +AUDIT_SIEM_ENABLED=true +AUDIT_SIEM_TRANSPORT=http +AUDIT_SIEM_HTTP_URL=https://splunk.example.com:8088/services/collector/event +AUDIT_SIEM_HTTP_TOKEN=your-hec-token +``` + +**Example – Logstash HTTP input:** + +```bash +AUDIT_SIEM_ENABLED=true +AUDIT_SIEM_TRANSPORT=http +AUDIT_SIEM_HTTP_URL=https://logstash.example.com:8080 +AUDIT_SIEM_HTTP_TOKEN= +``` + ### Rate Limiting DocuElevate implements rate limiting to protect against DoS attacks and API abuse. **Rate limiting is enabled by default** and uses Redis for distributed rate limiting across multiple workers. diff --git a/frontend/templates/audit_logs.html b/frontend/templates/audit_logs.html new file mode 100644 index 00000000..92073816 --- /dev/null +++ b/frontend/templates/audit_logs.html @@ -0,0 +1,222 @@ +{% extends "base.html" %} + +{% block title %}Audit Logs - DocuElevate{% endblock %} + +{% block content %} +
+ + +
+
+

+ Audit Logs +

+

+ Comprehensive, append-only record of all significant actions. +

+
+
+ {% if siem_enabled %} + + SIEM: {{ siem_transport|upper }} + + {% else %} + + SIEM: Off + + {% endif %} + +
+
+ + +
+
+
+ + +
+
+ + +
+
+ + +
+
+ + +
+
+
+ + +
+ + Loading… +
+ + +
+
+ + + + + + + + + + + + + + + + + + +
TimestampSeverityUserActionResourceIPDetails
+ +

No audit events recorded yet.

+

Significant actions (logins, document operations, settings changes) will appear here.

+
+
+
+ + + + +
+ + +{% endblock %} diff --git a/frontend/templates/base.html b/frontend/templates/base.html index e4bb200a..81609f23 100644 --- a/frontend/templates/base.html +++ b/frontend/templates/base.html @@ -171,6 +171,9 @@ Backup & Restore + + Audit Logs + Status diff --git a/migrations/env.py b/migrations/env.py index 69ff2995..67fc3ad3 100644 --- a/migrations/env.py +++ b/migrations/env.py @@ -22,6 +22,7 @@ from app.database import Base from app.models import ( # noqa: F401 ApiToken, ApplicationSettings, + AuditLog, BackupRecord, DocumentMetadata, FileProcessingStep, diff --git a/migrations/versions/028_add_audit_logs.py b/migrations/versions/028_add_audit_logs.py new file mode 100644 index 00000000..58114e7a --- /dev/null +++ b/migrations/versions/028_add_audit_logs.py @@ -0,0 +1,47 @@ +"""Add audit_logs table for comprehensive compliance audit logging. + +Revision ID: 028_add_audit_logs +Revises: 027_ensure_shared_links_table +Create Date: 2026-03-09 +""" + +from typing import Union + +import sqlalchemy as sa +from alembic import op + +revision: str = "028_add_audit_logs" +down_revision: Union[str, None] = "027_ensure_shared_links_table" +depends_on: Union[str, None] = None + + +def upgrade() -> None: + """Create audit_logs table.""" + op.create_table( + "audit_logs", + sa.Column("id", sa.Integer(), nullable=False), + sa.Column("timestamp", sa.DateTime(timezone=True), server_default=sa.func.now(), nullable=False), + sa.Column("user", sa.String(), nullable=False), + sa.Column("action", sa.String(), nullable=False), + sa.Column("resource_type", sa.String(), nullable=True), + sa.Column("resource_id", sa.String(), nullable=True), + sa.Column("ip_address", sa.String(), nullable=True), + sa.Column("details", sa.Text(), nullable=True), + sa.Column("severity", sa.String(16), nullable=False, server_default="info"), + sa.PrimaryKeyConstraint("id"), + ) + op.create_index("ix_audit_logs_id", "audit_logs", ["id"]) + op.create_index("ix_audit_logs_timestamp", "audit_logs", ["timestamp"]) + op.create_index("ix_audit_logs_user", "audit_logs", ["user"]) + op.create_index("ix_audit_logs_action", "audit_logs", ["action"]) + op.create_index("ix_audit_logs_resource_type", "audit_logs", ["resource_type"]) + + +def downgrade() -> None: + """Drop audit_logs table.""" + op.drop_index("ix_audit_logs_resource_type", "audit_logs") + op.drop_index("ix_audit_logs_action", "audit_logs") + op.drop_index("ix_audit_logs_user", "audit_logs") + op.drop_index("ix_audit_logs_timestamp", "audit_logs") + op.drop_index("ix_audit_logs_id", "audit_logs") + op.drop_table("audit_logs") diff --git a/tests/conftest.py b/tests/conftest.py index ae6db91e..cce347f7 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -61,6 +61,7 @@ from app.main import app as fastapi_app # noqa: E402 # Import models to register them with SQLAlchemy Base from app.models import ( # noqa: F401, E402 ApiToken, + AuditLog, DocumentMetadata, FileRecord, Pipeline, diff --git a/tests/test_audit_logs.py b/tests/test_audit_logs.py new file mode 100644 index 00000000..1671fd47 --- /dev/null +++ b/tests/test_audit_logs.py @@ -0,0 +1,365 @@ +""" +Tests for the comprehensive audit logging feature. + +Covers the audit service (recording, querying, SIEM forwarding), +the REST API endpoints, and the admin viewer page. +""" + +import json +import socket +from datetime import datetime, timezone +from unittest.mock import MagicMock, patch + +import pytest +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker +from sqlalchemy.pool import StaticPool + +from app.database import Base +from app.models import AuditLog + +# --------------------------------------------------------------------------- +# Fixtures +# --------------------------------------------------------------------------- + + +@pytest.fixture() +def audit_db(): + """Fresh in-memory database with all tables created.""" + engine = create_engine( + "sqlite:///:memory:", + connect_args={"check_same_thread": False}, + poolclass=StaticPool, + ) + Base.metadata.create_all(bind=engine) + Session = sessionmaker(bind=engine) + session = Session() + yield session + session.close() + Base.metadata.drop_all(bind=engine) + + +# --------------------------------------------------------------------------- +# Model tests +# --------------------------------------------------------------------------- + + +@pytest.mark.unit +class TestAuditLogModel: + """Verify the AuditLog ORM model.""" + + def test_create_minimal_entry(self, audit_db): + """Minimal required fields can be persisted.""" + entry = AuditLog(user="alice", action="login") + audit_db.add(entry) + audit_db.commit() + audit_db.refresh(entry) + assert entry.id is not None + assert entry.user == "alice" + assert entry.action == "login" + assert entry.severity == "info" # server default + + def test_create_full_entry(self, audit_db): + """All columns persist correctly.""" + entry = AuditLog( + user="bob", + action="document.create", + resource_type="document", + resource_id="42", + ip_address="10.0.0.1", + details='{"filename": "invoice.pdf"}', + severity="warning", + ) + audit_db.add(entry) + audit_db.commit() + audit_db.refresh(entry) + assert entry.resource_type == "document" + assert entry.resource_id == "42" + assert entry.ip_address == "10.0.0.1" + assert json.loads(entry.details) == {"filename": "invoice.pdf"} + assert entry.severity == "warning" + + +# --------------------------------------------------------------------------- +# Service tests +# --------------------------------------------------------------------------- + + +@pytest.mark.unit +class TestAuditService: + """Verify the audit_service helper functions.""" + + @patch("app.utils.audit_service.settings") + def test_record_event(self, mock_settings, audit_db): + """record_event persists a row and returns the entry.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import record_event + + entry = record_event( + audit_db, + action="settings.update", + user="admin", + resource_type="settings", + resource_id="openai_model", + details={"old": "gpt-4", "new": "gpt-4o"}, + ) + assert entry.id is not None + assert entry.action == "settings.update" + assert entry.user == "admin" + + @patch("app.utils.audit_service.settings") + def test_query_events_no_filter(self, mock_settings, audit_db): + """query_events returns all events when no filter is supplied.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import query_events, record_event + + for i in range(5): + record_event(audit_db, action=f"action_{i}", user="sys") + results = query_events(audit_db) + assert len(results) == 5 + + @patch("app.utils.audit_service.settings") + def test_query_events_filter_action(self, mock_settings, audit_db): + """query_events filters by action.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import query_events, record_event + + record_event(audit_db, action="login", user="alice") + record_event(audit_db, action="logout", user="alice") + results = query_events(audit_db, action="login") + assert len(results) == 1 + assert results[0].action == "login" + + @patch("app.utils.audit_service.settings") + def test_query_events_filter_user(self, mock_settings, audit_db): + """query_events filters by user.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import query_events, record_event + + record_event(audit_db, action="login", user="alice") + record_event(audit_db, action="login", user="bob") + results = query_events(audit_db, user="bob") + assert len(results) == 1 + + @patch("app.utils.audit_service.settings") + def test_query_events_filter_severity(self, mock_settings, audit_db): + """query_events filters by severity.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import query_events, record_event + + record_event(audit_db, action="fail", user="sys", severity="error") + record_event(audit_db, action="ok", user="sys", severity="info") + results = query_events(audit_db, severity="error") + assert len(results) == 1 + assert results[0].severity == "error" + + @patch("app.utils.audit_service.settings") + def test_count_events(self, mock_settings, audit_db): + """count_events returns the correct total.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import count_events, record_event + + for _ in range(3): + record_event(audit_db, action="ping", user="sys") + assert count_events(audit_db) == 3 + assert count_events(audit_db, action="ping") == 3 + assert count_events(audit_db, action="pong") == 0 + + @patch("app.utils.audit_service.settings") + def test_query_events_pagination(self, mock_settings, audit_db): + """query_events respects limit and offset.""" + mock_settings.audit_siem_enabled = False + from app.utils.audit_service import query_events, record_event + + for i in range(10): + record_event(audit_db, action=f"a{i}", user="sys") + page1 = query_events(audit_db, limit=3, offset=0) + page2 = query_events(audit_db, limit=3, offset=3) + assert len(page1) == 3 + assert len(page2) == 3 + assert page1[0].id != page2[0].id + + +# --------------------------------------------------------------------------- +# SIEM forwarding tests +# --------------------------------------------------------------------------- + + +@pytest.mark.unit +class TestSIEMForwarding: + """Verify SIEM transport helpers.""" + + @patch("app.utils.audit_service.settings") + def test_build_siem_payload(self, mock_settings): + """_build_siem_payload returns a dict with all expected keys.""" + from app.utils.audit_service import _build_siem_payload + + entry = AuditLog( + id=1, + user="admin", + action="login", + resource_type="session", + timestamp=datetime(2026, 1, 1, tzinfo=timezone.utc), + severity="info", + ) + payload = _build_siem_payload(entry) + assert payload["user"] == "admin" + assert payload["action"] == "login" + assert payload["source"] == "docuelevate" + assert "timestamp" in payload + + @patch("app.utils.audit_service.settings") + @patch("app.utils.audit_service.socket") + def test_send_syslog_udp(self, mock_socket_mod, mock_settings): + """_send_syslog sends a UDP datagram to the configured host.""" + mock_settings.audit_siem_syslog_protocol = "udp" + mock_settings.audit_siem_syslog_host = "127.0.0.1" + mock_settings.audit_siem_syslog_port = 5140 + + mock_sock = MagicMock() + mock_socket_mod.AF_INET = socket.AF_INET + mock_socket_mod.SOCK_DGRAM = socket.SOCK_DGRAM + mock_socket_mod.gethostname.return_value = "test-host" + mock_socket_mod.socket.return_value.__enter__ = MagicMock(return_value=mock_sock) + mock_socket_mod.socket.return_value.__exit__ = MagicMock(return_value=False) + + from app.utils.audit_service import _send_syslog + + _send_syslog({"user": "test", "action": "login", "severity": "info", "timestamp": "2026-01-01T00:00:00"}) + mock_sock.sendto.assert_called_once() + + @patch("app.utils.audit_service.settings") + @patch("app.utils.audit_service.httpx") + def test_send_http_generic(self, mock_httpx, mock_settings): + """_send_http POSTs JSON to a generic endpoint.""" + mock_settings.audit_siem_http_url = "https://siem.example.com/ingest" + mock_settings.audit_siem_http_token = "my-token" + mock_settings.audit_siem_http_custom_headers = "" + + mock_client = MagicMock() + mock_resp = MagicMock() + mock_resp.status_code = 200 + mock_client.post.return_value = mock_resp + mock_httpx.Client.return_value.__enter__ = MagicMock(return_value=mock_client) + mock_httpx.Client.return_value.__exit__ = MagicMock(return_value=False) + + from app.utils.audit_service import _send_http + + _send_http({"user": "test", "action": "login"}) + mock_client.post.assert_called_once() + call_kwargs = mock_client.post.call_args + assert call_kwargs.kwargs["headers"]["Authorization"] == "Bearer my-token" + + @patch("app.utils.audit_service.settings") + @patch("app.utils.audit_service.httpx") + def test_send_http_splunk_hec(self, mock_httpx, mock_settings): + """_send_http wraps payload in Splunk HEC envelope when URL contains /services/collector.""" + mock_settings.audit_siem_http_url = "https://splunk:8088/services/collector/event" + mock_settings.audit_siem_http_token = "hec-token" + mock_settings.audit_siem_http_custom_headers = "" + + mock_client = MagicMock() + mock_resp = MagicMock() + mock_resp.status_code = 200 + mock_client.post.return_value = mock_resp + mock_httpx.Client.return_value.__enter__ = MagicMock(return_value=mock_client) + mock_httpx.Client.return_value.__exit__ = MagicMock(return_value=False) + + from app.utils.audit_service import _send_http + + _send_http({"user": "test", "action": "login"}) + call_kwargs = mock_client.post.call_args + body = call_kwargs.kwargs["json"] + assert "event" in body + assert body["sourcetype"] == "docuelevate:audit" + + +# --------------------------------------------------------------------------- +# API endpoint tests +# --------------------------------------------------------------------------- + + +@pytest.mark.integration +class TestAuditLogAPI: + """Test /api/audit-logs REST endpoints.""" + + def test_list_audit_logs_empty(self, client): + """GET /api/audit-logs returns empty list when no events exist.""" + resp = client.get("/api/audit-logs") + assert resp.status_code == 200 + data = resp.json() + assert data["items"] == [] + assert data["total"] == 0 + + def test_list_audit_logs_with_data(self, client, db_session): + """GET /api/audit-logs returns recorded events.""" + entry = AuditLog(user="tester", action="test.action", severity="info") + db_session.add(entry) + db_session.commit() + + resp = client.get("/api/audit-logs") + assert resp.status_code == 200 + data = resp.json() + assert data["total"] == 1 + assert data["items"][0]["action"] == "test.action" + + def test_list_audit_logs_filter_by_action(self, client, db_session): + """GET /api/audit-logs?action=x filters correctly.""" + db_session.add(AuditLog(user="a", action="login", severity="info")) + db_session.add(AuditLog(user="a", action="logout", severity="info")) + db_session.commit() + + resp = client.get("/api/audit-logs?action=login") + assert resp.status_code == 200 + data = resp.json() + assert data["total"] == 1 + + def test_list_distinct_actions(self, client, db_session): + """GET /api/audit-logs/actions returns distinct action values.""" + db_session.add(AuditLog(user="a", action="login", severity="info")) + db_session.add(AuditLog(user="b", action="login", severity="info")) + db_session.add(AuditLog(user="a", action="logout", severity="info")) + db_session.commit() + + resp = client.get("/api/audit-logs/actions") + assert resp.status_code == 200 + actions = resp.json() + assert set(actions) == {"login", "logout"} + + def test_list_distinct_users(self, client, db_session): + """GET /api/audit-logs/users returns distinct user values.""" + db_session.add(AuditLog(user="alice", action="x", severity="info")) + db_session.add(AuditLog(user="bob", action="x", severity="info")) + db_session.commit() + + resp = client.get("/api/audit-logs/users") + assert resp.status_code == 200 + users = resp.json() + assert set(users) == {"alice", "bob"} + + def test_list_audit_logs_pagination(self, client, db_session): + """GET /api/audit-logs supports limit/offset pagination.""" + for i in range(5): + db_session.add(AuditLog(user="u", action=f"a{i}", severity="info")) + db_session.commit() + + resp = client.get("/api/audit-logs?limit=2&offset=0") + data = resp.json() + assert len(data["items"]) == 2 + assert data["total"] == 5 + + +# --------------------------------------------------------------------------- +# View tests +# --------------------------------------------------------------------------- + + +@pytest.mark.integration +class TestAuditLogView: + """Test the admin audit-log viewer page.""" + + def test_audit_logs_page_loads(self, client): + """GET /admin/audit-logs returns 200 and renders the template.""" + resp = client.get("/admin/audit-logs") + assert resp.status_code == 200 + assert "Audit Logs" in resp.text