mirror of
https://github.com/taylanbakircioglu/haproxy-openmanager.git
synced 2026-09-22 18:43:26 +00:00
02b1cb2bca
Closes #13, Closes #14. This release squashes the v1.4.0 → v1.5.0 development line. v1.4.0 shipped the ACME stability & enterprise audit (Issues #10/#11/#12). v1.5.0 builds on that foundation with two co-equal headline features plus a 22-round audit campaign hardening the prior configuration surface. License remains MIT for v1.5.0 (relicense to AGPL-3.0 lands in v1.5.2). ------------------------------------------------------------------ HEADLINE FEATURE A — ACME Diagnostic Panel (Issue #13) ------------------------------------------------------------------ A live pre-flight + post-failure diagnostic surface for every ACME order, reachable from the ACME Automation page. The panel exists to make ACME failures legible to operators who do NOT have shell access to the API host. Endpoints (`backend/routers/acme_diagnostics.py`): POST /api/letsencrypt/orders/{order_id}/diagnostics Run the full 5-check suite (DNS / port-80 / routing / account / agents) and humanize the order's `error_detail` (>=11 RFC-8555 problem types, backwards compatible with legacy plain-string failures). POST /api/letsencrypt/orders/{order_id}/diagnostics/ {check_id}/rerun Re-run a single check in place — used by the "Re-run" button on every row of the modal's pre-flight table. GET /api/letsencrypt/orders/{order_id}/events Merged event timeline combining the typed `acme_order_events` rows with correlated `user_activity_logs` entries (resource_type = 'letsencrypt_order' AND resource_id = order_id). The diagnostic modal auto-tails this timeline every 5 seconds while open. Service-level checks (`backend/services/acme_diagnostics.py`): * DNS resolution via stdlib socket.gethostbyname_ex through run_in_executor (intentionally avoiding an aiodns runtime dep for v1.5.0). * Port-80 HEAD probe, target locked to the order's domains, success on HTTP 200 OR 404, warns on egress timeout (corp egress policies routinely blackhole outbound 80 — fail-hard would be too noisy). * SSRF guard: probe refuses non-public IPs and surfaces the skip in the diagnostic result; IPv4-mapped IPv6 normalisation closes the `::ffff:169.254.169.254` cloud-metadata vector. * HAProxy routing presence check: matches the order's cluster_ids to a port-80 HTTP frontend. * ACME account validity check against `letsencrypt_accounts`. * Agent presence check (>=1 active agent in target cluster). * Every sub-check wrapped in a wall-clock timeout to bound impact on the API event loop. RBAC: ssl.read for run, ssl.read for events. Per-user 5/min rate limit on both run and rerun, backed by the (user_id, action, created_at DESC) composite index. Frontend (`frontend/src/components/ACMEAutomation.js`): * "Diagnose" button on every order row + the existing "stuck order" warning row. * Modal with two tabs: - Pre-flight Checks (Antd Table with status pills + Re-run buttons + humanized error banner) - Event Log (Antd Timeline with auto-tail polling, scroll- to-bottom, pause-on-hover) * Correlation IDs surfaced in error banners and individual check fail details for backend-log lookup. ------------------------------------------------------------------ HEADLINE FEATURE B — Site Setup Wizard (Issue #14) ------------------------------------------------------------------ A single guided flow that creates a Backend + Servers + HTTP Frontend (and optional HTTPS Frontend) in one atomic transaction. Endpoints (`backend/routers/site_wizard.py`): POST /api/site-wizard/preview — diff-preview the changeset POST /api/site-wizard/create — atomic execute POST /api/site-wizard/reject — clean rollback (including any wizard_staged ACME orders) GET /api/site-wizard/drafts — draft persistence PUT /api/site-wizard/drafts/{id} — save/update DELETE /api/site-wizard/drafts/{id} Feature surface: * One screen captures both backend (mode + servers) AND frontend (http + optional https + SSL mode) inputs. * SSL modes: ACME (new order, HTTP-01 only for v1.5.0), Upload (existing PEM), Existing (link to a stored cert), or None. * ACME-staged path: wizard_staged_until watermark on the `letsencrypt_orders` row defers finalisation until agent confirmation; per-mode reject cleanly cancels and rolls back the staged order. * Live diff preview against the cluster's current generated config (renderer-evolution noise stripped — track-sc<N> dedup, per-server cookie strip, defaults-cookie inheritance, listen-block flattening). * Draft persistence with PEM stripped at save time (private keys never round-trip through the drafts table). * Per-cluster multi-tenancy: drafts and wizard_staged orders are isolated to the creating user's cluster scope. Frontend (`frontend/src/components/SiteWizard.js`): * 4-step Antd Steps flow: Backend → Frontend → SSL → Review. * Render the live diff preview inline before commit. * Antd Form-level validation mirrors backend Pydantic validators (numeric bounds, HAProxy reserved keywords, ALPN consistency, IPv6 scope-id, domain regex, server name dedup). ------------------------------------------------------------------ AUDIT CAMPAIGN — Rounds 1 → 22 (Bulgu #1 → #82) ------------------------------------------------------------------ v1.5.0 includes 22 adversarial review passes. Each round produced its own commit set in the corporate development line; this squash collapses those into the v1.5.0 release artefact. Highlights: Round 1-4 Site Wizard core: dry-run parity, single-line value injection guard, ACL -f pattern-file block, SSL parity, timeout regex, form-state pin. Round 5-7 defaults-cookie inheritance, server-named-cookie guard, fe/be mode mismatch, duplicate server names, health_check_uri + server_address validators. Round 8-10 cookie_name / cookie_options newline-injection guard, dry-run parity (round 9), TCP-mode HTTP-only feature blockers. Round 11 SSL name path traversal + health-check >= 1. Round 12-13 SSL & ACME deep dive (Bulgu #23-#32). Round 14 single-line value injection (Bulgu #33). Round 15-17 ACME multi-tenant UX, numeric bounds, HAProxy reserved keywords, ALPN/TLS consistency, all-backup, multi-domain & multi-user enterprise edges, drain/HSTS/post-completion (Bulgu #34-#53). Round 18-21 concurrency, agent state, TCP-mode HTTP-only, list size caps, IPv6 scope-id, preview account validation, TCP backend + balance uri reject (Bulgu #54-#61). Round 22 FE error visibility + 3x stale-data lockouts, referential integrity + cascade safety, authentication & authorization, multi-cluster isolation, apply_pending_changes concurrency, script injection + bulk import multi-tenancy, prefix-stripped signature comparison (Bulgu #62-#82). ------------------------------------------------------------------ NO CORPORATE-SPECIFIC ARTIFACTS ------------------------------------------------------------------ This squash deliberately sanitises corporate hostnames, container registry references, and TLS secret names into generic placeholders (`your-registry.example.com/your-org`, `haproxy-openmanager*.example.com`, `wildcard-tls`, `taylanbakircioglu/haproxy-openmanager-*`) so the public artefact contains no internal infrastructure detail. Pilot / development history that retained those values stays in the corporate fork and is NOT part of this commit.
155 lines
5.4 KiB
Python
155 lines
5.4 KiB
Python
"""
|
|
v1.5.0 service extraction parity — frontend_service.
|
|
|
|
Asserts:
|
|
- create_frontend_row writes BOTH ssl_certificate_id (INT col) AND
|
|
ssl_certificate_ids (JSONB col) consistently (M13).
|
|
- check_bind_port_collision honours exclude_frontend_id (M21/R35).
|
|
- mark_pending toggles the follow-up UPDATE.
|
|
"""
|
|
import json
|
|
from types import SimpleNamespace
|
|
from unittest.mock import AsyncMock
|
|
|
|
import pytest
|
|
|
|
from services.frontend_service import (
|
|
check_bind_port_collision,
|
|
create_frontend_row,
|
|
)
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# create_frontend_row
|
|
# ----------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_writes_both_ssl_columns_when_cert_present():
|
|
"""M13: ssl_certificate_id (INT) and ssl_certificate_ids (JSONB) both set."""
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 99
|
|
|
|
payload = SimpleNamespace(
|
|
name="fe_https",
|
|
bind_address="0.0.0.0",
|
|
bind_port=443,
|
|
default_backend="be",
|
|
mode="http",
|
|
ssl_enabled=True,
|
|
)
|
|
new_id = await create_frontend_row(
|
|
conn, payload, cluster_id=1,
|
|
ssl_certificate_id=42, ssl_enabled=True,
|
|
)
|
|
assert new_id == 99
|
|
|
|
sql, *args = conn.fetchval.call_args.args
|
|
assert "INSERT INTO frontends" in sql
|
|
# ssl_certificate_id position $7 → index 6
|
|
assert args[6] == 42
|
|
# ssl_certificate_ids position $8 → index 7 (JSONB-encoded)
|
|
assert json.loads(args[7]) == [42]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_emits_empty_ssl_cert_ids_when_no_cert():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(name="fe", bind_address="*", bind_port=80, mode="http")
|
|
await create_frontend_row(conn, payload, cluster_id=1)
|
|
sql, *args = conn.fetchval.call_args.args
|
|
assert args[6] is None # ssl_certificate_id NULL
|
|
assert json.loads(args[7]) == [] # ssl_certificate_ids JSONB empty list
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_uses_name_override():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(name="fe_http", bind_address="*", bind_port=80, mode="http")
|
|
await create_frontend_row(conn, payload, cluster_id=1, name_override="fe_http-https")
|
|
sql, *args = conn.fetchval.call_args.args
|
|
assert args[0] == "fe_http-https"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_uses_bind_port_override():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(name="fe", bind_address="*", bind_port=80, mode="http")
|
|
await create_frontend_row(conn, payload, cluster_id=1, bind_port_override=443)
|
|
sql, *args = conn.fetchval.call_args.args
|
|
assert args[2] == 443 # bind_port position $3
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_jsonb_rules_serialized():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(
|
|
name="fe", bind_address="*", bind_port=80, mode="http",
|
|
acl_rules=[{"name": "a"}],
|
|
redirect_rules=[{"type": "redirect"}],
|
|
use_backend_rules=[{"backend": "be"}],
|
|
)
|
|
await create_frontend_row(conn, payload, cluster_id=1)
|
|
sql, *args = conn.fetchval.call_args.args
|
|
# acl_rules ($20 idx 19), redirect_rules ($21 idx 20), use_backend_rules ($22 idx 21)
|
|
assert json.loads(args[19]) == [{"name": "a"}]
|
|
assert json.loads(args[20]) == [{"type": "redirect"}]
|
|
assert json.loads(args[21]) == [{"backend": "be"}]
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_mark_pending_default_true():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(name="fe", bind_address="*", bind_port=80, mode="http")
|
|
await create_frontend_row(conn, payload, cluster_id=1)
|
|
update_calls = [c for c in conn.execute.call_args_list
|
|
if c.args and "UPDATE frontends" in c.args[0]]
|
|
assert len(update_calls) == 1
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_create_frontend_row_mark_pending_false_skips_update():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 1
|
|
payload = SimpleNamespace(name="fe", bind_address="*", bind_port=80, mode="http")
|
|
await create_frontend_row(conn, payload, cluster_id=1, mark_pending=False)
|
|
update_calls = [c for c in conn.execute.call_args_list
|
|
if c.args and "UPDATE frontends" in c.args[0]]
|
|
assert update_calls == []
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# check_bind_port_collision
|
|
# ----------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_check_bind_port_collision_returns_id_when_conflict():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = 17
|
|
out = await check_bind_port_collision(conn, 1, "0.0.0.0", 80)
|
|
assert out == 17
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_check_bind_port_collision_no_conflict_returns_none():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = None
|
|
out = await check_bind_port_collision(conn, 1, "0.0.0.0", 80)
|
|
assert out is None
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_check_bind_port_collision_excludes_frontend_id():
|
|
conn = AsyncMock()
|
|
conn.fetchval.return_value = None
|
|
await check_bind_port_collision(conn, 1, "0.0.0.0", 443, exclude_frontend_id=99)
|
|
sql, *args = conn.fetchval.call_args.args
|
|
assert "id <> $4" in sql
|
|
assert args[3] == 99
|