M4-T06: add TOTP second factor to login (totp_code + recovery codes)
This commit is contained in:
+442
-1
@@ -1,7 +1,24 @@
|
||||
"""Tests for M2-T02: GET /api/session, POST /api/auth/login, /logout, /password."""
|
||||
"""Tests for M2-T02: GET /api/session, POST /api/auth/login, /logout, /password.
|
||||
|
||||
Also covers M4-T06: two-factor login regression tests (TOTP not enabled → same
|
||||
as before; TOTP enabled → two-step protocol).
|
||||
"""
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pyotp
|
||||
import pytest
|
||||
from alembic import command
|
||||
from alembic.config import Config
|
||||
from fastapi.testclient import TestClient
|
||||
from sqlalchemy import create_engine
|
||||
from sqlalchemy.orm import Session
|
||||
|
||||
from app.db import reset_db_caches
|
||||
from app.config import get_settings
|
||||
from app.main import create_app
|
||||
from app.services.login_throttle import N_FREE
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -330,3 +347,427 @@ def test_session_response_has_no_secret_fields(client: TestClient) -> None:
|
||||
assert set(body.keys()) == {"user", "csrf_token"}
|
||||
# user must have exactly these keys
|
||||
assert set(body["user"].keys()) == {"username", "force_password_change"}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# M4-T06 — Two-factor login (TOTP second step)
|
||||
# Fixtures & helpers
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def _make_app_alembic_config(database_url: str) -> Config:
|
||||
cfg = Config("alembic_app.ini")
|
||||
cfg.set_main_option("sqlalchemy.url", database_url)
|
||||
return cfg
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def totp_login_client(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
|
||||
"""Full client with TOTP-capable DB (throttle disabled for simplicity)."""
|
||||
db_path = tmp_path / "totp_login_test.db"
|
||||
db_url = f"sqlite:///{db_path}"
|
||||
|
||||
monkeypatch.setenv("APP_DATABASE_URL", db_url)
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_USERNAME", "admin")
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_PASSWORD", "test-password")
|
||||
monkeypatch.setenv("AUTH_COOKIE_SECURE_OVERRIDE", "false")
|
||||
monkeypatch.setenv("AUTH_LOGIN_THROTTLE_ENABLED", "false")
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
|
||||
command.upgrade(_make_app_alembic_config(db_url), "head")
|
||||
reset_db_caches()
|
||||
|
||||
app = create_app()
|
||||
with TestClient(app) as tc:
|
||||
yield tc
|
||||
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def totp_login_throttle_client(tmp_path: Path, monkeypatch: pytest.MonkeyPatch):
|
||||
"""Full client with TOTP + throttle ENABLED (for throttle-interaction tests)."""
|
||||
db_path = tmp_path / "totp_throttle_test.db"
|
||||
db_url = f"sqlite:///{db_path}"
|
||||
|
||||
monkeypatch.setenv("APP_DATABASE_URL", db_url)
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_USERNAME", "admin")
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_PASSWORD", "test-password")
|
||||
monkeypatch.setenv("AUTH_COOKIE_SECURE_OVERRIDE", "false")
|
||||
monkeypatch.setenv("AUTH_LOGIN_THROTTLE_ENABLED", "true")
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
|
||||
command.upgrade(_make_app_alembic_config(db_url), "head")
|
||||
reset_db_caches()
|
||||
|
||||
engine = create_engine(db_url, connect_args={"check_same_thread": False})
|
||||
app = create_app()
|
||||
with TestClient(app) as tc:
|
||||
yield tc, engine
|
||||
engine.dispose()
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
|
||||
|
||||
def _enable_totp(client: TestClient) -> tuple[str, list[str]]:
|
||||
"""Log in, setup TOTP, enable it; return (secret, recovery_codes)."""
|
||||
login_resp = client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert login_resp.status_code == 200, login_resp.text
|
||||
csrf = login_resp.json()["csrf_token"]
|
||||
|
||||
setup_resp = client.post("/api/auth/totp/setup", headers={"X-CSRF-Token": csrf})
|
||||
assert setup_resp.status_code == 200, setup_resp.text
|
||||
setup_body = setup_resp.json()
|
||||
secret = setup_body["secret"]
|
||||
recovery_codes = setup_body["recovery_codes"]
|
||||
|
||||
enable_resp = client.post(
|
||||
"/api/auth/totp/enable",
|
||||
json={"code": pyotp.TOTP(secret).now()},
|
||||
headers={"X-CSRF-Token": csrf},
|
||||
)
|
||||
assert enable_resp.status_code == 204, enable_resp.text
|
||||
|
||||
# Log out so subsequent login tests start fresh
|
||||
client.post("/api/auth/logout", headers={"X-CSRF-Token": csrf})
|
||||
return secret, recovery_codes
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# M4-T06 — Regression: TOTP not enabled → login unchanged
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestLoginWithoutTotpEnabled:
|
||||
"""TOTP not enabled: login behaves exactly as before T06."""
|
||||
|
||||
def test_login_without_totp_code_succeeds(self, totp_login_client: TestClient) -> None:
|
||||
"""Standard login (no totp_code field at all) still works when TOTP is off."""
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
body = resp.json()
|
||||
assert "user" in body
|
||||
assert "csrf_token" in body
|
||||
|
||||
def test_login_with_null_totp_code_succeeds(self, totp_login_client: TestClient) -> None:
|
||||
"""Explicitly sending totp_code=null works fine when TOTP is off."""
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": None},
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
|
||||
def test_login_sets_session_cookie(self, totp_login_client: TestClient) -> None:
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
assert "home_automation_session=" in resp.headers.get("set-cookie", "").lower()
|
||||
|
||||
def test_wrong_password_still_401(self, totp_login_client: TestClient) -> None:
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "wrong"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
# Must be the standard generic message
|
||||
assert resp.json()["detail"] == "invalid username or password"
|
||||
|
||||
def test_wrong_password_no_cookie(self, totp_login_client: TestClient) -> None:
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "wrong"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
assert "home_automation_session=" not in resp.headers.get("set-cookie", "").lower()
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# M4-T06 — TOTP enabled: two-step protocol
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestLoginWithTotpEnabled:
|
||||
"""TOTP enabled: missing/wrong/correct code semantics."""
|
||||
|
||||
def test_missing_totp_code_returns_401_with_totp_required(
|
||||
self, totp_login_client: TestClient
|
||||
) -> None:
|
||||
"""Correct password but no totp_code → 401 with totp_required signal."""
|
||||
_enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
body = resp.json()
|
||||
# detail must be a dict with totp_required=true
|
||||
assert isinstance(body["detail"], dict)
|
||||
assert body["detail"].get("totp_required") is True
|
||||
|
||||
def test_totp_required_response_has_no_session_cookie(
|
||||
self, totp_login_client: TestClient
|
||||
) -> None:
|
||||
"""totp_required 401 must NOT set a session cookie."""
|
||||
_enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
assert "home_automation_session=" not in resp.headers.get("set-cookie", "").lower()
|
||||
|
||||
def test_wrong_totp_code_returns_generic_401(
|
||||
self, totp_login_client: TestClient
|
||||
) -> None:
|
||||
"""Wrong TOTP code → generic 401 (no totp_required signal)."""
|
||||
_enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": "000000"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
detail = resp.json()["detail"]
|
||||
# Must be a plain string (not dict with totp_required)
|
||||
assert isinstance(detail, str)
|
||||
assert detail == "invalid username or password"
|
||||
|
||||
def test_wrong_totp_code_no_cookie(self, totp_login_client: TestClient) -> None:
|
||||
"""Wrong TOTP → no cookie."""
|
||||
_enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": "000000"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
assert "home_automation_session=" not in resp.headers.get("set-cookie", "").lower()
|
||||
|
||||
def test_correct_totp_code_issues_session(self, totp_login_client: TestClient) -> None:
|
||||
"""Correct TOTP code → 200 + cookie + csrf."""
|
||||
secret, _ = _enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={
|
||||
"username": "admin",
|
||||
"password": "test-password",
|
||||
"totp_code": pyotp.TOTP(secret).now(),
|
||||
},
|
||||
)
|
||||
assert resp.status_code == 200
|
||||
body = resp.json()
|
||||
assert "user" in body
|
||||
assert "csrf_token" in body
|
||||
assert "home_automation_session=" in resp.headers.get("set-cookie", "").lower()
|
||||
|
||||
def test_totp_required_detail_not_on_wrong_password(
|
||||
self, totp_login_client: TestClient
|
||||
) -> None:
|
||||
"""Wrong password must NOT carry totp_required (cannot reveal TOTP state)."""
|
||||
_enable_totp(totp_login_client)
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "wrong-password"},
|
||||
)
|
||||
assert resp.status_code == 401
|
||||
detail = resp.json()["detail"]
|
||||
assert isinstance(detail, str), "Wrong-password 401 must not expose totp_required"
|
||||
if isinstance(detail, dict):
|
||||
assert "totp_required" not in detail
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# M4-T06 — Recovery codes can be used for login (one-time)
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestRecoveryCodeLogin:
|
||||
"""Recovery codes work as second factor and are consumed after use."""
|
||||
|
||||
def test_recovery_code_login_succeeds(self, totp_login_client: TestClient) -> None:
|
||||
_, recovery_codes = _enable_totp(totp_login_client)
|
||||
code = recovery_codes[0]
|
||||
resp = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": code},
|
||||
)
|
||||
assert resp.status_code == 200, resp.text
|
||||
|
||||
def test_recovery_code_is_one_time_only(self, totp_login_client: TestClient) -> None:
|
||||
"""Using the same recovery code twice: second use must fail (401)."""
|
||||
_, recovery_codes = _enable_totp(totp_login_client)
|
||||
code = recovery_codes[0]
|
||||
|
||||
# First use: success
|
||||
resp1 = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": code},
|
||||
)
|
||||
assert resp1.status_code == 200, resp1.text
|
||||
|
||||
# Log out
|
||||
csrf = resp1.json()["csrf_token"]
|
||||
totp_login_client.post("/api/auth/logout", headers={"X-CSRF-Token": csrf})
|
||||
|
||||
# Second use: must fail
|
||||
resp2 = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": code},
|
||||
)
|
||||
assert resp2.status_code == 401, (
|
||||
"Recovery code must be rejected on second use"
|
||||
)
|
||||
|
||||
def test_recovery_code_used_at_set_in_db(self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||
"""After consuming a recovery code, its used_at is set in the DB."""
|
||||
from app.models.auth import RecoveryCode
|
||||
from sqlalchemy import select
|
||||
|
||||
db_path = tmp_path / "rc_used_test.db"
|
||||
db_url = f"sqlite:///{db_path}"
|
||||
|
||||
monkeypatch.setenv("APP_DATABASE_URL", db_url)
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_USERNAME", "admin")
|
||||
monkeypatch.setenv("AUTH_BOOTSTRAP_PASSWORD", "test-password")
|
||||
monkeypatch.setenv("AUTH_COOKIE_SECURE_OVERRIDE", "false")
|
||||
monkeypatch.setenv("AUTH_LOGIN_THROTTLE_ENABLED", "false")
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
command.upgrade(_make_app_alembic_config(db_url), "head")
|
||||
reset_db_caches()
|
||||
|
||||
engine = create_engine(db_url, connect_args={"check_same_thread": False})
|
||||
app = create_app()
|
||||
with TestClient(app) as tc:
|
||||
secret, recovery_codes = _enable_totp(tc)
|
||||
code = recovery_codes[0]
|
||||
|
||||
tc.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": code},
|
||||
)
|
||||
|
||||
with Session(engine) as db:
|
||||
used_codes = db.execute(
|
||||
select(RecoveryCode).where(RecoveryCode.used_at.isnot(None))
|
||||
).scalars().all()
|
||||
assert len(used_codes) >= 1, "At least one recovery code should have used_at set"
|
||||
|
||||
engine.dispose()
|
||||
get_settings.cache_clear()
|
||||
reset_db_caches()
|
||||
|
||||
def test_other_recovery_codes_still_work_after_one_consumed(
|
||||
self, totp_login_client: TestClient
|
||||
) -> None:
|
||||
"""Consuming one recovery code leaves the others intact."""
|
||||
_, recovery_codes = _enable_totp(totp_login_client)
|
||||
|
||||
# Use first code
|
||||
resp1 = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": recovery_codes[0]},
|
||||
)
|
||||
assert resp1.status_code == 200
|
||||
csrf = resp1.json()["csrf_token"]
|
||||
totp_login_client.post("/api/auth/logout", headers={"X-CSRF-Token": csrf})
|
||||
|
||||
# Second code must still work
|
||||
resp2 = totp_login_client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": recovery_codes[1]},
|
||||
)
|
||||
assert resp2.status_code == 200, (
|
||||
"Second recovery code should still be valid after first is consumed"
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# M4-T06 — Throttle interaction with TOTP second step
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
class TestThrottleWithTotpEnabled:
|
||||
"""Verify throttle semantics when TOTP is enabled:
|
||||
- Missing code (totp_required) does NOT count as a throttle failure.
|
||||
- Wrong TOTP/recovery code DOES count as a throttle failure.
|
||||
- Throttle check at step 1 still gates step 2.
|
||||
"""
|
||||
|
||||
def test_missing_code_does_not_register_throttle_failure(
|
||||
self, totp_login_throttle_client
|
||||
) -> None:
|
||||
"""Sending correct password without totp_code must not count as a failure.
|
||||
|
||||
If this test sends N_FREE+1 such requests without accumulating throttle
|
||||
failures, the next request will still get 401 (totp_required) not 429.
|
||||
"""
|
||||
client, engine = totp_login_throttle_client
|
||||
_enable_totp(client)
|
||||
|
||||
# Send N_FREE + 2 requests with correct password but no totp_code.
|
||||
for i in range(N_FREE + 2):
|
||||
resp = client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
# Must never become 429 — each is a legitimate first-step
|
||||
assert resp.status_code == 401, (
|
||||
f"Iteration {i}: expected 401 (totp_required), got {resp.status_code}"
|
||||
)
|
||||
body = resp.json()
|
||||
assert isinstance(body["detail"], dict)
|
||||
assert body["detail"].get("totp_required") is True
|
||||
|
||||
def test_wrong_totp_code_accumulates_throttle_failures(
|
||||
self, totp_login_throttle_client
|
||||
) -> None:
|
||||
"""Wrong TOTP codes should eventually trigger 429."""
|
||||
client, engine = totp_login_throttle_client
|
||||
_enable_totp(client)
|
||||
|
||||
# Send N_FREE + 1 wrong-code requests — each should register a failure
|
||||
for _ in range(N_FREE + 1):
|
||||
client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": "000000"},
|
||||
)
|
||||
|
||||
# Next attempt (even with correct password + no code) should hit 429
|
||||
resp = client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password"},
|
||||
)
|
||||
assert resp.status_code == 429, (
|
||||
"After N_FREE+1 wrong TOTP codes the throttle should kick in"
|
||||
)
|
||||
|
||||
def test_throttle_blocks_step_one_when_in_window(
|
||||
self, totp_login_throttle_client
|
||||
) -> None:
|
||||
"""Once throttled (by wrong codes), even step-1 attempt is rejected 429."""
|
||||
client, engine = totp_login_throttle_client
|
||||
_enable_totp(client)
|
||||
|
||||
# Accumulate failures via wrong TOTP codes
|
||||
for _ in range(N_FREE + 1):
|
||||
client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "test-password", "totp_code": "000000"},
|
||||
)
|
||||
|
||||
# Throttle check is before password — even wrong password should get 429
|
||||
resp = client.post(
|
||||
"/api/auth/login",
|
||||
json={"username": "admin", "password": "wrong"},
|
||||
)
|
||||
assert resp.status_code == 429
|
||||
|
||||
Reference in New Issue
Block a user