unis_manager/app/audit.py

126 lines
4.7 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

"""操作审计:谁在什么时候改了哪个菜单的数据,成功还是被拒。
写入口只有一个:`/api` 子应用上的 HTTP 中间件。它在每个请求结束后落一行:
- 写操作(POST/PUT/PATCH/DELETE)+ 登录/退出/改密/下线:成功失败都记;
- 403 一律改记 `action=deny`(**含 GET**——越权探测也要留痕);
- 500:业务代码抛穿中间件时按 `status=500` 补记,不丢失败的写操作;
- 其余 GET 不落库,避免日志被列表刷新刷爆。
业务代码可以用 `audit.note(request, "……")` 补一句说明,日志的「说明」列直接可读。
"""
from __future__ import annotations
from datetime import timedelta
from fastapi import Request
from sqlalchemy.orm import Session
from .db import SessionLocal
from .models import AuditLog, now
# 方法 → 动作
METHOD_ACTION = {"POST": "create", "PUT": "update", "PATCH": "update", "DELETE": "delete"}
# 特殊动作:路径以这些结尾时按语义记,不套 method 默认值
SPECIAL_ACTION = {
"/api/auth/login": "login",
"/api/auth/logout": "logout",
"/api/auth/password": "password",
}
KEEP_DAYS = 180 # 日志保留天数,启动时清一次
def client_ip(request: Request) -> str | None:
fwd = request.headers.get("x-forwarded-for")
if fwd:
return fwd.split(",")[0].strip()[:64]
return request.client.host[:64] if request.client else None
def action_for(path: str, method: str) -> str | None:
"""返回 None 表示这个请求不进审计(403 例外,中间件会改记 deny)。"""
clean = path.rstrip("/")
if clean in SPECIAL_ACTION:
return SPECIAL_ACTION[clean]
if clean.endswith("/revoke"): # 先于 METHOD_ACTION:否则被 POST→create 吃掉,revoke 永远 0 条
return "revoke"
if method in METHOD_ACTION:
return METHOD_ACTION[method]
return None
def note(request: Request, text: str | None = None, *, username: str | None = None) -> None:
"""业务代码给审计日志留一句人话说明;落库由中间件完成。
`username` 只在拿不到登录用户时用得上(比如密码输错,操作人记的是被尝试的账号)。
"""
try:
if text:
request.state.audit_detail = text[:255]
if username:
request.state.audit_username = username[:64]
except Exception: # 审计说明是锦上添花,不能带崩业务
pass
def write(db: Session, *, user, request: Request, status: int, action: str,
menu: str | None = None, detail: str | None = None,
username: str | None = None) -> None:
db.add(AuditLog(
user_id=getattr(user, "id", None),
username=username or getattr(user, "username", None),
action=action,
menu=menu,
method=request.method,
path=request.url.path[:255],
status=status,
ip=client_ip(request),
detail=detail[:255] if detail else None,
))
db.commit()
def prune(db: Session, keep_days: int = KEEP_DAYS) -> int:
q = db.query(AuditLog).filter(AuditLog.created_at < now() - timedelta(days=keep_days))
n = q.count()
if n:
q.delete(synchronize_session=False)
db.commit()
return n
def audit_middleware_factory():
"""给 /api 子应用用的中间件:写完响应后补一条审计。"""
async def audit(request: Request, call_next):
from .security import resolve_rule # 避免循环导入
def record(action: str, status: int) -> None:
rule = resolve_rule(request.url.path.rstrip("/"), request.method)
state = getattr(request, "state", None)
detail = getattr(state, "audit_detail", None)
if status >= 400:
detail = f"{detail};" if detail else ""
detail += f"HTTP {status}"
try:
with SessionLocal() as db:
write(db, user=getattr(state, "user", None), request=request,
status=status, action=action, menu=rule[0] if rule else None,
detail=detail, username=getattr(state, "audit_username", None))
except Exception: # 审计绝不能把业务请求带崩
pass
action = action_for(request.url.path, request.method)
try:
response = await call_next(request)
except Exception:
if action is not None: # 写操作抛穿:先补一条 500 再让上层处理
record(action, 500)
raise
status = response.status_code
if status == 403:
action = "deny" # 越权统一记 deny,含被拒的 GET
if action is not None:
record(action, status)
return response
return audit