mirror of
https://github.com/taylanbakircioglu/haproxy-openmanager.git
synced 2026-09-24 03:16:24 +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.
153 lines
5.9 KiB
Python
153 lines
5.9 KiB
Python
"""
|
|
v1.5.0 Feature B — reject path safety (CRITICAL — M4/L11).
|
|
|
|
When a wizard-created config_version is rejected, ALL of the wizard's
|
|
entities (frontend + backend + servers + ssl_certificate +
|
|
letsencrypt_order) must be cleanly removed so the user can retry without
|
|
orphan rows.
|
|
|
|
These tests target three critical gates:
|
|
|
|
1. utils/entity_snapshot._rollback_create handles the new
|
|
`letsencrypt_order` entity type (drops the staged ACME order, cascading
|
|
acme_challenges).
|
|
|
|
2. routers/cluster.py treats `bulk-proxied-host-create-*` as a
|
|
`is_bulk_style_version` so the existing bulk-rejection cleanup applies
|
|
to wizard versions.
|
|
|
|
3. The same rejection path collects letsencrypt_order entity ids into the
|
|
bulk_import_entity_ids dict so the force-delete sweep removes them.
|
|
"""
|
|
from unittest.mock import AsyncMock
|
|
|
|
import pytest
|
|
|
|
from utils.entity_snapshot import _rollback_create
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# 1. _rollback_create handles letsencrypt_order
|
|
# ----------------------------------------------------------------------------
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_rollback_create_drops_letsencrypt_order():
|
|
conn = AsyncMock()
|
|
ok = await _rollback_create(conn, "letsencrypt_order", entity_id=42)
|
|
assert ok is True
|
|
sql, *args = conn.execute.call_args.args
|
|
assert "DELETE FROM letsencrypt_orders" in sql
|
|
assert args[0] == 42
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_rollback_create_letsencrypt_order_swallows_db_error():
|
|
"""If the DELETE fails, return False (not raise)."""
|
|
conn = AsyncMock()
|
|
conn.execute.side_effect = Exception("FK violation")
|
|
ok = await _rollback_create(conn, "letsencrypt_order", entity_id=1)
|
|
assert ok is False
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_rollback_create_unknown_entity_type_returns_false():
|
|
conn = AsyncMock()
|
|
ok = await _rollback_create(conn, "made_up_thing", entity_id=1)
|
|
assert ok is False
|
|
conn.execute.assert_not_awaited()
|
|
|
|
|
|
# ----------------------------------------------------------------------------
|
|
# 2. cluster.py is_bulk_style_version recognises wizard prefix
|
|
# ----------------------------------------------------------------------------
|
|
|
|
|
|
def _is_bulk_style_version(version_name: str) -> bool:
|
|
"""Mirror of the predicate inside routers/cluster.py:apply_pending_changes.
|
|
|
|
Pulled into a helper here so we can verify the recognised prefixes
|
|
without standing up the full FastAPI app.
|
|
"""
|
|
return (
|
|
version_name.startswith("bulk-import-")
|
|
or version_name.startswith("restore-")
|
|
or version_name.startswith("bulk-site-create-")
|
|
or version_name.startswith("bulk-proxied-host-create-")
|
|
)
|
|
|
|
|
|
def test_is_bulk_style_version_recognises_wizard_prefix():
|
|
assert _is_bulk_style_version("bulk-site-create-1715195200") is True
|
|
# Phase D backward-compat: the legacy `bulk-proxied-host-create-`
|
|
# prefix must keep matching so historical APPLIED versions still
|
|
# reject cleanly after the rename.
|
|
assert _is_bulk_style_version("bulk-proxied-host-create-1715195200") is True
|
|
|
|
|
|
def test_is_bulk_style_version_recognises_existing_prefixes():
|
|
assert _is_bulk_style_version("bulk-import-12345") is True
|
|
assert _is_bulk_style_version("restore-snapshot-99") is True
|
|
|
|
|
|
def test_is_bulk_style_version_rejects_arbitrary_names():
|
|
assert _is_bulk_style_version("manual-edit-1") is False
|
|
assert _is_bulk_style_version("ad-hoc-change") is False
|
|
assert _is_bulk_style_version("user-edit-12345") is False
|
|
|
|
|
|
def test_is_bulk_style_version_actual_predicate_in_cluster_router():
|
|
"""Sanity-check that the cluster.py source file truly contains the
|
|
wizard-version prefixes in BOTH locations:
|
|
- the snapshot collection branch
|
|
- the has_bulk_versions detection branch
|
|
Both the current `bulk-site-create-` prefix AND the legacy
|
|
`bulk-proxied-host-create-` prefix must be wired into both
|
|
branches so reject cleanup works for current AND historical
|
|
APPLIED versions.
|
|
"""
|
|
from pathlib import Path
|
|
src = Path(__file__).resolve().parent.parent / "routers" / "cluster.py"
|
|
text = src.read_text()
|
|
# Current naming.
|
|
site_occurrences = text.count("'bulk-site-create-'")
|
|
assert site_occurrences >= 2, (
|
|
f"Expected >= 2 'bulk-site-create-' occurrences in cluster.py, "
|
|
f"found {site_occurrences}. The reject path only works when BOTH "
|
|
f"branches recognise the wizard prefix (snapshot collect + "
|
|
f"has_bulk_versions)."
|
|
)
|
|
# Legacy naming (Phase D backward-compat).
|
|
legacy_occurrences = text.count("'bulk-proxied-host-create-'")
|
|
assert legacy_occurrences >= 2, (
|
|
f"Expected >= 2 'bulk-proxied-host-create-' (legacy) occurrences "
|
|
f"in cluster.py, found {legacy_occurrences}. After the Phase D "
|
|
f"rename the legacy prefix MUST still be wired into both "
|
|
f"branches so historical APPLIED versions can still be "
|
|
f"rejected/cleaned up."
|
|
)
|
|
|
|
|
|
def test_letsencrypt_order_force_delete_branch_exists_in_cluster_router():
|
|
"""Sanity-check that the force-delete cleanup explicitly handles
|
|
letsencrypt_orders (the wizard's staged ACME order).
|
|
"""
|
|
from pathlib import Path
|
|
src = Path(__file__).resolve().parent.parent / "routers" / "cluster.py"
|
|
text = src.read_text()
|
|
assert "letsencrypt_orders" in text
|
|
# The cluster router must include a DELETE for letsencrypt_orders in the
|
|
# bulk-rejection force-delete sweep — otherwise the wizard's staged
|
|
# ACME order would orphan when the bulk version is rejected.
|
|
assert "DELETE FROM letsencrypt_orders" in text
|
|
|
|
|
|
def test_entity_snapshot_branch_for_letsencrypt_order_exists():
|
|
"""Sanity check that entity_snapshot.py truly has the letsencrypt_order
|
|
branch (not just we hand-wrote the helper test above)."""
|
|
from pathlib import Path
|
|
src = (Path(__file__).resolve().parent.parent
|
|
/ "utils" / "entity_snapshot.py")
|
|
text = src.read_text()
|
|
assert 'entity_type == "letsencrypt_order"' in text
|