Feat: audit (#2779)

lnbits/core/models/__init__.py

@@ -1,3 +1,4 @@
+from .audit import AuditEntry, AuditFilters
 from .lnurl import CreateLnurl, CreateLnurlAuth, PayLnurlWData
 from .misc import (
     BalanceDelta,
@@ -41,6 +42,9 @@ from .wallets import BaseWallet, CreateWallet, KeyType, Wallet, WalletTypeInfo
 from .webpush import CreateWebPushSubscription, WebPushSubscription
 
 __all__ = [
+    # audit
+    "AuditEntry",
+    "AuditFilters",
     # lnurl
     "CreateLnurl",
     "CreateLnurlAuth",

lnbits/core/models/audit.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from datetime import datetime, timedelta, timezone
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+from lnbits.db import FilterModel
+from lnbits.settings import settings
+
+
+class AuditEntry(BaseModel):
+    component: Optional[str] = None
+    ip_address: Optional[str] = None
+    user_id: Optional[str] = None
+    path: Optional[str] = None
+    request_type: Optional[str] = None
+    request_method: Optional[str] = None
+    request_details: Optional[str] = None
+    response_code: Optional[str] = None
+    duration: float
+    delete_at: Optional[datetime] = None
+    created_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))
+
+    def __init__(self, **data):
+        super().__init__(**data)
+        retention_days = max(0, settings.lnbits_audit_retention_days) or 365
+        self.delete_at = self.created_at + timedelta(days=retention_days)
+
+
+class AuditFilters(FilterModel):
+    __search_fields__ = [
+        "ip_address",
+        "user_id",
+        "path",
+        "request_method",
+        "response_code",
+        "component",
+    ]
+    __sort_fields__ = [
+        "created_at",
+        "duration",
+    ]
+
+    ip_address: Optional[str] = None
+    user_id: Optional[str] = None
+    path: Optional[str] = None
+    request_method: Optional[str] = None
+    response_code: Optional[str] = None
+    component: Optional[str] = None
+
+
+class AuditCountStat(BaseModel):
+    field: str
+    total: float
+
+
+class AuditStats(BaseModel):
+    request_method: list[AuditCountStat] = []
+    response_code: list[AuditCountStat] = []
+    component: list[AuditCountStat] = []
+    long_duration: list[AuditCountStat] = []