mirror of
https://github.com/taylanbakircioglu/haproxy-openmanager.git
synced 2026-09-16 15:45:11 +00:00
taylanbakircioglu
bd6a31cb0d
Adds opt-in TOTP-based Multi-Factor Authentication that is fully
backwards compatible with existing logins. Operators choose to enable
MFA per account; nothing changes for users who do not opt in.
Highlights
==========
* RFC 6238 TOTP (6 digits, 30s period, SHA1) with ±30s skew tolerance,
compatible with Microsoft / Google Authenticator, Authy, Duo, 1Password.
* Per-step replay protection (`mfa_last_used_totp_step`) so a captured
code cannot be reused inside the same window.
* Fernet-encrypted TOTP secrets at rest, key resolution via
`MFA_ENCRYPTION_KEY` env (HKDF-derived from `SECRET_KEY` as fallback).
* 10 single-use, bcrypt-hashed backup codes per user, formatted
`XXXX-YYYY` from a confusion-free alphabet (no 0/O/1/I/L).
* Two-step login flow: `POST /api/auth/login` returns `mfa_required`
+ `mfa_token`, then `POST /api/auth/login/mfa-verify` accepts a TOTP
code OR a backup code. JWT is minted only after MFA succeeds.
* Self-service: users enable / disable MFA from their own row in the
Users page; admins reset (single user or bulk) but never enable on
behalf of someone else (matches AWS IAM / GitHub / Google Workspace).
* Bulk emergency reset CLI: `scripts/admin-mfa-reset-all.sh`.
Security hardening
==================
* Atomic transactions with `SELECT … FOR UPDATE` on `mfa_pending_logins`
and `users` rows so concurrent verify / enroll calls cannot race.
* `/api/mfa/enroll/start` refuses re-enrollment when MFA is already on
(prevents silent secret rotation via a stolen JWT).
* Pydantic `ValidationError` messages are sanitized before reaching the
audit log so request bodies (TOTP / backup codes in flight) never
appear in plaintext.
* Slowapi rate limits are per-USER, not per-IP, with a trusted-proxy
XFF strategy so a single ingress address cannot exhaust the bucket
for thousands of operators (`MFA_TRUSTED_PROXY_CIDRS`,
`MFA_RATE_LIMIT_*` env-overridable).
* Login query now scopes to `is_active = TRUE` so a soft-deleted row
with the same username can no longer occlude the active user
(also closes a small account-enumeration side channel).
Database
========
Additive migrations (idempotent `ADD COLUMN IF NOT EXISTS`,
`CREATE TABLE IF NOT EXISTS`):
- users: mfa_enabled, mfa_method, mfa_secret_encrypted,
mfa_enrolled_at, mfa_last_used_at, mfa_last_used_totp_step
- mfa_backup_codes (user_id ON DELETE CASCADE)
- mfa_pending_logins (user_id ON DELETE CASCADE, challenge_token,
attempts, expires_at)
- mfa_pending_enrollments (user_id ON DELETE CASCADE)
Frontend
========
* Login page becomes a 3-phase state machine
(credentials → MFA → submitting); legacy single-step login is
preserved for users who haven't enrolled.
* New MFAEnrollModal (3-step wizard: QR + secret → verify → backup
codes) using `qrcode.react`.
* Users page shows MFA column + per-row enable/disable/reset actions.
Admins viewing other users with MFA off see a non-actionable info
icon explaining that only the user themselves can enable MFA.
Deployment
==========
* `MFA_ENCRYPTION_KEY` is added to `k8s/manifests/03-secrets.yaml` as
a placeholder; `SECRET_KEY` is also placeholder-ized so both are
injected by the existing pipeline pattern (sed-replace + apply).
* No new build-time env vars are required for the frontend. The SPA
uses `window.location.host` for `/api/*` and is routed by the
existing nginx ingress configuration.
* `frontend/.dockerignore` ensures host `.env*` files cannot bleed
into the production bundle.
Tests
=====
* New unit suites:
- `test_mfa_service.py` (TOTP, encryption, backup codes)
- `test_mfa_backwards_compat.py` (regression — non-MFA flow unchanged)
- `test_mfa_rate_limits.py` (env override + dataclass immutability)
- `test_mfa_rate_limit_key.py` (JWT key, trusted-proxy XFF, fallbacks)
* All existing 1000+ unit tests continue to pass.
Documentation
=============
* README MFA section (overview, day-to-day operations, emergency
reset CLI, env variables, rate-limit tuning).
* `scripts/README.md` documents the bulk reset script.
Issue: #18
74 lines
2.0 KiB
Python
74 lines
2.0 KiB
Python
"""MFA-specific Pydantic models — Issue #18, v1.6.0.
|
|
|
|
Kept in a separate module so the existing User / UserUpdate contracts in
|
|
``backend/models/user.py`` stay byte-identical for backwards compatibility.
|
|
"""
|
|
from typing import List, Literal, Optional
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class MfaVerifyRequest(BaseModel):
|
|
"""Body of POST /api/auth/login/mfa-verify (pre-auth — no JWT)."""
|
|
|
|
mfa_token: str = Field(..., min_length=64, max_length=64)
|
|
# 6 digits for TOTP or 8 alphanumerics (with optional dash) for backup codes
|
|
code: str = Field(..., min_length=6, max_length=10)
|
|
|
|
|
|
class MfaEnrollStartResponse(BaseModel):
|
|
"""Returned by POST /api/mfa/enroll/start."""
|
|
|
|
secret: str
|
|
otpauth_uri: str
|
|
expires_in: int # pending enrollment TTL in seconds
|
|
|
|
|
|
class MfaEnrollConfirmRequest(BaseModel):
|
|
"""Body of POST /api/mfa/enroll/confirm (TOTP only — backup codes not yet issued)."""
|
|
|
|
code: str = Field(..., min_length=6, max_length=6)
|
|
|
|
|
|
class MfaEnrollConfirmResponse(BaseModel):
|
|
enabled: bool
|
|
backup_codes: List[str]
|
|
method: Literal["totp"] = "totp"
|
|
|
|
|
|
class MfaDisableRequest(BaseModel):
|
|
"""Body of POST /api/mfa/disable — TOTP or backup."""
|
|
|
|
code: str = Field(..., min_length=6, max_length=10)
|
|
|
|
|
|
class MfaRegenerateBackupRequest(BaseModel):
|
|
"""Body of POST /api/mfa/backup-codes/regenerate — TOTP only."""
|
|
|
|
code: str = Field(..., min_length=6, max_length=6)
|
|
|
|
|
|
class MfaRegenerateBackupResponse(BaseModel):
|
|
backup_codes: List[str]
|
|
|
|
|
|
class MfaAdminResetRequest(BaseModel):
|
|
"""Body of POST /api/mfa/admin-reset/{user_id}."""
|
|
|
|
reason: str = Field(..., min_length=3, max_length=500)
|
|
|
|
|
|
class MfaAdminResetAllRequest(BaseModel):
|
|
"""Body of POST /api/mfa/admin-reset-all (emergency)."""
|
|
|
|
confirm: Literal["RESET ALL MFA"]
|
|
reason: str = Field(..., min_length=3, max_length=500)
|
|
|
|
|
|
class MfaStatusResponse(BaseModel):
|
|
enabled: bool
|
|
method: Optional[str] = None
|
|
enrolled_at: Optional[str] = None
|
|
last_used_at: Optional[str] = None
|
|
backup_codes_remaining: int = 0
|