Compare commits
28
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b2f835a88c | ||
|
|
711c670319 | ||
|
|
67837f59cb | ||
|
|
e7d08c3b30 | ||
|
|
465253c640 | ||
|
|
b931baa9a7 | ||
|
|
2148d72334 | ||
|
|
17ca731ed3 | ||
|
|
bcd56b8352 | ||
|
|
e545f3b6e0 | ||
|
|
8a8d9c5fe3 | ||
|
|
18750861b4 | ||
|
|
6b0b5893b6 | ||
|
|
704be38882 | ||
|
|
2171bedb20 | ||
|
|
992bf49138 | ||
|
|
491f54928a | ||
|
|
ecc1184533 | ||
|
|
53422c35e8 | ||
|
|
f21ade06d9 | ||
|
|
871181c345 | ||
|
|
fda73c62de | ||
|
|
79a1b84ca2 | ||
|
|
af9fb1d2f0 | ||
|
|
77b8cb029b | ||
|
|
4f0949d534 | ||
|
|
22dab685d0 | ||
|
|
233044fb1d |
+57
-2
@@ -23,7 +23,23 @@ LABEL org.opencontainers.image.title="haproxy-manager-base" \
|
|||||||
org.opencontainers.image.version="${VERSION}" \
|
org.opencontainers.image.version="${VERSION}" \
|
||||||
org.opencontainers.image.licenses="MIT"
|
org.opencontainers.image.licenses="MIT"
|
||||||
|
|
||||||
RUN apt update -y && apt dist-upgrade -y && apt install socat haproxy cron certbot curl jq net-tools -y && apt clean && rm -rf /var/lib/apt/lists/*
|
# haproxy is PINNED. It was previously unpinned, so the binary could move under
|
||||||
|
# us at Debian's timing — an upstream release that rejected our config would have
|
||||||
|
# broken an unrelated commit's build, or worse, shipped an edge that refuses to
|
||||||
|
# start (see the `haproxy -c` gate below for why that matters: a config HAProxy
|
||||||
|
# rejects leaves the container Up with 80/443 unbound and /health still 200).
|
||||||
|
#
|
||||||
|
# Pinning does NOT make the gate redundant, and the gate does NOT make pinning
|
||||||
|
# unnecessary — they compose. Pinned means the version moves deliberately; the
|
||||||
|
# gate then answers immediately whether the new binary still accepts fleet config.
|
||||||
|
# It also makes the image reproducible, which it previously was not.
|
||||||
|
#
|
||||||
|
# To move it: bump the version here, rebuild, and let the gate verify. If Debian
|
||||||
|
# security-updates the package (e.g. -1+deb13u4) the build FAILS until this pin is
|
||||||
|
# updated — that failure is the point, not a bug. Check availability with:
|
||||||
|
# apt-cache policy haproxy
|
||||||
|
ARG HAPROXY_VERSION=3.0.11-1+deb13u3
|
||||||
|
RUN apt update -y && apt dist-upgrade -y && apt install socat "haproxy=${HAPROXY_VERSION}" cron certbot curl jq net-tools -y && apt-mark hold haproxy && apt clean && rm -rf /var/lib/apt/lists/*
|
||||||
WORKDIR /haproxy
|
WORKDIR /haproxy
|
||||||
COPY ./templates /haproxy/templates
|
COPY ./templates /haproxy/templates
|
||||||
COPY requirements.txt /haproxy/
|
COPY requirements.txt /haproxy/
|
||||||
@@ -32,12 +48,51 @@ COPY scripts /haproxy/scripts
|
|||||||
COPY trusted_ips.list /etc/haproxy/trusted_ips.list
|
COPY trusted_ips.list /etc/haproxy/trusted_ips.list
|
||||||
COPY trusted_ips.map /etc/haproxy/trusted_ips.map
|
COPY trusted_ips.map /etc/haproxy/trusted_ips.map
|
||||||
# /etc/haproxy is a named volume in deployed containers, so baked-in files
|
# /etc/haproxy is a named volume in deployed containers, so baked-in files
|
||||||
# under that path get shadowed by the volume on existing deployments.
|
# under that path get shadowed by the volume on existing deployments. The
|
||||||
|
# trusted_ips.* pair above predates that discovery and is handled by the
|
||||||
|
# older start-up.sh guard (out of scope here). cloudflare_ips.list and
|
||||||
|
# trusted_proxies.list are staged under /haproxy/defaults instead, so
|
||||||
|
# start-up.sh can always read the image's baked copy regardless of what the
|
||||||
|
# volume shadows /etc/haproxy with.
|
||||||
|
COPY cloudflare_ips.list /haproxy/defaults/cloudflare_ips.list
|
||||||
|
COPY trusted_proxies.list /haproxy/defaults/trusted_proxies.list
|
||||||
|
COPY wpadmin_gate_exempt.list /haproxy/defaults/wpadmin_gate_exempt.list
|
||||||
# Place errorfiles outside the volumed path; the HAProxy config references
|
# Place errorfiles outside the volumed path; the HAProxy config references
|
||||||
# them by absolute path.
|
# them by absolute path.
|
||||||
COPY errors /haproxy/errors
|
COPY errors /haproxy/errors
|
||||||
RUN chmod +x /haproxy/scripts/*
|
RUN chmod +x /haproxy/scripts/*
|
||||||
RUN pip install -r requirements.txt
|
RUN pip install -r requirements.txt
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Build gate: no image ships unless the real haproxy binary accepts the config
|
||||||
|
# this image's templates actually produce.
|
||||||
|
#
|
||||||
|
# On 2026-08-14 a template change rendered fine, passed all 13 unit tests, and
|
||||||
|
# was rejected by HAProxy ("invalid arg 2 in converter 'regsub'"). It was only
|
||||||
|
# caught because someone built an image by hand and ran `haproxy -c`. Nothing
|
||||||
|
# in the build or in CI would have stopped it: .gitea/workflows/build-push.yaml
|
||||||
|
# is checkout -> build -> push, and test-config-rollback.py's "haproxy" is a
|
||||||
|
# shell stub that only rejects a sentinel token. In production an invalid
|
||||||
|
# haproxy.cfg means init.py refuses to start HAProxy while the container stays
|
||||||
|
# Up - ports 80/443 unbound, every site on the host down, /health still 200.
|
||||||
|
#
|
||||||
|
# This lives in the Dockerfile rather than in the workflow deliberately:
|
||||||
|
# * it cannot be skipped, and it protects local `docker build` too;
|
||||||
|
# * no workflow restructuring (build-push-action builds and pushes in one
|
||||||
|
# step, so gating in CI would mean splitting build from push);
|
||||||
|
# * it validates against the EXACT haproxy binary in this image. Line 26
|
||||||
|
# installs haproxy unpinned, so that binary moves between builds - this
|
||||||
|
# turns "the new haproxy rejects our config" from a silent production
|
||||||
|
# risk into a build failure.
|
||||||
|
#
|
||||||
|
# The unit suites run here too. They had never run anywhere automated either,
|
||||||
|
# and they cost a few seconds.
|
||||||
|
RUN python3 /haproxy/scripts/test-wpadmin-gate.py \
|
||||||
|
&& python3 /haproxy/scripts/test-trusted-proxy-gate.py \
|
||||||
|
&& python3 /haproxy/scripts/test-xmlrpc-rate-limit.py \
|
||||||
|
&& python3 /haproxy/scripts/test-config-rollback.py \
|
||||||
|
&& python3 /haproxy/scripts/test-cert-write-safety.py \
|
||||||
|
&& python3 /haproxy/scripts/test-cert-scripts.py \
|
||||||
|
&& python3 /haproxy/scripts/validate-rendered-config.py
|
||||||
# Create log directories
|
# Create log directories
|
||||||
RUN mkdir -p /var/log && touch /var/log/haproxy-manager.log /var/log/haproxy-manager-errors.log
|
RUN mkdir -p /var/log && touch /var/log/haproxy-manager.log /var/log/haproxy-manager-errors.log
|
||||||
RUN chmod 755 /var/log/haproxy-manager.log /var/log/haproxy-manager-errors.log
|
RUN chmod 755 /var/log/haproxy-manager.log /var/log/haproxy-manager-errors.log
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# Cloudflare edge ranges — peers allowed to set CF-Connecting-IP / X-Real-IP /
|
||||||
|
# X-Forwarded-For. Referenced by templates/hap_listener.tpl:
|
||||||
|
# acl from_trusted_proxy src -f /etc/haproxy/cloudflare_ips.list -f /etc/haproxy/trusted_proxies.list
|
||||||
|
#
|
||||||
|
# PUBLIC DATA — safe to commit. Source: https://www.cloudflare.com/ips-v4
|
||||||
|
# and https://www.cloudflare.com/ips-v6. Keep in sync with the IPv4 snapshot in
|
||||||
|
# WHP's ssl_renewal_orchestrator.php::isCloudflareIP() (that one is IPv4-only).
|
||||||
|
# Refresh at release time; Cloudflare has not added a range since 2021.
|
||||||
|
#
|
||||||
|
# IPv4
|
||||||
|
173.245.48.0/20
|
||||||
|
103.21.244.0/22
|
||||||
|
103.22.200.0/22
|
||||||
|
103.31.4.0/22
|
||||||
|
141.101.64.0/18
|
||||||
|
108.162.192.0/18
|
||||||
|
190.93.240.0/20
|
||||||
|
188.114.96.0/20
|
||||||
|
197.234.240.0/22
|
||||||
|
198.41.128.0/17
|
||||||
|
162.158.0.0/15
|
||||||
|
104.16.0.0/13
|
||||||
|
104.24.0.0/14
|
||||||
|
172.64.0.0/13
|
||||||
|
131.0.72.0/22
|
||||||
|
#
|
||||||
|
# IPv6
|
||||||
|
2400:cb00::/32
|
||||||
|
2606:4700::/32
|
||||||
|
2803:f800::/32
|
||||||
|
2405:b500::/32
|
||||||
|
2405:8100::/32
|
||||||
|
2a06:98c0::/29
|
||||||
|
2c0f:f248::/32
|
||||||
+692
-52
@@ -113,6 +113,12 @@ BLOCKED_IPS_MAP_BACKUP_PATH = '/etc/haproxy/blocked_ips.map.backup'
|
|||||||
CORAZA_SPOE_CONFIG_PATH = '/etc/haproxy/coraza-spoe.cfg'
|
CORAZA_SPOE_CONFIG_PATH = '/etc/haproxy/coraza-spoe.cfg'
|
||||||
CORAZA_SPOE_BACKUP_PATH = '/etc/haproxy/coraza-spoe.cfg.backup'
|
CORAZA_SPOE_BACKUP_PATH = '/etc/haproxy/coraza-spoe.cfg.backup'
|
||||||
HAPROXY_SOCKET_PATH = '/var/run/haproxy.sock'
|
HAPROXY_SOCKET_PATH = '/var/run/haproxy.sock'
|
||||||
|
# HAProxy loads this path as a DIRECTORY (`bind ... ssl crt /etc/haproxy/certs`),
|
||||||
|
# which means it tries to load EVERY file it finds in here. Nothing but final,
|
||||||
|
# validated `<name>.pem` bundles may ever exist in this directory - no temp
|
||||||
|
# files, no `.backup` copies. Staging and backups live in the sibling
|
||||||
|
# directories below, on the same filesystem so os.replace() stays atomic.
|
||||||
|
# See publish_pem_bundle().
|
||||||
SSL_CERTS_DIR = '/etc/haproxy/certs'
|
SSL_CERTS_DIR = '/etc/haproxy/certs'
|
||||||
# Stable per-host secret for QUIC Retry/address-validation tokens. Lives in the
|
# Stable per-host secret for QUIC Retry/address-validation tokens. Lives in the
|
||||||
# /etc/haproxy named volume so it survives container recreates; self-healed on
|
# /etc/haproxy named volume so it survives container recreates; self-healed on
|
||||||
@@ -309,6 +315,340 @@ def find_certbot_live_dir(base_domain):
|
|||||||
candidates.sort(key=lambda x: x[1], reverse=True)
|
candidates.sort(key=lambda x: x[1], reverse=True)
|
||||||
return candidates[0][0]
|
return candidates[0][0]
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Certificate publishing
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Until 2026-08 every code path that refreshed a combined PEM did this:
|
||||||
|
#
|
||||||
|
# with open(combined_path, 'w') as combined: # TRUNCATES the file
|
||||||
|
# subprocess.run(['cat', cert, key], stdout=combined) # rc ignored
|
||||||
|
#
|
||||||
|
# `combined_path` is the live bundle HAProxy is serving. open(...,'w') empties
|
||||||
|
# it BEFORE a single byte of source material has been read, and the `cat` exit
|
||||||
|
# status was never checked. Any failure in between - source unreadable, disk
|
||||||
|
# full, container killed, certbot lineage half-written - left a truncated or
|
||||||
|
# key-less PEM in place. HAProxy loads /etc/haproxy/certs as a directory, so one
|
||||||
|
# unusable file there fails the whole `bind ... ssl crt` and takes down HTTPS
|
||||||
|
# for every site on the host. Unlike a bad haproxy.cfg this is NOT recoverable
|
||||||
|
# by config rollback, and re-issuing hits Let's Encrypt rate limits.
|
||||||
|
#
|
||||||
|
# Everything below exists to make publishing a bundle all-or-nothing:
|
||||||
|
# assemble in a staging dir -> validate -> back up the old one -> os.replace()
|
||||||
|
# The live file is only ever swapped for a complete, validated replacement.
|
||||||
|
|
||||||
|
|
||||||
|
class CertificatePublishError(Exception):
|
||||||
|
"""A certificate bundle could not be published. The live PEM is untouched."""
|
||||||
|
|
||||||
|
|
||||||
|
def _cert_sibling_dir(name):
|
||||||
|
"""A directory next to SSL_CERTS_DIR (NOT inside it).
|
||||||
|
|
||||||
|
HAProxy loads SSL_CERTS_DIR as a crt directory and tries to load every file
|
||||||
|
in it, so staging and backup copies must live outside. Siblings share the
|
||||||
|
/etc/haproxy filesystem, which is what keeps os.replace() atomic.
|
||||||
|
|
||||||
|
Derived at call time so tests that repoint SSL_CERTS_DIR get matching
|
||||||
|
staging/backup dirs, the same pattern as _config_backup_pairs().
|
||||||
|
"""
|
||||||
|
parent = os.path.dirname(SSL_CERTS_DIR.rstrip('/')) or '/'
|
||||||
|
return os.path.join(parent, name)
|
||||||
|
|
||||||
|
|
||||||
|
def cert_staging_dir():
|
||||||
|
"""Directory where bundles are assembled and validated before publishing."""
|
||||||
|
return _cert_sibling_dir('cert-staging')
|
||||||
|
|
||||||
|
|
||||||
|
def cert_backup_dir():
|
||||||
|
"""Directory holding the previous copy of each published bundle.
|
||||||
|
|
||||||
|
Mirrors the config backup on the parent branch (one `.backup` alongside
|
||||||
|
haproxy.cfg): one copy per cert, overwritten on each successful publish, so
|
||||||
|
an operator always has a manual path back to the bundle that was being
|
||||||
|
served before the last change.
|
||||||
|
"""
|
||||||
|
return _cert_sibling_dir('cert-backups')
|
||||||
|
|
||||||
|
|
||||||
|
# ENCRYPTED PRIVATE KEY is deliberately absent: HAProxy cannot use a
|
||||||
|
# passphrase-protected key from a crt file, so a bundle containing one is not
|
||||||
|
# publishable, and the structural layer is the only layer that names the
|
||||||
|
# problem ("no complete private key block") rather than reporting it as an
|
||||||
|
# unreadable key.
|
||||||
|
_PEM_KEY_LABELS = ('PRIVATE KEY', 'RSA PRIVATE KEY', 'EC PRIVATE KEY')
|
||||||
|
|
||||||
|
|
||||||
|
def _pem_labels(text):
|
||||||
|
"""Labels of well-formed PEM blocks in text, in order.
|
||||||
|
|
||||||
|
A block counts only if its BEGIN line is followed by the matching END line,
|
||||||
|
so a bundle truncated in the middle of a block yields no label for it -
|
||||||
|
which is exactly the corruption we are guarding against.
|
||||||
|
"""
|
||||||
|
labels = []
|
||||||
|
open_label = None
|
||||||
|
for line in text.splitlines():
|
||||||
|
line = line.strip()
|
||||||
|
if line.startswith('-----BEGIN ') and line.endswith('-----'):
|
||||||
|
open_label = line[len('-----BEGIN '):-len('-----')].strip()
|
||||||
|
elif line.startswith('-----END ') and line.endswith('-----'):
|
||||||
|
end_label = line[len('-----END '):-len('-----')].strip()
|
||||||
|
if open_label is not None and end_label == open_label:
|
||||||
|
labels.append(end_label)
|
||||||
|
open_label = None
|
||||||
|
return labels
|
||||||
|
|
||||||
|
|
||||||
|
def validate_pem_structure(text):
|
||||||
|
"""Structural check on an assembled bundle. Returns (ok, message).
|
||||||
|
|
||||||
|
Pure Python and therefore ALWAYS available - it can never be skipped for
|
||||||
|
lack of a tool. It catches every failure mode the truncation bug produced:
|
||||||
|
empty file, certificate without a key, key without a certificate, and a
|
||||||
|
block cut off mid-write.
|
||||||
|
|
||||||
|
It is NOT sufficient on its own, which is why _openssl_pairing_status() is
|
||||||
|
mandatory rather than best-effort: a bundle of EMPTY pem blocks (a BEGIN
|
||||||
|
line immediately followed by its END line, no base64 between them) passes
|
||||||
|
every check here and is rejected only by openssl.
|
||||||
|
"""
|
||||||
|
if not text.strip():
|
||||||
|
return False, 'bundle is empty'
|
||||||
|
labels = _pem_labels(text)
|
||||||
|
if not labels:
|
||||||
|
return False, 'bundle contains no complete PEM block (truncated?)'
|
||||||
|
if 'CERTIFICATE' not in labels:
|
||||||
|
return False, 'bundle contains no complete CERTIFICATE block'
|
||||||
|
if not any(label in _PEM_KEY_LABELS for label in labels):
|
||||||
|
return False, 'bundle contains no complete private key block'
|
||||||
|
return True, None
|
||||||
|
|
||||||
|
|
||||||
|
def _openssl_pairing_status(path):
|
||||||
|
"""Does the private key in `path` match the leaf certificate in `path`?
|
||||||
|
|
||||||
|
Returns (status, message) with status 'valid' | 'invalid' | 'unavailable'.
|
||||||
|
|
||||||
|
`openssl x509` reads the FIRST certificate in the file (our bundles are
|
||||||
|
fullchain-then-key, so that is the leaf) and `openssl pkey` scans past the
|
||||||
|
certificate blocks to the first private key, so both run against the
|
||||||
|
assembled bundle directly. Comparing the two public keys proves the pair.
|
||||||
|
|
||||||
|
'unavailable' means the openssl BINARY is absent - a verdict about our
|
||||||
|
tooling, not about the bundle. validate_pem_bundle() treats it as a HARD
|
||||||
|
FAILURE.
|
||||||
|
|
||||||
|
That is a deliberate reversal. This docstring used to say "the Dockerfile
|
||||||
|
installs haproxy, certbot, socat and curl but not the openssl CLI, so this
|
||||||
|
is a real possibility", and callers accepted the bundle on the structural
|
||||||
|
checks alone. The premise is false: openssl 3.x IS in the image, as a
|
||||||
|
dependency of ca-certificates (which certbot requires), and
|
||||||
|
generate_self_signed_cert() below already runs `openssl req` with
|
||||||
|
check=True during first-run setup - so no container has ever reached a
|
||||||
|
publish without it. The 'unavailable' branch never fired, which means the
|
||||||
|
pairing check has in fact always run, and THAT is what made the fail-open
|
||||||
|
harmless - not the stated reasoning. Structural validation on its own is
|
||||||
|
weak: a bundle of empty pem blocks passes validate_pem_structure() and is
|
||||||
|
caught only here.
|
||||||
|
|
||||||
|
So an absent openssl now means the image is broken, and we say so and stop
|
||||||
|
instead of quietly downgrading to the weaker check. The cost is that a
|
||||||
|
hypothetical openssl-less image stops publishing renewals - but it does so
|
||||||
|
immediately and loudly, in the monitored error log, at the first renewal,
|
||||||
|
rather than 90 days later; and publishing an unverified bundle can take the
|
||||||
|
whole :443 bind, i.e. every site on the host, down at the next reload.
|
||||||
|
|
||||||
|
There is no python `cryptography` fallback on purpose: this process runs on
|
||||||
|
/usr/local/bin/python3 (the base image's 3.12), where cryptography is not
|
||||||
|
importable. It is installed for Debian's /usr/bin/python3 as a certbot
|
||||||
|
dependency, and reaching for that interpreter would be a second unverified
|
||||||
|
premise of exactly the kind this comment is correcting.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
cert_pub = subprocess.run(
|
||||||
|
['openssl', 'x509', '-in', path, '-noout', '-pubkey'],
|
||||||
|
capture_output=True, text=True, stdin=subprocess.DEVNULL)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return 'unavailable', 'openssl binary not found'
|
||||||
|
except Exception as e:
|
||||||
|
return 'unavailable', f'could not run openssl: {e}'
|
||||||
|
if cert_pub.returncode != 0:
|
||||||
|
return 'invalid', ('leaf certificate is unreadable: '
|
||||||
|
f'{(cert_pub.stderr or "").strip()[:200]}')
|
||||||
|
try:
|
||||||
|
# -passin pass: plus a closed stdin so an (unexpected) encrypted key
|
||||||
|
# fails fast instead of blocking on a passphrase prompt.
|
||||||
|
key_pub = subprocess.run(
|
||||||
|
['openssl', 'pkey', '-in', path, '-pubout', '-passin', 'pass:'],
|
||||||
|
capture_output=True, text=True, stdin=subprocess.DEVNULL)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return 'unavailable', 'openssl binary not found'
|
||||||
|
except Exception as e:
|
||||||
|
return 'unavailable', f'could not run openssl: {e}'
|
||||||
|
if key_pub.returncode != 0:
|
||||||
|
return 'invalid', ('private key is unreadable: '
|
||||||
|
f'{(key_pub.stderr or "").strip()[:200]}')
|
||||||
|
if cert_pub.stdout.strip() != key_pub.stdout.strip():
|
||||||
|
return 'invalid', 'private key does not match the leaf certificate'
|
||||||
|
return 'valid', None
|
||||||
|
|
||||||
|
|
||||||
|
def validate_pem_bundle(path):
|
||||||
|
"""Validate a bundle file on disk. Returns (ok, message).
|
||||||
|
|
||||||
|
Structural validation AND the cryptographic pairing check, both mandatory -
|
||||||
|
see _openssl_pairing_status() for why a missing openssl is a failure rather
|
||||||
|
than a downgrade to structure-only.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with open(path, 'r') as fh:
|
||||||
|
text = fh.read()
|
||||||
|
except (OSError, UnicodeDecodeError) as e:
|
||||||
|
# UnicodeDecodeError, not just OSError: a bundle corrupted into binary
|
||||||
|
# is unreadable as text but reads perfectly well as bytes, so `except
|
||||||
|
# OSError` let the decode error escape as an unhandled traceback.
|
||||||
|
return False, f'cannot read assembled bundle: {e}'
|
||||||
|
|
||||||
|
ok, msg = validate_pem_structure(text)
|
||||||
|
if not ok:
|
||||||
|
return False, msg
|
||||||
|
|
||||||
|
status, pair_msg = _openssl_pairing_status(path)
|
||||||
|
if status == 'invalid':
|
||||||
|
return False, pair_msg
|
||||||
|
if status == 'unavailable':
|
||||||
|
logger.error(
|
||||||
|
"Certificate key/leaf pairing check could not run for %s (%s) - "
|
||||||
|
"REFUSING to publish. openssl is required; structural validation "
|
||||||
|
"alone cannot tell a real bundle from empty pem blocks.",
|
||||||
|
path, pair_msg)
|
||||||
|
return False, (f'cert/key pairing check unavailable ({pair_msg}); '
|
||||||
|
'refusing to publish on structural checks alone')
|
||||||
|
return True, None
|
||||||
|
|
||||||
|
|
||||||
|
def backup_existing_pem(dest_path):
|
||||||
|
"""Copy the currently published bundle aside before it is replaced.
|
||||||
|
|
||||||
|
Only a bundle that still validates is promoted to backup: overwriting a
|
||||||
|
good backup with an already-corrupt live file would turn "restore the
|
||||||
|
backup" into "restore different garbage". Same require_valid reasoning as
|
||||||
|
create_backup() for haproxy.cfg.
|
||||||
|
|
||||||
|
Never fatal - failing to take a backup must not stop us replacing a cert
|
||||||
|
with a validated one - but always logged.
|
||||||
|
"""
|
||||||
|
if not os.path.exists(dest_path):
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
with open(dest_path, 'r') as fh:
|
||||||
|
ok, msg = validate_pem_structure(fh.read())
|
||||||
|
except (OSError, UnicodeDecodeError) as e:
|
||||||
|
# UnicodeDecodeError, not just OSError. A live pem corrupted into
|
||||||
|
# BINARY (the exact state a republish is meant to heal) raises
|
||||||
|
# UnicodeDecodeError here, and with only OSError caught it escaped all
|
||||||
|
# the way out of publish_pem_bundle() - so the one operation that would
|
||||||
|
# have put a working certificate back blew up on the way to taking a
|
||||||
|
# backup of the broken one. The shell half recovers from this fine;
|
||||||
|
# this is the only reason the Python half did not.
|
||||||
|
ok, msg = False, str(e)
|
||||||
|
backup_path = os.path.join(cert_backup_dir(), os.path.basename(dest_path))
|
||||||
|
if not ok:
|
||||||
|
logger.warning(
|
||||||
|
"Not backing up %s before replacing it: the file on disk is not a "
|
||||||
|
"valid bundle (%s). Keeping any previous backup at %s.",
|
||||||
|
dest_path, msg, backup_path)
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
os.makedirs(cert_backup_dir(), exist_ok=True)
|
||||||
|
shutil.copy2(dest_path, backup_path)
|
||||||
|
return backup_path
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to back up %s to %s: %s",
|
||||||
|
dest_path, backup_path, e)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def publish_pem_bundle(dest_path, source_paths):
|
||||||
|
"""Publish cert+key as a combined PEM at dest_path, atomically.
|
||||||
|
|
||||||
|
source_paths are concatenated in order (fullchain first, then privkey) into
|
||||||
|
a staging file OUTSIDE the crt directory, validated there, and only then
|
||||||
|
moved into place with os.replace(). If anything fails, the exception is
|
||||||
|
raised and dest_path still holds the previous, working bundle - the live
|
||||||
|
PEM is never opened for writing at any point.
|
||||||
|
|
||||||
|
Returns the path of the backup taken (or None). Raises
|
||||||
|
CertificatePublishError on any failure.
|
||||||
|
"""
|
||||||
|
for src in source_paths:
|
||||||
|
if not os.path.exists(src):
|
||||||
|
raise CertificatePublishError(
|
||||||
|
f'source certificate material missing: {src}')
|
||||||
|
|
||||||
|
parts = []
|
||||||
|
for src in source_paths:
|
||||||
|
try:
|
||||||
|
with open(src, 'r') as fh:
|
||||||
|
data = fh.read()
|
||||||
|
except (OSError, UnicodeDecodeError) as e:
|
||||||
|
# Binary-corrupt source material must be a clean, reported refusal,
|
||||||
|
# not an unhandled UnicodeDecodeError out of the request handler.
|
||||||
|
raise CertificatePublishError(f'cannot read {src}: {e}')
|
||||||
|
if not data.strip():
|
||||||
|
raise CertificatePublishError(f'source file is empty: {src}')
|
||||||
|
if not data.endswith('\n'):
|
||||||
|
# Guard against a cert whose last line runs into the key's BEGIN
|
||||||
|
# line; certbot always ends with a newline, but a hand-placed file
|
||||||
|
# might not.
|
||||||
|
data += '\n'
|
||||||
|
parts.append(data)
|
||||||
|
content = ''.join(parts)
|
||||||
|
|
||||||
|
ok, msg = validate_pem_structure(content)
|
||||||
|
if not ok:
|
||||||
|
raise CertificatePublishError(
|
||||||
|
f'assembled bundle for {dest_path} is not usable: {msg}')
|
||||||
|
|
||||||
|
dest_dir = os.path.dirname(dest_path) or '.'
|
||||||
|
try:
|
||||||
|
os.makedirs(dest_dir, exist_ok=True)
|
||||||
|
os.makedirs(cert_staging_dir(), exist_ok=True)
|
||||||
|
except OSError as e:
|
||||||
|
raise CertificatePublishError(f'cannot prepare directories: {e}')
|
||||||
|
|
||||||
|
# os.replace() is only atomic within one filesystem. Checking up front
|
||||||
|
# turns an EXDEV rename failure into an operator-readable message; the
|
||||||
|
# outcome is the same either way (nothing published, live PEM untouched)
|
||||||
|
# because staging inside the crt directory is not an acceptable fallback.
|
||||||
|
try:
|
||||||
|
if os.stat(cert_staging_dir()).st_dev != os.stat(dest_dir).st_dev:
|
||||||
|
raise CertificatePublishError(
|
||||||
|
f'{cert_staging_dir()} and {dest_dir} are on different '
|
||||||
|
'filesystems, so a certificate cannot be swapped in atomically')
|
||||||
|
except OSError as e:
|
||||||
|
raise CertificatePublishError(f'cannot stat certificate dirs: {e}')
|
||||||
|
|
||||||
|
backup_path = backup_existing_pem(dest_path)
|
||||||
|
|
||||||
|
def _validate_staged(staged_path):
|
||||||
|
return validate_pem_bundle(staged_path)
|
||||||
|
|
||||||
|
try:
|
||||||
|
write_config_atomically(dest_path, content,
|
||||||
|
staging_dir=cert_staging_dir(),
|
||||||
|
validate=_validate_staged)
|
||||||
|
except Exception as e:
|
||||||
|
raise CertificatePublishError(
|
||||||
|
f'refused to publish {dest_path}: {e}. The previously served '
|
||||||
|
'certificate is still in place.')
|
||||||
|
logger.info("Published validated certificate bundle to %s%s", dest_path,
|
||||||
|
f' (previous copy backed up to {backup_path})'
|
||||||
|
if backup_path else '')
|
||||||
|
return backup_path
|
||||||
|
|
||||||
|
|
||||||
def certbot_register():
|
def certbot_register():
|
||||||
"""Register with Let's Encrypt using the certbot client and agree to the terms of service"""
|
"""Register with Let's Encrypt using the certbot client and agree to the terms of service"""
|
||||||
result = subprocess.run(['certbot', 'show_account'], capture_output=True)
|
result = subprocess.run(['certbot', 'show_account'], capture_output=True)
|
||||||
@@ -337,12 +677,26 @@ def generate_self_signed_cert(ssl_certs_dir):
|
|||||||
'-subj', f'/CN={DOMAIN}'
|
'-subj', f'/CN={DOMAIN}'
|
||||||
], check=True)
|
], check=True)
|
||||||
|
|
||||||
# Combine cert and key for HAProxy
|
# Combine cert and key for HAProxy. Same publisher as every other bundle:
|
||||||
with open(self_sign_cert, 'wb') as combined:
|
# this file lands in the crt directory, so a half-written one would break
|
||||||
|
# the TLS bind for every site on the host, and because the function
|
||||||
|
# short-circuits on "file exists" a corrupt one would never be regenerated.
|
||||||
|
try:
|
||||||
|
publish_pem_bundle(self_sign_cert, ['/tmp/cert.pem', '/tmp/key.pem'])
|
||||||
|
except CertificatePublishError as e:
|
||||||
|
# do_initial_setup() calls this unguarded, so raising here would abort
|
||||||
|
# container startup before HAProxy is ever launched. Refusing to write
|
||||||
|
# an unusable default cert is right; taking the whole container down
|
||||||
|
# over it is not - start_haproxy() already degrades gracefully.
|
||||||
|
logger.critical("Could not publish the default self-signed certificate "
|
||||||
|
"to %s: %s", self_sign_cert, e)
|
||||||
|
return False
|
||||||
|
finally:
|
||||||
for file in ['/tmp/cert.pem', '/tmp/key.pem']:
|
for file in ['/tmp/cert.pem', '/tmp/key.pem']:
|
||||||
with open(file, 'rb') as f:
|
try:
|
||||||
combined.write(f.read())
|
os.remove(file) # Clean up temporary files
|
||||||
os.remove(file) # Clean up temporary files
|
except OSError:
|
||||||
|
pass
|
||||||
generate_config()
|
generate_config()
|
||||||
return True
|
return True
|
||||||
|
|
||||||
@@ -581,8 +935,15 @@ def request_ssl():
|
|||||||
# Ensure SSL certs directory exists
|
# Ensure SSL certs directory exists
|
||||||
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
||||||
|
|
||||||
with open(combined_path, 'w') as combined:
|
try:
|
||||||
subprocess.run(['cat', cert_path, key_path], stdout=combined)
|
publish_pem_bundle(combined_path, [cert_path, key_path])
|
||||||
|
except CertificatePublishError as e:
|
||||||
|
# Nothing was written: any previously served bundle for this
|
||||||
|
# name is untouched and HAProxy is not reloaded.
|
||||||
|
error_msg = f'Certificate issued but not published: {e}'
|
||||||
|
logger.critical(error_msg)
|
||||||
|
log_operation('request_ssl', False, error_msg)
|
||||||
|
return jsonify({'status': 'error', 'message': error_msg}), 500
|
||||||
|
|
||||||
# Update database
|
# Update database
|
||||||
with sqlite3.connect(DB_FILE) as conn:
|
with sqlite3.connect(DB_FILE) as conn:
|
||||||
@@ -611,8 +972,8 @@ def request_ssl():
|
|||||||
log_operation('request_ssl', False, str(e))
|
log_operation('request_ssl', False, str(e))
|
||||||
return jsonify({'status': 'error', 'message': str(e)}), 500
|
return jsonify({'status': 'error', 'message': str(e)}), 500
|
||||||
|
|
||||||
def _cleanup_superseded_lineages(keep_path, keep_lineage, bundle_names):
|
def _quarantine_superseded_certs(keep_path, keep_lineage, bundle_names):
|
||||||
"""Remove cert files + certbot lineages that the just-issued bundle supersedes.
|
"""Move aside cert files that the just-issued bundle supersedes.
|
||||||
|
|
||||||
A `.pem` in /etc/haproxy/certs/ is "superseded" iff its certificate's CN
|
A `.pem` in /etc/haproxy/certs/ is "superseded" iff its certificate's CN
|
||||||
is one of the bundle's names AND the file isn't the bundle's own combined
|
is one of the bundle's names AND the file isn't the bundle's own combined
|
||||||
@@ -620,10 +981,24 @@ def _cleanup_superseded_lineages(keep_path, keep_lineage, bundle_names):
|
|||||||
since that's what HAProxy SNI-matches against and what the file
|
since that's what HAProxy SNI-matches against and what the file
|
||||||
convention names it after.
|
convention names it after.
|
||||||
|
|
||||||
Also drops the corresponding certbot renewal config so `certbot renew`
|
This used to os.remove() the file and immediately `certbot delete` the
|
||||||
stops trying to renew the dead lineage on its next 12h cron tick.
|
lineage, both BEFORE anything had checked that the replacement bundle was
|
||||||
|
usable — destroying the only two copies of a working certificate on the
|
||||||
|
strength of a `cat` whose exit status nobody read. Now:
|
||||||
|
|
||||||
Returns a small summary dict for logging / API response.
|
* the superseded file is MOVED to the cert backup directory instead of
|
||||||
|
unlinked, so an operator can put it back by hand;
|
||||||
|
* the certbot lineage is left alone here. Deleting it is irreversible
|
||||||
|
(archive, live and renewal config all go) and recovering means fresh,
|
||||||
|
rate-limited ACME orders, so it happens only in
|
||||||
|
_delete_superseded_lineages(), after HAProxy has actually loaded the
|
||||||
|
replacement.
|
||||||
|
|
||||||
|
Moving still solves the problem the removal existed for: the old file no
|
||||||
|
longer sits in the crt directory shadowing the new bundle's SNI match.
|
||||||
|
|
||||||
|
Returns a summary dict for logging / API response. Entries in 'removed'
|
||||||
|
carry the lineage name for the deletion phase.
|
||||||
"""
|
"""
|
||||||
summary = {'removed': [], 'errors': [], 'skipped': []}
|
summary = {'removed': [], 'errors': [], 'skipped': []}
|
||||||
|
|
||||||
@@ -675,26 +1050,54 @@ def _cleanup_superseded_lineages(keep_path, keep_lineage, bundle_names):
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
try:
|
try:
|
||||||
os.remove(fpath)
|
os.makedirs(cert_backup_dir(), exist_ok=True)
|
||||||
removed_entry = {'file': fname, 'cn': cn, 'lineage_deleted': False}
|
quarantine_path = os.path.join(cert_backup_dir(), fname)
|
||||||
# Best-effort certbot lineage delete. Some files may not have a
|
# Move, not unlink: out of the crt directory (so it stops shadowing
|
||||||
# corresponding lineage (e.g. self-signed dev certs); ignore those.
|
# the new bundle) but still on disk for manual recovery.
|
||||||
try:
|
shutil.move(fpath, quarantine_path)
|
||||||
cb_proc = subprocess.run(
|
summary['removed'].append({
|
||||||
['certbot', 'delete', '--cert-name', lineage_name, '-n'],
|
'file': fname,
|
||||||
capture_output=True, text=True
|
'cn': cn,
|
||||||
)
|
'lineage': lineage_name,
|
||||||
removed_entry['lineage_deleted'] = (cb_proc.returncode == 0)
|
'moved_to': quarantine_path,
|
||||||
if cb_proc.returncode != 0:
|
'lineage_deleted': False,
|
||||||
removed_entry['certbot_stderr'] = (cb_proc.stderr or '').strip()[:200]
|
})
|
||||||
except Exception as e:
|
|
||||||
removed_entry['certbot_error'] = str(e)
|
|
||||||
summary['removed'].append(removed_entry)
|
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
summary['errors'].append({'file': fname, 'error': str(e)})
|
summary['errors'].append({'file': fname, 'error': str(e)})
|
||||||
|
|
||||||
return summary
|
return summary
|
||||||
|
|
||||||
|
|
||||||
|
def _delete_superseded_lineages(summary):
|
||||||
|
"""`certbot delete` the lineages quarantined by _quarantine_superseded_certs().
|
||||||
|
|
||||||
|
IRREVERSIBLE: certbot removes the lineage's archive, live symlinks and
|
||||||
|
renewal config. If it turns out we needed that certificate, the only way
|
||||||
|
back is a fresh ACME order, which Let's Encrypt rate-limits — an outage
|
||||||
|
measured in hours. So this is gated hardest of anything in this module: it
|
||||||
|
runs only after the replacement bundle has been assembled, validated,
|
||||||
|
published, AND loaded by a HAProxy that reloaded successfully.
|
||||||
|
|
||||||
|
Mutates `summary` in place. Best-effort: some files have no corresponding
|
||||||
|
lineage (e.g. self-signed dev certs) and a failure here is harmless — a
|
||||||
|
dead lineage merely wastes a renewal attempt on the next 12h cron tick.
|
||||||
|
"""
|
||||||
|
for entry in summary.get('removed', []):
|
||||||
|
lineage_name = entry.get('lineage')
|
||||||
|
if not lineage_name:
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
cb_proc = subprocess.run(
|
||||||
|
['certbot', 'delete', '--cert-name', lineage_name, '-n'],
|
||||||
|
capture_output=True, text=True
|
||||||
|
)
|
||||||
|
entry['lineage_deleted'] = (cb_proc.returncode == 0)
|
||||||
|
if cb_proc.returncode != 0:
|
||||||
|
entry['certbot_stderr'] = (cb_proc.stderr or '').strip()[:200]
|
||||||
|
except Exception as e:
|
||||||
|
entry['certbot_error'] = str(e)
|
||||||
|
return summary
|
||||||
|
|
||||||
@app.route('/api/ssl/bundle', methods=['POST'])
|
@app.route('/api/ssl/bundle', methods=['POST'])
|
||||||
@require_api_key
|
@require_api_key
|
||||||
def request_ssl_bundle():
|
def request_ssl_bundle():
|
||||||
@@ -794,8 +1197,17 @@ def request_ssl_bundle():
|
|||||||
combined_path = f'{SSL_CERTS_DIR}/{primary}.pem'
|
combined_path = f'{SSL_CERTS_DIR}/{primary}.pem'
|
||||||
|
|
||||||
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
||||||
with open(combined_path, 'w') as combined:
|
try:
|
||||||
subprocess.run(['cat', cert_path, key_path], stdout=combined)
|
publish_pem_bundle(combined_path, [cert_path, key_path])
|
||||||
|
except CertificatePublishError as e:
|
||||||
|
# Publishing is all-or-nothing, so at this point nothing has been
|
||||||
|
# written, no old certificate has been touched and no lineage has
|
||||||
|
# been deleted. Stop before any of that becomes untrue.
|
||||||
|
error_msg = f'Bundle issued but not published for {primary}: {e}'
|
||||||
|
logger.critical(error_msg)
|
||||||
|
log_operation('request_ssl_bundle', False, error_msg)
|
||||||
|
return jsonify({'status': 'error', 'message': error_msg,
|
||||||
|
'primary': primary, 'names': names}), 500
|
||||||
|
|
||||||
# Mark every name in the bundle as ssl_enabled, all pointing at the
|
# Mark every name in the bundle as ssl_enabled, all pointing at the
|
||||||
# same combined .pem. HAProxy serves one file for many SNI hostnames.
|
# same combined .pem. HAProxy serves one file for many SNI hostnames.
|
||||||
@@ -816,15 +1228,35 @@ def request_ssl_bundle():
|
|||||||
# `bind ... ssl crt /etc/haproxy/certs` directive. HAProxy then picks
|
# `bind ... ssl crt /etc/haproxy/certs` directive. HAProxy then picks
|
||||||
# one of them by alphabetical/load order — frequently the older
|
# one of them by alphabetical/load order — frequently the older
|
||||||
# single-SAN file — and the new bundle has no effect on what's served.
|
# single-SAN file — and the new bundle has no effect on what's served.
|
||||||
# This block deletes those superseded files (and their certbot lineage)
|
# This block moves those superseded files out of the crt directory
|
||||||
# before the generate_config() reload so HAProxy picks up the bundle.
|
# before the generate_config() reload so HAProxy picks up the bundle.
|
||||||
cleanup_summary = _cleanup_superseded_lineages(
|
# It only runs once publish_pem_bundle() above has validated the
|
||||||
|
# replacement and put it in place, so the old certificate is never the
|
||||||
|
# only copy we have.
|
||||||
|
cleanup_summary = _quarantine_superseded_certs(
|
||||||
keep_path=combined_path,
|
keep_path=combined_path,
|
||||||
keep_lineage=primary,
|
keep_lineage=primary,
|
||||||
bundle_names=set(names),
|
bundle_names=set(names),
|
||||||
)
|
)
|
||||||
|
|
||||||
generate_config()
|
# Raises if the config does not validate or HAProxy does not reload;
|
||||||
|
# the certbot lineages below are therefore only deleted once the new
|
||||||
|
# bundle is genuinely being served.
|
||||||
|
try:
|
||||||
|
generate_config()
|
||||||
|
except Exception:
|
||||||
|
if cleanup_summary['removed']:
|
||||||
|
logger.critical(
|
||||||
|
"HAProxy did not reload after publishing the bundle for "
|
||||||
|
"%s. The superseded certificate files were moved to %s and "
|
||||||
|
"their certbot lineages were NOT deleted, so they can be "
|
||||||
|
"restored by hand: %s",
|
||||||
|
primary, cert_backup_dir(),
|
||||||
|
[e['file'] for e in cleanup_summary['removed']])
|
||||||
|
raise
|
||||||
|
|
||||||
|
_delete_superseded_lineages(cleanup_summary)
|
||||||
|
|
||||||
log_operation(
|
log_operation(
|
||||||
'request_ssl_bundle', True,
|
'request_ssl_bundle', True,
|
||||||
f'SSL bundle issued for {primary} covering {len(names)} names; '
|
f'SSL bundle issued for {primary} covering {len(names)} names; '
|
||||||
@@ -861,6 +1293,7 @@ def renew_certificates():
|
|||||||
# Check if any certificates were renewed
|
# Check if any certificates were renewed
|
||||||
if 'Congratulations' in result.stdout or 'renewed' in result.stdout:
|
if 'Congratulations' in result.stdout or 'renewed' in result.stdout:
|
||||||
# Update combined certificates for HAProxy
|
# Update combined certificates for HAProxy
|
||||||
|
publish_failures = []
|
||||||
with sqlite3.connect(DB_FILE) as conn:
|
with sqlite3.connect(DB_FILE) as conn:
|
||||||
cursor = conn.cursor()
|
cursor = conn.cursor()
|
||||||
cursor.execute('SELECT domain, ssl_cert_path FROM domains WHERE ssl_enabled = 1')
|
cursor.execute('SELECT domain, ssl_cert_path FROM domains WHERE ssl_enabled = 1')
|
||||||
@@ -876,15 +1309,40 @@ def renew_certificates():
|
|||||||
letsencrypt_key = os.path.join(live_dir, 'privkey.pem')
|
letsencrypt_key = os.path.join(live_dir, 'privkey.pem')
|
||||||
|
|
||||||
if os.path.exists(letsencrypt_cert) and os.path.exists(letsencrypt_key):
|
if os.path.exists(letsencrypt_cert) and os.path.exists(letsencrypt_key):
|
||||||
with open(cert_path, 'w') as combined:
|
# A failure here leaves the currently
|
||||||
subprocess.run(['cat', letsencrypt_cert, letsencrypt_key], stdout=combined)
|
# served bundle in place. That certificate
|
||||||
|
# is still valid (renewal runs ~30 days
|
||||||
|
# before expiry and retries every 12h), so
|
||||||
|
# keeping it is strictly better than
|
||||||
|
# replacing it with something unverified.
|
||||||
|
try:
|
||||||
|
publish_pem_bundle(
|
||||||
|
cert_path,
|
||||||
|
[letsencrypt_cert, letsencrypt_key])
|
||||||
|
except CertificatePublishError as e:
|
||||||
|
logger.critical(
|
||||||
|
"Renewed certificate for %s was NOT "
|
||||||
|
"published: %s", domain, e)
|
||||||
|
publish_failures.append(
|
||||||
|
{'domain': domain, 'error': str(e)})
|
||||||
|
|
||||||
# Regenerate config and reload HAProxy
|
# Regenerate config and reload HAProxy. Safe to do with
|
||||||
|
# publish failures present: those certificates were left
|
||||||
|
# untouched, so nothing unvalidated is being loaded.
|
||||||
generate_config()
|
generate_config()
|
||||||
reload_result = subprocess.run('echo "reload" | socat stdio /tmp/haproxy-cli',
|
reload_result = subprocess.run('echo "reload" | socat stdio /tmp/haproxy-cli',
|
||||||
capture_output=True, text=True, shell=True)
|
capture_output=True, text=True, shell=True)
|
||||||
|
|
||||||
if reload_result.returncode == 0:
|
if reload_result.returncode == 0:
|
||||||
|
if publish_failures:
|
||||||
|
error_msg = (
|
||||||
|
f'{len(publish_failures)} renewed certificate(s) could '
|
||||||
|
'not be published and are still being served from '
|
||||||
|
'their previous bundle')
|
||||||
|
log_operation('renew_certificates', False, error_msg)
|
||||||
|
return jsonify({'status': 'partial_success',
|
||||||
|
'message': error_msg,
|
||||||
|
'failures': publish_failures}), 500
|
||||||
log_operation('renew_certificates', True, 'Certificates renewed and HAProxy reloaded')
|
log_operation('renew_certificates', True, 'Certificates renewed and HAProxy reloaded')
|
||||||
return jsonify({'status': 'success', 'message': 'Certificates renewed and HAProxy reloaded'})
|
return jsonify({'status': 'success', 'message': 'Certificates renewed and HAProxy reloaded'})
|
||||||
else:
|
else:
|
||||||
@@ -1077,8 +1535,18 @@ def request_certificates():
|
|||||||
# Ensure SSL certs directory exists
|
# Ensure SSL certs directory exists
|
||||||
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
||||||
|
|
||||||
with open(combined_path, 'w') as combined:
|
try:
|
||||||
subprocess.run(['cat', cert_path, key_path], stdout=combined)
|
publish_pem_bundle(combined_path, [cert_path, key_path])
|
||||||
|
except CertificatePublishError as e:
|
||||||
|
error_msg = f'Certificate issued but not published: {e}'
|
||||||
|
logger.critical('%s (%s)', error_msg, domain)
|
||||||
|
results.append({
|
||||||
|
'domain': domain,
|
||||||
|
'status': 'error',
|
||||||
|
'message': error_msg,
|
||||||
|
})
|
||||||
|
error_count += 1
|
||||||
|
continue
|
||||||
|
|
||||||
# Update database (add domain if it doesn't exist)
|
# Update database (add domain if it doesn't exist)
|
||||||
with sqlite3.connect(DB_FILE) as conn:
|
with sqlite3.connect(DB_FILE) as conn:
|
||||||
@@ -1700,11 +2168,13 @@ def dns_challenge_verify():
|
|||||||
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
os.makedirs(SSL_CERTS_DIR, exist_ok=True)
|
||||||
combined_path = f'{SSL_CERTS_DIR}/_wildcard_.{base_domain}.pem'
|
combined_path = f'{SSL_CERTS_DIR}/_wildcard_.{base_domain}.pem'
|
||||||
|
|
||||||
with open(combined_path, 'w') as combined:
|
try:
|
||||||
with open(cert_path, 'r') as cf:
|
publish_pem_bundle(combined_path, [cert_path, key_path])
|
||||||
combined.write(cf.read())
|
except CertificatePublishError as e:
|
||||||
with open(key_path, 'r') as kf:
|
error_msg = f'Wildcard certificate obtained but not published: {e}'
|
||||||
combined.write(kf.read())
|
logger.critical(error_msg)
|
||||||
|
log_operation('dns_challenge_verify', False, error_msg)
|
||||||
|
return jsonify({'success': False, 'error': error_msg}), 500
|
||||||
|
|
||||||
# Update database
|
# Update database
|
||||||
with sqlite3.connect(DB_FILE) as conn:
|
with sqlite3.connect(DB_FILE) as conn:
|
||||||
@@ -1750,6 +2220,40 @@ def get_or_create_cluster_secret():
|
|||||||
secret = f.read().strip()
|
secret = f.read().strip()
|
||||||
if secret:
|
if secret:
|
||||||
return secret
|
return secret
|
||||||
|
# File exists but is blank — e.g. a create that died between
|
||||||
|
# open() and write(), or a volume restored empty. Without healing
|
||||||
|
# it here we fall through to the O_EXCL create below, which fails
|
||||||
|
# with FileExistsError, and the handler re-reads the same blank
|
||||||
|
# file: this function would return '' forever and the host would
|
||||||
|
# never get the stable secret its docstring promises.
|
||||||
|
#
|
||||||
|
# Rewrite in place under an exclusive lock rather than unlinking
|
||||||
|
# and recreating: the file is never momentarily absent, and two
|
||||||
|
# workers healing at once serialise instead of racing to install
|
||||||
|
# two different secrets.
|
||||||
|
try:
|
||||||
|
fd = os.open(CLUSTER_SECRET_PATH, os.O_RDWR)
|
||||||
|
try:
|
||||||
|
fcntl.flock(fd, fcntl.LOCK_EX)
|
||||||
|
# Re-read under the lock: another worker may have healed it
|
||||||
|
# while we were waiting.
|
||||||
|
existing = os.read(fd, 4096).decode(errors='replace').strip()
|
||||||
|
if existing:
|
||||||
|
return existing
|
||||||
|
secret = os.urandom(32).hex()
|
||||||
|
os.ftruncate(fd, 0)
|
||||||
|
os.lseek(fd, 0, os.SEEK_SET)
|
||||||
|
os.write(fd, secret.encode())
|
||||||
|
os.fchmod(fd, 0o600)
|
||||||
|
logger.warning(
|
||||||
|
"Healed empty QUIC cluster-secret at %s",
|
||||||
|
CLUSTER_SECRET_PATH)
|
||||||
|
return secret
|
||||||
|
finally:
|
||||||
|
os.close(fd)
|
||||||
|
except Exception as e:
|
||||||
|
logger.error("Failed to heal empty cluster-secret: %s", e)
|
||||||
|
return ''
|
||||||
# Generate and persist exclusively (0600). hex => config-safe charset.
|
# Generate and persist exclusively (0600). hex => config-safe charset.
|
||||||
secret = os.urandom(32).hex()
|
secret = os.urandom(32).hex()
|
||||||
fd = os.open(CLUSTER_SECRET_PATH, os.O_CREAT | os.O_EXCL | os.O_WRONLY, 0o600)
|
fd = os.open(CLUSTER_SECRET_PATH, os.O_CREAT | os.O_EXCL | os.O_WRONLY, 0o600)
|
||||||
@@ -1847,14 +2351,29 @@ def generate_config():
|
|||||||
except Exception as e:
|
except Exception as e:
|
||||||
logger.error(f"Failed to create {suspended_list_path}: {e}")
|
logger.error(f"Failed to create {suspended_list_path}: {e}")
|
||||||
|
|
||||||
|
# Access-log destination for the `log` line in the global section.
|
||||||
|
# Default 172.18.0.1:514 is the docker bridge gateway for WHP's
|
||||||
|
# `client-net`, i.e. the host, where rsyslog's imudp listener is bound
|
||||||
|
# by setup-haproxy-logrotate.sh. Overridable so this image stays usable
|
||||||
|
# on standalone/home deployments with a different bridge subnet or a
|
||||||
|
# remote log collector -- set HAPROXY_SYSLOG_TARGET to `<ip>:<port>`.
|
||||||
|
# UDP, so an absent listener drops log lines and never affects request
|
||||||
|
# handling.
|
||||||
|
syslog_target = os.environ.get('HAPROXY_SYSLOG_TARGET', '172.18.0.1:514').strip()
|
||||||
|
|
||||||
# Add Haproxy Default Headers
|
# Add Haproxy Default Headers
|
||||||
default_headers = template_env.get_template('hap_header.tpl').render(
|
default_headers = template_env.get_template('hap_header.tpl').render(
|
||||||
cluster_secret = get_or_create_cluster_secret(),
|
cluster_secret = get_or_create_cluster_secret(),
|
||||||
|
syslog_target = syslog_target,
|
||||||
)
|
)
|
||||||
config_parts.append(default_headers)
|
config_parts.append(default_headers)
|
||||||
|
|
||||||
# Update blocked IPs map file first
|
# Update blocked IPs map file first. promote_backup=False: the rollback
|
||||||
update_blocked_ips_map()
|
# snapshot was taken a few lines above and this map is part of the
|
||||||
|
# not-yet-validated change, so refreshing the backup copy here would
|
||||||
|
# overwrite the bytes rollback needs - the same class of bug as backing
|
||||||
|
# up after the write.
|
||||||
|
update_blocked_ips_map(promote_backup=False)
|
||||||
|
|
||||||
# Add Listener Block
|
# Add Listener Block
|
||||||
listener_block = template_env.get_template('hap_listener.tpl').render(
|
listener_block = template_env.get_template('hap_listener.tpl').render(
|
||||||
@@ -2107,7 +2626,7 @@ def _config_backup_pairs():
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def write_config_atomically(path, content):
|
def write_config_atomically(path, content, staging_dir=None, validate=None):
|
||||||
"""Write content to path via temp file + rename.
|
"""Write content to path via temp file + rename.
|
||||||
|
|
||||||
A half-written haproxy.cfg (disk full, container killed mid-write) is just
|
A half-written haproxy.cfg (disk full, container killed mid-write) is just
|
||||||
@@ -2115,8 +2634,26 @@ def write_config_atomically(path, content):
|
|||||||
atomic within a filesystem, so the file on disk is always either the whole
|
atomic within a filesystem, so the file on disk is always either the whole
|
||||||
old config or the whole new one — never a truncated hybrid. This also keeps
|
old config or the whole new one — never a truncated hybrid. This also keeps
|
||||||
the "existing config is already broken" case from being self-inflicted.
|
the "existing config is already broken" case from being self-inflicted.
|
||||||
|
|
||||||
|
The same guarantee is what certificate bundles need, so this is the single
|
||||||
|
atomic publisher for both (see publish_pem_bundle()); the two extra
|
||||||
|
arguments exist for that caller:
|
||||||
|
|
||||||
|
staging_dir: where the temp file is created. Defaults to the destination's
|
||||||
|
own directory, which is right for /etc/haproxy but WRONG for
|
||||||
|
/etc/haproxy/certs — HAProxy loads that path as a crt directory and
|
||||||
|
tries to load every file in it, so a `.tmp` there (or one leaked by a
|
||||||
|
crash) can break the whole TLS bind. Must be on the same filesystem as
|
||||||
|
`path` or os.replace() cannot be atomic; if it is not, the rename fails
|
||||||
|
loudly and the destination is left untouched, which is the safe outcome.
|
||||||
|
|
||||||
|
validate: optional callable(temp_path) -> (ok, message), run on the staged
|
||||||
|
file BEFORE it is moved into place. Returning False aborts the publish
|
||||||
|
with the temp file removed and `path` still holding its previous
|
||||||
|
contents. This is the only ordering that lets us validate the
|
||||||
|
replacement without having destroyed the original first.
|
||||||
"""
|
"""
|
||||||
directory = os.path.dirname(path) or '.'
|
directory = staging_dir or os.path.dirname(path) or '.'
|
||||||
# Preserve the mode of the file we are replacing; mkstemp defaults to 0600
|
# Preserve the mode of the file we are replacing; mkstemp defaults to 0600
|
||||||
# and HAProxy config files are conventionally 0644.
|
# and HAProxy config files are conventionally 0644.
|
||||||
try:
|
try:
|
||||||
@@ -2132,6 +2669,10 @@ def write_config_atomically(path, content):
|
|||||||
f.flush()
|
f.flush()
|
||||||
os.fsync(f.fileno())
|
os.fsync(f.fileno())
|
||||||
os.chmod(tmp_path, mode)
|
os.chmod(tmp_path, mode)
|
||||||
|
if validate is not None:
|
||||||
|
ok, message = validate(tmp_path)
|
||||||
|
if not ok:
|
||||||
|
raise ValueError(f'staged file failed validation: {message}')
|
||||||
os.replace(tmp_path, path)
|
os.replace(tmp_path, path)
|
||||||
except Exception:
|
except Exception:
|
||||||
try:
|
try:
|
||||||
@@ -2287,7 +2828,19 @@ def validate_config_file(config_path):
|
|||||||
|
|
||||||
|
|
||||||
def validate_haproxy_config():
|
def validate_haproxy_config():
|
||||||
"""Validate the live HAProxy configuration file. Returns (is_valid, error)."""
|
"""Validate the live HAProxy configuration file. Returns (is_valid, error).
|
||||||
|
|
||||||
|
NOTE the invalid/unavailable distinction validate_config_file() draws does
|
||||||
|
NOT survive here: this returns a bare bool, so a validator that could not
|
||||||
|
run is reported the same as a rejected config and the reload path rolls
|
||||||
|
back, logging "Config validation failed". That is deliberate - without a
|
||||||
|
working validator we cannot claim the new config is safe, and the reload
|
||||||
|
path is the one place where guessing wrong takes the edge down. The
|
||||||
|
distinction is only acted on inside create_backup(), where treating
|
||||||
|
"cannot check" as "bad" would mean refusing to keep any rollback target at
|
||||||
|
all. (The 2026-08 commit message said flatly that "a missing haproxy binary
|
||||||
|
is not read as a bad config"; that is true of create_backup() only.)
|
||||||
|
"""
|
||||||
status, message = validate_config_file(HAPROXY_CONFIG_PATH)
|
status, message = validate_config_file(HAPROXY_CONFIG_PATH)
|
||||||
if status == 'valid':
|
if status == 'valid':
|
||||||
logger.info("HAProxy configuration validation passed")
|
logger.info("HAProxy configuration validation passed")
|
||||||
@@ -2399,12 +2952,89 @@ def reload_haproxy_safely(backup_status=None):
|
|||||||
logger.error(error_msg)
|
logger.error(error_msg)
|
||||||
return False, error_msg
|
return False, error_msg
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
|
# KNOWN GAP (pre-existing, unchanged by the 2026-08 backup-ordering
|
||||||
|
# fix): this outer handler does NOT roll back. The window is narrow -
|
||||||
|
# everything after the validation gate has its own handler - but an
|
||||||
|
# exception raised between the gate and those handlers leaves the new
|
||||||
|
# config on disk. Left as-is deliberately; rolling back from here would
|
||||||
|
# also undo changes that had in fact loaded.
|
||||||
error_msg = f"Critical error in reload process: {e}"
|
error_msg = f"Critical error in reload process: {e}"
|
||||||
logger.error(error_msg)
|
logger.error(error_msg)
|
||||||
return False, error_msg
|
return False, error_msg
|
||||||
|
|
||||||
def update_blocked_ips_map():
|
def _blocked_ips_map_is_wellformed(path):
|
||||||
"""Update the blocked IPs map file from database"""
|
"""True if every key in a blocked-IPs map is one HAProxy will parse.
|
||||||
|
|
||||||
|
map_ip() rejects the ENTIRE configuration if a single key is not an IP or
|
||||||
|
CIDR ("'198.51.10' is not a valid IPv4 or IPv6 address at line 2 of file
|
||||||
|
..."), so this is the property that decides whether the file is safe to
|
||||||
|
record as a rollback target. Pure Python over a small file - deliberately
|
||||||
|
not another `haproxy -c`, which is the cost this check exists to avoid.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with open(path) as fh:
|
||||||
|
for line in fh:
|
||||||
|
line = line.strip()
|
||||||
|
if not line or line.startswith('#'):
|
||||||
|
continue
|
||||||
|
ipaddress.ip_network(line.split()[0], strict=False)
|
||||||
|
except (OSError, ValueError, IndexError):
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def _promote_blocked_ips_map_to_backup():
|
||||||
|
"""Keep blocked_ips.map.backup in step with the map just written.
|
||||||
|
|
||||||
|
The /api/blocked-ips routes call update_blocked_ips_map() OUTSIDE
|
||||||
|
generate_config(): the map write IS the whole change there, published
|
||||||
|
against a config HAProxy is already running. Without promoting it, the live
|
||||||
|
map drifts from its backup, create_backup() misses its fast path on the
|
||||||
|
NEXT config change, and an edge that blocks IPs automatically (this fleet
|
||||||
|
does) pays an extra `haproxy -c` on the following customer-facing domain
|
||||||
|
add - permanently, since every block re-opens the drift.
|
||||||
|
|
||||||
|
Guarded twice:
|
||||||
|
* a config backup set must already exist - never fabricate a rollback
|
||||||
|
target out of nothing (see restore_backup()); and
|
||||||
|
* the map must be well-formed, so promoting it cannot leave a "rollback
|
||||||
|
target" HAProxy refuses to load. That would be this module's own bug
|
||||||
|
on a different file.
|
||||||
|
When either fails we leave the older backup map alone and the next
|
||||||
|
create_backup() takes the slow, `haproxy -c`-validated path - i.e. the
|
||||||
|
behaviour before this function existed. Nothing here can lose data.
|
||||||
|
|
||||||
|
Note the map is promoted after the write rather than after the caller's
|
||||||
|
reload: the routes only warn on a failed reload and carry on, so there is
|
||||||
|
no reload result to gate on. A well-formed map that HAProxy has not loaded
|
||||||
|
yet is still a loadable rollback target, which is the guarantee that
|
||||||
|
matters.
|
||||||
|
"""
|
||||||
|
if not os.path.exists(HAPROXY_BACKUP_PATH):
|
||||||
|
return False
|
||||||
|
if not _blocked_ips_map_is_wellformed(BLOCKED_IPS_MAP_PATH):
|
||||||
|
logger.warning(
|
||||||
|
f"Not recording {BLOCKED_IPS_MAP_PATH} as known-good: it contains "
|
||||||
|
"an entry HAProxy cannot parse, which would make the whole "
|
||||||
|
"configuration invalid. Keeping the previous backup map."
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
try:
|
||||||
|
shutil.copy2(BLOCKED_IPS_MAP_PATH, BLOCKED_IPS_MAP_BACKUP_PATH)
|
||||||
|
return True
|
||||||
|
except OSError as e:
|
||||||
|
logger.warning(f"Could not update the backup blocked IPs map: {e}")
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def update_blocked_ips_map(promote_backup=True):
|
||||||
|
"""Update the blocked IPs map file from database.
|
||||||
|
|
||||||
|
promote_backup=False is for callers that are in the middle of an
|
||||||
|
unvalidated configuration change - generate_config() has already taken the
|
||||||
|
rollback snapshot by the time it gets here, so refreshing the backup map
|
||||||
|
would overwrite the very bytes rollback needs.
|
||||||
|
"""
|
||||||
try:
|
try:
|
||||||
with sqlite3.connect(DB_FILE) as conn:
|
with sqlite3.connect(DB_FILE) as conn:
|
||||||
cursor = conn.cursor()
|
cursor = conn.cursor()
|
||||||
@@ -2415,9 +3045,19 @@ def update_blocked_ips_map():
|
|||||||
# For IP blocking, we use: <ip_or_cidr> 1
|
# For IP blocking, we use: <ip_or_cidr> 1
|
||||||
# This allows map_ip() to work with both single IPs and CIDR ranges
|
# This allows map_ip() to work with both single IPs and CIDR ranges
|
||||||
os.makedirs(os.path.dirname(BLOCKED_IPS_MAP_PATH), exist_ok=True)
|
os.makedirs(os.path.dirname(BLOCKED_IPS_MAP_PATH), exist_ok=True)
|
||||||
with open(BLOCKED_IPS_MAP_PATH, 'w') as f:
|
# Atomically, for the same reason haproxy.cfg is: `haproxy -c` LOADS
|
||||||
for ip in blocked_ips:
|
# this file (hap_listener.tpl matches on
|
||||||
f.write(f"{ip} 1\n")
|
# map_ip(/etc/haproxy/blocked_ips.map,0)), and a half-written final
|
||||||
|
# line is a FATAL config error rather than one dropped entry - verified
|
||||||
|
# against HAProxy 2.8. A truncated map is therefore exactly the failure
|
||||||
|
# this module's backup ordering exists to prevent, on a different file.
|
||||||
|
write_config_atomically(
|
||||||
|
BLOCKED_IPS_MAP_PATH,
|
||||||
|
''.join(f"{ip} 1\n" for ip in blocked_ips)
|
||||||
|
)
|
||||||
|
|
||||||
|
if promote_backup:
|
||||||
|
_promote_blocked_ips_map_to_backup()
|
||||||
|
|
||||||
logger.info(f"Updated blocked IPs map file with {len(blocked_ips)} IPs")
|
logger.info(f"Updated blocked IPs map file with {len(blocked_ips)} IPs")
|
||||||
return True
|
return True
|
||||||
|
|||||||
@@ -0,0 +1,371 @@
|
|||||||
|
# shellcheck shell=bash
|
||||||
|
# cert-publish-lib.sh - safe publication of HAProxy certificate bundles.
|
||||||
|
#
|
||||||
|
# This file is SOURCED, never executed (hence no shebang / no exec bit).
|
||||||
|
#
|
||||||
|
# Why this exists
|
||||||
|
# ---------------
|
||||||
|
# renew-certificates.sh and sync-certificates.sh used to publish a bundle with
|
||||||
|
#
|
||||||
|
# cat "$CERT_FILE" "$KEY_FILE" > "$COMBINED_FILE"
|
||||||
|
#
|
||||||
|
# where $COMBINED_FILE is the LIVE pem HAProxy is serving right now. The shell
|
||||||
|
# truncates the destination to zero bytes when it sets up the redirect, BEFORE
|
||||||
|
# cat ever runs, so any failure after that point (unreadable source, ENOSPC,
|
||||||
|
# container killed mid-write) leaves a zero-length or key-less pem in place.
|
||||||
|
# Checking cat's exit status does not help: the damage is already done.
|
||||||
|
#
|
||||||
|
# That matters more here than for an ordinary file because HAProxy loads
|
||||||
|
# $SSL_CERTS_DIR as a DIRECTORY:
|
||||||
|
#
|
||||||
|
# bind 0.0.0.0:443 ssl crt /etc/haproxy/certs
|
||||||
|
#
|
||||||
|
# It tries to load *every* file in that directory, and one unloadable file
|
||||||
|
# fails the whole bind - i.e. HTTPS goes down for every customer on the host.
|
||||||
|
#
|
||||||
|
# Two consequences drive the design below:
|
||||||
|
# 1. Assemble somewhere else and rename into place, so the live pem is either
|
||||||
|
# the old bundle or the new one and never a half-written one.
|
||||||
|
# 2. NEVER create a temp file, .tmp, .backup or any other non-final file
|
||||||
|
# inside $SSL_CERTS_DIR. Staging and backups live in SIBLING directories.
|
||||||
|
#
|
||||||
|
# Directory layout (kept identical to the Python half in haproxy_manager.py):
|
||||||
|
# staging: $(dirname $SSL_CERTS_DIR)/cert-staging [$CERT_STAGING_DIR]
|
||||||
|
# backups: $(dirname $SSL_CERTS_DIR)/cert-backups [$CERT_BACKUP_DIR]
|
||||||
|
# Both siblings of the certs dir, so they are on the same filesystem and the
|
||||||
|
# final mv is a rename(2) - atomic. There is deliberately no "just write it
|
||||||
|
# directly into the certs dir" fallback path.
|
||||||
|
#
|
||||||
|
# The same-filesystem property is CHECKED, not assumed (see cert_publish step
|
||||||
|
# (c)). An earlier revision of this comment claimed a cross-device mv would
|
||||||
|
# "fail loudly and leave the live pem alone". It does not: GNU mv falls back to
|
||||||
|
# copy-then-unlink across filesystems, so it OPENS THE DESTINATION FOR WRITING
|
||||||
|
# and only then discovers it cannot finish - e.g. with a full destination
|
||||||
|
# filesystem the live pem is already overwritten when mv reports failure. That
|
||||||
|
# is precisely the truncation this library exists to prevent, so the device
|
||||||
|
# numbers of the staging dir and the certs dir are compared with stat(1) before
|
||||||
|
# anything is written, and a mismatch aborts the publish. Both directories are
|
||||||
|
# env-overridable ($CERT_STAGING_DIR / $SSL_CERTS_DIR), so "they are siblings"
|
||||||
|
# is not something the code can take on faith. This mirrors the explicit
|
||||||
|
# st_dev check in publish_pem_bundle() on the Python side.
|
||||||
|
|
||||||
|
# Logging: the callers define their own log_info/log_error. Only provide
|
||||||
|
# fallbacks so this library is usable standalone (e.g. from a test or a shell).
|
||||||
|
declare -F log_info >/dev/null || log_info() {
|
||||||
|
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [INFO] $*"
|
||||||
|
}
|
||||||
|
declare -F log_error >/dev/null || log_error() {
|
||||||
|
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [ERROR] $*" >&2
|
||||||
|
}
|
||||||
|
# log_warn is not part of the callers' vocabulary; route it through log_info
|
||||||
|
# with a loud prefix so it lands in the main log without tripping the
|
||||||
|
# error-log monitors (scripts/monitor-errors.sh) for non-fatal conditions.
|
||||||
|
declare -F log_warn >/dev/null || log_warn() {
|
||||||
|
log_info "WARNING: $*"
|
||||||
|
}
|
||||||
|
|
||||||
|
cert_staging_dir() {
|
||||||
|
if [ -n "${CERT_STAGING_DIR:-}" ]; then
|
||||||
|
echo "$CERT_STAGING_DIR"
|
||||||
|
else
|
||||||
|
echo "$(dirname "${SSL_CERTS_DIR:-/etc/haproxy/certs}")/cert-staging"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
cert_backup_dir() {
|
||||||
|
if [ -n "${CERT_BACKUP_DIR:-}" ]; then
|
||||||
|
echo "$CERT_BACKUP_DIR"
|
||||||
|
else
|
||||||
|
echo "$(dirname "${SSL_CERTS_DIR:-/etc/haproxy/certs}")/cert-backups"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# cert_bundle_valid FILE
|
||||||
|
#
|
||||||
|
# Returns 0 if FILE is publishable as an HAProxy pem bundle.
|
||||||
|
#
|
||||||
|
# Layer 1 (structure, pure shell/grep): covers the truncation / partial-write /
|
||||||
|
# key-less failure modes this library exists to prevent.
|
||||||
|
# Layer 2 (cryptographic pairing via the openssl CLI): covers what layer 1
|
||||||
|
# cannot see. Structural checks are weak on their own - a bundle of
|
||||||
|
# EMPTY pem blocks ("-----BEGIN CERTIFICATE-----" immediately followed
|
||||||
|
# by "-----END CERTIFICATE-----") satisfies every grep below and is
|
||||||
|
# caught only by openssl.
|
||||||
|
#
|
||||||
|
# BOTH LAYERS ARE MANDATORY. An absent openssl binary is a hard failure, not a
|
||||||
|
# skip.
|
||||||
|
#
|
||||||
|
# The previous revision made layer 2 best-effort and justified it with "the
|
||||||
|
# container image installs haproxy, certbot and socat, but not necessarily the
|
||||||
|
# openssl CLI". That premise is false. openssl 3.x is present in the image: it
|
||||||
|
# is a dependency of ca-certificates, which certbot needs, and
|
||||||
|
# generate_self_signed_cert() in haproxy_manager.py shells out to `openssl req`
|
||||||
|
# with check=True during first-run setup, so a container that reached the point
|
||||||
|
# of publishing a bundle has always had it. The "unavailable" branch therefore
|
||||||
|
# never fired in production, which means the fail-open was safe only by
|
||||||
|
# accident - and a comment that justifies a decision on a false premise is
|
||||||
|
# worse than no comment, because the next person extends the reasoning.
|
||||||
|
#
|
||||||
|
# Making it mandatory does mean a hypothetical image without openssl stops
|
||||||
|
# publishing renewals. That is the right trade: it fails immediately and
|
||||||
|
# loudly, into the monitored error log, on the first renewal run, whereas
|
||||||
|
# publishing an unpaired or empty-block bundle takes the whole :443 bind (i.e.
|
||||||
|
# every site on the host) down at the next reload. There is deliberately no
|
||||||
|
# python `cryptography` fallback: the app runs on /usr/local/bin/python3 (the
|
||||||
|
# base image's 3.12), where cryptography is NOT importable - it is installed
|
||||||
|
# for Debian's /usr/bin/python3 as a certbot dependency. Coding to a hardcoded
|
||||||
|
# /usr/bin/python3 would just be a second unverified premise.
|
||||||
|
cert_bundle_valid() {
|
||||||
|
local file="$1"
|
||||||
|
|
||||||
|
if [ -z "$file" ]; then
|
||||||
|
log_error "cert_bundle_valid: no file given"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ ! -f "$file" ]; then
|
||||||
|
log_error "Certificate bundle $file does not exist (or is not a regular file)"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# openssl is checked BEFORE any content check so a broken image is reported
|
||||||
|
# as a broken image rather than as a bad certificate.
|
||||||
|
if ! command -v openssl >/dev/null 2>&1; then
|
||||||
|
log_error "openssl binary not found - REFUSING to publish $file." \
|
||||||
|
"The cert/key pairing check (openssl x509 -pubkey vs openssl pkey -pubout)" \
|
||||||
|
"is mandatory; structural checks alone cannot tell a real bundle from" \
|
||||||
|
"empty pem blocks. Install openssl in this image."
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Read the file ONCE and run every check against that snapshot.
|
||||||
|
#
|
||||||
|
# This used to open $file six times (two [ ] tests, three greps, two
|
||||||
|
# openssl invocations). cert_bundle_valid() is called on the LIVE pem in
|
||||||
|
# cert_publish() step (d), where a concurrent publisher can replace it
|
||||||
|
# between two of those opens - each open then sees a different file. The
|
||||||
|
# observable symptom was a spurious "private key does not match the
|
||||||
|
# certificate" ERROR in the monitored error log for a pair that was fine:
|
||||||
|
# openssl x509 read the old bundle and openssl pkey the new one.
|
||||||
|
local content
|
||||||
|
if ! content="$(cat -- "$file" 2>/dev/null)"; then
|
||||||
|
log_error "Certificate bundle $file could not be read"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ -z "$content" ]; then
|
||||||
|
log_error "Certificate bundle $file is empty"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --- layer 1: structure -------------------------------------------------
|
||||||
|
if ! grep -qF -- '-----BEGIN CERTIFICATE-----' <<< "$content"; then
|
||||||
|
log_error "Certificate bundle $file contains no certificate block"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if ! grep -qF -- '-----END CERTIFICATE-----' <<< "$content"; then
|
||||||
|
log_error "Certificate bundle $file has an unterminated certificate block (truncated?)"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
local key_begin key_end
|
||||||
|
key_begin="$(grep -m1 -oE -- '-----BEGIN (RSA |EC )?PRIVATE KEY-----' <<< "$content")"
|
||||||
|
if [ -z "$key_begin" ]; then
|
||||||
|
log_error "Certificate bundle $file contains no private key block"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
key_end="${key_begin/BEGIN/END}"
|
||||||
|
if ! grep -qF -- "$key_end" <<< "$content"; then
|
||||||
|
log_error "Certificate bundle $file has an unterminated private key block (truncated?)"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# --- layer 2: cert/key pairing ------------------------------------------
|
||||||
|
# Fed from the same snapshot on stdin (openssl reads stdin when -in is
|
||||||
|
# omitted) rather than re-opening $file, so layer 2 judges exactly the
|
||||||
|
# bytes layer 1 judged. -passin pass: means an encrypted key fails fast
|
||||||
|
# instead of prompting - a passphrase prompt in a cron job is a hang, not
|
||||||
|
# an error.
|
||||||
|
local cert_pub key_pub
|
||||||
|
if ! cert_pub="$(openssl x509 -noout -pubkey 2>/dev/null <<< "$content")" \
|
||||||
|
|| [ -z "$cert_pub" ]; then
|
||||||
|
log_error "Certificate bundle $file: openssl could not read the certificate"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if ! key_pub="$(openssl pkey -pubout -passin pass: 2>/dev/null <<< "$content")" \
|
||||||
|
|| [ -z "$key_pub" ]; then
|
||||||
|
log_error "Certificate bundle $file: openssl could not read the private key"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ "$cert_pub" != "$key_pub" ]; then
|
||||||
|
log_error "Certificate bundle $file: private key does not match the certificate"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# cert_publish CERT_FILE KEY_FILE DEST_FILE
|
||||||
|
#
|
||||||
|
# Assemble CERT_FILE + KEY_FILE into DEST_FILE without ever exposing a
|
||||||
|
# partially written DEST_FILE to HAProxy. Returns 0 on success.
|
||||||
|
#
|
||||||
|
# On ANY failure DEST_FILE is left exactly as it was.
|
||||||
|
cert_publish() {
|
||||||
|
if [ $# -ne 3 ]; then
|
||||||
|
log_error "cert_publish: expected 3 arguments (cert key dest), got $#"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
local cert_file="$1" key_file="$2" dest_file="$3"
|
||||||
|
local staging_dir backup_dir dest_dir tmp base
|
||||||
|
|
||||||
|
# (a) sources must exist and be non-empty before we touch anything.
|
||||||
|
if [ ! -s "$cert_file" ]; then
|
||||||
|
log_error "cert_publish: certificate $cert_file is missing or empty"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ ! -s "$key_file" ]; then
|
||||||
|
log_error "cert_publish: private key $key_file is missing or empty"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# (b) assemble in the staging dir - NOT in the certs dir, which HAProxy
|
||||||
|
# scans wholesale.
|
||||||
|
staging_dir="$(cert_staging_dir)"
|
||||||
|
dest_dir="$(dirname "$dest_file")"
|
||||||
|
if ! mkdir -p "$staging_dir" || ! mkdir -p "$dest_dir"; then
|
||||||
|
log_error "cert_publish: cannot create staging directory $staging_dir or destination directory $dest_dir"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# (c) the final swap is `mv`, which is only a rename(2) - and therefore only
|
||||||
|
# atomic - within one filesystem. Across filesystems GNU mv copies:
|
||||||
|
# it truncates and writes the DESTINATION, then unlinks the source, so a
|
||||||
|
# failure part-way through (ENOSPC is the realistic one) leaves exactly
|
||||||
|
# the half-written live pem this library exists to prevent. Both paths
|
||||||
|
# are env-overridable, so check instead of assuming. Same check as the
|
||||||
|
# st_dev comparison in publish_pem_bundle() on the Python side.
|
||||||
|
local staging_dev dest_dev
|
||||||
|
staging_dev="$(stat -Lc '%d' "$staging_dir" 2>/dev/null)"
|
||||||
|
dest_dev="$(stat -Lc '%d' "$dest_dir" 2>/dev/null)"
|
||||||
|
if [ -z "$staging_dev" ] || [ -z "$dest_dev" ]; then
|
||||||
|
log_error "cert_publish: cannot stat $staging_dir and/or $dest_dir - refusing to publish $dest_file"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ "$staging_dev" != "$dest_dev" ]; then
|
||||||
|
log_error "cert_publish: staging dir $staging_dir and destination dir $dest_dir" \
|
||||||
|
"are on different filesystems, so the bundle cannot be swapped in atomically." \
|
||||||
|
"Refusing to publish $dest_file (live file left untouched);" \
|
||||||
|
"point CERT_STAGING_DIR at a directory on the same filesystem as $dest_dir"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Sweep temps orphaned by a kill -9 / OOM in an earlier run. Two shapes,
|
||||||
|
# because two publishers share this directory: mktemp's six-X suffix from
|
||||||
|
# this library, and `<name>.<random>.tmp` from write_config_atomically() on
|
||||||
|
# the Python side (tempfile.mkstemp(prefix=name + '.', suffix='.tmp')).
|
||||||
|
# Matching only the mktemp shape - as this did - left every Python-side
|
||||||
|
# temp behind forever.
|
||||||
|
find "$staging_dir" -maxdepth 1 -type f \
|
||||||
|
\( -name '*.??????' -o -name '*.tmp' \) -mmin +1440 -delete 2>/dev/null
|
||||||
|
|
||||||
|
base="$(basename "$dest_file")"
|
||||||
|
tmp="$(mktemp "${staging_dir}/${base}.XXXXXX" 2>/dev/null)"
|
||||||
|
if [ -z "$tmp" ] || [ ! -f "$tmp" ]; then
|
||||||
|
log_error "cert_publish: cannot create a staging file in $staging_dir"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
# 0600 while the temp file holds a private key; the final mode is matched
|
||||||
|
# to the file being replaced just before the swap (see below).
|
||||||
|
chmod 600 "$tmp" 2>/dev/null
|
||||||
|
|
||||||
|
if ! cat "$cert_file" "$key_file" > "$tmp"; then
|
||||||
|
log_error "cert_publish: failed to assemble $cert_file + $key_file (live $dest_file left untouched)"
|
||||||
|
rm -f "$tmp"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
if [ ! -s "$tmp" ]; then
|
||||||
|
log_error "cert_publish: assembled bundle for $dest_file is empty (live file left untouched)"
|
||||||
|
rm -f "$tmp"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# (d) never promote something HAProxy would choke on.
|
||||||
|
if ! cert_bundle_valid "$tmp"; then
|
||||||
|
log_error "cert_publish: assembled bundle for $dest_file failed validation (live file left untouched)"
|
||||||
|
rm -f "$tmp"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# (e) back up the bundle we are about to replace - but only if it is itself
|
||||||
|
# valid. Overwriting a good backup with garbage would turn "restore the
|
||||||
|
# backup" into "restore a different broken file". Same semantics as
|
||||||
|
# create_backup(require_valid=True) in haproxy_manager.py.
|
||||||
|
if [ -e "$dest_file" ]; then
|
||||||
|
backup_dir="$(cert_backup_dir)"
|
||||||
|
if cert_bundle_valid "$dest_file"; then
|
||||||
|
if mkdir -p "$backup_dir"; then
|
||||||
|
if ! cp -p "$dest_file" "${backup_dir}/${base}"; then
|
||||||
|
log_warn "could not back up $dest_file to ${backup_dir}/${base}; publishing anyway"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_warn "could not create backup directory $backup_dir; publishing without a backup"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_warn "existing $dest_file is not a valid bundle - KEEPING the previous backup" \
|
||||||
|
"in $backup_dir rather than overwriting it with an unusable one"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Preserve the mode of the bundle being replaced (0644 by default, which is
|
||||||
|
# what `cat > file` produced under the standard umask). mktemp gives 0600,
|
||||||
|
# and mv carries the temp file's mode onto the destination, so without this
|
||||||
|
# every publish would silently tighten the live pem's permissions. Changing
|
||||||
|
# who can read these files is not something a write-safety fix should do as
|
||||||
|
# a side effect - and it must match write_config_atomically() on the Python
|
||||||
|
# side, which preserves the mode the same way.
|
||||||
|
#
|
||||||
|
# -L (follow symlinks) matters: stat without it reports the mode of the
|
||||||
|
# SYMLINK, which is 0777 on Linux and is not a permission at all. A live
|
||||||
|
# pem that is a symlink therefore produced a world-WRITABLE 0777 private
|
||||||
|
# key sitting in the crt directory. With -L we copy the mode of the file
|
||||||
|
# the link points at, which is the mode an operator actually chose.
|
||||||
|
local mode
|
||||||
|
mode="$(stat -Lc '%a' "$dest_file" 2>/dev/null)"
|
||||||
|
[ -n "$mode" ] || mode=644
|
||||||
|
chmod "$mode" "$tmp" 2>/dev/null
|
||||||
|
|
||||||
|
# (f) atomic swap. Same filesystem, verified in (c); if it still fails,
|
||||||
|
# stop - do not fall back to writing into the certs dir.
|
||||||
|
if ! mv -f "$tmp" "$dest_file"; then
|
||||||
|
log_error "cert_publish: failed to move $tmp into place as $dest_file" \
|
||||||
|
"(live file left untouched; NOT falling back to a direct write)"
|
||||||
|
rm -f "$tmp"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
# haproxy_config_ok
|
||||||
|
#
|
||||||
|
# Gate a reload on `haproxy -c`. Returns 0 if the config validates, or if we
|
||||||
|
# cannot check (no haproxy binary) - a missing checker must not block a reload
|
||||||
|
# that is otherwise needed, but a checker that says "no" always wins.
|
||||||
|
haproxy_config_ok() {
|
||||||
|
local cfg="${HAPROXY_CONFIG:-/etc/haproxy/haproxy.cfg}"
|
||||||
|
local out rc
|
||||||
|
|
||||||
|
if ! command -v haproxy >/dev/null 2>&1; then
|
||||||
|
log_warn "haproxy binary not found - skipping 'haproxy -c' validation before reload"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
out="$(haproxy -c -f "$cfg" 2>&1 </dev/null)"
|
||||||
|
rc=$?
|
||||||
|
if [ $rc -eq 0 ]; then
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
log_error "haproxy -c -f $cfg failed (exit $rc): $out"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
@@ -8,6 +8,7 @@ LOG_FILE="${LOG_FILE:-/var/log/haproxy-manager.log}"
|
|||||||
ERROR_LOG_FILE="${ERROR_LOG_FILE:-/var/log/haproxy-manager-errors.log}"
|
ERROR_LOG_FILE="${ERROR_LOG_FILE:-/var/log/haproxy-manager-errors.log}"
|
||||||
DB_FILE="${DB_FILE:-/etc/haproxy/haproxy_config.db}"
|
DB_FILE="${DB_FILE:-/etc/haproxy/haproxy_config.db}"
|
||||||
SSL_CERTS_DIR="${SSL_CERTS_DIR:-/etc/haproxy/certs}"
|
SSL_CERTS_DIR="${SSL_CERTS_DIR:-/etc/haproxy/certs}"
|
||||||
|
LETSENCRYPT_LIVE_DIR="${LETSENCRYPT_LIVE_DIR:-/etc/letsencrypt/live}"
|
||||||
|
|
||||||
# Logging functions
|
# Logging functions
|
||||||
log_info() {
|
log_info() {
|
||||||
@@ -18,6 +19,18 @@ log_error() {
|
|||||||
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [ERROR] $*" | tee -a "$LOG_FILE" >> "$ERROR_LOG_FILE"
|
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [ERROR] $*" | tee -a "$LOG_FILE" >> "$ERROR_LOG_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Safe certificate publication helpers (cert_publish / cert_bundle_valid /
|
||||||
|
# haproxy_config_ok). Sourced AFTER the log_* functions above so the library
|
||||||
|
# uses this script's logging rather than its own fallbacks.
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
|
# shellcheck source=cert-publish-lib.sh
|
||||||
|
if [ -r "${SCRIPT_DIR}/cert-publish-lib.sh" ]; then
|
||||||
|
. "${SCRIPT_DIR}/cert-publish-lib.sh"
|
||||||
|
else
|
||||||
|
log_error "Missing ${SCRIPT_DIR}/cert-publish-lib.sh - refusing to touch live certificates"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
log_info "Starting certificate renewal process"
|
log_info "Starting certificate renewal process"
|
||||||
|
|
||||||
# Run certbot renewal — don't exit on failure, some certs may have
|
# Run certbot renewal — don't exit on failure, some certs may have
|
||||||
@@ -42,7 +55,7 @@ fi
|
|||||||
mkdir -p "$SSL_CERTS_DIR"
|
mkdir -p "$SSL_CERTS_DIR"
|
||||||
|
|
||||||
# Get all SSL-enabled domains from database
|
# Get all SSL-enabled domains from database
|
||||||
DOMAINS=$(find /etc/letsencrypt/live/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n')
|
DOMAINS=$(find "$LETSENCRYPT_LIVE_DIR/" -mindepth 1 -maxdepth 1 -type d -printf '%f\n')
|
||||||
|
|
||||||
if [ -z "$DOMAINS" ]; then
|
if [ -z "$DOMAINS" ]; then
|
||||||
log_info "No SSL-enabled domains found"
|
log_info "No SSL-enabled domains found"
|
||||||
@@ -54,13 +67,16 @@ UPDATED=0
|
|||||||
FAILED=0
|
FAILED=0
|
||||||
|
|
||||||
while read -r domain; do
|
while read -r domain; do
|
||||||
CERT_FILE="/etc/letsencrypt/live/${domain}/fullchain.pem"
|
CERT_FILE="${LETSENCRYPT_LIVE_DIR}/${domain}/fullchain.pem"
|
||||||
KEY_FILE="/etc/letsencrypt/live/${domain}/privkey.pem"
|
KEY_FILE="${LETSENCRYPT_LIVE_DIR}/${domain}/privkey.pem"
|
||||||
COMBINED_FILE="${SSL_CERTS_DIR}/${domain}.pem"
|
COMBINED_FILE="${SSL_CERTS_DIR}/${domain}.pem"
|
||||||
|
|
||||||
if [ -f "$CERT_FILE" ] && [ -f "$KEY_FILE" ]; then
|
if [ -f "$CERT_FILE" ] && [ -f "$KEY_FILE" ]; then
|
||||||
# Combine cert and key into single file for HAProxy
|
# Assemble in a staging dir and rename into place. NEVER redirect into
|
||||||
if cat "$CERT_FILE" "$KEY_FILE" > "$COMBINED_FILE"; then
|
# $COMBINED_FILE: the shell truncates the live pem before cat runs, and
|
||||||
|
# HAProxy loads $SSL_CERTS_DIR as a directory, so one bad file there
|
||||||
|
# takes down the whole ssl bind. See scripts/cert-publish-lib.sh.
|
||||||
|
if cert_publish "$CERT_FILE" "$KEY_FILE" "$COMBINED_FILE"; then
|
||||||
log_info "Updated certificate for $domain"
|
log_info "Updated certificate for $domain"
|
||||||
UPDATED=$((UPDATED + 1))
|
UPDATED=$((UPDATED + 1))
|
||||||
else
|
else
|
||||||
@@ -77,6 +93,13 @@ log_info "Certificate update completed: $UPDATED updated, $FAILED failed"
|
|||||||
|
|
||||||
# Reload HAProxy if any certificates were updated
|
# Reload HAProxy if any certificates were updated
|
||||||
if [ $UPDATED -gt 0 ]; then
|
if [ $UPDATED -gt 0 ]; then
|
||||||
|
# Never reload onto unvalidated material: a reload that fails to load the
|
||||||
|
# certs directory drops HTTPS for every site on this host.
|
||||||
|
if ! haproxy_config_ok; then
|
||||||
|
log_error "HAProxy configuration does not validate - refusing to reload after certificate renewal"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
if echo "reload" | socat stdio /tmp/haproxy-cli 2>/dev/null; then
|
if echo "reload" | socat stdio /tmp/haproxy-cli 2>/dev/null; then
|
||||||
log_info "HAProxy reloaded successfully"
|
log_info "HAProxy reloaded successfully"
|
||||||
else
|
else
|
||||||
@@ -85,5 +108,18 @@ if [ $UPDATED -gt 0 ]; then
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# A per-domain publication failure is a real failure and must be reported as
|
||||||
|
# one. This script used to `exit 0` no matter how many domains failed, so
|
||||||
|
# "0 updated, 12 failed" - a host that has completely stopped publishing
|
||||||
|
# renewals - looked identical to a clean run to cron, to
|
||||||
|
# host-renew-certificates.sh (which branches on this exit code) and to any
|
||||||
|
# external monitoring. The first visible symptom would have been certificates
|
||||||
|
# expiring. The loop above deliberately continues past a failed domain so the
|
||||||
|
# others still get published; the status is reported here instead.
|
||||||
|
if [ "$FAILED" -gt 0 ]; then
|
||||||
|
log_error "Certificate renewal process completed with failures: $UPDATED updated, $FAILED failed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
log_info "Certificate renewal process completed"
|
log_info "Certificate renewal process completed"
|
||||||
exit 0
|
exit 0
|
||||||
|
|||||||
@@ -22,6 +22,39 @@ mkdir -p /etc/haproxy
|
|||||||
[ -f /etc/haproxy/trusted_ips.list ] || : > /etc/haproxy/trusted_ips.list
|
[ -f /etc/haproxy/trusted_ips.list ] || : > /etc/haproxy/trusted_ips.list
|
||||||
[ -f /etc/haproxy/trusted_ips.map ] || : > /etc/haproxy/trusted_ips.map
|
[ -f /etc/haproxy/trusted_ips.map ] || : > /etc/haproxy/trusted_ips.map
|
||||||
|
|
||||||
|
# cloudflare_ips.list is SHIPPED DATA: it must always match what this image
|
||||||
|
# bakes in (/haproxy/defaults), so a Cloudflare range refresh actually reaches
|
||||||
|
# existing hosts instead of being permanently shadowed by the volume.
|
||||||
|
# Overwrite it from the baked copy on every start.
|
||||||
|
#
|
||||||
|
# trusted_proxies.list and wpadmin_gate_exempt.list are OPERATOR DATA:
|
||||||
|
# operators add entries directly on the server and those must survive
|
||||||
|
# restarts/recreates. Seed each from the baked copy only when it's missing;
|
||||||
|
# never overwrite an existing one.
|
||||||
|
#
|
||||||
|
# All branches fall back to an empty file if the baked default is somehow
|
||||||
|
# absent, because "acl ... -f <missing file>" is a fatal HAProxy config
|
||||||
|
# error -- the list files must exist unconditionally by the time HAProxy starts.
|
||||||
|
if [ -f /haproxy/defaults/cloudflare_ips.list ]; then
|
||||||
|
cp /haproxy/defaults/cloudflare_ips.list /etc/haproxy/cloudflare_ips.list
|
||||||
|
else
|
||||||
|
[ -f /etc/haproxy/cloudflare_ips.list ] || : > /etc/haproxy/cloudflare_ips.list
|
||||||
|
fi
|
||||||
|
if [ ! -f /etc/haproxy/trusted_proxies.list ]; then
|
||||||
|
if [ -f /haproxy/defaults/trusted_proxies.list ]; then
|
||||||
|
cp /haproxy/defaults/trusted_proxies.list /etc/haproxy/trusted_proxies.list
|
||||||
|
else
|
||||||
|
: > /etc/haproxy/trusted_proxies.list
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if [ ! -f /etc/haproxy/wpadmin_gate_exempt.list ]; then
|
||||||
|
if [ -f /haproxy/defaults/wpadmin_gate_exempt.list ]; then
|
||||||
|
cp /haproxy/defaults/wpadmin_gate_exempt.list /etc/haproxy/wpadmin_gate_exempt.list
|
||||||
|
else
|
||||||
|
: > /etc/haproxy/wpadmin_gate_exempt.list
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
cron &
|
cron &
|
||||||
|
|
||||||
# Phase 1: container init
|
# Phase 1: container init
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ LOG_FILE="${LOG_FILE:-/var/log/haproxy-manager.log}"
|
|||||||
ERROR_LOG_FILE="${ERROR_LOG_FILE:-/var/log/haproxy-manager-errors.log}"
|
ERROR_LOG_FILE="${ERROR_LOG_FILE:-/var/log/haproxy-manager-errors.log}"
|
||||||
DB_FILE="${DB_FILE:-/etc/haproxy/haproxy_config.db}"
|
DB_FILE="${DB_FILE:-/etc/haproxy/haproxy_config.db}"
|
||||||
SSL_CERTS_DIR="${SSL_CERTS_DIR:-/etc/haproxy/certs}"
|
SSL_CERTS_DIR="${SSL_CERTS_DIR:-/etc/haproxy/certs}"
|
||||||
|
LETSENCRYPT_LIVE_DIR="${LETSENCRYPT_LIVE_DIR:-/etc/letsencrypt/live}"
|
||||||
|
|
||||||
# Logging functions
|
# Logging functions
|
||||||
log_info() {
|
log_info() {
|
||||||
@@ -18,13 +19,25 @@ log_error() {
|
|||||||
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [ERROR] $*" | tee -a "$LOG_FILE" >> "$ERROR_LOG_FILE"
|
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [ERROR] $*" | tee -a "$LOG_FILE" >> "$ERROR_LOG_FILE"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# Safe certificate publication helpers (cert_publish / cert_bundle_valid /
|
||||||
|
# haproxy_config_ok). Sourced AFTER the log_* functions above so the library
|
||||||
|
# uses this script's logging rather than its own fallbacks.
|
||||||
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
|
# shellcheck source=cert-publish-lib.sh
|
||||||
|
if [ -r "${SCRIPT_DIR}/cert-publish-lib.sh" ]; then
|
||||||
|
. "${SCRIPT_DIR}/cert-publish-lib.sh"
|
||||||
|
else
|
||||||
|
log_error "Missing ${SCRIPT_DIR}/cert-publish-lib.sh - refusing to touch live certificates"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
log_info "Starting certificate sync process"
|
log_info "Starting certificate sync process"
|
||||||
|
|
||||||
# Ensure SSL certs directory exists
|
# Ensure SSL certs directory exists
|
||||||
mkdir -p "$SSL_CERTS_DIR"
|
mkdir -p "$SSL_CERTS_DIR"
|
||||||
|
|
||||||
# Get all SSL-enabled domains from database
|
# Get all SSL-enabled domains from database
|
||||||
DOMAINS=$(find /etc/letsencrypt/live/ -mindepth 1 -maxdepth 1 -type d -printf '%f\n')
|
DOMAINS=$(find "$LETSENCRYPT_LIVE_DIR/" -mindepth 1 -maxdepth 1 -type d -printf '%f\n')
|
||||||
|
|
||||||
if [ -z "$DOMAINS" ]; then
|
if [ -z "$DOMAINS" ]; then
|
||||||
log_info "No SSL-enabled domains found"
|
log_info "No SSL-enabled domains found"
|
||||||
@@ -36,13 +49,16 @@ UPDATED=0
|
|||||||
FAILED=0
|
FAILED=0
|
||||||
|
|
||||||
while read -r domain; do
|
while read -r domain; do
|
||||||
CERT_FILE="/etc/letsencrypt/live/${domain}/fullchain.pem"
|
CERT_FILE="${LETSENCRYPT_LIVE_DIR}/${domain}/fullchain.pem"
|
||||||
KEY_FILE="/etc/letsencrypt/live/${domain}/privkey.pem"
|
KEY_FILE="${LETSENCRYPT_LIVE_DIR}/${domain}/privkey.pem"
|
||||||
COMBINED_FILE="${SSL_CERTS_DIR}/${domain}.pem"
|
COMBINED_FILE="${SSL_CERTS_DIR}/${domain}.pem"
|
||||||
|
|
||||||
if [ -f "$CERT_FILE" ] && [ -f "$KEY_FILE" ]; then
|
if [ -f "$CERT_FILE" ] && [ -f "$KEY_FILE" ]; then
|
||||||
# Combine cert and key into single file for HAProxy
|
# Assemble in a staging dir and rename into place. NEVER redirect into
|
||||||
if cat "$CERT_FILE" "$KEY_FILE" > "$COMBINED_FILE"; then
|
# $COMBINED_FILE: the shell truncates the live pem before cat runs, and
|
||||||
|
# HAProxy loads $SSL_CERTS_DIR as a directory, so one bad file there
|
||||||
|
# takes down the whole ssl bind. See scripts/cert-publish-lib.sh.
|
||||||
|
if cert_publish "$CERT_FILE" "$KEY_FILE" "$COMBINED_FILE"; then
|
||||||
log_info "Updated certificate for $domain"
|
log_info "Updated certificate for $domain"
|
||||||
UPDATED=$((UPDATED + 1))
|
UPDATED=$((UPDATED + 1))
|
||||||
else
|
else
|
||||||
@@ -59,6 +75,13 @@ log_info "Certificate sync completed: $UPDATED updated, $FAILED failed"
|
|||||||
|
|
||||||
# Reload HAProxy if any certificates were updated
|
# Reload HAProxy if any certificates were updated
|
||||||
if [ $UPDATED -gt 0 ]; then
|
if [ $UPDATED -gt 0 ]; then
|
||||||
|
# Never reload onto unvalidated material: a reload that fails to load the
|
||||||
|
# certs directory drops HTTPS for every site on this host.
|
||||||
|
if ! haproxy_config_ok; then
|
||||||
|
log_error "HAProxy configuration does not validate - refusing to reload after certificate sync"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
if echo "reload" | socat stdio /tmp/haproxy-cli 2>/dev/null; then
|
if echo "reload" | socat stdio /tmp/haproxy-cli 2>/dev/null; then
|
||||||
log_info "HAProxy reloaded successfully"
|
log_info "HAProxy reloaded successfully"
|
||||||
else
|
else
|
||||||
@@ -67,5 +90,12 @@ if [ $UPDATED -gt 0 ]; then
|
|||||||
fi
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# See the matching block in renew-certificates.sh: a run in which every domain
|
||||||
|
# failed to publish must not look like a clean run to its caller.
|
||||||
|
if [ "$FAILED" -gt 0 ]; then
|
||||||
|
log_error "Certificate sync process completed with failures: $UPDATED updated, $FAILED failed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
log_info "Certificate sync process completed"
|
log_info "Certificate sync process completed"
|
||||||
exit 0
|
exit 0
|
||||||
|
|||||||
Executable
+958
@@ -0,0 +1,958 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for the certificate publication shell scripts.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
renew-certificates.sh and sync-certificates.sh published a bundle with
|
||||||
|
|
||||||
|
cat "$CERT_FILE" "$KEY_FILE" > "$COMBINED_FILE"
|
||||||
|
|
||||||
|
where $COMBINED_FILE is the pem HAProxy is serving *right now*. The shell
|
||||||
|
truncates the destination when it opens the redirect, before cat runs, so any
|
||||||
|
failure after that point - unreadable source key, ENOSPC, container killed
|
||||||
|
mid-write - left a zero-length or key-less pem behind. The exit status of cat
|
||||||
|
was checked, but by then the live file was already destroyed.
|
||||||
|
|
||||||
|
HAProxy loads $SSL_CERTS_DIR as a DIRECTORY (`bind :443 ssl crt /etc/haproxy/
|
||||||
|
certs`) and tries to load every file in it, so a single unloadable file fails
|
||||||
|
the whole bind: HTTPS down for every customer on the host.
|
||||||
|
|
||||||
|
The fix (scripts/cert-publish-lib.sh) assembles into a sibling staging dir,
|
||||||
|
validates, backs up the outgoing bundle into a sibling backup dir, and renames
|
||||||
|
into place. These tests pin the observable guarantees:
|
||||||
|
|
||||||
|
* a successful publish replaces the live pem and archives the old one;
|
||||||
|
* a FAILED publish leaves the previous, still-valid pem byte-for-byte intact;
|
||||||
|
* nothing that is not a final *.pem ever appears in the certs directory;
|
||||||
|
* HAProxy is not reloaded when `haproxy -c` rejects the configuration.
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/test-cert-scripts.py # tests the repo checkout
|
||||||
|
HAPROXY_MANAGER_DIR=/some/other/tree \
|
||||||
|
python3 scripts/test-cert-scripts.py # tests another tree
|
||||||
|
|
||||||
|
Self-contained stdlib unittest - no pytest, no venv, no bats, and nothing is
|
||||||
|
imported from the application. The scripts are driven as subprocesses with
|
||||||
|
every path they touch redirected by environment variable (SSL_CERTS_DIR,
|
||||||
|
LETSENCRYPT_LIVE_DIR, CERT_STAGING_DIR, CERT_BACKUP_DIR, LOG_FILE,
|
||||||
|
ERROR_LOG_FILE, HAPROXY_CONFIG) and stub `certbot`, `socat` and `haproxy`
|
||||||
|
binaries on PATH.
|
||||||
|
|
||||||
|
The certificate material below is a real self-signed test certificate with its
|
||||||
|
matching key (plus a second, unrelated key for the mismatch case), embedded as
|
||||||
|
constants so the tests need no openssl to *create* material. openssl IS needed
|
||||||
|
to run them: the library's cert/key pairing check is mandatory (it is the only
|
||||||
|
layer that can reject a bundle of empty pem blocks), so without the binary
|
||||||
|
every publish is refused by design. The image ships openssl 3.x.
|
||||||
|
|
||||||
|
The acceptance bar for this file is a green run INSIDE the built image, as
|
||||||
|
root, which is where these scripts actually execute - not on a workstation.
|
||||||
|
Several failure modes are invisible outside the container (root ignores the
|
||||||
|
directory permissions one test used to rely on) and one was actively
|
||||||
|
destructive there; see _cleanup_tmp().
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
import stat
|
||||||
|
import subprocess
|
||||||
|
import tempfile
|
||||||
|
import textwrap
|
||||||
|
import time
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
SCRIPTS_DIR = os.path.join(MODULE_DIR, 'scripts')
|
||||||
|
LIB = os.path.join(SCRIPTS_DIR, 'cert-publish-lib.sh')
|
||||||
|
|
||||||
|
BROKEN_TOKEN = '__BROKEN__'
|
||||||
|
DOMAIN = 'test.example.com'
|
||||||
|
|
||||||
|
# --- test key material -------------------------------------------------------
|
||||||
|
# openssl req -x509 -newkey rsa:2048 -keyout key1 -out cert1 -days 3650 -nodes \
|
||||||
|
# -subj /CN=test.example.com
|
||||||
|
TEST_CERT = """\
|
||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDFzCCAf+gAwIBAgIUeaz/lNOESOTHsB3Y97+Xja7Fy4gwDQYJKoZIhvcNAQEL
|
||||||
|
BQAwGzEZMBcGA1UEAwwQdGVzdC5leGFtcGxlLmNvbTAeFw0yNjA4MDYxNTQyMTda
|
||||||
|
Fw0zNjA4MDMxNTQyMTdaMBsxGTAXBgNVBAMMEHRlc3QuZXhhbXBsZS5jb20wggEi
|
||||||
|
MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDF5GL7Gjn+UnPFy5sqP2k4XHth
|
||||||
|
mkWFZj+mjK6cDhbBXYt60NrwVdrrgOFydMC75VeUceFxG/5GD7wrXZP23xzbnWKm
|
||||||
|
7FxfOSmr4y+1rVEZwi8IeWEz3W6C6y5rjZsCI+pBgdna+aJSpTQZHPfDpNtQm5vl
|
||||||
|
enj5BfizYixinORxm9kvXMGXV+Cw1CJkqB3mzScwWt40EtQoVxekebf8B7i4ZHyx
|
||||||
|
xT6/xwF+WY8OliZkY1pdqncoTLUAYcaE/HR/ojJKmSVIq1GswZE/y3E56LIwq+wJ
|
||||||
|
eGbgH46a+86z+VO2UX1jbad1kWKBCsRoOpaybZDEWAYTOqahW7kOH7umTUsRAgMB
|
||||||
|
AAGjUzBRMB0GA1UdDgQWBBTIqa3BNEjjcxkhXqnRwInrLM9yijAfBgNVHSMEGDAW
|
||||||
|
gBTIqa3BNEjjcxkhXqnRwInrLM9yijAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3
|
||||||
|
DQEBCwUAA4IBAQB/lYzXb5PI3magMz/IXmwTsMCrVSdaUYEIKLEJggmbGxqpwO1a
|
||||||
|
iYagWZ/5H3B9KDvNQA+L4FkMJ726ZkdGEH/vkwvTAuhwU2NSWcbRJ8DK5u3Q4rnJ
|
||||||
|
VswPcW5njUF9mQq0NPX/PMCeOoFDEI8+RrgQZxtHhopwuKOgVA6HRBINKdEZJlrp
|
||||||
|
oLLQrHDNVLMYTclNHG6kBg0lOHUV31TgkJQ8kMgtq0WQX7RseKR10QKgN5iOBomU
|
||||||
|
3+y713Ibpac5B1zw5l3LjE/59xFteFbDENr2+A5VGhVNVZC+bs+YTYTzeAsGB0e3
|
||||||
|
MQ+XJMJq3kaJmQ+QcTrRaKMtoMz2h1AIRbLd
|
||||||
|
-----END CERTIFICATE-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
# The private key that matches TEST_CERT.
|
||||||
|
TEST_KEY = """\
|
||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQDF5GL7Gjn+UnPF
|
||||||
|
y5sqP2k4XHthmkWFZj+mjK6cDhbBXYt60NrwVdrrgOFydMC75VeUceFxG/5GD7wr
|
||||||
|
XZP23xzbnWKm7FxfOSmr4y+1rVEZwi8IeWEz3W6C6y5rjZsCI+pBgdna+aJSpTQZ
|
||||||
|
HPfDpNtQm5vlenj5BfizYixinORxm9kvXMGXV+Cw1CJkqB3mzScwWt40EtQoVxek
|
||||||
|
ebf8B7i4ZHyxxT6/xwF+WY8OliZkY1pdqncoTLUAYcaE/HR/ojJKmSVIq1GswZE/
|
||||||
|
y3E56LIwq+wJeGbgH46a+86z+VO2UX1jbad1kWKBCsRoOpaybZDEWAYTOqahW7kO
|
||||||
|
H7umTUsRAgMBAAECggEAA9SnFFqGfR1yO4XUlfmmgyZqJoJmnl2TdZlDT4bHyrwx
|
||||||
|
dSIKHO0iiNzEsHMhYHnA62EVdruunUNUdofwE28v9zHZnSbV5mt8OqUyERue5mdf
|
||||||
|
gvPbjXYXu63LBx61fZH9qME3WwFqUpx7UNGiW62LJ8ktWEC5ywNCNFG+D3YfR3Iu
|
||||||
|
v3PdIFXwkpJMaXO+42JSoSVoiqxlONqNiqcdQj64iYgCYdNxcgdLy+mHGrf1hAZs
|
||||||
|
dom2Jp0oEM4ZdOQu3Z6uyEyPsECiz1PdQjzagaEfPWtKCQk0kY8DDCn5X2xQif9w
|
||||||
|
3xeaISqho7bQgSo4IEgWHTP6V0v7brTP7VcK+gyMyQKBgQD15FrE4XAL89NBQ6iX
|
||||||
|
m2l6quZv5tIUtreuYxsOpFIMU22zfsRZOvA7sJR3ufOJ+b7tFHuJ8DAJUpK08Vvg
|
||||||
|
A930/LW9wUsY42d54XKIO/8DTsIrmjppoGdshs3axJQkqfN0zQkhqfbwaXRJ9X2k
|
||||||
|
Fvax+5jftaIaw0hQdWLnfTmGmQKBgQDOBue89D8THYl/LvDGg6WoVyK3ljBMK2s3
|
||||||
|
4BljeZCJdWAjtido13Mltubc6YVHScmVoIZKTmx+fCjdQ3y1t92vZZSBeLsXhfFr
|
||||||
|
N+IOGZu3ZmJu64x3OukSYQ7x6agi5yP3+7k0siZgxOMXJRQDYZUcHxIHDrSGLeLZ
|
||||||
|
sj7LnbvLOQKBgE8murE1gEPYsOAJT3O96y45ZQQQYP+Z8XaJIGSOMHsXP/DPlZTD
|
||||||
|
jCEqrh/8E5EOe48FUN8OGehmVCM6rkBl/kSmNDpoxiu0x9JL5/pClcwSxh4S/0qQ
|
||||||
|
/7nHiuwo6ycCLgQjHBViCMNKrsw/4bm4SqDwRD1+0jebNOPxZWzuul3BAoGAZij0
|
||||||
|
ZjSyxhbCZEdxau5CiYvTkjct8cch3k4IKNRRwGdsaajcN9eFqHDeXzKIPQYwqDo1
|
||||||
|
/MiQcdO9K6JYR39JtLxo/B5Sn2JyiJjoRdea6EEjlB7GwyR6B/wKvhf/oHb+1euD
|
||||||
|
NccU0q0ucf6XwulzV8NsXAWFrHc6YnpJOwwW37kCgYAkEyjUc73jImiTyf/IXVOD
|
||||||
|
UHlRXZPvwtZUuPGe4RI0Gds97tKnvXnvFsPIRCOGfVzZ8z79DGiQ8TR2a0hgZec1
|
||||||
|
Mo3J2dCjlv4Q6ACjHkCA1cmi13OHUPnpaeesrOk+SpEVJfR2k4qRWH4z3oxbPO/q
|
||||||
|
TDFnjWHSgjkDMrxVHZ8wPg==
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
# A perfectly valid RSA key that has nothing to do with TEST_CERT.
|
||||||
|
UNRELATED_KEY = """\
|
||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDE7mosrsdBhdn1
|
||||||
|
ZIErYmMuPU69ws51JdyqwtRZlV2uLLby0dOfJpFKZPuBPEqTqDimd9N4FSL0CGjG
|
||||||
|
zXG23RYd9AbdSoorFORrUxeiPzFnbz4v38srGHckOS9ozKAbPLACUEjWMX1NwAZ+
|
||||||
|
wGlSz3cWYTWVztFCUIxpvLVR87PSpTnpdCXIj0EABOc6WoLBLE+v2knZOa63LKg6
|
||||||
|
GryInD43CnWFBKpH0gdgWqh+ie3NFMumLR8M3lZq2Mk0EFgVWrxPnJobYvOmavNp
|
||||||
|
NBR3ZugR4X57c1YFyLkYXQIdhxuYV1ZAY6NgmAIsaiCKFqdksF5AJSV7FZNBM43r
|
||||||
|
33ae/R5hAgMBAAECggEAIgNYsL9+OEWtU8ooWi0r2q5plXJaVNb1gkPUx+U5sS3V
|
||||||
|
amKNxbj0UrBW1Scr7U1afXwIOP8TkqkKKb4NpCsS2RkO/3USoKbC3fuTwyjdeFM5
|
||||||
|
Hy0sytR2rXm4A8aF57ZnYvrpXZ9eGEnwhT9n4Y7mL2YaSnXWZDkDy3Z1rcIk/p5P
|
||||||
|
jUo4UQyzD/9Gab1stcBbGv+66B3mlVdRVJor5+tGn6zmr4TjvqupAexuXd+Q6+1L
|
||||||
|
OG4e2bAUmuOVOa+w8Xo4vwkiXSDLVEsl1z1x4Bcrv61bIg0rbZAeqcZ4EUPyrEyR
|
||||||
|
RpaaOLAiwdzjOj5pQvHAF2q/++IlY6xPhotTr11tvQKBgQD37C2UQRGRo622+2kx
|
||||||
|
qgsdA6jPM9vCE9S4aS4qaOj8XSMMCu6bQW5lU48DaONvXxDmT6x9IrgR3QN1Iz/t
|
||||||
|
17kUCCghuviEP1RjnahBRQqZR38KdDzKhaWt9jgdjCun9MzUXIaQRTFlFGA1z1pz
|
||||||
|
apZ9a8/ehYPSk4pv9h06/B3IjQKBgQDLWPBuhj203QOmwVF1v1k4yyuJ7UBqtRaY
|
||||||
|
I9jMW93sB2hPs6Se10UroQHlF95IHeRXvNKH/UXuAILIJMN8oTI4uU7t60shJHvI
|
||||||
|
o14RzEZoUQjES7BBVhePglndJmYIKoKKAX5lSFe9Lk0ei9B+1Dle5Q+9ZeP09cp4
|
||||||
|
vVcGvOgqJQKBgQCtxe1srO8TlhZ821uwY+/GNnpsQX0XW68OUyr4rvAfc2jNWBxG
|
||||||
|
1mX6v8bOLQa9WXUO+Wl9jIhYfQGfaUW2AC7Jy63VdqgaigksiaUVmr8DEQoK2c6C
|
||||||
|
ZYrrlFlg3I78+qlXcEMhfF5S6yVEkkJkA6HX52mcHxl2z9OJBokWfwChQQKBgAzH
|
||||||
|
xzy7FS/D4FHfvpXu89Wc91yQ28aZIRVo01xsvbLy+DxiJwuQrhlC4lKawG656jsV
|
||||||
|
dAn2AiomQBICNYMkwnpMM0jCzBMGLv16PxRRSW+PAEUOGMLSfWKYp7s9iZYjzdaM
|
||||||
|
p3wIIvOR8GjmErGV9xEexnF58OzZceNKyyhyQQk9AoGAbvjJvYLOhQpAbbqErNNv
|
||||||
|
LK1P+TngKpukRHXjiUpPVEGNhN6krBBJCBWzY7ucrIy6jz8UBy7SbITBy7qIKhxZ
|
||||||
|
PVP7WVATMWEeW1AfdBfCYDI4jFKAD8SLECby45nRBuBllYdQnW1gBzLcCulCwB+w
|
||||||
|
FV0RvuQPDYkqsx8ibqpSv7c=
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
# A SECOND, unrelated but internally consistent pair. Needed by the
|
||||||
|
# concurrency test: two bundles that are each perfectly valid but whose keys
|
||||||
|
# differ, so a validator that reads the certificate from one and the key from
|
||||||
|
# the other reports a mismatch. Two bundles sharing key material - which is
|
||||||
|
# what PREVIOUS_BUNDLE and NEW_BUNDLE are - cannot detect that at all.
|
||||||
|
# openssl req -x509 -newkey rsa:2048 -nodes -days 3650 \
|
||||||
|
# -subj /CN=second.example.com
|
||||||
|
TEST_CERT_2 = """\
|
||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDGzCCAgOgAwIBAgIUKQAAvrVkden7gIg2zYMLb6dO1c8wDQYJKoZIhvcNAQEL
|
||||||
|
BQAwHTEbMBkGA1UEAwwSc2Vjb25kLmV4YW1wbGUuY29tMB4XDTI2MDgwNjE2NTcz
|
||||||
|
NVoXDTM2MDgwMzE2NTczNVowHTEbMBkGA1UEAwwSc2Vjb25kLmV4YW1wbGUuY29t
|
||||||
|
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv2pfTOvN2zrZJ6d+biiD
|
||||||
|
VOczMqanuHPBCy2CnTBif+7VWf8AaywRzQ3ShfhmalVRNEFMn0MSO+GocmH71Ve1
|
||||||
|
nl89oGiJPmvX1lpncbgM692ddhP9ez4xUeNj+QAWp9VBZhInNuM4Pawv5BPngtpj
|
||||||
|
2MGXf3ZlBSli8Ng7jBo1fTMT3bh8GcE1rIPRvmUuQwFIt2eGnLR8jQd+xGelhAjG
|
||||||
|
nnXtlc+ebo4r2OjljNgvtdUknBZdpiZXmjdFzyClYTeMuEen2uwMpJNc0wLbRjcU
|
||||||
|
khVF3nw4jUnkOhWH3JYGAoWslJyEqZSANwt/eOHwXgyVuxg31bCl297iskW0IRZL
|
||||||
|
wQIDAQABo1MwUTAdBgNVHQ4EFgQU7HH8GacJzc2j9s2UJCPwykgrIckwHwYDVR0j
|
||||||
|
BBgwFoAU7HH8GacJzc2j9s2UJCPwykgrIckwDwYDVR0TAQH/BAUwAwEB/zANBgkq
|
||||||
|
hkiG9w0BAQsFAAOCAQEAYE5jHX1dK091jVsFSZDdiw9AU5rrk8XpF1yuPmDisRnE
|
||||||
|
dJ4QQq3dzWXRnp0bzZnq7fdfiEz1m39zVixov7WFp24QhenD2n5K7/wew7RpXTnA
|
||||||
|
pAGBEdsGvBJ+3MgkRYklXCM9f9f4z21xXRNZ+BwBcM25D+gR4b+PRMQR6BhZx5R+
|
||||||
|
y2jQsoM68cFjRApFWgmji4pBjg/eOaZMBCfVTjP+npVyqG7UtV5EyYXwPgPa/rm2
|
||||||
|
FoP+eftzP6dszBEonkIVyyvkdscI4Wkr8hw3S0R/TP8l9lTnvN1HC3o7Es5VY53R
|
||||||
|
swNAXWBlgm0N7A96ISLtQjgvOfeMRTCSjxW9pm0wJA==
|
||||||
|
-----END CERTIFICATE-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
TEST_KEY_2 = """\
|
||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQC/al9M683bOtkn
|
||||||
|
p35uKINU5zMypqe4c8ELLYKdMGJ/7tVZ/wBrLBHNDdKF+GZqVVE0QUyfQxI74ahy
|
||||||
|
YfvVV7WeXz2gaIk+a9fWWmdxuAzr3Z12E/17PjFR42P5ABan1UFmEic24zg9rC/k
|
||||||
|
E+eC2mPYwZd/dmUFKWLw2DuMGjV9MxPduHwZwTWsg9G+ZS5DAUi3Z4actHyNB37E
|
||||||
|
Z6WECMaede2Vz55ujivY6OWM2C+11SScFl2mJleaN0XPIKVhN4y4R6fa7Aykk1zT
|
||||||
|
AttGNxSSFUXefDiNSeQ6FYfclgYChayUnISplIA3C3944fBeDJW7GDfVsKXb3uKy
|
||||||
|
RbQhFkvBAgMBAAECggEABQLqy6eedRPt31sLOMFEDkzbZdFHOMpZeuqThsNmjo7z
|
||||||
|
t9diokgeD4ZQXimbEQqsZYDAtmFGdiEp86I9JQBk/4TUiqFhHrOADBe1jQAptjfs
|
||||||
|
iyIb51gIPnjZ1RBA5Al8zohy28T9h1+Z7+/OeCvcgLyVAixf/U9pU8D1El9cu9zv
|
||||||
|
4q4WJPB5Tgkq+YwcmeuT8LzsKoSDmPQjFVY9v+gz6hoVUVyP6gswnlFnKjNcmfZU
|
||||||
|
0CKP90sCAc5mKZv7RyGG920LDU4u2ggnQoK05GhXK8R3amJmoAF3i+xGeTRvNEKe
|
||||||
|
wDC7NinTG2WDVo6y/FCvFKs0+qqlKww1u39fq166rQKBgQDtjPjvkDkSYFcWFznn
|
||||||
|
sfsxN5R1cLpxdutLZhfvtpHIj5NkQbmOk0r3LbDAwU+UNVQ6F8jWQVHUsni9jAY6
|
||||||
|
3RNRF4ZabC51aqg/Ssj7d5mE4kj7y6Ch/nnSXIogRxLG4bWo2rtG1M2Dt3Ef08R4
|
||||||
|
6gjcp9ZmELyVx7H4yXFJGIaDdQKBgQDOSCHFK/ggZzzy4iC7DOq1lrbR+jyk95rh
|
||||||
|
F5EGzyAkgJ4uYc9TCPkUDxXjWL17r61/obfbW4znaV9fHEKpz3R54osDXln3oLea
|
||||||
|
BBWkJI3ANe8iNrGDE4FN9to4DdUMFsWX/WEiRyBPIqDy9DTyadblMLTNZjNPuLmg
|
||||||
|
ZJOB3tRZnQKBgQCjeglya9Eq2Uv1MuSxk2VnmHU9YOed4BXLHKZKXFz1JgFr1GNL
|
||||||
|
QAguFK536FDIkO62z9lxwR/8fRnkb7F13uBFRSg7oAlU2qKQc/nePI9UyJkrVxXj
|
||||||
|
hYn2f6K61c6ROZFXc7e/5gDMrXhXS9gA0iZpG8PLF6eAeB39NTwV7p/bZQKBgQCV
|
||||||
|
v5eEY58FJu0ABVhtcbsRiA+/70EHIRi2Pz1xC/vxg81RLoArb2AiR7FEEa+8kpQJ
|
||||||
|
C4VFIPjxJXWuvf1G+Os9cFAqadw1/95JWJ29QywEVSL8W2gSF57O0l0oRCJdXEql
|
||||||
|
Q7O4BppV2HWu6clmEZ+HUgxu77pgLWHUJi9PIExXoQKBgEq6rYBXmsSQermnPTOn
|
||||||
|
YFx7c2ns97hsjYIbs497+gPW4/xQWwsN76t60SWqjXV4DHJCpi5Tnjo2fk5/OzK+
|
||||||
|
HfshC9CKFDk8T0KGQWwaPwqP/OYbqOA88IlJ7xbPdSuJkjefHCtVVEtao6+HNgzm
|
||||||
|
lniLtDMpU0MLPgB98ClQ4HDA
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
# The bundle already on disk when a run starts. Same key material, plus a
|
||||||
|
# trailing marker so "the live file was replaced" and "the old file was
|
||||||
|
# archived" can be told apart byte-for-byte.
|
||||||
|
PREVIOUS_BUNDLE = TEST_CERT + TEST_KEY + '# previous bundle\n'
|
||||||
|
NEW_BUNDLE = TEST_CERT + TEST_KEY
|
||||||
|
OTHER_BUNDLE = TEST_CERT_2 + TEST_KEY_2
|
||||||
|
|
||||||
|
# --- stub binaries -----------------------------------------------------------
|
||||||
|
STUB_CERTBOT = """\
|
||||||
|
#!/bin/sh
|
||||||
|
# Test stub for certbot: pretend there was nothing to renew.
|
||||||
|
echo "No renewals were attempted."
|
||||||
|
exit 0
|
||||||
|
"""
|
||||||
|
|
||||||
|
STUB_SOCAT = """\
|
||||||
|
#!/bin/sh
|
||||||
|
# Test stub for socat: record that a reload was attempted, and what was sent.
|
||||||
|
{ printf 'socat %s <<' "$*"; cat; printf '>>\\n'; } >> "$SOCAT_LOG"
|
||||||
|
exit 0
|
||||||
|
"""
|
||||||
|
|
||||||
|
STUB_HAPROXY = """\
|
||||||
|
#!/bin/sh
|
||||||
|
# Test stub for the haproxy binary: `haproxy -c -f FILE` rejects any config
|
||||||
|
# containing %(token)s, which is how the tests inject an invalid config.
|
||||||
|
cfg=""
|
||||||
|
while [ $# -gt 0 ]; do
|
||||||
|
case "$1" in -f) cfg="$2"; shift ;; esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
if [ -n "$cfg" ] && grep -q '%(token)s' "$cfg" 2>/dev/null; then
|
||||||
|
echo "[ALERT] parsing [$cfg:1] : unknown keyword '%(token)s'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
exit 0
|
||||||
|
""" % {'token': BROKEN_TOKEN}
|
||||||
|
|
||||||
|
GOOD_HAPROXY_CFG = textwrap.dedent("""\
|
||||||
|
global
|
||||||
|
daemon
|
||||||
|
defaults
|
||||||
|
mode http
|
||||||
|
frontend fe
|
||||||
|
bind 0.0.0.0:443 ssl crt /etc/haproxy/certs
|
||||||
|
""")
|
||||||
|
|
||||||
|
|
||||||
|
def write(path, content, mode=None):
|
||||||
|
with open(path, 'w') as fh:
|
||||||
|
fh.write(content)
|
||||||
|
if mode is not None:
|
||||||
|
os.chmod(path, mode)
|
||||||
|
return path
|
||||||
|
|
||||||
|
|
||||||
|
def read(path):
|
||||||
|
with open(path) as fh:
|
||||||
|
return fh.read()
|
||||||
|
|
||||||
|
|
||||||
|
class CertScriptFixture(unittest.TestCase):
|
||||||
|
"""An isolated fake /etc/haproxy + /etc/letsencrypt plus stub binaries."""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
# Without the library every "the library rejects X" assertion in this
|
||||||
|
# file can be satisfied by bash exiting 127, so make its absence a
|
||||||
|
# failure of every test rather than a silent pass of several.
|
||||||
|
self.assertTrue(os.path.isfile(LIB),
|
||||||
|
f'{LIB} is missing - nothing below tests anything')
|
||||||
|
|
||||||
|
self.tmp = tempfile.mkdtemp(prefix='haproxy-cert-test-')
|
||||||
|
self.addCleanup(self._cleanup_tmp)
|
||||||
|
|
||||||
|
self.bindir = os.path.join(self.tmp, 'bin')
|
||||||
|
os.makedirs(self.bindir)
|
||||||
|
write(os.path.join(self.bindir, 'certbot'), STUB_CERTBOT, 0o755)
|
||||||
|
write(os.path.join(self.bindir, 'socat'), STUB_SOCAT, 0o755)
|
||||||
|
write(os.path.join(self.bindir, 'haproxy'), STUB_HAPROXY, 0o755)
|
||||||
|
self.socat_log = os.path.join(self.tmp, 'socat-invocations.log')
|
||||||
|
|
||||||
|
# Mirrors the real layout: certs dir, with staging/backups as SIBLINGS.
|
||||||
|
self.haproxy_dir = os.path.join(self.tmp, 'etc', 'haproxy')
|
||||||
|
self.certs_dir = os.path.join(self.haproxy_dir, 'certs')
|
||||||
|
self.staging_dir = os.path.join(self.haproxy_dir, 'cert-staging')
|
||||||
|
self.backup_dir = os.path.join(self.haproxy_dir, 'cert-backups')
|
||||||
|
os.makedirs(self.certs_dir)
|
||||||
|
|
||||||
|
self.le_live = os.path.join(self.tmp, 'etc', 'letsencrypt', 'live')
|
||||||
|
self.domain_dir = os.path.join(self.le_live, DOMAIN)
|
||||||
|
os.makedirs(self.domain_dir)
|
||||||
|
self.src_cert = write(os.path.join(self.domain_dir, 'fullchain.pem'), TEST_CERT)
|
||||||
|
self.src_key = write(os.path.join(self.domain_dir, 'privkey.pem'), TEST_KEY)
|
||||||
|
|
||||||
|
self.live_pem = os.path.join(self.certs_dir, DOMAIN + '.pem')
|
||||||
|
self.haproxy_cfg = write(os.path.join(self.haproxy_dir, 'haproxy.cfg'),
|
||||||
|
GOOD_HAPROXY_CFG)
|
||||||
|
self.log_file = os.path.join(self.tmp, 'haproxy-manager.log')
|
||||||
|
self.error_log = os.path.join(self.tmp, 'haproxy-manager-errors.log')
|
||||||
|
|
||||||
|
def _cleanup_tmp(self):
|
||||||
|
# A test may have chmod 000'd a fixture file, which would stop rmtree.
|
||||||
|
#
|
||||||
|
# SYMLINKS ARE SKIPPED, and that is not a nicety. os.chmod() FOLLOWS
|
||||||
|
# symlinks, and the openssl-availability tests below build a stripped
|
||||||
|
# PATH directory out of symlinks to real system binaries (/usr/bin/cat,
|
||||||
|
# /usr/bin/chmod, ...). Walking those with chmod 0600 as root - which is
|
||||||
|
# how this container runs - stripped the exec bit from a dozen core
|
||||||
|
# binaries of the machine running the tests, chmod itself included, so
|
||||||
|
# it could not even be undone from inside the container: every later
|
||||||
|
# test failed with "/usr/bin/grep: Permission denied" and certificate
|
||||||
|
# publishing stayed dead until the container was recreated. It never
|
||||||
|
# showed up on a workstation because an unprivileged chmod of a
|
||||||
|
# root-owned file fails EPERM and was swallowed by `except OSError`.
|
||||||
|
# This file ships in the image (COPY scripts /haproxy/scripts), so
|
||||||
|
# running it in place is a thing an operator will do.
|
||||||
|
for root, dirs, files in os.walk(self.tmp):
|
||||||
|
for name in files:
|
||||||
|
path = os.path.join(root, name)
|
||||||
|
if os.path.islink(path):
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
os.chmod(path, 0o600)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
shutil.rmtree(self.tmp, ignore_errors=True)
|
||||||
|
|
||||||
|
# -- helpers ---------------------------------------------------------
|
||||||
|
def env(self, **overrides):
|
||||||
|
env = dict(os.environ)
|
||||||
|
env.update({
|
||||||
|
'PATH': self.bindir + os.pathsep + os.environ['PATH'],
|
||||||
|
'SSL_CERTS_DIR': self.certs_dir,
|
||||||
|
'LETSENCRYPT_LIVE_DIR': self.le_live,
|
||||||
|
'CERT_STAGING_DIR': self.staging_dir,
|
||||||
|
'CERT_BACKUP_DIR': self.backup_dir,
|
||||||
|
'LOG_FILE': self.log_file,
|
||||||
|
'ERROR_LOG_FILE': self.error_log,
|
||||||
|
'HAPROXY_CONFIG': self.haproxy_cfg,
|
||||||
|
'SOCAT_LOG': self.socat_log,
|
||||||
|
})
|
||||||
|
env.update(overrides)
|
||||||
|
return env
|
||||||
|
|
||||||
|
def run_script(self, name, **env_overrides):
|
||||||
|
path = os.path.join(SCRIPTS_DIR, name)
|
||||||
|
self.assertTrue(os.path.exists(path), f'{path} does not exist')
|
||||||
|
return subprocess.run(['bash', path], env=self.env(**env_overrides),
|
||||||
|
capture_output=True, text=True, timeout=120)
|
||||||
|
|
||||||
|
def bundle_is_valid(self, path):
|
||||||
|
"""Ask the shipped library whether HAProxy could use this bundle."""
|
||||||
|
return subprocess.run(
|
||||||
|
['bash', '-c', '. "$1"; cert_bundle_valid "$2"', '_', LIB, path],
|
||||||
|
env=self.env(), capture_output=True, text=True).returncode == 0
|
||||||
|
|
||||||
|
def reload_attempted(self):
|
||||||
|
return os.path.exists(self.socat_log) and os.path.getsize(self.socat_log) > 0
|
||||||
|
|
||||||
|
def logs(self):
|
||||||
|
text = ''
|
||||||
|
for path in (self.log_file, self.error_log):
|
||||||
|
if os.path.exists(path):
|
||||||
|
text += read(path)
|
||||||
|
return text
|
||||||
|
|
||||||
|
def seed_previous_bundle(self, content=PREVIOUS_BUNDLE):
|
||||||
|
return write(self.live_pem, content)
|
||||||
|
|
||||||
|
def assert_certs_dir_is_clean(self):
|
||||||
|
"""HAProxy loads this directory wholesale: only final *.pem may be here."""
|
||||||
|
entries = sorted(os.listdir(self.certs_dir))
|
||||||
|
strays = [e for e in entries if not e.endswith('.pem')]
|
||||||
|
self.assertEqual(strays, [],
|
||||||
|
f'non-.pem files left in the certs directory HAProxy '
|
||||||
|
f'loads wholesale: {strays} (dir: {entries})')
|
||||||
|
|
||||||
|
def assert_no_staging_leftovers(self):
|
||||||
|
if os.path.isdir(self.staging_dir):
|
||||||
|
self.assertEqual(sorted(os.listdir(self.staging_dir)), [],
|
||||||
|
'staging file was not cleaned up')
|
||||||
|
|
||||||
|
def assert_rejected(self, result, because):
|
||||||
|
"""The library refused, FOR THE STATED REASON.
|
||||||
|
|
||||||
|
`assertNotEqual(rc, 0)` on its own proves nothing about this library.
|
||||||
|
Delete cert-publish-lib.sh and `. "$1"` fails, cert_bundle_valid is
|
||||||
|
never defined, bash exits 127 - and a bare rc!=0 assertion passes. Four
|
||||||
|
tests in TestCertPublishLibrary were doing exactly that; they were
|
||||||
|
pinning "some bash pipeline failed", not "the bundle was rejected".
|
||||||
|
"""
|
||||||
|
output = result.stdout + result.stderr
|
||||||
|
self.assertNotIn('command not found', output,
|
||||||
|
'the shell could not find the function under test - '
|
||||||
|
'this asserts nothing about the library')
|
||||||
|
self.assertNotEqual(127, result.returncode,
|
||||||
|
f'exit 127 means "no such command", not "rejected": {output}')
|
||||||
|
self.assertNotEqual(0, result.returncode,
|
||||||
|
f'expected a rejection, got success: {output}')
|
||||||
|
self.assertIn(because, output,
|
||||||
|
f'rejected, but not for the expected reason '
|
||||||
|
f'({because!r} not in output): {output}')
|
||||||
|
|
||||||
|
|
||||||
|
class CertScriptBehaviour:
|
||||||
|
"""Behaviour shared by renew-certificates.sh and sync-certificates.sh.
|
||||||
|
|
||||||
|
A mixin rather than a TestCase so the cases are collected once per concrete
|
||||||
|
script, not a third time for the base class.
|
||||||
|
"""
|
||||||
|
|
||||||
|
SCRIPT = None
|
||||||
|
|
||||||
|
def run_it(self, **env_overrides):
|
||||||
|
return self.run_script(self.SCRIPT, **env_overrides)
|
||||||
|
|
||||||
|
# -- happy path ------------------------------------------------------
|
||||||
|
def test_publish_replaces_live_pem_and_archives_the_previous_one(self):
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
result = self.run_it()
|
||||||
|
|
||||||
|
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
|
||||||
|
self.assertEqual(read(self.live_pem), NEW_BUNDLE,
|
||||||
|
'live pem is not the newly assembled cert+key')
|
||||||
|
backup = os.path.join(self.backup_dir, DOMAIN + '.pem')
|
||||||
|
self.assertTrue(os.path.exists(backup),
|
||||||
|
f'previous bundle was not archived to {backup}')
|
||||||
|
self.assertEqual(read(backup), PREVIOUS_BUNDLE,
|
||||||
|
'the archived bundle is not the one that was replaced')
|
||||||
|
self.assertIn('1 updated, 0 failed', self.logs())
|
||||||
|
self.assertTrue(self.reload_attempted(),
|
||||||
|
'HAProxy was never reloaded after a successful update')
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
|
||||||
|
def test_first_publish_works_with_no_previous_bundle(self):
|
||||||
|
result = self.run_it()
|
||||||
|
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
|
||||||
|
self.assertEqual(read(self.live_pem), NEW_BUNDLE)
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
|
||||||
|
# -- THE HEADLINE ----------------------------------------------------
|
||||||
|
def test_unreadable_source_key_leaves_the_previous_bundle_intact(self):
|
||||||
|
"""The bug this whole change exists for.
|
||||||
|
|
||||||
|
Pre-fix: `cat cert key > live.pem` truncated live.pem before cat ran,
|
||||||
|
so an unreadable key left a key-less (or empty) pem in the directory
|
||||||
|
HAProxy loads wholesale -> the :443 bind fails -> every site on the
|
||||||
|
host loses HTTPS. Checking cat's exit status did not undo that.
|
||||||
|
"""
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
self.assertTrue(self.bundle_is_valid(self.live_pem),
|
||||||
|
'fixture precondition: the seeded bundle must be valid')
|
||||||
|
|
||||||
|
how = self.break_source_key()
|
||||||
|
|
||||||
|
result = self.run_it()
|
||||||
|
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
f'the live pem was damaged by a failed publish ({how}); '
|
||||||
|
f'HAProxy would fail to load the certs directory')
|
||||||
|
self.assertTrue(self.bundle_is_valid(self.live_pem),
|
||||||
|
'the pem left on disk is no longer a usable bundle')
|
||||||
|
logs = self.logs()
|
||||||
|
self.assertIn(f'Failed to combine certificate for {DOMAIN}', logs)
|
||||||
|
self.assertIn('0 updated, 1 failed', logs)
|
||||||
|
self.assertFalse(self.reload_attempted(),
|
||||||
|
'HAProxy was reloaded even though nothing was updated')
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
# This used to assert returncode == 0 with the comment "a per-domain
|
||||||
|
# failure should not change the exit code", codifying the script's
|
||||||
|
# `exit 0`. That is wrong and it is the dangerous kind of wrong: a host
|
||||||
|
# where EVERY domain fails to publish looked, to cron and to
|
||||||
|
# host-renew-certificates.sh (which branches on this exit code),
|
||||||
|
# exactly like a clean run. Nothing would notice until the certificates
|
||||||
|
# expired. Continuing past a failed domain so the others still get
|
||||||
|
# published is right; reporting success afterwards is not.
|
||||||
|
self.assertNotEqual(result.returncode, 0,
|
||||||
|
'a domain that failed to publish must be reported '
|
||||||
|
'in the exit code, not just in the log')
|
||||||
|
|
||||||
|
def break_source_key(self):
|
||||||
|
"""Make reading the source key fail, however this environment allows.
|
||||||
|
|
||||||
|
chmod 000 is the faithful reproduction (file present, `-f` true, cat
|
||||||
|
fails), but it is a no-op for root, so as root we truncate the key
|
||||||
|
instead: pre-fix that is even nastier, because `cat` then *succeeds*
|
||||||
|
and silently publishes a key-less pem.
|
||||||
|
"""
|
||||||
|
if os.geteuid() == 0:
|
||||||
|
write(self.src_key, '')
|
||||||
|
return 'zero-length source key (running as root)'
|
||||||
|
os.chmod(self.src_key, 0o000)
|
||||||
|
return 'unreadable source key (chmod 000)'
|
||||||
|
|
||||||
|
# -- other ways to end up with an unusable bundle --------------------
|
||||||
|
def test_cert_only_bundle_is_rejected(self):
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
write(self.src_key, TEST_CERT) # no private key block at all
|
||||||
|
|
||||||
|
self.run_it()
|
||||||
|
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'a key-less bundle was published over the live pem')
|
||||||
|
self.assertIn('0 updated, 1 failed', self.logs())
|
||||||
|
self.assertFalse(self.reload_attempted())
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
|
||||||
|
def test_truncated_certificate_block_is_rejected(self):
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
write(self.src_cert, TEST_CERT.split('\n')[0] + '\nMIIDFzCCAf+gAwIBA\n')
|
||||||
|
|
||||||
|
self.run_it()
|
||||||
|
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'a truncated certificate was published over the live pem')
|
||||||
|
self.assertIn('0 updated, 1 failed', self.logs())
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
|
||||||
|
def test_mismatched_key_is_rejected(self):
|
||||||
|
if shutil.which('openssl') is None:
|
||||||
|
self.skipTest('openssl CLI not available: without it every publish '
|
||||||
|
'is refused, so this test could not tell a pairing '
|
||||||
|
'rejection from a missing-checker rejection')
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
write(self.src_key, UNRELATED_KEY)
|
||||||
|
|
||||||
|
self.run_it()
|
||||||
|
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'a bundle whose key does not match the cert was published')
|
||||||
|
self.assertIn('does not match the certificate', self.logs())
|
||||||
|
self.assertIn('0 updated, 1 failed', self.logs())
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
|
||||||
|
# -- the certs directory is HAProxy's, not ours ----------------------
|
||||||
|
def test_no_stray_files_in_certs_dir_after_success_or_failure(self):
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
self.run_it()
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assertEqual(sorted(os.listdir(self.certs_dir)), [DOMAIN + '.pem'])
|
||||||
|
|
||||||
|
self.break_source_key()
|
||||||
|
self.run_it()
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assertEqual(sorted(os.listdir(self.certs_dir)), [DOMAIN + '.pem'])
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
|
||||||
|
def test_staging_and_backup_dirs_are_outside_the_certs_dir(self):
|
||||||
|
"""Belt and braces: even with the defaults, nothing lands under certs/."""
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
# Drop the explicit overrides so the derived defaults are exercised.
|
||||||
|
env = {'CERT_STAGING_DIR': '', 'CERT_BACKUP_DIR': ''}
|
||||||
|
self.run_it(**env)
|
||||||
|
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assertEqual(sorted(os.listdir(self.certs_dir)), [DOMAIN + '.pem'])
|
||||||
|
self.assertTrue(
|
||||||
|
os.path.exists(os.path.join(self.haproxy_dir, 'cert-staging')),
|
||||||
|
'default staging dir is not the documented sibling of the certs dir')
|
||||||
|
self.assertTrue(
|
||||||
|
os.path.exists(os.path.join(self.haproxy_dir, 'cert-backups',
|
||||||
|
DOMAIN + '.pem')),
|
||||||
|
'default backup dir is not the documented sibling of the certs dir')
|
||||||
|
|
||||||
|
# -- reload gating ---------------------------------------------------
|
||||||
|
def test_reload_is_not_attempted_when_haproxy_config_is_invalid(self):
|
||||||
|
write(self.haproxy_cfg, GOOD_HAPROXY_CFG + BROKEN_TOKEN + '\n')
|
||||||
|
|
||||||
|
result = self.run_it()
|
||||||
|
|
||||||
|
self.assertFalse(self.reload_attempted(),
|
||||||
|
'HAProxy was reloaded with a configuration that '
|
||||||
|
'`haproxy -c` rejects')
|
||||||
|
self.assertNotEqual(result.returncode, 0,
|
||||||
|
'refusing to reload must be a loud, non-zero exit')
|
||||||
|
self.assertIn('does not validate', self.logs())
|
||||||
|
|
||||||
|
def test_reload_happens_when_the_config_validates(self):
|
||||||
|
self.run_it()
|
||||||
|
self.assertTrue(self.reload_attempted())
|
||||||
|
self.assertIn('reload', read(self.socat_log))
|
||||||
|
|
||||||
|
def test_reload_is_not_attempted_when_nothing_was_updated(self):
|
||||||
|
shutil.rmtree(self.domain_dir)
|
||||||
|
result = self.run_it()
|
||||||
|
self.assertEqual(result.returncode, 0)
|
||||||
|
self.assertFalse(self.reload_attempted())
|
||||||
|
|
||||||
|
|
||||||
|
class TestRenewCertificates(CertScriptBehaviour, CertScriptFixture):
|
||||||
|
SCRIPT = 'renew-certificates.sh'
|
||||||
|
|
||||||
|
|
||||||
|
class TestSyncCertificates(CertScriptBehaviour, CertScriptFixture):
|
||||||
|
SCRIPT = 'sync-certificates.sh'
|
||||||
|
|
||||||
|
|
||||||
|
class TestCertPublishLibrary(CertScriptFixture):
|
||||||
|
"""Unit-level checks on cert-publish-lib.sh itself."""
|
||||||
|
|
||||||
|
def call(self, snippet, *args, **env_overrides):
|
||||||
|
return subprocess.run(
|
||||||
|
['bash', '-c', '. "$1"; shift; ' + snippet, '_', LIB, *args],
|
||||||
|
env=self.env(**env_overrides), capture_output=True, text=True)
|
||||||
|
|
||||||
|
def test_valid_bundle_accepted(self):
|
||||||
|
path = write(os.path.join(self.tmp, 'ok.pem'), NEW_BUNDLE)
|
||||||
|
self.assertEqual(self.call('cert_bundle_valid "$1"', path).returncode, 0)
|
||||||
|
|
||||||
|
def test_empty_and_missing_bundles_rejected(self):
|
||||||
|
empty = write(os.path.join(self.tmp, 'empty.pem'), '')
|
||||||
|
self.assert_rejected(self.call('cert_bundle_valid "$1"', empty),
|
||||||
|
'is empty')
|
||||||
|
missing = os.path.join(self.tmp, 'nope.pem')
|
||||||
|
self.assert_rejected(self.call('cert_bundle_valid "$1"', missing),
|
||||||
|
'does not exist')
|
||||||
|
|
||||||
|
def test_key_without_end_marker_rejected(self):
|
||||||
|
truncated = write(os.path.join(self.tmp, 'cut.pem'),
|
||||||
|
TEST_CERT + '-----BEGIN PRIVATE KEY-----\nMIIEvAIB\n')
|
||||||
|
self.assert_rejected(self.call('cert_bundle_valid "$1"', truncated),
|
||||||
|
'unterminated private key block')
|
||||||
|
|
||||||
|
def test_empty_pem_blocks_are_rejected(self):
|
||||||
|
"""Why the pairing check is mandatory rather than best-effort.
|
||||||
|
|
||||||
|
Every structural check in the library passes on this file: a complete
|
||||||
|
CERTIFICATE block and a complete PRIVATE KEY block, both with nothing
|
||||||
|
between BEGIN and END. Only openssl can tell it is not a certificate.
|
||||||
|
"""
|
||||||
|
hollow = write(os.path.join(self.tmp, 'hollow.pem'),
|
||||||
|
'-----BEGIN CERTIFICATE-----\n'
|
||||||
|
'-----END CERTIFICATE-----\n'
|
||||||
|
'-----BEGIN PRIVATE KEY-----\n'
|
||||||
|
'-----END PRIVATE KEY-----\n')
|
||||||
|
self.assert_rejected(self.call('cert_bundle_valid "$1"', hollow),
|
||||||
|
'openssl could not read the certificate')
|
||||||
|
|
||||||
|
def test_a_broken_live_pem_does_not_overwrite_a_good_backup(self):
|
||||||
|
"""Mirrors create_backup(require_valid=True) in haproxy_manager.py.
|
||||||
|
|
||||||
|
If the pem currently on disk is already garbage, archiving it would
|
||||||
|
replace a restorable backup with an unusable one.
|
||||||
|
"""
|
||||||
|
os.makedirs(self.backup_dir)
|
||||||
|
good_backup = write(os.path.join(self.backup_dir, DOMAIN + '.pem'),
|
||||||
|
PREVIOUS_BUNDLE)
|
||||||
|
write(self.live_pem, 'garbage, not a pem at all\n')
|
||||||
|
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem)
|
||||||
|
|
||||||
|
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
|
||||||
|
self.assertEqual(read(self.live_pem), NEW_BUNDLE)
|
||||||
|
self.assertEqual(read(good_backup), PREVIOUS_BUNDLE,
|
||||||
|
'a good backup was overwritten with an unusable pem')
|
||||||
|
|
||||||
|
def test_publish_fails_loudly_when_the_rename_cannot_happen(self):
|
||||||
|
"""No silent fallback to writing straight into the certs dir.
|
||||||
|
|
||||||
|
The failure is injected with a stub `mv` that refuses, rather than by
|
||||||
|
chmod 0500 on the certs dir: the container these scripts run in is
|
||||||
|
root, root ignores directory permissions, so the chmod version skipped
|
||||||
|
itself exactly where it matters and only ever ran on a workstation.
|
||||||
|
"""
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
write(os.path.join(self.bindir, 'mv'),
|
||||||
|
"#!/bin/sh\n"
|
||||||
|
"echo \"mv: cannot move '$2': Permission denied\" >&2\n"
|
||||||
|
"exit 1\n", 0o755)
|
||||||
|
self.addCleanup(os.unlink, os.path.join(self.bindir, 'mv'))
|
||||||
|
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem)
|
||||||
|
|
||||||
|
self.assert_rejected(result, 'NOT falling back to a direct write')
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'the live pem was damaged by a failed rename')
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
|
||||||
|
def test_published_pem_keeps_the_mode_of_the_file_it_replaces(self):
|
||||||
|
"""A write-safety fix must not silently re-permission private keys.
|
||||||
|
|
||||||
|
Both directions matter: mktemp stages at 0600, so without the explicit
|
||||||
|
chmod every publish would tighten a 0644 bundle; and the mode must not
|
||||||
|
be copied from a symlink (see the next test).
|
||||||
|
"""
|
||||||
|
for mode in (0o644, 0o640, 0o600):
|
||||||
|
with self.subTest(oct(mode)):
|
||||||
|
write(self.live_pem, PREVIOUS_BUNDLE, mode)
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem)
|
||||||
|
self.assertEqual(result.returncode, 0,
|
||||||
|
result.stdout + result.stderr)
|
||||||
|
self.assertEqual(read(self.live_pem), NEW_BUNDLE)
|
||||||
|
self.assertEqual(
|
||||||
|
stat.S_IMODE(os.stat(self.live_pem).st_mode), mode,
|
||||||
|
'publishing changed who can read the private key')
|
||||||
|
|
||||||
|
def test_symlinked_live_pem_does_not_become_world_writable(self):
|
||||||
|
"""`stat -c %a` on a symlink reports 0777 - the LINK's mode, not a
|
||||||
|
permission. Copying that onto the staged bundle put a world-writable
|
||||||
|
private key in the directory HAProxy serves from. -L is what makes the
|
||||||
|
preserved mode the mode of the file an operator actually chose.
|
||||||
|
"""
|
||||||
|
target = write(os.path.join(self.tmp, 'real-bundle.pem'),
|
||||||
|
PREVIOUS_BUNDLE, 0o640)
|
||||||
|
os.symlink(target, self.live_pem)
|
||||||
|
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem)
|
||||||
|
|
||||||
|
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
|
||||||
|
mode = stat.S_IMODE(os.stat(self.live_pem).st_mode)
|
||||||
|
self.assertEqual(
|
||||||
|
0, mode & 0o022,
|
||||||
|
f'published bundle is group/world writable ({oct(mode)}) - the '
|
||||||
|
f'symlink mode was copied onto a real private key')
|
||||||
|
self.assertEqual(0o640, mode)
|
||||||
|
|
||||||
|
def test_publish_refuses_when_staging_is_on_another_filesystem(self):
|
||||||
|
"""The header used to claim a cross-device mv "fails loudly and leaves
|
||||||
|
the live pem alone". GNU mv does no such thing: across filesystems it
|
||||||
|
copies, so it truncates and writes the DESTINATION first and only then
|
||||||
|
discovers it cannot finish (ENOSPC being the realistic case) - the very
|
||||||
|
truncation this library exists to prevent. Both directories are
|
||||||
|
env-overridable, so the device numbers have to be checked up front.
|
||||||
|
"""
|
||||||
|
staging = os.path.join(self.a_dir_on_another_filesystem(),
|
||||||
|
'cert-staging')
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem,
|
||||||
|
CERT_STAGING_DIR=staging)
|
||||||
|
|
||||||
|
self.assert_rejected(result, 'different filesystems')
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'the live pem was disturbed by a refused publish')
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
|
||||||
|
def test_stale_python_side_staging_temps_are_reaped(self):
|
||||||
|
"""The staging dir has two writers.
|
||||||
|
|
||||||
|
write_config_atomically() on the Python side stages as
|
||||||
|
`<name>.<random>.tmp` (tempfile.mkstemp(prefix=name + '.',
|
||||||
|
suffix='.tmp')). The reaper matched only mktemp's `*.??????` shape, so
|
||||||
|
every temp leaked by a SIGKILL on the Python side stayed there forever.
|
||||||
|
"""
|
||||||
|
os.makedirs(self.staging_dir, exist_ok=True)
|
||||||
|
stale_py = write(os.path.join(self.staging_dir,
|
||||||
|
DOMAIN + '.pem.ab12cd34.tmp'), 'stale\n')
|
||||||
|
stale_sh = write(os.path.join(self.staging_dir,
|
||||||
|
DOMAIN + '.pem.AbCdEf'), 'stale\n')
|
||||||
|
fresh = write(os.path.join(self.staging_dir,
|
||||||
|
'recent.pem.zz99yy.tmp'), 'fresh\n')
|
||||||
|
old = time.time() - 3 * 24 * 3600
|
||||||
|
for path in (stale_py, stale_sh):
|
||||||
|
os.utime(path, (old, old))
|
||||||
|
|
||||||
|
result = self.call('cert_publish "$1" "$2" "$3"',
|
||||||
|
self.src_cert, self.src_key, self.live_pem)
|
||||||
|
self.assertEqual(result.returncode, 0, result.stdout + result.stderr)
|
||||||
|
|
||||||
|
self.assertFalse(os.path.exists(stale_py),
|
||||||
|
'a stale Python-side staging temp was never reaped')
|
||||||
|
self.assertFalse(os.path.exists(stale_sh),
|
||||||
|
'a stale shell-side staging temp was never reaped')
|
||||||
|
self.assertTrue(os.path.exists(fresh),
|
||||||
|
'the reaper deleted a temp a concurrent publisher may '
|
||||||
|
'still be writing')
|
||||||
|
|
||||||
|
def test_validation_of_a_live_pem_being_republished_is_not_spurious(self):
|
||||||
|
"""cert_bundle_valid must judge ONE snapshot of the file.
|
||||||
|
|
||||||
|
cert_publish() calls cert_bundle_valid() on the LIVE pem (step (e), to
|
||||||
|
decide whether it is worth backing up) while another publisher may be
|
||||||
|
renaming a new bundle over it. The function used to open the file six
|
||||||
|
times, so `openssl x509` could read the outgoing bundle and `openssl
|
||||||
|
pkey` the incoming one - and report "private key does not match the
|
||||||
|
certificate" about two files that were each perfectly fine. That ERROR
|
||||||
|
goes into the log monitor-errors.sh watches, which makes it a page.
|
||||||
|
|
||||||
|
The two bundles alternated below are each internally valid but carry
|
||||||
|
DIFFERENT key material. That matters: NEW_BUNDLE and PREVIOUS_BUNDLE
|
||||||
|
share a cert and a key, so alternating those two could never produce a
|
||||||
|
mismatch no matter how badly the reads were interleaved - the test
|
||||||
|
would model a world in which the bug cannot happen and pass forever.
|
||||||
|
"""
|
||||||
|
write(self.live_pem, NEW_BUNDLE)
|
||||||
|
a = write(os.path.join(self.tmp, 'churn-a.pem'), NEW_BUNDLE)
|
||||||
|
b = write(os.path.join(self.tmp, 'churn-b.pem'), OTHER_BUNDLE)
|
||||||
|
|
||||||
|
# A publisher renaming over the live pem as fast as it can. Staged
|
||||||
|
# outside the certs dir, then renamed, exactly like cert_publish().
|
||||||
|
churn = subprocess.Popen(
|
||||||
|
['bash', '-c',
|
||||||
|
'end=$((SECONDS+8)); s="$4"; while [ $SECONDS -lt $end ]; do '
|
||||||
|
' cp "$1" "$s"; mv -f "$s" "$2"; '
|
||||||
|
' cp "$3" "$s"; mv -f "$s" "$2"; '
|
||||||
|
'done', '_', a, self.live_pem, b,
|
||||||
|
os.path.join(self.tmp, 'churn-staged.pem')],
|
||||||
|
env=self.env(), stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
|
||||||
|
def _stop():
|
||||||
|
churn.kill()
|
||||||
|
churn.wait()
|
||||||
|
self.addCleanup(_stop)
|
||||||
|
|
||||||
|
result = subprocess.run(
|
||||||
|
['bash', '-c',
|
||||||
|
'. "$1"; for i in $(seq 1 200); do cert_bundle_valid "$2" || exit 1; done',
|
||||||
|
'_', LIB, self.live_pem],
|
||||||
|
env=self.env(), capture_output=True, text=True, timeout=120)
|
||||||
|
_stop()
|
||||||
|
|
||||||
|
output = result.stdout + result.stderr
|
||||||
|
self.assertNotIn('does not match the certificate', output,
|
||||||
|
'two valid bundles were reported as a mismatched pair '
|
||||||
|
'because the checks read different files')
|
||||||
|
self.assertEqual(0, result.returncode,
|
||||||
|
f'a concurrent republish made validation fail: {output}')
|
||||||
|
|
||||||
|
def a_dir_on_another_filesystem(self):
|
||||||
|
certs_dev = os.stat(self.certs_dir).st_dev
|
||||||
|
for candidate in ('/dev/shm', '/run', '/var/tmp', '/tmp', '/'):
|
||||||
|
try:
|
||||||
|
if (os.path.isdir(candidate)
|
||||||
|
and os.access(candidate, os.W_OK)
|
||||||
|
and os.stat(candidate).st_dev != certs_dev):
|
||||||
|
path = tempfile.mkdtemp(prefix='cert-xdev-', dir=candidate)
|
||||||
|
self.addCleanup(shutil.rmtree, path, True)
|
||||||
|
return path
|
||||||
|
except OSError:
|
||||||
|
continue
|
||||||
|
self.skipTest('no writable directory on a second filesystem available')
|
||||||
|
|
||||||
|
def test_haproxy_config_ok_follows_the_validator(self):
|
||||||
|
self.assertEqual(self.call('haproxy_config_ok').returncode, 0)
|
||||||
|
write(self.haproxy_cfg, GOOD_HAPROXY_CFG + BROKEN_TOKEN + '\n')
|
||||||
|
self.assertNotEqual(self.call('haproxy_config_ok').returncode, 0)
|
||||||
|
|
||||||
|
def _openssl_free_path(self, name):
|
||||||
|
"""A PATH directory with the library's tools but no openssl.
|
||||||
|
|
||||||
|
Symlinks, so this directory must never be walked with a chmod that
|
||||||
|
follows them - see _cleanup_tmp().
|
||||||
|
"""
|
||||||
|
fake_path = os.path.join(self.tmp, name)
|
||||||
|
os.makedirs(fake_path)
|
||||||
|
for tool in ('cat', 'grep', 'mktemp', 'mv', 'cp', 'rm', 'mkdir',
|
||||||
|
'basename', 'dirname', 'find', 'date', 'chmod', 'stat'):
|
||||||
|
real = shutil.which(tool)
|
||||||
|
if real:
|
||||||
|
os.symlink(real, os.path.join(fake_path, tool))
|
||||||
|
return fake_path
|
||||||
|
|
||||||
|
def test_missing_openssl_is_a_hard_failure(self):
|
||||||
|
"""The pairing check is MANDATORY: no openssl, no publication.
|
||||||
|
|
||||||
|
This used to assert the opposite - that a missing openssl warns and
|
||||||
|
publishes anyway - justified by "the image does not necessarily install
|
||||||
|
the openssl CLI". The image does: openssl 3.x arrives with
|
||||||
|
ca-certificates, which certbot needs, and generate_self_signed_cert()
|
||||||
|
already runs `openssl req` with check=True at first-run setup. So the
|
||||||
|
fail-open never actually fired, and structural checks alone accept a
|
||||||
|
bundle of empty pem blocks (see test_empty_pem_blocks_are_rejected).
|
||||||
|
"""
|
||||||
|
fake_path = self._openssl_free_path('no-openssl-bin')
|
||||||
|
path = write(os.path.join(self.tmp, 'ok.pem'), NEW_BUNDLE)
|
||||||
|
|
||||||
|
# bash by absolute path: the stripped PATH cannot resolve it.
|
||||||
|
result = subprocess.run(
|
||||||
|
[shutil.which('bash'), '-c', '. "$1"; cert_bundle_valid "$2"',
|
||||||
|
'_', LIB, path],
|
||||||
|
env=self.env(PATH=fake_path), capture_output=True, text=True)
|
||||||
|
|
||||||
|
self.assert_rejected(result, 'openssl binary not found')
|
||||||
|
self.assertIn('REFUSING', result.stdout + result.stderr,
|
||||||
|
'a broken image must be reported as a broken image')
|
||||||
|
|
||||||
|
def test_missing_openssl_stops_a_publish_rather_than_weakening_it(self):
|
||||||
|
"""cert_publish must inherit the refusal, and not touch the live pem."""
|
||||||
|
fake_path = self._openssl_free_path('no-openssl-bin2')
|
||||||
|
self.seed_previous_bundle()
|
||||||
|
before = read(self.live_pem)
|
||||||
|
|
||||||
|
result = subprocess.run(
|
||||||
|
[shutil.which('bash'), '-c',
|
||||||
|
'. "$1"; cert_publish "$2" "$3" "$4"',
|
||||||
|
'_', LIB, self.src_cert, self.src_key, self.live_pem],
|
||||||
|
env=self.env(PATH=fake_path), capture_output=True, text=True)
|
||||||
|
|
||||||
|
self.assert_rejected(result, 'openssl binary not found')
|
||||||
|
self.assertEqual(read(self.live_pem), before,
|
||||||
|
'the live pem was disturbed by a refused publish')
|
||||||
|
self.assert_certs_dir_is_clean()
|
||||||
|
self.assert_no_staging_leftovers()
|
||||||
|
|
||||||
|
|
||||||
|
class TestScriptsAreSane(unittest.TestCase):
|
||||||
|
"""Cheap static guards against the failure mode coming back."""
|
||||||
|
|
||||||
|
SHELL_FILES = ('renew-certificates.sh', 'sync-certificates.sh',
|
||||||
|
'cert-publish-lib.sh')
|
||||||
|
|
||||||
|
def test_shell_files_parse(self):
|
||||||
|
for name in self.SHELL_FILES:
|
||||||
|
path = os.path.join(SCRIPTS_DIR, name)
|
||||||
|
result = subprocess.run(['bash', '-n', path],
|
||||||
|
capture_output=True, text=True)
|
||||||
|
self.assertEqual(result.returncode, 0,
|
||||||
|
f'{name}: {result.stderr}')
|
||||||
|
|
||||||
|
def test_no_script_redirects_into_the_live_pem(self):
|
||||||
|
pattern = re.compile(r'>\s*"?\$\{?COMBINED_FILE')
|
||||||
|
for name in ('renew-certificates.sh', 'sync-certificates.sh'):
|
||||||
|
body = read(os.path.join(SCRIPTS_DIR, name))
|
||||||
|
self.assertIsNone(pattern.search(body),
|
||||||
|
f'{name} still redirects output straight into the '
|
||||||
|
f'live pem HAProxy is serving')
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
print(f'testing scripts from: {SCRIPTS_DIR}')
|
||||||
|
unittest.main(verbosity=2)
|
||||||
Executable
+938
@@ -0,0 +1,938 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for certificate bundle publishing.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
Every code path that refreshed a combined PEM used to do this:
|
||||||
|
|
||||||
|
with open(combined_path, 'w') as combined: # TRUNCATES
|
||||||
|
subprocess.run(['cat', cert, key], stdout=combined) # rc ignored
|
||||||
|
|
||||||
|
`combined_path` is the live bundle HAProxy is serving. open(..., 'w') empties it
|
||||||
|
BEFORE any source material has been read, and the `cat` exit status was never
|
||||||
|
checked, so a half-written certbot lineage, an unreadable source or a full disk
|
||||||
|
left a truncated or key-less PEM in place. HAProxy loads /etc/haproxy/certs as a
|
||||||
|
directory and refuses to start if any file in it is unusable, so that is HTTPS
|
||||||
|
down for every site on the host - and unlike a broken haproxy.cfg it is not
|
||||||
|
recoverable by config rollback.
|
||||||
|
|
||||||
|
The bundle endpoint made it worse: it deleted superseded .pem files AND ran
|
||||||
|
`certbot delete` on their lineages before anything had checked that the
|
||||||
|
replacement was usable, destroying both copies of a working certificate.
|
||||||
|
Recovery there means fresh, rate-limited ACME orders.
|
||||||
|
|
||||||
|
These tests pin the invariants:
|
||||||
|
* a failed publish leaves the previously served bundle byte-for-byte intact
|
||||||
|
and the edge still able to start;
|
||||||
|
* nothing is published that is not a complete, validated cert+key pair;
|
||||||
|
* no old certificate file is removed and no lineage deleted until the
|
||||||
|
replacement is validated, in place, and actually loaded by HAProxy;
|
||||||
|
* only final .pem files ever exist in the crt directory.
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/test-cert-write-safety.py # tests the repo checkout
|
||||||
|
HAPROXY_MANAGER_DIR=/some/other/tree \
|
||||||
|
python3 scripts/test-cert-write-safety.py # tests another tree
|
||||||
|
|
||||||
|
Pointing HAPROXY_MANAGER_DIR at a pre-fix checkout is how the bugs above were
|
||||||
|
reproduced: the behavioural tests run there too (the fix-only tests skip
|
||||||
|
themselves), and they fail.
|
||||||
|
|
||||||
|
Same conventions as scripts/test-config-rollback.py: self-contained stdlib
|
||||||
|
unittest, no pytest/venv/extra dependencies, stub binaries on PATH. The
|
||||||
|
certificate material below is real (a self-signed leaf plus its matching key,
|
||||||
|
and one unrelated key for the mismatch case) and embedded as constants so the
|
||||||
|
suite needs no crypto tooling to create fixtures.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import sqlite3
|
||||||
|
import stat
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
import textwrap
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
BROKEN_TOKEN = '__BROKEN__'
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
|
||||||
|
# haproxy_manager builds its Jinja2 environment from the relative path
|
||||||
|
# Path('templates'), so it has to be imported with the module dir as cwd.
|
||||||
|
os.chdir(MODULE_DIR)
|
||||||
|
sys.path.insert(0, MODULE_DIR)
|
||||||
|
|
||||||
|
# The module opens /var/log/haproxy-manager.log at import time via
|
||||||
|
# logging.FileHandler. Redirect that one call so the suite runs unprivileged.
|
||||||
|
_LOG_DIR = tempfile.mkdtemp(prefix='haproxy-mgr-test-logs-')
|
||||||
|
_real_file_handler = logging.FileHandler
|
||||||
|
logging.FileHandler = (
|
||||||
|
lambda fn, *a, **kw: _real_file_handler(
|
||||||
|
os.path.join(_LOG_DIR, os.path.basename(fn)), *a, **kw)
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
import haproxy_manager as hm
|
||||||
|
except ImportError as exc: # pragma: no cover - environment problem, not a failure
|
||||||
|
sys.stderr.write(
|
||||||
|
f"SKIP: cannot import haproxy_manager ({exc}).\n"
|
||||||
|
"Install the application requirements first: pip install -r requirements.txt\n"
|
||||||
|
)
|
||||||
|
raise SystemExit(77)
|
||||||
|
finally:
|
||||||
|
logging.FileHandler = _real_file_handler
|
||||||
|
|
||||||
|
logging.getLogger('haproxy_manager').setLevel(logging.CRITICAL)
|
||||||
|
|
||||||
|
HAS_PUBLISHER = hasattr(hm, 'publish_pem_bundle')
|
||||||
|
|
||||||
|
# FIX_ONLY marks tests that can only run against a tree that HAS the fix, so
|
||||||
|
# that pointing HAPROXY_MANAGER_DIR at a pre-fix checkout (how the bugs were
|
||||||
|
# reproduced) skips them instead of erroring.
|
||||||
|
#
|
||||||
|
# It used to be `skipUnless(HAS_PUBLISHER, ...)` unconditionally, which is
|
||||||
|
# tautological when testing THIS tree: rename or delete publish_pem_bundle and
|
||||||
|
# 10 of the 17 tests silently skip themselves while the run still reports OK.
|
||||||
|
# A guard that disappears when the thing it guards disappears is not a guard.
|
||||||
|
# So the escape hatch is now tied to the thing it exists for - testing a
|
||||||
|
# FOREIGN tree - and a missing publisher in the repo checkout is a hard
|
||||||
|
# failure (see TestPublisherApiIsPresent).
|
||||||
|
_REPO_ROOT = os.path.realpath(
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
TESTING_FOREIGN_TREE = os.path.realpath(MODULE_DIR) != _REPO_ROOT
|
||||||
|
FIX_ONLY = unittest.skipIf(
|
||||||
|
TESTING_FOREIGN_TREE and not HAS_PUBLISHER,
|
||||||
|
'HAPROXY_MANAGER_DIR points at a tree without the certificate publishing '
|
||||||
|
'fix (publish_pem_bundle)')
|
||||||
|
NEEDS_OPENSSL = unittest.skipUnless(
|
||||||
|
shutil.which('openssl'), 'needs the openssl CLI')
|
||||||
|
|
||||||
|
# --- real test material -----------------------------------------------------
|
||||||
|
# Self-signed leaf, CN=test.example.com, SAN test.example.com +
|
||||||
|
# www.test.example.com, valid until 2126.
|
||||||
|
LEAF_CERT = """\
|
||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDTjCCAjagAwIBAgIUTliK3dNIdYS3i7R3yxNMHfxVWTcwDQYJKoZIhvcNAQEL
|
||||||
|
BQAwGzEZMBcGA1UEAwwQdGVzdC5leGFtcGxlLmNvbTAgFw0yNjA4MDYxNTQxMjda
|
||||||
|
GA8yMTI2MDcxMzE1NDEyN1owGzEZMBcGA1UEAwwQdGVzdC5leGFtcGxlLmNvbTCC
|
||||||
|
ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRuorQDGdsyc/rk3WST8J70
|
||||||
|
9oVcTz2QSTQ5QNxqa4jKX7vD0YdLK2Kz7TKLbR//ju+dnqFhLTAs38KqljmU5M1d
|
||||||
|
7hC1frSV9Y9heHTa51fc9hxewDl9535TdIsUga5HT+sc7q3Np7RparOf1NOm/aBd
|
||||||
|
27j+LGKclbJ5YaU3I39S05H+S8mgmFpLezwQ7uzFomkk/E5deUcqGpJrW8k2t6Uv
|
||||||
|
jvfejB8FGAM6DxEL4yTjizmIaJE+jadPTJRq1TtHG+LE4rt2UpF4ggNFXlK7xXfp
|
||||||
|
p0mcIE1b3MwGaPGmAe5Vw2+nl4uD9LRgQh3XxO2+as4QTTYhlR40Fn03ksXVo6cC
|
||||||
|
AwEAAaOBhzCBhDAdBgNVHQ4EFgQUjAt+yg/dpNHyeWNqH2oAURfW3iUwHwYDVR0j
|
||||||
|
BBgwFoAUjAt+yg/dpNHyeWNqH2oAURfW3iUwDwYDVR0TAQH/BAUwAwEB/zAxBgNV
|
||||||
|
HREEKjAoghB0ZXN0LmV4YW1wbGUuY29tghR3d3cudGVzdC5leGFtcGxlLmNvbTAN
|
||||||
|
BgkqhkiG9w0BAQsFAAOCAQEABo5x4n3/61XxwJEkNPyv/mCAN5t/+NrMxfadRFJK
|
||||||
|
+jBxtOO8w8vhi21zF1NDVQkt2bt69QGrVleP5X78FaIaI6sJpLKDE1nOyE9Dpt4y
|
||||||
|
mnLoRi0Ep7NaDV6rHmfbokLkVdd4Z9RKUESnYCc1Zt5x82oGhEe3GJ4ej2HS8sGY
|
||||||
|
r79qGVEhQIbLPDA3PD+RQCF6+xNU2CVgZUJ7ZtSeAaNaQQqTRUT2qCBvIKfV8fMS
|
||||||
|
VDmV6/YORV2jTzO3odKsKxXQY8oWCzfwosxD0dJ2zbZWvMAqcQQq3d/iuH8NiS4Y
|
||||||
|
+zZ6j9KI/RdRYJz/co2FKAy3FfQ/gZo8eWF2gf9RUDgNQg==
|
||||||
|
-----END CERTIFICATE-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
LEAF_KEY = """\
|
||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDEbqK0AxnbMnP6
|
||||||
|
5N1kk/Ce9PaFXE89kEk0OUDcamuIyl+7w9GHSytis+0yi20f/47vnZ6hYS0wLN/C
|
||||||
|
qpY5lOTNXe4QtX60lfWPYXh02udX3PYcXsA5fed+U3SLFIGuR0/rHO6tzae0aWqz
|
||||||
|
n9TTpv2gXdu4/ixinJWyeWGlNyN/UtOR/kvJoJhaS3s8EO7sxaJpJPxOXXlHKhqS
|
||||||
|
a1vJNrelL4733owfBRgDOg8RC+Mk44s5iGiRPo2nT0yUatU7RxvixOK7dlKReIID
|
||||||
|
RV5Su8V36adJnCBNW9zMBmjxpgHuVcNvp5eLg/S0YEId18TtvmrOEE02IZUeNBZ9
|
||||||
|
N5LF1aOnAgMBAAECggEAR0NcA7KcTsmfCga9yx9gzEpSpU838D3IUQn0XgK9wIKq
|
||||||
|
+JOyEENVGhnsk8nBbTppwMSOKD35BuFAzH7WwU0jNN4+4BD4RsugqsPRz5MbGuUu
|
||||||
|
5Fv7oN/sfAgK3+owoel9NO7qKGPT07/q1f/GVoLewK9MZ3DO6XelV3px0l6OokHn
|
||||||
|
Oy+ShWw4CnUXRIAKBuRNLLA0HQ4ld0dceV/kT428tZIluj9pkUhnp9xux5yDWkMu
|
||||||
|
dj26CXZxp2PMzVLD21TmI/BZO+3Ev+Nf5GaS8GrmROlXLKTE5YDmU1ZTECsSSFLK
|
||||||
|
Nuw7B3TT+xEQUf5lokDigkbTgIQ5kpnIy1LSbqLAAQKBgQDudSbhaqABZk6B09UL
|
||||||
|
PZVQZSrGZDXl4vwnkHXArrr2BRz1+B67tWebq3V0pCrZqwFc9eOtq1F0vH6q11Ns
|
||||||
|
vLZ9lZ7KUEsFS6InZkqSQSGrgWt4MIjocc8qHLlaEk/EGgHgtwBblm2hEyDwy487
|
||||||
|
jhnc2wI82D6ZLvIc27pQQFNjAQKBgQDS4gXINPsaq9YFiQ9JQG8oJGSq6yn137wJ
|
||||||
|
DQYrTaB9tqcmIXWx6ZgMiKZiOGLQYVmlNFoh10cTxbebWjXjWL4VP3gg5nE87pQz
|
||||||
|
8KKvkXP07QWiSQLV5SJzEeDM/l3Lkyc9O69PYnusWjdFOrIPDTmxZ2l6wNyAVxpm
|
||||||
|
zEK17gYOpwKBgQC+glxAxZX16E2ajanspBPRujG1dMRW2MTJuzFIcpCuEyGzJbsw
|
||||||
|
DlsrVI2vVaViZ6vcIBr5WiDm2d19EjD1c8N8i/fj/Mgi/+0Z+zBirqR+yBQbXvNS
|
||||||
|
efKf23j+DBksO/b6GFqx0XnesVCk8IyLcRkaiOK9x6ojag1Gnwm4Kdw1AQKBgAen
|
||||||
|
ssQIwFDAih1bU1W6ZA6V+52Eudo2C/JcKawqvjeyCLFGp6oUq7NQxpFsMJIV5pYr
|
||||||
|
p1XxJaBfHgIirTAaiZPl4Ot40gV/N5wHETDEW+w5Kmowskyna6+3p2xpk2gPaG49
|
||||||
|
m2iLT6f7AmSd89a+CSkacubE13xFLS0sHwPRpyCjAoGBAJfFYXWFAD2viAmBshCS
|
||||||
|
g6Ba78n0vkF74/DnFRWpIqxw8vufQ5nY/k67tGko+zZg3jzI1d1REvI1qHYctKFM
|
||||||
|
Ko7fmF3ny803cdJT8EuIlrU2+V5lh0GkPO/or+68qso+qBj3R8f6jRLbahkUbY5e
|
||||||
|
yR3PzoVVfGaftvLsdbAqD+VC
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
# A perfectly valid key that simply does not belong to LEAF_CERT.
|
||||||
|
UNRELATED_KEY = """\
|
||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQDBpZAkTBLhiDnq
|
||||||
|
cCjsSsBwAW/fhYYfx+t2iauYPrvaLmiJHFkXEr7gaBlYWTKJRISY2jqYTM1RdLJB
|
||||||
|
DDjNThrewOLtcF7d+k+ArMPWXxqBotbCTKMkh7djRfnXEcjJ/mil31W351cR/11q
|
||||||
|
EPBdCcj4BYegBzc4GG2qIh/Nww+jd1KkkxUhnTMPp5Ie0myJafh0Pdsss9lbmqBH
|
||||||
|
fW6BO341C9jG8N/7C7FHCzzf74q7mf0Bx+isYgW/1YL0Ndg/R8yTRVKTbPvU3ZM2
|
||||||
|
hEeLDXFbvcceREq1j0VEXGd9rcB2JHBE4TAQZq9WmeT51uynW8a1hnUcUs/li7jL
|
||||||
|
cuI6DswxAgMBAAECggEADeC4Z42HJeAeLHG80RBbYbuMobN/RPxOIOjlYgwO6Og+
|
||||||
|
CCN+tANdKBZ1yInd8A33xb+QBvWsGjwXgUdns7j2/oNK0BLnTZfAhlt7Tnvy2ZsK
|
||||||
|
spKM95N9XlE3wkTNQ8Kmi8qpaTxcVlcbgfw0SaqnmzTEP0D9IVlI1LJM3rFtx7xn
|
||||||
|
xhrtKzhcv6WbnZKjrKlPpJq7dFC8+3WtbWFBvWFUTs2mQJ3eFWlc/EBh60PKuMAz
|
||||||
|
44aMrypzQSdcAs0+f0fOpnhpWa6Px4uEAIvSNPjPI7gt/7v4qb+fNrGGYrou9Pd9
|
||||||
|
hW0MGDOxfTxr094YCdapklIV3OyCvrCeS8XVYnVddQKBgQDiZzBTNnc6O2EWgY2h
|
||||||
|
82VSEBMDTnk+rT7CTx4RGkzyq2z6oUg0itr+TQGhyjRX24VbROXtXlCBNXQkn9UA
|
||||||
|
aZsss+KnrF6KLEmdwQIoNKSgBIiTgX/PHmkf3a+scDShgL5aIItjazu9TEblBqKF
|
||||||
|
+H4eBwuPjKc20h2CctoZswE0HQKBgQDa9iZBOPCjyTtq4oSeJbyvjYfJN5EoI9nZ
|
||||||
|
hl0Yqa8ajbJ8nyxGziy5z5ktqBFYiVa53xamagJJp69DCmnm6vSy01KZIOtKNEKb
|
||||||
|
PCaNc1Lp+cf5SEIHX0Pakx/zmi0PzDx1V0DhtjLhF8dFUfQhWvvxF+m16LZeBYZ+
|
||||||
|
0UP6NRAUJQKBgQCM/e/1UkzrocDzkBiQy4/EjCga/gq5gpA716OEyRk0YpdKeZgK
|
||||||
|
yJJancAvbkoskJO64+xAZ2TBInXCvRqb2Ch/rUKwYsK5T51EtcbPHQGMeWZIXfQn
|
||||||
|
GuwioR7exz2vegqQ/AVyE3yvhUn9JKWfwsFfl8mWSuRzWmRwMXArYvOT7QKBgQCV
|
||||||
|
6Y2LfjaTjMUXivsNY/zpnNbo1xiVCOawXaQDrLlsTrNzS29/Es3gcdgIQFeP7Ifq
|
||||||
|
Pmk9irsCPsJp/gk/xoG+pZyZpsYxSdKIgghLNDgCZbeaXvSGI51LWwu3N0m+1TBX
|
||||||
|
jmOnpZz0K9mNBm1FIQv5p0ul9ixV9yZ8UT5fYlEd2QKBgQDLWMgMD9rOORl+0s8Z
|
||||||
|
RcpSfu2E7KP0e2DaxP4dYRmUyNuE8iK8hglNqqVBLhrFHmDZ1yo1lFIDBROaJ9EW
|
||||||
|
pAxSb8kRi2dba8ZnpEDhhiqoDwkoXRDOrzd5bdHyiOJV39U1F5U6HqDE4URaq8iu
|
||||||
|
k49ABlblWHBsoUF63ka1PBrMgA==
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
|
"""
|
||||||
|
|
||||||
|
GOOD_BUNDLE = LEAF_CERT + LEAF_KEY
|
||||||
|
|
||||||
|
# What a bundle already on disk looks like when a test starts: the same, valid
|
||||||
|
# material plus a trailing marker. Without it the "previous" and "new" bundles
|
||||||
|
# are byte-identical, and a test that meant to prove a publish HAPPENED cannot
|
||||||
|
# tell that from a publish that did nothing at all. Trailing text after the key
|
||||||
|
# is ignored by both HAProxy and openssl, so the file stays genuinely usable.
|
||||||
|
PREVIOUS_MARKER = '# previous bundle\n'
|
||||||
|
PREVIOUS_BUNDLE = GOOD_BUNDLE + PREVIOUS_MARKER
|
||||||
|
|
||||||
|
# Stub haproxy. Beyond the config check the parent suite's stub does, this one
|
||||||
|
# also walks the crt directory the way HAProxy does when a `bind ... ssl crt
|
||||||
|
# <dir>` is used: every file in there must be a loadable cert+key bundle, and
|
||||||
|
# one that is not takes the whole listener (i.e. the whole edge) down. That is
|
||||||
|
# what makes "the edge would still start" an assertion rather than a hope.
|
||||||
|
FAKE_HAPROXY = textwrap.dedent(f"""\
|
||||||
|
#!/bin/sh
|
||||||
|
# haproxy -c -f FILE -> reject FILE containing {BROKEN_TOKEN}
|
||||||
|
# reject any unusable file in $TEST_CERTS_DIR
|
||||||
|
cfg=""
|
||||||
|
while [ $# -gt 0 ]; do
|
||||||
|
case "$1" in -f) cfg="$2"; shift ;; esac
|
||||||
|
shift
|
||||||
|
done
|
||||||
|
if [ -n "$cfg" ] && grep -q '{BROKEN_TOKEN}' "$cfg" 2>/dev/null; then
|
||||||
|
echo "[ALERT] parsing [$cfg:1] : unknown keyword '{BROKEN_TOKEN}'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -n "$TEST_CERTS_DIR" ] && [ -d "$TEST_CERTS_DIR" ]; then
|
||||||
|
for f in "$TEST_CERTS_DIR"/*; do
|
||||||
|
[ -e "$f" ] || continue
|
||||||
|
if [ ! -s "$f" ]; then
|
||||||
|
echo "[ALERT] unable to load SSL certificate from empty file '$f'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! grep -q -- '-----END CERTIFICATE-----' "$f"; then
|
||||||
|
echo "[ALERT] unable to load SSL certificate from '$f'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if ! grep -q -- '-----END .*PRIVATE KEY-----' "$f"; then
|
||||||
|
echo "[ALERT] unable to load SSL private key from '$f'" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
exit 0
|
||||||
|
""")
|
||||||
|
|
||||||
|
# certbot stub: succeeds, announces a renewal, and records every invocation so
|
||||||
|
# tests can assert that `certbot delete` did or did not run.
|
||||||
|
FAKE_CERTBOT = textwrap.dedent("""\
|
||||||
|
#!/bin/sh
|
||||||
|
if [ -n "$TEST_CERTBOT_LOG" ]; then
|
||||||
|
echo "$@" >> "$TEST_CERTBOT_LOG"
|
||||||
|
fi
|
||||||
|
case "$1" in
|
||||||
|
renew) echo "Congratulations, all renewals succeeded" ;;
|
||||||
|
delete) [ -n "$TEST_CERTBOT_DELETE_FAILS" ] && exit 1 ;;
|
||||||
|
esac
|
||||||
|
exit 0
|
||||||
|
""")
|
||||||
|
|
||||||
|
# socat stub: records reload attempts so tests can assert HAProxy was NOT
|
||||||
|
# reloaded with unvalidated material.
|
||||||
|
FAKE_SOCAT = textwrap.dedent("""\
|
||||||
|
#!/bin/sh
|
||||||
|
if [ -n "$TEST_SOCAT_LOG" ]; then
|
||||||
|
echo "$@" >> "$TEST_SOCAT_LOG"
|
||||||
|
fi
|
||||||
|
cat > /dev/null 2>&1
|
||||||
|
exit 0
|
||||||
|
""")
|
||||||
|
|
||||||
|
|
||||||
|
def structurally_valid(text):
|
||||||
|
"""Is this text a usable cert+key bundle?
|
||||||
|
|
||||||
|
Deliberately implemented here rather than calling into haproxy_manager, so
|
||||||
|
the assertions stay honest when the suite is pointed at a tree whose
|
||||||
|
validation code is the thing under test (or absent entirely).
|
||||||
|
"""
|
||||||
|
return ('-----BEGIN CERTIFICATE-----' in text
|
||||||
|
and '-----END CERTIFICATE-----' in text
|
||||||
|
and any(f'-----END {label}-----' in text for label in
|
||||||
|
('PRIVATE KEY', 'RSA PRIVATE KEY', 'EC PRIVATE KEY')))
|
||||||
|
|
||||||
|
|
||||||
|
class CertPublishTestCase(unittest.TestCase):
|
||||||
|
"""Isolated fake /etc/haproxy + /etc/letsencrypt plus stub binaries."""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.tmp = tempfile.mkdtemp(prefix='haproxy-cert-test-')
|
||||||
|
self.addCleanup(shutil.rmtree, self.tmp, True)
|
||||||
|
|
||||||
|
bindir = os.path.join(self.tmp, 'bin')
|
||||||
|
os.makedirs(bindir)
|
||||||
|
for name, body in (('haproxy', FAKE_HAPROXY),
|
||||||
|
('certbot', FAKE_CERTBOT),
|
||||||
|
('socat', FAKE_SOCAT)):
|
||||||
|
path = os.path.join(bindir, name)
|
||||||
|
with open(path, 'w') as fh:
|
||||||
|
fh.write(body)
|
||||||
|
os.chmod(path, 0o755)
|
||||||
|
|
||||||
|
self.certbot_log = os.path.join(self.tmp, 'certbot-invocations.log')
|
||||||
|
self.socat_log = os.path.join(self.tmp, 'socat-invocations.log')
|
||||||
|
self.etc = os.path.join(self.tmp, 'etc')
|
||||||
|
self.certs = os.path.join(self.etc, 'certs')
|
||||||
|
os.makedirs(self.certs)
|
||||||
|
|
||||||
|
self._saved_env = dict(os.environ)
|
||||||
|
os.environ['PATH'] = bindir + os.pathsep + os.environ['PATH']
|
||||||
|
os.environ['TEST_CERTS_DIR'] = self.certs
|
||||||
|
os.environ['TEST_CERTBOT_LOG'] = self.certbot_log
|
||||||
|
os.environ['TEST_SOCAT_LOG'] = self.socat_log
|
||||||
|
self.addCleanup(self._restore_env)
|
||||||
|
|
||||||
|
overrides = {
|
||||||
|
'DB_FILE': os.path.join(self.etc, 'haproxy_config.db'),
|
||||||
|
'HAPROXY_CONFIG_PATH': os.path.join(self.etc, 'haproxy.cfg'),
|
||||||
|
'HAPROXY_BACKUP_PATH': os.path.join(self.etc, 'haproxy.cfg.backup'),
|
||||||
|
'BLOCKED_IPS_MAP_PATH': os.path.join(self.etc, 'blocked_ips.map'),
|
||||||
|
'BLOCKED_IPS_MAP_BACKUP_PATH': os.path.join(self.etc, 'blocked_ips.map.backup'),
|
||||||
|
'CORAZA_SPOE_CONFIG_PATH': os.path.join(self.etc, 'coraza-spoe.cfg'),
|
||||||
|
'CORAZA_SPOE_BACKUP_PATH': os.path.join(self.etc, 'coraza-spoe.cfg.backup'),
|
||||||
|
'CLUSTER_SECRET_PATH': os.path.join(self.etc, 'cluster-secret'),
|
||||||
|
'SSL_CERTS_DIR': self.certs,
|
||||||
|
'HAPROXY_SOCKET_PATH': os.path.join(self.etc, 'haproxy.sock'),
|
||||||
|
'API_KEY': None,
|
||||||
|
}
|
||||||
|
self._saved = {}
|
||||||
|
for name, value in overrides.items():
|
||||||
|
self._saved[name] = getattr(hm, name, None)
|
||||||
|
setattr(hm, name, value)
|
||||||
|
self.addCleanup(self._restore_globals)
|
||||||
|
|
||||||
|
# find_certbot_live_dir() resolves /etc/letsencrypt/live, which we
|
||||||
|
# cannot repoint on older trees. Stubbing this one lookup keeps the
|
||||||
|
# suite runnable against a pre-fix checkout for bug reproduction; every
|
||||||
|
# line of code under test is downstream of it.
|
||||||
|
self.le_live = os.path.join(self.tmp, 'letsencrypt', 'live')
|
||||||
|
os.makedirs(self.le_live)
|
||||||
|
self._real_find = hm.find_certbot_live_dir
|
||||||
|
hm.find_certbot_live_dir = self._fake_find_live_dir
|
||||||
|
self.addCleanup(
|
||||||
|
lambda: setattr(hm, 'find_certbot_live_dir', self._real_find))
|
||||||
|
|
||||||
|
# log_operation() appends to a hardcoded /var/log path. Injecting `open`
|
||||||
|
# into the module namespace shadows the builtin for that module only.
|
||||||
|
real_open = open
|
||||||
|
log_dir = self.tmp
|
||||||
|
|
||||||
|
def _redirecting_open(path, *args, **kwargs):
|
||||||
|
if isinstance(path, str) and path.startswith('/var/log/'):
|
||||||
|
path = os.path.join(log_dir, os.path.basename(path))
|
||||||
|
return real_open(path, *args, **kwargs)
|
||||||
|
|
||||||
|
hm.open = _redirecting_open
|
||||||
|
self.addCleanup(lambda: hm.__dict__.pop('open', None))
|
||||||
|
|
||||||
|
hm.init_db()
|
||||||
|
self.client = hm.app.test_client()
|
||||||
|
|
||||||
|
def _restore_env(self):
|
||||||
|
os.environ.clear()
|
||||||
|
os.environ.update(self._saved_env)
|
||||||
|
|
||||||
|
def _restore_globals(self):
|
||||||
|
for name, value in self._saved.items():
|
||||||
|
if value is None:
|
||||||
|
setattr(hm, name, None)
|
||||||
|
else:
|
||||||
|
setattr(hm, name, value)
|
||||||
|
|
||||||
|
def _fake_find_live_dir(self, *args, **kwargs):
|
||||||
|
base = args[0] if args else kwargs.get('base_domain')
|
||||||
|
path = os.path.join(self.le_live, base)
|
||||||
|
return path if os.path.isdir(path) else None
|
||||||
|
|
||||||
|
# -- helpers ---------------------------------------------------------
|
||||||
|
def write(self, path, text):
|
||||||
|
os.makedirs(os.path.dirname(path), exist_ok=True)
|
||||||
|
with open(path, 'w') as fh:
|
||||||
|
fh.write(text)
|
||||||
|
return path
|
||||||
|
|
||||||
|
def read(self, path):
|
||||||
|
with open(path) as fh:
|
||||||
|
return fh.read()
|
||||||
|
|
||||||
|
def make_lineage(self, domain, cert=LEAF_CERT, key=LEAF_KEY):
|
||||||
|
"""Create a certbot live directory. key=None omits privkey.pem."""
|
||||||
|
live = os.path.join(self.le_live, domain)
|
||||||
|
os.makedirs(live, exist_ok=True)
|
||||||
|
self.write(os.path.join(live, 'fullchain.pem'), cert)
|
||||||
|
if key is not None:
|
||||||
|
self.write(os.path.join(live, 'privkey.pem'), key)
|
||||||
|
return live
|
||||||
|
|
||||||
|
def publish_live_bundle(self, domain, content=PREVIOUS_BUNDLE):
|
||||||
|
"""A good bundle already being served for `domain`."""
|
||||||
|
return self.write(os.path.join(self.certs, f'{domain}.pem'), content)
|
||||||
|
|
||||||
|
def add_domain(self, domain, backend_name, ssl_cert_path=None):
|
||||||
|
with sqlite3.connect(hm.DB_FILE) as conn:
|
||||||
|
cur = conn.cursor()
|
||||||
|
cur.execute(
|
||||||
|
'INSERT INTO domains (domain, ssl_enabled, ssl_cert_path) '
|
||||||
|
'VALUES (?, ?, ?)',
|
||||||
|
(domain, 1 if ssl_cert_path else 0, ssl_cert_path))
|
||||||
|
domain_id = cur.lastrowid
|
||||||
|
cur.execute('INSERT INTO backends (name, domain_id) VALUES (?, ?)',
|
||||||
|
(backend_name, domain_id))
|
||||||
|
backend_id = cur.lastrowid
|
||||||
|
cur.execute(
|
||||||
|
'INSERT INTO backend_servers '
|
||||||
|
'(backend_id, server_name, server_address, server_port) '
|
||||||
|
'VALUES (?, ?, ?, ?)', (backend_id, 'srv1', '10.0.0.1', 8080))
|
||||||
|
conn.commit()
|
||||||
|
|
||||||
|
def certbot_invocations(self):
|
||||||
|
if not os.path.exists(self.certbot_log):
|
||||||
|
return []
|
||||||
|
return [line.strip() for line in self.read(self.certbot_log).splitlines()]
|
||||||
|
|
||||||
|
def certbot_deletes(self):
|
||||||
|
return [c for c in self.certbot_invocations() if c.startswith('delete')]
|
||||||
|
|
||||||
|
def edge_would_start(self):
|
||||||
|
"""Would HAProxy load the current config + crt directory?"""
|
||||||
|
return subprocess.run(
|
||||||
|
['haproxy', '-c', '-f', hm.HAPROXY_CONFIG_PATH],
|
||||||
|
capture_output=True).returncode == 0
|
||||||
|
|
||||||
|
def assert_only_final_pems_in_certs_dir(self):
|
||||||
|
strays = [n for n in os.listdir(self.certs) if not n.endswith('.pem')]
|
||||||
|
self.assertEqual(
|
||||||
|
[], strays,
|
||||||
|
'HAProxy loads every file in the crt directory; only final .pem '
|
||||||
|
f'bundles may exist there, found: {strays}')
|
||||||
|
|
||||||
|
|
||||||
|
class TestLivePemIsNeverTruncated(CertPublishTestCase):
|
||||||
|
"""Bug 1: the live PEM was opened in truncate mode before any source read."""
|
||||||
|
|
||||||
|
def test_failed_renewal_leaves_previous_bundle_intact(self):
|
||||||
|
"""HEADLINE: a failure mid-publish must not disturb what is served.
|
||||||
|
|
||||||
|
The renewed lineage has a privkey.pem that exists but is empty - the
|
||||||
|
signature of a write that died half way, and the case the old
|
||||||
|
`os.path.exists(key)` guard waved straight through into
|
||||||
|
`cat fullchain emptykey > livepem`.
|
||||||
|
"""
|
||||||
|
cert_path = self.publish_live_bundle('renew.example.com')
|
||||||
|
before = self.read(cert_path)
|
||||||
|
self.add_domain('renew.example.com', 'renew_backend',
|
||||||
|
ssl_cert_path=cert_path)
|
||||||
|
self.make_lineage('renew.example.com', key='')
|
||||||
|
|
||||||
|
resp = self.client.post('/api/certificates/renew')
|
||||||
|
|
||||||
|
after = self.read(cert_path)
|
||||||
|
self.assertEqual(before, after,
|
||||||
|
'the live PEM must still be the previous bundle, '
|
||||||
|
'byte for byte')
|
||||||
|
self.assertTrue(structurally_valid(after),
|
||||||
|
'the served bundle must still contain a cert AND a key')
|
||||||
|
self.assertTrue(self.edge_would_start(),
|
||||||
|
'HAProxy must still be able to load the crt directory')
|
||||||
|
self.assertEqual(500, resp.status_code,
|
||||||
|
'a failed publish must be reported loudly, not as success')
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
def test_missing_source_key_leaves_previous_bundle_intact(self):
|
||||||
|
"""Same invariant when privkey.pem is absent rather than empty."""
|
||||||
|
cert_path = self.publish_live_bundle('gone.example.com')
|
||||||
|
before = self.read(cert_path)
|
||||||
|
self.add_domain('gone.example.com', 'gone_backend',
|
||||||
|
ssl_cert_path=cert_path)
|
||||||
|
self.make_lineage('gone.example.com', key=None)
|
||||||
|
|
||||||
|
self.client.post('/api/certificates/renew')
|
||||||
|
|
||||||
|
self.assertEqual(before, self.read(cert_path))
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
|
||||||
|
def test_issuance_failure_leaves_previous_bundle_intact(self):
|
||||||
|
"""/api/ssl re-issuing over an existing bundle must be all-or-nothing."""
|
||||||
|
cert_path = self.publish_live_bundle('issue.example.com')
|
||||||
|
before = self.read(cert_path)
|
||||||
|
self.add_domain('issue.example.com', 'issue_backend')
|
||||||
|
self.make_lineage('issue.example.com', key='')
|
||||||
|
|
||||||
|
resp = self.client.post('/api/ssl', json={'domain': 'issue.example.com'})
|
||||||
|
|
||||||
|
self.assertEqual(before, self.read(cert_path))
|
||||||
|
self.assertTrue(structurally_valid(self.read(cert_path)))
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
self.assertEqual(500, resp.status_code)
|
||||||
|
self.assertEqual('error', resp.get_json()['status'])
|
||||||
|
|
||||||
|
def test_successful_renewal_still_publishes(self):
|
||||||
|
"""The guard must not block the normal path.
|
||||||
|
|
||||||
|
The old version built its "renewed" certificate with a no-op
|
||||||
|
`.replace('\\n-----END CERTIFICATE-----', '\\n-----END CERTIFICATE-----')`,
|
||||||
|
so the renewed lineage was byte-identical to what was already being
|
||||||
|
served. Every assertion still passed if the renewal published nothing
|
||||||
|
at all - which is the failure this test is supposed to catch. The live
|
||||||
|
bundle now carries a marker the renewed material does not, so "the file
|
||||||
|
on disk changed" is an actual assertion.
|
||||||
|
"""
|
||||||
|
cert_path = self.publish_live_bundle('ok.example.com')
|
||||||
|
self.assertIn(PREVIOUS_MARKER, self.read(cert_path),
|
||||||
|
'fixture precondition: the live bundle is distinguishable')
|
||||||
|
self.add_domain('ok.example.com', 'ok_backend', ssl_cert_path=cert_path)
|
||||||
|
self.make_lineage('ok.example.com')
|
||||||
|
|
||||||
|
resp = self.client.post('/api/certificates/renew')
|
||||||
|
|
||||||
|
self.assertEqual(200, resp.status_code, resp.get_data(as_text=True))
|
||||||
|
published = self.read(cert_path)
|
||||||
|
self.assertEqual(GOOD_BUNDLE, published,
|
||||||
|
'the renewed cert+key was not written to the live pem')
|
||||||
|
self.assertNotIn(PREVIOUS_MARKER, published,
|
||||||
|
'the previous bundle is still on disk: the renewal '
|
||||||
|
'published nothing')
|
||||||
|
self.assertTrue(structurally_valid(published))
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
backup = os.path.join(hm.cert_backup_dir(), 'ok.example.com.pem')
|
||||||
|
self.assertTrue(os.path.exists(backup))
|
||||||
|
self.assertEqual(PREVIOUS_BUNDLE, self.read(backup),
|
||||||
|
'the archived copy is not the bundle that was replaced')
|
||||||
|
|
||||||
|
|
||||||
|
class TestOldCertificateIsNotDestroyedFirst(CertPublishTestCase):
|
||||||
|
"""Bug 2: superseded .pem removed and lineage deleted before validation."""
|
||||||
|
|
||||||
|
def _setup_supersede(self, broken=True):
|
||||||
|
# An older single-SAN file whose CN is covered by the new bundle.
|
||||||
|
old_path = self.write(
|
||||||
|
os.path.join(self.certs, 'www.test.example.com.pem'), GOOD_BUNDLE)
|
||||||
|
self.add_domain('test.example.com', 'bundle_backend')
|
||||||
|
self.make_lineage('test.example.com', key='' if broken else LEAF_KEY)
|
||||||
|
return old_path
|
||||||
|
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_failed_bundle_does_not_remove_the_old_certificate(self):
|
||||||
|
old_path = self._setup_supersede(broken=True)
|
||||||
|
|
||||||
|
resp = self.client.post('/api/ssl/bundle', json={
|
||||||
|
'primary': 'test.example.com',
|
||||||
|
'sans': ['www.test.example.com'],
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(500, resp.status_code)
|
||||||
|
self.assertTrue(
|
||||||
|
os.path.exists(old_path),
|
||||||
|
'the superseded certificate must survive a failed replacement - '
|
||||||
|
'it may be the only working copy left')
|
||||||
|
self.assertTrue(structurally_valid(self.read(old_path)))
|
||||||
|
self.assertEqual(
|
||||||
|
[], self.certbot_deletes(),
|
||||||
|
'`certbot delete` is irreversible and rate-limited to recover from; '
|
||||||
|
'it must never run for a replacement that was never published')
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_lineage_is_deleted_only_after_haproxy_loads_the_bundle(self):
|
||||||
|
"""A reload failure must leave the lineage intact and the file recoverable."""
|
||||||
|
old_path = self._setup_supersede(broken=False)
|
||||||
|
# Make generate_config() produce a config the validator rejects, so the
|
||||||
|
# publish succeeds but HAProxy never loads it.
|
||||||
|
self.add_domain('other.example.com', BROKEN_TOKEN + '_backend')
|
||||||
|
|
||||||
|
resp = self.client.post('/api/ssl/bundle', json={
|
||||||
|
'primary': 'test.example.com',
|
||||||
|
'sans': ['www.test.example.com'],
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(500, resp.status_code)
|
||||||
|
self.assertEqual(
|
||||||
|
[], self.certbot_deletes(),
|
||||||
|
'the lineage must not be deleted when HAProxy did not reload')
|
||||||
|
self.assertFalse(os.path.exists(old_path))
|
||||||
|
quarantined = os.path.join(hm.cert_backup_dir(),
|
||||||
|
os.path.basename(old_path))
|
||||||
|
self.assertTrue(os.path.exists(quarantined),
|
||||||
|
'the superseded file must be recoverable by hand')
|
||||||
|
self.assertTrue(structurally_valid(self.read(quarantined)))
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_successful_bundle_still_supersedes_and_deletes(self):
|
||||||
|
"""The cleanup must still do its job on the happy path."""
|
||||||
|
old_path = self._setup_supersede(broken=False)
|
||||||
|
|
||||||
|
resp = self.client.post('/api/ssl/bundle', json={
|
||||||
|
'primary': 'test.example.com',
|
||||||
|
'sans': ['www.test.example.com'],
|
||||||
|
})
|
||||||
|
|
||||||
|
self.assertEqual(200, resp.status_code, resp.get_data(as_text=True))
|
||||||
|
self.assertFalse(os.path.exists(old_path),
|
||||||
|
'the superseded file must leave the crt directory or '
|
||||||
|
'it keeps shadowing the new bundle')
|
||||||
|
self.assertEqual(['delete --cert-name www.test.example.com -n'],
|
||||||
|
self.certbot_deletes())
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
|
||||||
|
class TestBundleValidation(CertPublishTestCase):
|
||||||
|
"""What may and may not be published."""
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_structure_checks(self):
|
||||||
|
cases = [
|
||||||
|
('', False, 'empty'),
|
||||||
|
(' \n', False, 'whitespace only'),
|
||||||
|
(LEAF_CERT, False, 'certificate without a key'),
|
||||||
|
(LEAF_KEY, False, 'key without a certificate'),
|
||||||
|
(GOOD_BUNDLE[:len(LEAF_CERT) // 2], False, 'truncated mid-block'),
|
||||||
|
(LEAF_CERT + LEAF_KEY.replace('-----END PRIVATE KEY-----', ''),
|
||||||
|
False, 'key block never closed'),
|
||||||
|
(GOOD_BUNDLE, True, 'complete bundle'),
|
||||||
|
]
|
||||||
|
for text, expected, label in cases:
|
||||||
|
with self.subTest(label):
|
||||||
|
ok, _ = hm.validate_pem_structure(text)
|
||||||
|
self.assertEqual(expected, ok)
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_key_must_match_the_leaf_certificate(self):
|
||||||
|
dest = os.path.join(self.certs, 'pair.example.com.pem')
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src', 'fullchain.pem'), LEAF_CERT)
|
||||||
|
bad_key = self.write(os.path.join(self.tmp, 'src', 'wrong.pem'),
|
||||||
|
UNRELATED_KEY)
|
||||||
|
with self.assertRaises(hm.CertificatePublishError):
|
||||||
|
hm.publish_pem_bundle(dest, [cert, bad_key])
|
||||||
|
self.assertFalse(os.path.exists(dest))
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_mismatched_pair_does_not_disturb_the_live_bundle(self):
|
||||||
|
"""The atomic-swap invariant, not just the pre-write content check.
|
||||||
|
|
||||||
|
A cert+key that only turns out to be unusable once assembled (here: a
|
||||||
|
structurally perfect bundle whose key belongs to another certificate)
|
||||||
|
is the case that proves the live file is never opened for writing -
|
||||||
|
the failure is discovered with the replacement already fully staged.
|
||||||
|
"""
|
||||||
|
dest = self.publish_live_bundle('swap.example.com')
|
||||||
|
before = self.read(dest)
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'srcm', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
bad_key = self.write(os.path.join(self.tmp, 'srcm', 'privkey.pem'),
|
||||||
|
UNRELATED_KEY)
|
||||||
|
|
||||||
|
with self.assertRaises(hm.CertificatePublishError):
|
||||||
|
hm.publish_pem_bundle(dest, [cert, bad_key])
|
||||||
|
|
||||||
|
self.assertEqual(before, self.read(dest),
|
||||||
|
'the previously served bundle must survive byte for byte')
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_unexpected_error_mid_publish_leaves_the_live_bundle_intact(self):
|
||||||
|
"""A failure anywhere between staging and swap must be survivable.
|
||||||
|
|
||||||
|
Stands in for the failures we cannot stage deterministically - disk
|
||||||
|
full, container killed, an exception in a future validation step.
|
||||||
|
"""
|
||||||
|
dest = self.publish_live_bundle('boom.example.com')
|
||||||
|
before = self.read(dest)
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'srcb', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'srcb', 'privkey.pem'), LEAF_KEY)
|
||||||
|
|
||||||
|
real_validate = hm.validate_pem_bundle
|
||||||
|
|
||||||
|
def _explode(path):
|
||||||
|
raise RuntimeError('simulated failure while publishing')
|
||||||
|
|
||||||
|
hm.validate_pem_bundle = _explode
|
||||||
|
self.addCleanup(lambda: setattr(hm, 'validate_pem_bundle', real_validate))
|
||||||
|
|
||||||
|
with self.assertRaises(Exception):
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
|
||||||
|
self.assertEqual(before, self.read(dest))
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_staging_and_backups_live_outside_the_crt_directory(self):
|
||||||
|
"""A temp or backup file inside the crt dir would be loaded by HAProxy.
|
||||||
|
|
||||||
|
`startswith(certs + os.sep)` alone let the worst case through: if
|
||||||
|
cert_staging_dir() returned the crt directory ITSELF - staging straight
|
||||||
|
into the directory HAProxy scans, the exact hazard this design exists
|
||||||
|
to prevent - the assertion passed, because the certs dir is not a
|
||||||
|
strict subpath of itself.
|
||||||
|
"""
|
||||||
|
certs = os.path.realpath(self.certs)
|
||||||
|
for name, path in (('staging', hm.cert_staging_dir()),
|
||||||
|
('backup', hm.cert_backup_dir())):
|
||||||
|
real = os.path.realpath(path)
|
||||||
|
self.assertNotEqual(
|
||||||
|
certs, real,
|
||||||
|
f'the {name} directory IS the crt directory - HAProxy would '
|
||||||
|
f'load every temp/backup file in it')
|
||||||
|
self.assertFalse(
|
||||||
|
real.startswith(certs + os.sep),
|
||||||
|
f'the {name} directory {path} must not be inside {self.certs}')
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_previous_bundle_is_backed_up_on_publish(self):
|
||||||
|
dest = self.publish_live_bundle('backup.example.com')
|
||||||
|
previous = self.read(dest)
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src2', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'src2', 'privkey.pem'), LEAF_KEY)
|
||||||
|
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
|
||||||
|
backup = os.path.join(hm.cert_backup_dir(), 'backup.example.com.pem')
|
||||||
|
self.assertTrue(os.path.exists(backup),
|
||||||
|
'an operator needs a manual path back to the previous '
|
||||||
|
'certificate')
|
||||||
|
self.assertEqual(previous, self.read(backup))
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_corrupt_live_bundle_does_not_overwrite_a_good_backup(self):
|
||||||
|
"""Mirrors create_backup(require_valid=True) for haproxy.cfg."""
|
||||||
|
dest = os.path.join(self.certs, 'guard.example.com.pem')
|
||||||
|
os.makedirs(hm.cert_backup_dir(), exist_ok=True)
|
||||||
|
good_backup = self.write(
|
||||||
|
os.path.join(hm.cert_backup_dir(), 'guard.example.com.pem'),
|
||||||
|
GOOD_BUNDLE)
|
||||||
|
self.write(dest, LEAF_CERT) # live file is key-less garbage
|
||||||
|
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src3', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'src3', 'privkey.pem'), LEAF_KEY)
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
|
||||||
|
self.assertEqual(GOOD_BUNDLE, self.read(good_backup),
|
||||||
|
'a good backup must not be replaced by a corrupt live '
|
||||||
|
'file')
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_no_temp_file_survives_a_failed_publish(self):
|
||||||
|
"""The failure must happen AFTER something has been staged.
|
||||||
|
|
||||||
|
This used to feed publish_pem_bundle() an empty privkey, which is
|
||||||
|
rejected while reading the sources - before the staging directory is
|
||||||
|
even created. The test then asserted `[] == []` and proved nothing
|
||||||
|
about temp-file cleanup. A structurally perfect bundle whose key
|
||||||
|
belongs to a different certificate is rejected by the pairing check,
|
||||||
|
which runs on the fully staged file, so the temp definitely exists at
|
||||||
|
the moment the publish fails.
|
||||||
|
"""
|
||||||
|
dest = os.path.join(self.certs, 'leak.example.com.pem')
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src4', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
wrong = self.write(os.path.join(self.tmp, 'src4', 'privkey.pem'),
|
||||||
|
UNRELATED_KEY)
|
||||||
|
with self.assertRaises(hm.CertificatePublishError):
|
||||||
|
hm.publish_pem_bundle(dest, [cert, wrong])
|
||||||
|
|
||||||
|
staging = hm.cert_staging_dir()
|
||||||
|
self.assertTrue(os.path.isdir(staging),
|
||||||
|
'the publish never got as far as staging, so this '
|
||||||
|
'asserts nothing about cleanup')
|
||||||
|
self.assertEqual([], os.listdir(staging),
|
||||||
|
'staged files must be cleaned up when a publish fails')
|
||||||
|
self.assertFalse(os.path.exists(dest),
|
||||||
|
'a rejected bundle was published anyway')
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
@NEEDS_OPENSSL
|
||||||
|
def test_empty_pem_blocks_are_rejected(self):
|
||||||
|
"""Why the pairing check may not be best-effort.
|
||||||
|
|
||||||
|
Structural validation is weak on its own: BEGIN/END pairs with nothing
|
||||||
|
between them satisfy every rule in validate_pem_structure(). Only
|
||||||
|
openssl can say this is not a certificate.
|
||||||
|
"""
|
||||||
|
hollow = ('-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----\n'
|
||||||
|
'-----BEGIN PRIVATE KEY-----\n-----END PRIVATE KEY-----\n')
|
||||||
|
ok, _ = hm.validate_pem_structure(hollow)
|
||||||
|
self.assertTrue(ok, 'precondition: structure alone accepts this file')
|
||||||
|
|
||||||
|
path = self.write(os.path.join(self.tmp, 'hollow.pem'), hollow)
|
||||||
|
ok, msg = hm.validate_pem_bundle(path)
|
||||||
|
self.assertFalse(ok, 'a bundle of empty pem blocks was accepted')
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_publish_refuses_when_the_pairing_check_cannot_run(self):
|
||||||
|
"""No fail-open. 'unavailable' means the image is broken, not the cert.
|
||||||
|
|
||||||
|
The previous behaviour logged a warning and published on structural
|
||||||
|
checks alone, justified by "the Dockerfile does not install the openssl
|
||||||
|
CLI". It does - openssl 3.x comes in with ca-certificates, and
|
||||||
|
generate_self_signed_cert() shells out to `openssl req` with
|
||||||
|
check=True during setup - so this branch never fired and the fail-open
|
||||||
|
was safe only by accident.
|
||||||
|
"""
|
||||||
|
real = hm._openssl_pairing_status
|
||||||
|
hm._openssl_pairing_status = lambda path: ('unavailable',
|
||||||
|
'openssl binary not found')
|
||||||
|
self.addCleanup(setattr, hm, '_openssl_pairing_status', real)
|
||||||
|
|
||||||
|
dest = self.publish_live_bundle('nocheck.example.com')
|
||||||
|
before = self.read(dest)
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src5', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'src5', 'privkey.pem'), LEAF_KEY)
|
||||||
|
|
||||||
|
with self.assertRaises(hm.CertificatePublishError):
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
|
||||||
|
self.assertEqual(before, self.read(dest),
|
||||||
|
'the live pem was disturbed by a refused publish')
|
||||||
|
self.assert_only_final_pems_in_certs_dir()
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_binary_corrupt_live_bundle_can_still_be_republished(self):
|
||||||
|
"""Republishing is how an operator heals a corrupt live pem.
|
||||||
|
|
||||||
|
A pem corrupted into binary (a partial write from before this fix, a
|
||||||
|
bad restore) is unreadable as text. backup_existing_pem() opens it in
|
||||||
|
text mode and caught only OSError, so the UnicodeDecodeError escaped
|
||||||
|
publish_pem_bundle() entirely: the single operation that would have put
|
||||||
|
a working certificate back blew up trying to archive the broken one.
|
||||||
|
The shell half recovers from this without complaint.
|
||||||
|
"""
|
||||||
|
dest = os.path.join(self.certs, 'binary.example.com.pem')
|
||||||
|
with open(dest, 'wb') as fh:
|
||||||
|
fh.write(b'\x00\x01\x02\xfe\xff' * 128)
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src6', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'src6', 'privkey.pem'), LEAF_KEY)
|
||||||
|
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
|
||||||
|
self.assertEqual(GOOD_BUNDLE, self.read(dest),
|
||||||
|
'a binary-corrupt live pem blocked its own repair')
|
||||||
|
self.assertTrue(self.edge_would_start())
|
||||||
|
|
||||||
|
@FIX_ONLY
|
||||||
|
def test_published_pem_file_mode(self):
|
||||||
|
"""Publishing must not silently re-permission a private key.
|
||||||
|
|
||||||
|
The staged file is created by mkstemp at 0600; without the explicit
|
||||||
|
mode copy in write_config_atomically() every publish would tighten a
|
||||||
|
0644 bundle, and a future change in the other direction would loosen
|
||||||
|
one. Neither is a decision a write-safety fix gets to make as a side
|
||||||
|
effect, so pin it.
|
||||||
|
"""
|
||||||
|
cert = self.write(os.path.join(self.tmp, 'src7', 'fullchain.pem'),
|
||||||
|
LEAF_CERT)
|
||||||
|
key = self.write(os.path.join(self.tmp, 'src7', 'privkey.pem'), LEAF_KEY)
|
||||||
|
|
||||||
|
for mode in (0o644, 0o640, 0o600):
|
||||||
|
with self.subTest(oct(mode)):
|
||||||
|
dest = self.publish_live_bundle(f'mode{mode:o}.example.com')
|
||||||
|
os.chmod(dest, mode)
|
||||||
|
hm.publish_pem_bundle(dest, [cert, key])
|
||||||
|
self.assertEqual(mode,
|
||||||
|
stat.S_IMODE(os.stat(dest).st_mode),
|
||||||
|
'publishing changed who can read the key')
|
||||||
|
|
||||||
|
fresh = os.path.join(self.certs, 'fresh.example.com.pem')
|
||||||
|
hm.publish_pem_bundle(fresh, [cert, key])
|
||||||
|
fresh_mode = stat.S_IMODE(os.stat(fresh).st_mode)
|
||||||
|
self.assertEqual(0o644, fresh_mode,
|
||||||
|
'a newly created bundle should match the 0644 that '
|
||||||
|
'`cat > file` produced under the standard umask')
|
||||||
|
self.assertEqual(0, fresh_mode & 0o022,
|
||||||
|
'a private key must never be group/world writable')
|
||||||
|
|
||||||
|
|
||||||
|
@unittest.skipIf(TESTING_FOREIGN_TREE,
|
||||||
|
'HAPROXY_MANAGER_DIR points at another tree')
|
||||||
|
class TestPublisherApiIsPresent(unittest.TestCase):
|
||||||
|
"""FIX_ONLY must never be able to hide the fix going missing.
|
||||||
|
|
||||||
|
With `FIX_ONLY = skipUnless(hasattr(hm, 'publish_pem_bundle'))`, renaming
|
||||||
|
that one function turned 10 of these 17 tests into skips and the run still
|
||||||
|
printed OK. This class fails loudly instead.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_publisher_api_is_present(self):
|
||||||
|
for name in ('publish_pem_bundle', 'validate_pem_bundle',
|
||||||
|
'validate_pem_structure', 'backup_existing_pem',
|
||||||
|
'cert_staging_dir', 'cert_backup_dir',
|
||||||
|
'CertificatePublishError', '_openssl_pairing_status'):
|
||||||
|
self.assertTrue(
|
||||||
|
hasattr(hm, name),
|
||||||
|
f'haproxy_manager.{name} is gone - the tests that exercise it '
|
||||||
|
f'would otherwise skip themselves and report OK')
|
||||||
|
|
||||||
|
|
||||||
|
class TestClusterSecretSelfHeal(CertPublishTestCase):
|
||||||
|
"""Bug 4: a zero-byte secret file was never healed."""
|
||||||
|
|
||||||
|
def test_empty_secret_file_is_healed(self):
|
||||||
|
self.write(hm.CLUSTER_SECRET_PATH, '')
|
||||||
|
secret = hm.get_or_create_cluster_secret()
|
||||||
|
self.assertTrue(
|
||||||
|
secret,
|
||||||
|
'an empty secret file must be regenerated, not returned as ""')
|
||||||
|
self.assertEqual(secret, self.read(hm.CLUSTER_SECRET_PATH).strip())
|
||||||
|
self.assertEqual(secret, hm.get_or_create_cluster_secret(),
|
||||||
|
'the healed secret must then be stable')
|
||||||
|
|
||||||
|
def test_existing_secret_is_preserved(self):
|
||||||
|
self.write(hm.CLUSTER_SECRET_PATH, 'deadbeef\n')
|
||||||
|
self.assertEqual('deadbeef', hm.get_or_create_cluster_secret())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
print(f"testing haproxy_manager from: {MODULE_DIR}", file=sys.stderr)
|
||||||
|
unittest.main(verbosity=2)
|
||||||
@@ -31,8 +31,10 @@ __BROKEN__, which is how the tests inject an invalid configuration.
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
import sys
|
import sys
|
||||||
import shutil
|
import shutil
|
||||||
|
import inspect
|
||||||
import sqlite3
|
import sqlite3
|
||||||
import logging
|
import logging
|
||||||
import tempfile
|
import tempfile
|
||||||
@@ -412,12 +414,79 @@ class TestBackupPrimitives(RollbackTestCase):
|
|||||||
self.assertEqual(self.read(hm.HAPROXY_BACKUP_PATH), good)
|
self.assertEqual(self.read(hm.HAPROXY_BACKUP_PATH), good)
|
||||||
|
|
||||||
def test_backup_set_covers_every_file_generate_config_writes(self):
|
def test_backup_set_covers_every_file_generate_config_writes(self):
|
||||||
pairs = dict(hm._config_backup_pairs())
|
"""Derived, not restated.
|
||||||
for path in (hm.HAPROXY_CONFIG_PATH, hm.BLOCKED_IPS_MAP_PATH,
|
|
||||||
hm.CORAZA_SPOE_CONFIG_PATH):
|
An earlier version of this test listed the three files it expected and
|
||||||
self.assertIn(path, pairs,
|
checked they were in the backup set, so it could never have noticed a
|
||||||
f'{path} is written by generate_config() but is not '
|
FOURTH file being added. Here the set of files generate_config() writes
|
||||||
'part of the backed-up config set')
|
is observed (and, for env-gated branches this fixture cannot safely
|
||||||
|
execute, read out of the source), and anything not backed up has to be
|
||||||
|
on the documented exclusion list below.
|
||||||
|
"""
|
||||||
|
# Written by generate_config() but deliberately NOT restorable, with
|
||||||
|
# the reason. Everything else must be in the backup set: `haproxy -c`
|
||||||
|
# validates the config as a set, so a file it loads that is not
|
||||||
|
# restored alongside haproxy.cfg breaks rollback.
|
||||||
|
excluded = {
|
||||||
|
# Only ever created empty-when-missing (haproxy refuses to start
|
||||||
|
# with an ACL -f pointing at a missing file); its contents are
|
||||||
|
# owned by the /suspended API, not by generate_config(), so there
|
||||||
|
# is nothing here for a config rollback to undo.
|
||||||
|
'suspended_domains.list',
|
||||||
|
# Generated once and then read, never rewritten with new content.
|
||||||
|
# Its value is rendered INTO haproxy.cfg, so restoring an older
|
||||||
|
# haproxy.cfg alongside the current secret file is consistent.
|
||||||
|
'cluster-secret',
|
||||||
|
}
|
||||||
|
backed_up = {os.path.basename(p) for p, _ in hm._config_backup_pairs()}
|
||||||
|
|
||||||
|
# 1. Observed: run a generation with every patchable optional branch on
|
||||||
|
# and see what actually changed on disk.
|
||||||
|
self.add_domain('derive.example.com', 'derive_backend')
|
||||||
|
os.environ['HAPROXY_CORAZA_SPOE_BACKEND'] = '127.0.0.1:9000'
|
||||||
|
self.addCleanup(os.environ.pop, 'HAPROXY_CORAZA_SPOE_BACKEND', None)
|
||||||
|
before = self._snapshot_etc()
|
||||||
|
hm.generate_config()
|
||||||
|
after = self._snapshot_etc()
|
||||||
|
touched = {name for name, blob in after.items()
|
||||||
|
if before.get(name) != blob}
|
||||||
|
self.assertIn('coraza-spoe.cfg', touched,
|
||||||
|
'fixture precondition: the Coraza branch did not run')
|
||||||
|
|
||||||
|
# 2. Read out of the source: branches this fixture must not execute
|
||||||
|
# (suspension writes a hardcoded /etc/haproxy path that no test
|
||||||
|
# global can redirect) still have to be accounted for.
|
||||||
|
touched |= {
|
||||||
|
os.path.basename(m)
|
||||||
|
for m in re.findall(r"'(/etc/haproxy/[\w.+-]+)'",
|
||||||
|
inspect.getsource(hm.generate_config))
|
||||||
|
}
|
||||||
|
|
||||||
|
unaccounted = touched - backed_up - excluded
|
||||||
|
self.assertEqual(
|
||||||
|
unaccounted, set(),
|
||||||
|
f'generate_config() writes {sorted(unaccounted)}, which is neither '
|
||||||
|
'in the backup set nor on the documented exclusion list - a '
|
||||||
|
'rollback would restore a mixed-vintage config set')
|
||||||
|
|
||||||
|
def _snapshot_etc(self):
|
||||||
|
"""Contents of every plain file in the fake /etc/haproxy.
|
||||||
|
|
||||||
|
Skips the backup halves (they are the thing being maintained), the
|
||||||
|
SQLite database and its journals, and the stats socket.
|
||||||
|
"""
|
||||||
|
skip_prefixes = (os.path.basename(hm.DB_FILE),
|
||||||
|
os.path.basename(hm.HAPROXY_SOCKET_PATH))
|
||||||
|
state = {}
|
||||||
|
for name in os.listdir(self.etc):
|
||||||
|
path = os.path.join(self.etc, name)
|
||||||
|
if not os.path.isfile(path) or name.endswith('.backup'):
|
||||||
|
continue
|
||||||
|
if name.startswith(skip_prefixes):
|
||||||
|
continue
|
||||||
|
with open(path, 'rb') as fh:
|
||||||
|
state[name] = fh.read()
|
||||||
|
return state
|
||||||
|
|
||||||
def test_coraza_spoe_config_round_trips(self):
|
def test_coraza_spoe_config_round_trips(self):
|
||||||
self.generate_good_config()
|
self.generate_good_config()
|
||||||
@@ -452,8 +521,12 @@ class TestAtomicWrite(RollbackTestCase):
|
|||||||
fh.write('old content\n')
|
fh.write('old content\n')
|
||||||
|
|
||||||
# Anything that makes f.write() blow up mid-flight stands in for a full
|
# Anything that makes f.write() blow up mid-flight stands in for a full
|
||||||
# disk / killed container.
|
# disk / killed container. TypeError specifically, not Exception: a
|
||||||
with self.assertRaises(Exception):
|
# bare assertRaises(Exception) also swallows the AttributeError raised
|
||||||
|
# when write_config_atomically does not exist at all, so this test
|
||||||
|
# passed against the pre-fix tree and would keep passing if the
|
||||||
|
# function were deleted.
|
||||||
|
with self.assertRaises(TypeError):
|
||||||
hm.write_config_atomically(path, object())
|
hm.write_config_atomically(path, object())
|
||||||
|
|
||||||
self.assertEqual(self.read(path), 'old content\n',
|
self.assertEqual(self.read(path), 'old content\n',
|
||||||
@@ -462,6 +535,241 @@ class TestAtomicWrite(RollbackTestCase):
|
|||||||
self.assertEqual(leftovers, [], f'temp files left behind: {leftovers}')
|
self.assertEqual(leftovers, [], f'temp files left behind: {leftovers}')
|
||||||
|
|
||||||
|
|
||||||
|
class TestBackupFailureGuard(RollbackTestCase):
|
||||||
|
"""generate_config() refuses to write when no rollback target could be taken."""
|
||||||
|
|
||||||
|
def test_a_failed_backup_stops_the_config_from_being_written(self):
|
||||||
|
good = self.generate_good_config()
|
||||||
|
self.block_ip('192.0.2.10')
|
||||||
|
hm.update_blocked_ips_map()
|
||||||
|
good_map = self.read(hm.BLOCKED_IPS_MAP_PATH)
|
||||||
|
|
||||||
|
real_create_backup = hm.create_backup
|
||||||
|
hm.create_backup = lambda *a, **kw: (False, 'error')
|
||||||
|
self.addCleanup(setattr, hm, 'create_backup', real_create_backup)
|
||||||
|
|
||||||
|
self.add_domain('second.example.com', 'second_backend', '10.0.0.3')
|
||||||
|
with self.assertRaises(Exception) as ctx:
|
||||||
|
hm.generate_config()
|
||||||
|
|
||||||
|
self.assertIn('Refusing to regenerate', str(ctx.exception),
|
||||||
|
'a backup failure was not reported as a refusal')
|
||||||
|
self.assertEqual(
|
||||||
|
self.read(hm.HAPROXY_CONFIG_PATH), good,
|
||||||
|
'a new config was written even though the snapshot failed - a bad '
|
||||||
|
'change could not have been rolled back')
|
||||||
|
self.assertEqual(
|
||||||
|
self.read(hm.BLOCKED_IPS_MAP_PATH), good_map,
|
||||||
|
'the blocked IPs map was rewritten even though the snapshot failed')
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidatorAvailability(RollbackTestCase):
|
||||||
|
"""'the validator could not run' is not the same as 'the config is bad'."""
|
||||||
|
|
||||||
|
def _hide_the_haproxy_binary(self):
|
||||||
|
empty = os.path.join(self.tmp, 'empty-bin')
|
||||||
|
os.makedirs(empty, exist_ok=True)
|
||||||
|
os.environ['PATH'] = empty
|
||||||
|
# setUp's cleanup restores the original PATH.
|
||||||
|
|
||||||
|
def test_a_missing_validator_is_unavailable_not_invalid(self):
|
||||||
|
good = self.generate_good_config()
|
||||||
|
self._hide_the_haproxy_binary()
|
||||||
|
|
||||||
|
status, message = hm.validate_config_file(hm.HAPROXY_CONFIG_PATH)
|
||||||
|
self.assertEqual(status, 'unavailable',
|
||||||
|
'a validator that could not run was reported as a '
|
||||||
|
f'verdict on the config ({status}: {message})')
|
||||||
|
|
||||||
|
# And the consequence create_backup() draws from it: a config it could
|
||||||
|
# not check is still snapshotted, because refusing would leave the box
|
||||||
|
# with no rollback target at all. Contrast
|
||||||
|
# test_a_broken_current_config_does_not_replace_a_good_backup, where a
|
||||||
|
# real 'invalid' verdict yields 'kept_previous'.
|
||||||
|
with open(hm.HAPROXY_CONFIG_PATH, 'w') as fh:
|
||||||
|
fh.write('hand written, unverifiable\n')
|
||||||
|
ok, status = hm.create_backup()
|
||||||
|
self.assertTrue(ok)
|
||||||
|
self.assertEqual(status, 'created',
|
||||||
|
'an unverifiable config was treated as a rejected one')
|
||||||
|
self.assertEqual(self.read(hm.HAPROXY_BACKUP_PATH),
|
||||||
|
'hand written, unverifiable\n')
|
||||||
|
self.assertNotEqual(self.read(hm.HAPROXY_BACKUP_PATH), good)
|
||||||
|
|
||||||
|
|
||||||
|
class TestFileComparison(RollbackTestCase):
|
||||||
|
"""The fast path compares bytes, not sizes."""
|
||||||
|
|
||||||
|
def test_same_size_different_content_is_not_identical(self):
|
||||||
|
a = os.path.join(self.etc, 'a')
|
||||||
|
b = os.path.join(self.etc, 'b')
|
||||||
|
with open(a, 'w') as fh:
|
||||||
|
fh.write('aaaa\n')
|
||||||
|
with open(b, 'w') as fh:
|
||||||
|
fh.write('aaba\n')
|
||||||
|
self.assertEqual(os.path.getsize(a), os.path.getsize(b),
|
||||||
|
'fixture: the two files must be the same size')
|
||||||
|
self.assertFalse(hm._files_identical(a, b),
|
||||||
|
'two same-size files with different bytes compared equal')
|
||||||
|
|
||||||
|
def test_a_same_size_drifted_config_still_hits_the_validation_gate(self):
|
||||||
|
"""The case the byte-compare exists for.
|
||||||
|
|
||||||
|
A config edited in place without changing its length (one character
|
||||||
|
swapped, a hostname replaced by another of the same width) must not be
|
||||||
|
mistaken for the known-good backup and waved through.
|
||||||
|
"""
|
||||||
|
good = self.generate_good_config()
|
||||||
|
# Sized in BYTES, not characters: the rendered config contains
|
||||||
|
# non-ASCII (em dashes in template comments), so len(str) would be
|
||||||
|
# smaller than the file and this test would pass for the wrong reason.
|
||||||
|
size = os.path.getsize(hm.HAPROXY_CONFIG_PATH)
|
||||||
|
broken = f'# {BROKEN_TOKEN}\n'.encode()
|
||||||
|
broken += b'#' * (size - len(broken) - 1) + b'\n'
|
||||||
|
with open(hm.HAPROXY_CONFIG_PATH, 'wb') as fh:
|
||||||
|
fh.write(broken)
|
||||||
|
self.assertEqual(os.path.getsize(hm.HAPROXY_CONFIG_PATH), size,
|
||||||
|
'fixture: the drifted config must be the same size')
|
||||||
|
|
||||||
|
ok, status = hm.create_backup()
|
||||||
|
self.assertTrue(ok)
|
||||||
|
self.assertEqual(
|
||||||
|
status, 'kept_previous',
|
||||||
|
'a same-size broken config was accepted as unchanged and skipped '
|
||||||
|
'the validation gate')
|
||||||
|
self.assertEqual(self.read(hm.HAPROXY_BACKUP_PATH), good,
|
||||||
|
'the known-good backup was overwritten')
|
||||||
|
|
||||||
|
|
||||||
|
class TestBlockedIpsMapWrites(RollbackTestCase):
|
||||||
|
"""blocked_ips.map is loaded by `haproxy -c`, so it gets the same care.
|
||||||
|
|
||||||
|
Verified against HAProxy 2.8: with the map referenced by
|
||||||
|
map_ip(/etc/haproxy/blocked_ips.map,0), a half-written final line makes the
|
||||||
|
WHOLE configuration invalid ("'198.51.10' is not a valid IPv4 or IPv6
|
||||||
|
address at line 2 of file ..."), not merely a dropped entry.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_the_map_goes_through_the_atomic_writer(self):
|
||||||
|
seen = []
|
||||||
|
real_write = hm.write_config_atomically
|
||||||
|
|
||||||
|
def spy(path, content, *args, **kwargs):
|
||||||
|
seen.append(path)
|
||||||
|
return real_write(path, content, *args, **kwargs)
|
||||||
|
|
||||||
|
hm.write_config_atomically = spy
|
||||||
|
self.addCleanup(setattr, hm, 'write_config_atomically', real_write)
|
||||||
|
|
||||||
|
self.block_ip('192.0.2.10')
|
||||||
|
self.assertTrue(hm.update_blocked_ips_map())
|
||||||
|
self.assertIn(hm.BLOCKED_IPS_MAP_PATH, seen,
|
||||||
|
'the blocked IPs map was written without the atomic '
|
||||||
|
'writer - a truncated map is a fatal config')
|
||||||
|
|
||||||
|
def test_a_crash_before_the_rename_leaves_the_old_map_intact(self):
|
||||||
|
self.block_ip('192.0.2.10')
|
||||||
|
hm.update_blocked_ips_map()
|
||||||
|
good_map = self.read(hm.BLOCKED_IPS_MAP_PATH)
|
||||||
|
|
||||||
|
real_replace = os.replace
|
||||||
|
|
||||||
|
def boom(src, dst, *args, **kwargs):
|
||||||
|
if dst == hm.BLOCKED_IPS_MAP_PATH:
|
||||||
|
raise OSError('simulated crash between write and rename')
|
||||||
|
return real_replace(src, dst, *args, **kwargs)
|
||||||
|
|
||||||
|
os.replace = boom
|
||||||
|
self.addCleanup(setattr, os, 'replace', real_replace)
|
||||||
|
|
||||||
|
self.block_ip('198.51.100.20')
|
||||||
|
self.assertFalse(hm.update_blocked_ips_map(),
|
||||||
|
'a failed map write was reported as success')
|
||||||
|
os.replace = real_replace
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
self.read(hm.BLOCKED_IPS_MAP_PATH), good_map,
|
||||||
|
'an interrupted map write clobbered the map HAProxy is running')
|
||||||
|
leftovers = [n for n in os.listdir(self.etc) if n.endswith('.tmp')]
|
||||||
|
self.assertEqual(leftovers, [], f'temp files left behind: {leftovers}')
|
||||||
|
|
||||||
|
def test_a_malformed_map_is_not_recorded_as_known_good(self):
|
||||||
|
"""The map backup must stay something HAProxy would actually load."""
|
||||||
|
self.generate_good_config()
|
||||||
|
good_map = self.read(hm.BLOCKED_IPS_MAP_BACKUP_PATH)
|
||||||
|
|
||||||
|
# Straight into the table, the way a bad row gets there in the first
|
||||||
|
# place - the API route is not the only writer.
|
||||||
|
self.block_ip('not-an-ip')
|
||||||
|
hm.update_blocked_ips_map()
|
||||||
|
|
||||||
|
self.assertEqual(
|
||||||
|
self.read(hm.BLOCKED_IPS_MAP_BACKUP_PATH), good_map,
|
||||||
|
'a map HAProxy cannot parse was promoted to the rollback target')
|
||||||
|
|
||||||
|
def test_no_map_backup_is_fabricated_before_a_config_exists(self):
|
||||||
|
"""Nothing to stay in step with means nothing to write."""
|
||||||
|
self.block_ip('192.0.2.10')
|
||||||
|
self.assertTrue(hm.update_blocked_ips_map())
|
||||||
|
self.assertFalse(
|
||||||
|
os.path.exists(hm.BLOCKED_IPS_MAP_BACKUP_PATH),
|
||||||
|
'a rollback target was invented out of a map write alone')
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidationCost(RollbackTestCase):
|
||||||
|
"""`haproxy -c` runs are the customer-facing cost of a config change.
|
||||||
|
|
||||||
|
generate_config() runs synchronously inside the API call that adds a
|
||||||
|
domain, and on an edge with hundreds of certificates `haproxy -c` is the
|
||||||
|
expensive part. These counts are the contract; changing them should be a
|
||||||
|
deliberate decision, not a side effect.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def _count_validations(self, action):
|
||||||
|
calls = []
|
||||||
|
real_validate = hm.validate_config_file
|
||||||
|
|
||||||
|
def spy(path):
|
||||||
|
calls.append(path)
|
||||||
|
return real_validate(path)
|
||||||
|
|
||||||
|
hm.validate_config_file = spy
|
||||||
|
try:
|
||||||
|
action()
|
||||||
|
finally:
|
||||||
|
hm.validate_config_file = real_validate
|
||||||
|
return len(calls)
|
||||||
|
|
||||||
|
def test_blocking_an_ip_does_not_add_a_validation_to_the_next_change(self):
|
||||||
|
self.generate_good_config()
|
||||||
|
|
||||||
|
def add(domain, backend, address):
|
||||||
|
self.add_domain(domain, backend, address)
|
||||||
|
hm.generate_config()
|
||||||
|
|
||||||
|
steady = self._count_validations(
|
||||||
|
lambda: add('a.example.com', 'a_backend', '10.0.0.4'))
|
||||||
|
self.assertEqual(
|
||||||
|
steady, 1,
|
||||||
|
'a steady-state config change should cost exactly one `haproxy -c` '
|
||||||
|
'(the pre-reload gate); the known-good fast path should skip the '
|
||||||
|
f'other one, but {steady} ran')
|
||||||
|
|
||||||
|
# What POST /api/blocked-ips does: rewrite the map outside
|
||||||
|
# generate_config(). This fleet blocks IPs automatically, so it happens
|
||||||
|
# between most config changes.
|
||||||
|
self.block_ip('192.0.2.10')
|
||||||
|
hm.update_blocked_ips_map()
|
||||||
|
|
||||||
|
after_block = self._count_validations(
|
||||||
|
lambda: add('b.example.com', 'b_backend', '10.0.0.5'))
|
||||||
|
self.assertEqual(
|
||||||
|
after_block, steady,
|
||||||
|
'an IP block left the map out of step with its backup, so the next '
|
||||||
|
f'domain add paid {after_block} `haproxy -c` runs instead of '
|
||||||
|
f'{steady} - on the customer-facing call')
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
print(f"testing haproxy_manager from: {MODULE_DIR}")
|
print(f"testing haproxy_manager from: {MODULE_DIR}")
|
||||||
unittest.main(verbosity=2)
|
unittest.main(verbosity=2)
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for the trusted-proxy header gate in hap_listener.tpl.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
txn.real_ip was derived from CF-Connecting-IP / X-Real-IP / X-Forwarded-For
|
||||||
|
with no check on the peer, so any direct client could assert any client IP.
|
||||||
|
That variable drives rate limiting, the trusted-IP whitelist, the wp-login
|
||||||
|
brute-force table and cookie challenge, the wp-json/batch/v1 virtual patch,
|
||||||
|
IP blocking, and Coraza's src-ip -- so a spoofed header bypassed all of them.
|
||||||
|
|
||||||
|
These tests pin the invariant that the header strip is rendered BEFORE any
|
||||||
|
real-IP resolution. Ordering is the whole fix: a del-header emitted after the
|
||||||
|
set-var chain would parse fine, validate fine, and do nothing.
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/test-trusted-proxy-gate.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
import logging
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
os.chdir(MODULE_DIR)
|
||||||
|
sys.path.insert(0, MODULE_DIR)
|
||||||
|
|
||||||
|
_LOG_DIR = tempfile.mkdtemp(prefix='haproxy-mgr-test-logs-')
|
||||||
|
_real_file_handler = logging.FileHandler
|
||||||
|
logging.FileHandler = (
|
||||||
|
lambda filename, *a, **kw: _real_file_handler(
|
||||||
|
os.path.join(_LOG_DIR, os.path.basename(filename)), *a, **kw)
|
||||||
|
)
|
||||||
|
|
||||||
|
import haproxy_manager # noqa: E402
|
||||||
|
|
||||||
|
GATED_HEADERS = ('CF-Connecting-IP', 'X-Real-IP', 'X-Forwarded-For')
|
||||||
|
|
||||||
|
|
||||||
|
def render_listener():
|
||||||
|
return haproxy_manager.template_env.get_template('hap_listener.tpl').render(
|
||||||
|
crt_path='/etc/haproxy/certs',
|
||||||
|
suspension_enabled=False,
|
||||||
|
coraza_spoe_backend=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TrustedProxyGate(unittest.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.cfg = render_listener()
|
||||||
|
|
||||||
|
def test_trusted_proxy_acl_is_defined(self):
|
||||||
|
self.assertIn('acl from_trusted_proxy src', self.cfg)
|
||||||
|
self.assertIn('/etc/haproxy/cloudflare_ips.list', self.cfg)
|
||||||
|
self.assertIn('/etc/haproxy/trusted_proxies.list', self.cfg)
|
||||||
|
|
||||||
|
def test_each_header_is_deleted_for_untrusted_peers(self):
|
||||||
|
for header in GATED_HEADERS:
|
||||||
|
with self.subTest(header=header):
|
||||||
|
pattern = (r'http-request\s+del-header\s+%s\s+if\s+!from_trusted_proxy'
|
||||||
|
% re.escape(header))
|
||||||
|
self.assertRegex(self.cfg, pattern)
|
||||||
|
|
||||||
|
def test_strip_precedes_real_ip_resolution(self):
|
||||||
|
"""The ordering invariant. A strip after the set-var chain is a no-op."""
|
||||||
|
last_strip = max(
|
||||||
|
self.cfg.index('del-header %s' % h) for h in GATED_HEADERS
|
||||||
|
)
|
||||||
|
first_setvar = self.cfg.index('set-var(txn.real_ip)')
|
||||||
|
self.assertLess(
|
||||||
|
last_strip, first_setvar,
|
||||||
|
'del-header rules must be rendered before set-var(txn.real_ip)')
|
||||||
|
|
||||||
|
def test_src_fallback_still_present(self):
|
||||||
|
"""Direct clients must fall through to the real TCP peer."""
|
||||||
|
self.assertIn('set-var(txn.real_ip) src', self.cfg)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
unittest.main(verbosity=2)
|
||||||
@@ -0,0 +1,530 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for the WordPress admin edge gate in hap_listener.tpl.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
Unauthenticated GETs to /wp-admin/* were reaching PHP, booting WordPress just to
|
||||||
|
produce a login redirect and exhausting lsphp pools under a distributed
|
||||||
|
low-and-slow attack. The gate redirects them at the edge instead.
|
||||||
|
|
||||||
|
Two properties are easy to get wrong and invisible to `haproxy -c`:
|
||||||
|
|
||||||
|
* ORDERING. `is_whitelisted` reads var(txn.real_ip). If the rule renders before
|
||||||
|
the set-var chain, the whitelist evaluates against an unset variable.
|
||||||
|
* THE ALLOWLIST. wp-login.php loads its OWN css/js from /wp-admin/. Dropping
|
||||||
|
those entries leaves every login page on the fleet unstyled, while still
|
||||||
|
returning 200 -- a silent regression.
|
||||||
|
|
||||||
|
A THIRD property, added after an adversarial mutation audit: every assertion
|
||||||
|
here must be scoped to the CODE, not the surrounding prose. This file's own
|
||||||
|
comment blocks quote ACL names, rule fragments and even whole rules to explain
|
||||||
|
them -- which means a bare `assertIn` / `re.search` / `str.index` run over the
|
||||||
|
raw rendered config passes just as happily when the real rule has been deleted
|
||||||
|
(or merely commented out) and only its explanation survives. The audit proved
|
||||||
|
this concretely: commenting out the entire redirect rule, or the
|
||||||
|
`acl wp_admin_allowed` line, or all five normalizers, left the previous version
|
||||||
|
of this file at 26/26 PASS. See `rule_lines()` below, and use it (or one of the
|
||||||
|
guarded helpers built on it) for every assertion about whether a rule exists,
|
||||||
|
what it says, or where it sits relative to another rule. Do not add a new
|
||||||
|
`self.cfg.index(...)`, `self.assertIn(x, self.cfg)`, or `re.search(pattern,
|
||||||
|
self.cfg)` to this file -- none of them can tell code from comment.
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/test-wpadmin-gate.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
import logging
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
os.chdir(MODULE_DIR)
|
||||||
|
sys.path.insert(0, MODULE_DIR)
|
||||||
|
|
||||||
|
_LOG_DIR = tempfile.mkdtemp(prefix='haproxy-mgr-test-logs-')
|
||||||
|
_real_file_handler = logging.FileHandler
|
||||||
|
logging.FileHandler = (
|
||||||
|
lambda filename, *a, **kw: _real_file_handler(
|
||||||
|
os.path.join(_LOG_DIR, os.path.basename(filename)), *a, **kw)
|
||||||
|
)
|
||||||
|
|
||||||
|
import haproxy_manager # noqa: E402
|
||||||
|
|
||||||
|
ALLOWLIST = ('/admin-ajax.php', '/admin-post.php',
|
||||||
|
'/load-styles.php', '/load-scripts.php')
|
||||||
|
EXCLUSIONS = ('!wp_admin_allowed', '!wp_admin_asset', '!has_wp_logged_in',
|
||||||
|
'!wp_gate_exempt', '!is_local', '!is_trusted_ip', '!is_whitelisted')
|
||||||
|
|
||||||
|
# The normalizer set, in the order it MUST render. Decoding has to precede the
|
||||||
|
# path walkers or "%2e%2e" is decoded to ".." only after path-strip-dotdot has
|
||||||
|
# already run, leaving the ".." unresolved -- measured against real HAProxy
|
||||||
|
# 3.0.11, both orders side by side.
|
||||||
|
NORMALIZERS = ('percent-to-uppercase',
|
||||||
|
'percent-decode-unreserved',
|
||||||
|
'path-merge-slashes',
|
||||||
|
'path-strip-dot',
|
||||||
|
'path-strip-dotdot full')
|
||||||
|
|
||||||
|
|
||||||
|
def render_listener():
|
||||||
|
return haproxy_manager.template_env.get_template('hap_listener.tpl').render(
|
||||||
|
crt_path='/etc/haproxy/certs',
|
||||||
|
suspension_enabled=False,
|
||||||
|
coraza_spoe_backend=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def render_header():
|
||||||
|
return haproxy_manager.template_env.get_template('hap_header.tpl').render(
|
||||||
|
cluster_secret=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
# Comment-safe config inspection
|
||||||
|
#
|
||||||
|
# Every helper below operates on `rule_positions()`'s output, never on the raw
|
||||||
|
# rendered string. That is the one rule this whole module exists to enforce on
|
||||||
|
# itself: a mutation audit found that commenting out a real rule (prefixing it
|
||||||
|
# with '#', or -- more slyly -- deleting it and appending its own text as a
|
||||||
|
# TRAILING comment on the line above) left the previous version of these tests
|
||||||
|
# fully green, because plain `str.index` / `assertIn` / `re.search` over
|
||||||
|
# `self.cfg` cannot distinguish code from a comment that merely quotes it.
|
||||||
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
def rule_positions(cfg, needle):
|
||||||
|
"""[(comment-stripped line, char offset in cfg)] for every non-comment
|
||||||
|
line containing `needle`, in document order.
|
||||||
|
|
||||||
|
Two things a bare substring/regex search over `self.cfg` gets wrong, both
|
||||||
|
fixed here:
|
||||||
|
|
||||||
|
1. A line that is ENTIRELY a comment (starts with '#' once stripped) is
|
||||||
|
dropped. This is necessary but not sufficient -- see (2).
|
||||||
|
2. A line that MIXES real config with a trailing comment
|
||||||
|
(`live-code # note`, or the decoy `live-code # was: <the other
|
||||||
|
rule's exact text>`) is truncated at the first ' #' before matching,
|
||||||
|
so text stuffed into a trailing comment cannot masquerade as the
|
||||||
|
rule itself. A real HAProxy comment always starts at a '#' preceded
|
||||||
|
by whitespace here -- none of these templates use bare '#' as a
|
||||||
|
value character -- so this truncation does not clip real rules.
|
||||||
|
|
||||||
|
Returning (line, position) pairs together -- rather than making callers
|
||||||
|
re-derive one from the other with a second `cfg.index(line)` -- also
|
||||||
|
avoids a subtler bug: if the same comment-stripped line occurs twice
|
||||||
|
(e.g. a duplicated rule), re-deriving the position with `str.index` always
|
||||||
|
finds the FIRST copy regardless of which one you meant. Walking the file
|
||||||
|
once and recording positions as we go keeps first/last unambiguous.
|
||||||
|
"""
|
||||||
|
out = []
|
||||||
|
pos = 0
|
||||||
|
for raw in cfg.split('\n'):
|
||||||
|
stripped = raw.strip()
|
||||||
|
if stripped and not stripped.startswith('#'):
|
||||||
|
code = stripped.split(' #', 1)[0].rstrip()
|
||||||
|
if code and needle in code:
|
||||||
|
out.append((code, pos))
|
||||||
|
pos += len(raw) + 1 # +1 for the '\n' split() consumed
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
def rule_lines(cfg, needle):
|
||||||
|
"""Comment-stripped rule lines containing `needle` (text only, no
|
||||||
|
position). See `rule_positions()` for what this guards against. Every
|
||||||
|
assertion about a RULE's presence or content must go through this (or
|
||||||
|
`rule_positions`/the guarded helpers below) -- never a bare
|
||||||
|
`needle in cfg` or `re.search(pattern, cfg)`.
|
||||||
|
"""
|
||||||
|
return [line for line, _ in rule_positions(cfg, needle)]
|
||||||
|
|
||||||
|
|
||||||
|
def require_rule(cfg, needle, what=None):
|
||||||
|
"""The single rule line containing `needle`.
|
||||||
|
|
||||||
|
Raises a plain AssertionError naming what was being looked for -- not
|
||||||
|
IndexError from an unguarded `rule_lines(...)[0]`, and not
|
||||||
|
`ValueError: substring not found` from a bare `cfg.index(...)` -- when
|
||||||
|
the rule is missing. A missing rule and a broken test harness must not
|
||||||
|
look identical in a failure report.
|
||||||
|
|
||||||
|
Raises the same way if `needle` is ambiguous (matches more than one rule
|
||||||
|
line): silently taking the first match in that case would hide the
|
||||||
|
ambiguity instead of surfacing it.
|
||||||
|
"""
|
||||||
|
label = what or needle
|
||||||
|
lines = rule_lines(cfg, needle)
|
||||||
|
if not lines:
|
||||||
|
raise AssertionError('no rule found for %r (expected: %s)' % (needle, label))
|
||||||
|
if len(lines) > 1:
|
||||||
|
raise AssertionError(
|
||||||
|
'%r matched %d rule lines, expected exactly one (%s): %r'
|
||||||
|
% (needle, len(lines), label, lines))
|
||||||
|
return lines[0]
|
||||||
|
|
||||||
|
|
||||||
|
def require_position(cfg, needle, what=None, last=False):
|
||||||
|
"""(line, char offset) for an ordering assertion, guarded the same way as
|
||||||
|
`require_rule` -- but tolerant of the needle matching multiple lines
|
||||||
|
(e.g. a multi-line set-var "chain"), since ordering checks often want the
|
||||||
|
first or last of several. Pass last=True for the last occurrence.
|
||||||
|
"""
|
||||||
|
label = what or needle
|
||||||
|
positions = rule_positions(cfg, needle)
|
||||||
|
if not positions:
|
||||||
|
raise AssertionError(
|
||||||
|
'no rule found for %r, cannot check ordering (expected: %s)' % (needle, label))
|
||||||
|
return positions[-1] if last else positions[0]
|
||||||
|
|
||||||
|
|
||||||
|
class WpAdminGate(unittest.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.cfg = render_listener()
|
||||||
|
|
||||||
|
def test_wp_admin_path_acl_declared(self):
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_path', 'wp_admin_path ACL')
|
||||||
|
self.assertIn('path_reg', line)
|
||||||
|
|
||||||
|
def test_wp_admin_asset_acl_declared(self):
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_asset', 'wp_admin_asset ACL')
|
||||||
|
self.assertIn('path_reg', line)
|
||||||
|
|
||||||
|
def test_wp_admin_allowed_acl_declared(self):
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_allowed', 'wp_admin_allowed ACL')
|
||||||
|
self.assertIn('path_end', line)
|
||||||
|
|
||||||
|
def test_wp_gate_exempt_acl_declared(self):
|
||||||
|
"""Scoped to the ACL line itself, not `self.cfg` as a whole -- the
|
||||||
|
surrounding prose (see hap_listener.tpl's "per-site opt-out" comment)
|
||||||
|
also spells out /etc/haproxy/wpadmin_gate_exempt.list verbatim, so an
|
||||||
|
unscoped `assertIn` would still pass with the real ACL deleted.
|
||||||
|
"""
|
||||||
|
line = require_rule(self.cfg, 'acl wp_gate_exempt', 'wp_gate_exempt ACL')
|
||||||
|
self.assertIn('/etc/haproxy/wpadmin_gate_exempt.list', line)
|
||||||
|
|
||||||
|
def test_allowlist_entries_present(self):
|
||||||
|
"""wp-login.php loads its own css/js from /wp-admin/ -- see module docstring."""
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_allowed', 'wp_admin_allowed ACL')
|
||||||
|
for entry in ALLOWLIST:
|
||||||
|
with self.subTest(entry=entry):
|
||||||
|
self.assertIn(entry, line)
|
||||||
|
|
||||||
|
def test_static_asset_dirs_allowed(self):
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_asset', 'wp_admin_asset ACL')
|
||||||
|
self.assertRegex(line, r'path_reg.*\(css\|js\|images\)')
|
||||||
|
|
||||||
|
def test_install_php_is_NOT_allowlisted(self):
|
||||||
|
"""install.php is deliberately gated -- a takeover vector on abandoned installs."""
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_allowed', 'wp_admin_allowed ACL')
|
||||||
|
self.assertNotIn('install.php', line)
|
||||||
|
|
||||||
|
def test_redirect_rule_has_all_exclusions(self):
|
||||||
|
rule = require_rule_by_predicate(
|
||||||
|
self.cfg, 'http-request redirect', lambda ln: 'wp_admin_path' in ln,
|
||||||
|
'wp-admin redirect rule')
|
||||||
|
for excl in EXCLUSIONS:
|
||||||
|
with self.subTest(exclusion=excl):
|
||||||
|
self.assertIn(excl, rule)
|
||||||
|
|
||||||
|
def test_rule_renders_after_real_ip_resolution(self):
|
||||||
|
"""is_whitelisted reads txn.real_ip; before the set-var chain it is unset."""
|
||||||
|
_, setvar_pos = require_position(self.cfg, 'set-var(txn.real_ip)',
|
||||||
|
'real_ip set-var chain')
|
||||||
|
_, rule_pos = require_position(self.cfg, 'wp_admin_path', 'wp_admin_path ACL/rule')
|
||||||
|
self.assertLess(setvar_pos, rule_pos,
|
||||||
|
'wp_admin_path renders before txn.real_ip is resolved')
|
||||||
|
|
||||||
|
def test_rule_renders_after_has_wp_logged_in_declared(self):
|
||||||
|
"""HAProxy resolves ACLs as it parses; use-before-declare fails."""
|
||||||
|
_, decl_pos = require_position(self.cfg, 'acl has_wp_logged_in',
|
||||||
|
'has_wp_logged_in ACL declaration')
|
||||||
|
_, rule_pos = require_position(self.cfg, 'wp_admin_path', 'wp_admin_path ACL/rule')
|
||||||
|
self.assertLess(decl_pos, rule_pos,
|
||||||
|
'wp_admin_path renders before has_wp_logged_in is declared')
|
||||||
|
|
||||||
|
def test_only_one_has_wp_logged_in_declaration(self):
|
||||||
|
self.assertEqual(len(rule_lines(self.cfg, 'acl has_wp_logged_in')), 1)
|
||||||
|
|
||||||
|
def test_allowlist_entries_are_anchored_to_wp_admin(self):
|
||||||
|
"""Bare `path_end /admin-ajax.php` also matches
|
||||||
|
/wp-admin/evil/admin-ajax.php, which ALSO matches wp_admin_path
|
||||||
|
(path_reg only requires /wp-admin/ to appear somewhere) -- an
|
||||||
|
attacker-inserted path segment would then sail through the
|
||||||
|
allowlist ungated. Entries must be anchored to sit directly under
|
||||||
|
wp-admin/. Scoped to the captured ACL line only, since the
|
||||||
|
surrounding comment block also mentions these bare filenames.
|
||||||
|
"""
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_allowed', 'wp_admin_allowed ACL')
|
||||||
|
for entry in ALLOWLIST:
|
||||||
|
with self.subTest(entry=entry):
|
||||||
|
self.assertIn('/wp-admin' + entry, line)
|
||||||
|
self.assertNotRegex(
|
||||||
|
line, r'(?<!wp-admin)' + re.escape(entry) + r'(?!\S)',
|
||||||
|
'found a bare, unanchored allowlist entry: ' + entry)
|
||||||
|
|
||||||
|
def test_wp_login_url_setvar_renders_in_correct_order(self):
|
||||||
|
"""The inline regsub-in-`location` form is rejected by real HAProxy
|
||||||
|
3.0.11 (invalid arg 2 in converter 'regsub'), so the regsub is
|
||||||
|
computed in its own set-var line instead. That set-var must render
|
||||||
|
after the set-var(txn.real_ip) chain (it must not disturb that
|
||||||
|
load-bearing chain) and before the redirect rule that consumes it.
|
||||||
|
"""
|
||||||
|
_, last_real_ip_pos = require_position(self.cfg, 'set-var(txn.real_ip)',
|
||||||
|
'real_ip set-var chain', last=True)
|
||||||
|
_, wp_login_pos = require_position(self.cfg, 'set-var(txn.wp_login_url)',
|
||||||
|
'wp_login_url set-var')
|
||||||
|
_, redirect_pos = require_position(
|
||||||
|
self.cfg, 'http-request redirect code 302 location %[var(txn.wp_login_url)]',
|
||||||
|
'wp-admin redirect rule')
|
||||||
|
self.assertLess(last_real_ip_pos, wp_login_pos,
|
||||||
|
'wp_login_url set-var must render after the real_ip set-var chain')
|
||||||
|
self.assertLess(wp_login_pos, redirect_pos,
|
||||||
|
'wp_login_url set-var must render before the redirect rule that uses it')
|
||||||
|
|
||||||
|
def test_redirect_rule_uses_setvar_not_inline_regsub(self):
|
||||||
|
"""Guards against reintroducing the rejected inline form."""
|
||||||
|
rule = require_rule_by_predicate(
|
||||||
|
self.cfg, 'http-request redirect', lambda ln: 'wp_admin_path' in ln,
|
||||||
|
'wp-admin redirect rule')
|
||||||
|
self.assertIn('%[var(txn.wp_login_url)]', rule)
|
||||||
|
self.assertNotIn('regsub', rule)
|
||||||
|
|
||||||
|
def test_redirect_rule_requires_safe_path(self):
|
||||||
|
"""OPEN REDIRECT guard. The redirect target is built by rewriting
|
||||||
|
`path` with regsub, which only replaces the matched substring --
|
||||||
|
everything before "/wp-admin/" survives untouched in the output.
|
||||||
|
Three concrete requests turn that into an off-site `Location:`
|
||||||
|
header: "//evil.example.com/wp-admin/x.php" (protocol-relative,
|
||||||
|
browsers resolve "//host/path" to "https://host/path"),
|
||||||
|
"/\\evil.example.com/wp-admin/x.php" (browsers normalise a leading
|
||||||
|
"/\\" the same as "//"), and an RFC 7230 absolute-form request
|
||||||
|
target ("https://evil.example.com/wp-admin/x.php") which can make
|
||||||
|
HAProxy's `path` fetch return a full URI. wp_admin_safe_path
|
||||||
|
(requiring a well-formed absolute path) must be a POSITIVE
|
||||||
|
condition on the redirect rule -- scoped to the captured rule line
|
||||||
|
only, since the surrounding comment block also mentions this ACL
|
||||||
|
name and a bare substring match would pass even if the condition
|
||||||
|
were dropped from the rule itself.
|
||||||
|
"""
|
||||||
|
rule = require_rule_by_predicate(
|
||||||
|
self.cfg, 'http-request redirect', lambda ln: 'wp_admin_path' in ln,
|
||||||
|
'wp-admin redirect rule')
|
||||||
|
self.assertIn('wp_admin_safe_path', rule)
|
||||||
|
self.assertNotIn('!wp_admin_safe_path', rule,
|
||||||
|
'wp_admin_safe_path must be a positive condition, not negated')
|
||||||
|
|
||||||
|
def test_wp_admin_safe_path_acl_declared(self):
|
||||||
|
line = require_rule(self.cfg, 'acl wp_admin_safe_path', 'wp_admin_safe_path ACL')
|
||||||
|
self.assertIn('path_reg', line)
|
||||||
|
|
||||||
|
def test_unsafe_wp_admin_path_is_denied_not_passed_through(self):
|
||||||
|
"""wp_admin_safe_path being a POSITIVE condition on the redirect means
|
||||||
|
a path that fails it is simply not redirected -- which used to mean it
|
||||||
|
fell through to the backend UNGATED, i.e. exactly the PHP-booting
|
||||||
|
request the gate exists to stop. Normalisation removes the "//"
|
||||||
|
spelling of that, but not "/\\", so the fall-through must be closed
|
||||||
|
with an explicit deny rather than left implicit.
|
||||||
|
"""
|
||||||
|
denies = rule_lines(self.cfg, '!wp_admin_safe_path')
|
||||||
|
self.assertTrue(denies,
|
||||||
|
'no rule denies a wp-admin path that fails wp_admin_safe_path')
|
||||||
|
self.assertTrue(any(d.startswith('http-request deny') for d in denies),
|
||||||
|
'the !wp_admin_safe_path rule must be a deny: %r' % denies)
|
||||||
|
|
||||||
|
|
||||||
|
def require_rule_by_predicate(cfg, needle, predicate, what):
|
||||||
|
"""Like require_rule(), but for rules identified by needle + a predicate
|
||||||
|
over the comment-stripped line (e.g. "the `http-request redirect` line
|
||||||
|
that also mentions wp_admin_path", since the frontend has more than one
|
||||||
|
`http-request redirect`). Raises a clear AssertionError, not IndexError
|
||||||
|
or a silently-empty match, if no line satisfies both.
|
||||||
|
"""
|
||||||
|
candidates = [ln for ln in rule_lines(cfg, needle) if predicate(ln)]
|
||||||
|
if not candidates:
|
||||||
|
raise AssertionError('no rule found matching %s' % what)
|
||||||
|
if len(candidates) > 1:
|
||||||
|
raise AssertionError('%s matched more than one rule line: %r' % (what, candidates))
|
||||||
|
return candidates[0]
|
||||||
|
|
||||||
|
|
||||||
|
class UriNormalisation(unittest.TestCase):
|
||||||
|
"""The gate matches the RAW path; the backend normalises and decodes it.
|
||||||
|
Every gap between those is a bypass -- five were found this way. These
|
||||||
|
tests pin the normalisation that closes the gap as a class.
|
||||||
|
|
||||||
|
NOTE: these are config-TEXT assertions. They are necessary but NOT
|
||||||
|
sufficient: the previous revision of this file passed while five live
|
||||||
|
bypasses shipped. The real evidence is the behavioural matrix run against
|
||||||
|
real haproxy 3.0.11 with raw sockets -- see
|
||||||
|
.superpowers/sdd/2026-08-14-wpadmin-edge-gate/task-4-normalize-report.md.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.cfg = render_listener()
|
||||||
|
self.header = render_header()
|
||||||
|
|
||||||
|
def test_experimental_directives_exposed_in_global(self):
|
||||||
|
"""normalize-uri is experimental in 3.0; without this HAProxy refuses
|
||||||
|
to start (`haproxy -c` exits 1, ALERT). That does NOT crash-loop the
|
||||||
|
container, though -- see hap_header.tpl's comment and
|
||||||
|
haproxy_manager.py's start_haproxy()/do_initial_setup(): the failure
|
||||||
|
is swallowed, and the container comes up with haproxy simply never
|
||||||
|
running. This test exists so that silent-outage mode is never
|
||||||
|
reintroduced by dropping this line.
|
||||||
|
"""
|
||||||
|
lines = rule_lines(self.header, 'expose-experimental-directives')
|
||||||
|
matches = [ln for ln in lines if ln == 'expose-experimental-directives']
|
||||||
|
self.assertTrue(
|
||||||
|
matches, 'expose-experimental-directives missing from the global section')
|
||||||
|
|
||||||
|
def test_all_normalizers_render(self):
|
||||||
|
for norm in NORMALIZERS:
|
||||||
|
with self.subTest(normalizer=norm):
|
||||||
|
self.assertTrue(
|
||||||
|
rule_lines(self.cfg, 'normalize-uri ' + norm),
|
||||||
|
'missing normalizer: ' + norm)
|
||||||
|
|
||||||
|
def test_normalizer_order_decode_before_path_walkers(self):
|
||||||
|
"""Reverse this order and /wp-admin/js/%2e%2e/plugins.php reaches the
|
||||||
|
ACLs as /wp-admin/js/../plugins.php -- decoded but unresolved.
|
||||||
|
"""
|
||||||
|
lines = [ln for ln in rule_lines(self.cfg, 'http-request normalize-uri')
|
||||||
|
if ln.startswith('http-request normalize-uri')]
|
||||||
|
names = [ln.split('normalize-uri ', 1)[1] for ln in lines]
|
||||||
|
self.assertEqual(
|
||||||
|
names, list(NORMALIZERS),
|
||||||
|
'normalize-uri directives are missing, reordered, or duplicated: %r' % names)
|
||||||
|
|
||||||
|
def test_normalisation_precedes_every_path_based_rule(self):
|
||||||
|
"""A normalizer placed after a path rule normalises nothing for it."""
|
||||||
|
norm_positions = []
|
||||||
|
for n in NORMALIZERS:
|
||||||
|
_, pos = require_position(self.cfg, 'http-request normalize-uri ' + n,
|
||||||
|
'normalizer: ' + n)
|
||||||
|
norm_positions.append(pos)
|
||||||
|
last_norm = max(norm_positions)
|
||||||
|
for marker in ('acl is_health_check', 'acl wp_login_path',
|
||||||
|
'acl xmlrpc_path', 'acl wp_batch_path',
|
||||||
|
'acl wp_admin_path', 'http-request set-path'):
|
||||||
|
with self.subTest(rule=marker):
|
||||||
|
_, marker_pos = require_position(self.cfg, marker, marker)
|
||||||
|
self.assertLess(last_norm, marker_pos,
|
||||||
|
marker + ' renders before URI normalisation')
|
||||||
|
|
||||||
|
def test_query_sort_by_name_is_not_enabled(self):
|
||||||
|
"""query-sort-by-name reorders query parameters, which would break
|
||||||
|
anything that signs or caches on the exact query string. This is NOT
|
||||||
|
because the enabled normalizers already leave the query alone --
|
||||||
|
percent-to-uppercase and percent-decode-unreserved rewrite the WHOLE
|
||||||
|
request-target, query string included (see hap_listener.tpl's BLAST
|
||||||
|
RADIUS comment) -- it is a deliberate line between "case-fold /
|
||||||
|
decode" (no-ops under RFC 3986) and "reorder" (not a no-op for a
|
||||||
|
signed/cached query string).
|
||||||
|
"""
|
||||||
|
self.assertFalse(rule_lines(self.cfg, 'normalize-uri query-sort-by-name'))
|
||||||
|
|
||||||
|
def test_dotdot_normalizer_uses_full(self):
|
||||||
|
"""Without "full", ".." segments that climb above the root are left in
|
||||||
|
place and /../../wp-admin/plugins.php survives -- measured.
|
||||||
|
"""
|
||||||
|
lines = rule_lines(self.cfg, 'normalize-uri path-strip-dotdot')
|
||||||
|
self.assertTrue(lines, 'missing normalizer: path-strip-dotdot')
|
||||||
|
for ln in lines:
|
||||||
|
self.assertTrue(ln.endswith('path-strip-dotdot full'), ln)
|
||||||
|
|
||||||
|
def test_encoded_separator_on_wp_admin_is_denied(self):
|
||||||
|
"""percent-decode-unreserved deliberately leaves %2F encoded ("/" is
|
||||||
|
reserved), but OpenLiteSpeed decodes it and serves the file --
|
||||||
|
/wp-admin%2Fplugins.php was measured booting PHP on the OLS tier while
|
||||||
|
matching no wp-admin ACL. Normalisation cannot close this; it needs its
|
||||||
|
own rule.
|
||||||
|
"""
|
||||||
|
denies = [ln for ln in rule_lines(self.cfg, 'path_has_encoded_sep')
|
||||||
|
if ln.startswith('http-request deny')]
|
||||||
|
self.assertTrue(denies, 'no deny rule for encoded separators')
|
||||||
|
acl_line = require_rule(self.cfg, 'acl path_has_encoded_sep', 'path_has_encoded_sep ACL')
|
||||||
|
self.assertIn('%2f', acl_line.lower())
|
||||||
|
|
||||||
|
def test_encoded_separator_deny_is_scoped_to_wp_admin(self):
|
||||||
|
"""A blanket "deny any %2F in any path" would break non-WordPress
|
||||||
|
customer apps that legitimately pass an encoded slash in a path
|
||||||
|
parameter. The deny must be conditioned on the path mentioning
|
||||||
|
wp-admin.
|
||||||
|
"""
|
||||||
|
denies = [ln for ln in rule_lines(self.cfg, 'path_has_encoded_sep')
|
||||||
|
if ln.startswith('http-request deny')]
|
||||||
|
self.assertTrue(denies, 'no deny rule for encoded separators')
|
||||||
|
for d in denies:
|
||||||
|
self.assertIn('wp_admin_word', d)
|
||||||
|
|
||||||
|
def test_encoded_separator_deny_honors_the_same_whitelist(self):
|
||||||
|
denies = [ln for ln in rule_lines(self.cfg, 'path_has_encoded_sep')
|
||||||
|
if ln.startswith('http-request deny')]
|
||||||
|
self.assertTrue(denies, 'no deny rule for encoded separators')
|
||||||
|
for d in denies:
|
||||||
|
for excl in ('!has_wp_logged_in', '!wp_gate_exempt', '!is_local',
|
||||||
|
'!is_trusted_ip', '!is_whitelisted'):
|
||||||
|
with self.subTest(rule=d, exclusion=excl):
|
||||||
|
self.assertIn(excl, d)
|
||||||
|
|
||||||
|
def test_encoded_separator_acl_matches_a_substring_not_a_prefix(self):
|
||||||
|
"""/blog%2Fwp-admin/plugins.php hides the separator BEFORE "wp-admin",
|
||||||
|
where an anchored pattern never matches, and OLS still resolves it.
|
||||||
|
"""
|
||||||
|
acl_line = require_rule(self.cfg, 'acl path_has_encoded_sep', 'path_has_encoded_sep ACL')
|
||||||
|
self.assertIn('-m sub', acl_line)
|
||||||
|
|
||||||
|
def test_wp_admin_asset_bypass_cannot_cover_a_php_entrypoint(self):
|
||||||
|
"""The asset bypass anchored its prefix but not its suffix, so
|
||||||
|
/wp-admin/css/../plugins.php took it and the backend then resolved
|
||||||
|
".." and booted plugins.php. path-strip-dotdot is the real fix; this
|
||||||
|
keeps the bypass structurally incapable of covering PHP.
|
||||||
|
"""
|
||||||
|
acl_line = require_rule(self.cfg, 'acl wp_admin_asset', 'wp_admin_asset ACL')
|
||||||
|
self.assertIn('.php', acl_line,
|
||||||
|
'wp_admin_asset must exclude .php explicitly')
|
||||||
|
|
||||||
|
def test_wp_admin_asset_pattern_is_end_of_flags_guarded(self):
|
||||||
|
"""A pattern starting with "(" makes HAProxy warn on EVERY load/reload:
|
||||||
|
|
||||||
|
parsing acl 'wp_admin_asset' : matching 'path_reg' for pattern
|
||||||
|
'(^|/)wp-admin/...' is likely a mistake ... Maybe you need to
|
||||||
|
remove the extraneous space before '('.
|
||||||
|
|
||||||
|
"--" is the end-of-flags marker HAProxy itself names as the fix. It is
|
||||||
|
cosmetic to matching but not to operations: an unsilenced warning on
|
||||||
|
every reload on every host trains people to skim past warnings, which
|
||||||
|
is how a real one gets missed. Assert the pattern is still the one we
|
||||||
|
think it is, so this can never pass by the pattern having been changed.
|
||||||
|
"""
|
||||||
|
acl_line = require_rule(self.cfg, 'acl wp_admin_asset', 'wp_admin_asset ACL')
|
||||||
|
self.assertRegex(
|
||||||
|
acl_line, r'path_reg\s+--\s+\(',
|
||||||
|
'wp_admin_asset pattern begins with "(" and MUST be preceded by "--"')
|
||||||
|
self.assertIn('(^|/)wp-admin/(css|js|images)/', acl_line)
|
||||||
|
|
||||||
|
def test_case_insensitive_acl_and_regsub_are_kept_in_sync(self):
|
||||||
|
"""A case-insensitive wp_admin_path with a case-sensitive regsub is an
|
||||||
|
INFINITE REDIRECT LOOP: regsub finds no "/wp-admin/" in
|
||||||
|
"/WP-ADMIN/plugins.php", returns `path` unchanged, and the Location
|
||||||
|
then points at the request's own URL.
|
||||||
|
"""
|
||||||
|
acl_line = require_rule(self.cfg, 'acl wp_admin_path', 'wp_admin_path ACL')
|
||||||
|
setvar_line = require_rule(self.cfg, 'set-var(txn.wp_login_url)', 'wp_login_url set-var')
|
||||||
|
acl_ci = bool(re.search(r'path_reg\s+-i\s', acl_line))
|
||||||
|
regsub_ci = bool(re.search(r'regsub\([^)]*,\s*i\)', setvar_line))
|
||||||
|
self.assertEqual(
|
||||||
|
acl_ci, regsub_ci,
|
||||||
|
'wp_admin_path case-sensitivity (%s) and regsub flags (%s) disagree'
|
||||||
|
% (acl_line, setvar_line))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
unittest.main(verbosity=2)
|
||||||
@@ -0,0 +1,135 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for per-client-IP rate limiting on POST /xmlrpc.php.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
POST /xmlrpc.php floods were unthrottled fleet-wide. The generic frontend
|
||||||
|
rate limits (hap_listener.tpl) trigger at 3000/5000 req/10s -- i.e. 300-500
|
||||||
|
req/s -- but the observed floods run at a few req/s for hours, well under
|
||||||
|
that ceiling. The existing wp_bruteforce mechanism (dedicated stick-table,
|
||||||
|
60s window, per real client IP) solves exactly this shape of problem for
|
||||||
|
POST /wp-login.php; this change adds an equivalent dedicated table/rule pair
|
||||||
|
for POST /xmlrpc.php.
|
||||||
|
|
||||||
|
This is only safe to key on var(txn.real_ip) because of the trusted-proxy
|
||||||
|
gate added earlier (release 2026.08.3, see test-trusted-proxy-gate.py) --
|
||||||
|
before that fix, a direct client could spoof any client IP via
|
||||||
|
X-Forwarded-For and evade all per-IP tracking.
|
||||||
|
|
||||||
|
These tests pin:
|
||||||
|
- a dedicated stick-table for xmlrpc tracking exists in
|
||||||
|
hap_security_tables.tpl (own sc slot / own counter -- not sharing the
|
||||||
|
wp_bruteforce counter, so a wp-login brute-force run and an xmlrpc flood
|
||||||
|
from the same IP don't inflate each other's rate)
|
||||||
|
- the tracking rule only fires on POST /xmlrpc.php (path_end, so
|
||||||
|
subdirectory WP installs are covered)
|
||||||
|
- the limiting rule tarpits over the chosen threshold
|
||||||
|
- the limiting rule honors the same whitelist as every other rule in the
|
||||||
|
file (!is_local !is_trusted_ip !is_whitelisted)
|
||||||
|
- xmlrpc is not blocked outright -- only the rate-limit ACL is present,
|
||||||
|
there's no blanket deny of the path
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/test-xmlrpc-rate-limit.py
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
import logging
|
||||||
|
import tempfile
|
||||||
|
import unittest
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
os.chdir(MODULE_DIR)
|
||||||
|
sys.path.insert(0, MODULE_DIR)
|
||||||
|
|
||||||
|
_LOG_DIR = tempfile.mkdtemp(prefix='haproxy-mgr-test-logs-')
|
||||||
|
_real_file_handler = logging.FileHandler
|
||||||
|
logging.FileHandler = (
|
||||||
|
lambda filename, *a, **kw: _real_file_handler(
|
||||||
|
os.path.join(_LOG_DIR, os.path.basename(filename)), *a, **kw)
|
||||||
|
)
|
||||||
|
|
||||||
|
import haproxy_manager # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
def render_listener():
|
||||||
|
return haproxy_manager.template_env.get_template('hap_listener.tpl').render(
|
||||||
|
crt_path='/etc/haproxy/certs',
|
||||||
|
suspension_enabled=False,
|
||||||
|
coraza_spoe_backend=None,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def render_security_tables():
|
||||||
|
return haproxy_manager.template_env.get_template(
|
||||||
|
'hap_security_tables.tpl').render()
|
||||||
|
|
||||||
|
|
||||||
|
class XmlrpcRateLimit(unittest.TestCase):
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
self.listener_cfg = render_listener()
|
||||||
|
self.tables_cfg = render_security_tables()
|
||||||
|
|
||||||
|
def test_dedicated_stick_table_defined(self):
|
||||||
|
"""A dedicated table (not wp_bruteforce) tracks xmlrpc requests, so a
|
||||||
|
wp-login brute-force run and an xmlrpc flood from the same IP can't
|
||||||
|
inflate each other's rate counter."""
|
||||||
|
self.assertRegex(
|
||||||
|
self.tables_cfg,
|
||||||
|
r'backend\s+xmlrpc_bruteforce\s*\n\s*stick-table\s+type\s+ip\b.*store.*http_req_rate',
|
||||||
|
)
|
||||||
|
# Must not be the same table wp-login already uses.
|
||||||
|
self.assertNotIn('backend wp_bruteforce\n stick-table type ip size 100k expire 30m store http_req_rate(60s)\nbackend xmlrpc_bruteforce', self.tables_cfg)
|
||||||
|
|
||||||
|
def test_xmlrpc_path_acl_uses_path_end(self):
|
||||||
|
"""path_end (not path_beg) so subdirectory WP installs are covered,
|
||||||
|
matching the wp-login rule's reasoning."""
|
||||||
|
self.assertRegex(
|
||||||
|
self.listener_cfg,
|
||||||
|
r'acl\s+xmlrpc_path\s+path_end\s+/xmlrpc\.php',
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_tracking_rule_only_fires_on_post_xmlrpc(self):
|
||||||
|
self.assertRegex(
|
||||||
|
self.listener_cfg,
|
||||||
|
r'http-request\s+track-sc2\s+var\(txn\.real_ip\)\s+table\s+xmlrpc_bruteforce\s+if\s+METH_POST\s+xmlrpc_path',
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_limiting_rule_tarpits_over_threshold_with_whitelist(self):
|
||||||
|
pattern = (
|
||||||
|
r'http-request\s+tarpit\s+deny_status\s+429\s+if\s+METH_POST\s+xmlrpc_path\s+'
|
||||||
|
r'\{\s*sc_http_req_rate\(2\)\s+gt\s+(\d+)\s*\}\s+'
|
||||||
|
r'!is_local\s+!is_trusted_ip\s+!is_whitelisted'
|
||||||
|
)
|
||||||
|
match = re.search(pattern, self.listener_cfg)
|
||||||
|
self.assertIsNotNone(
|
||||||
|
match, 'expected a tarpit rule tracking sc2 with the full whitelist')
|
||||||
|
threshold = int(match.group(1))
|
||||||
|
self.assertGreater(threshold, 0)
|
||||||
|
|
||||||
|
def test_xmlrpc_not_blocked_outright(self):
|
||||||
|
"""The endpoint must remain functional for clients under the
|
||||||
|
threshold -- only a rate-limit ACL, no blanket deny of the path."""
|
||||||
|
self.assertNotRegex(
|
||||||
|
self.listener_cfg,
|
||||||
|
r'http-request\s+deny\s+deny_status\s+\d+\s+if\s+(?:METH_POST\s+)?xmlrpc_path\s*(?:!is_local|\n)',
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_rule_order_after_wp_login_block(self):
|
||||||
|
"""Not load-bearing for correctness (mutually exclusive paths), but
|
||||||
|
keep the new block grouped with the other WordPress-specific rules
|
||||||
|
rather than scattered elsewhere in the file."""
|
||||||
|
wp_login_idx = self.listener_cfg.index('wp_login_path')
|
||||||
|
xmlrpc_idx = self.listener_cfg.index('xmlrpc_path')
|
||||||
|
self.assertLess(wp_login_idx, xmlrpc_idx)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
unittest.main(verbosity=2)
|
||||||
@@ -0,0 +1,423 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Build gate: render the real HAProxy config and hand it to the real `haproxy -c`.
|
||||||
|
|
||||||
|
Why this file exists
|
||||||
|
--------------------
|
||||||
|
On 2026-08-14 a change to hap_listener.tpl rendered perfectly, passed every
|
||||||
|
unit test in scripts/ (13 green), and was then rejected outright by HAProxy:
|
||||||
|
|
||||||
|
[ALERT] config : parsing [/etc/haproxy/haproxy.cfg:...] :
|
||||||
|
invalid arg 2 in converter 'regsub' : ... unexpected empty
|
||||||
|
replacement string
|
||||||
|
|
||||||
|
Nothing between "commit" and "running in production" would have caught it.
|
||||||
|
The unit tests assert on the *text* of the rendered config with regexes, which
|
||||||
|
tells you what the template says, never whether HAProxy will accept it. And
|
||||||
|
scripts/test-config-rollback.py stubs the `haproxy` binary with a shell script
|
||||||
|
that only rejects a literal sentinel token, so its "validation" has never
|
||||||
|
parsed a single line of real HAProxy syntax.
|
||||||
|
|
||||||
|
The failure mode this guards is not cosmetic. When haproxy.cfg is invalid,
|
||||||
|
scripts/init.py refuses to start HAProxy but the container still comes up:
|
||||||
|
ports 80/443 are unbound, every site on the host is down, and /health keeps
|
||||||
|
answering 200 because the Flask API is fine.
|
||||||
|
|
||||||
|
So: render the config through the SAME code path production uses
|
||||||
|
(haproxy_manager.generate_config(), templates and all), then run the actual
|
||||||
|
`haproxy -c` against the result and gate on its exit code.
|
||||||
|
|
||||||
|
This runs as a RUN step in the Dockerfile, which means it also validates
|
||||||
|
against the exact haproxy binary that ships in the image being built - note
|
||||||
|
that the Dockerfile installs haproxy UNPINNED, so that binary can move under
|
||||||
|
us between builds. Any syntax the new binary rejects now fails the build
|
||||||
|
instead of failing at 3am on an edge node.
|
||||||
|
|
||||||
|
What it covers
|
||||||
|
--------------
|
||||||
|
* every template generate_config() touches, assembled in the real order
|
||||||
|
* a domain with SSL + a backend, a wildcard domain, a cert-only domain with
|
||||||
|
no backend, and two template_override backends
|
||||||
|
* blocked-IP map entries (single IP and CIDR)
|
||||||
|
* BOTH sides of the two conditional blocks in hap_listener.tpl -
|
||||||
|
{%- if suspension_enabled %} and {%- if coraza_spoe_backend %} - because a
|
||||||
|
syntax error inside a conditional ships undetected otherwise. Scenario
|
||||||
|
"full" turns both on; scenario "default" leaves both off, which is the
|
||||||
|
byte-identical-to-standalone shape.
|
||||||
|
|
||||||
|
Warnings vs failures
|
||||||
|
--------------------
|
||||||
|
`haproxy -c` emits warnings on a clean config here (at minimum "Can't load
|
||||||
|
stats file" because /var/lib/haproxy/stats.dat doesn't exist at build time,
|
||||||
|
plus assorted path_reg/ACL advisories). Those are NOT failures. This gate keys
|
||||||
|
on the process EXIT CODE only, and dumps the full output when it is non-zero.
|
||||||
|
|
||||||
|
Running
|
||||||
|
-------
|
||||||
|
python3 scripts/validate-rendered-config.py
|
||||||
|
|
||||||
|
Needs the real `haproxy` binary, the application's Python dependencies, and
|
||||||
|
write access to /etc/haproxy (several templates reference files there by
|
||||||
|
absolute path - see _REAL_PATH_NOTE below). Inside the image build all three
|
||||||
|
hold. On a workstation, run it in the container instead.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
|
import sqlite3
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
|
||||||
|
MODULE_DIR = os.path.abspath(
|
||||||
|
os.environ.get('HAPROXY_MANAGER_DIR',
|
||||||
|
os.path.join(os.path.dirname(os.path.abspath(__file__)), '..'))
|
||||||
|
)
|
||||||
|
os.chdir(MODULE_DIR)
|
||||||
|
sys.path.insert(0, MODULE_DIR)
|
||||||
|
|
||||||
|
# Same trick the other suites use: haproxy_manager configures logging at import
|
||||||
|
# time against /var/log/haproxy-manager.log. Redirect the handlers so this runs
|
||||||
|
# without root and without polluting the image's log files.
|
||||||
|
_LOG_DIR = tempfile.mkdtemp(prefix='haproxy-validate-logs-')
|
||||||
|
_real_file_handler = logging.FileHandler
|
||||||
|
logging.FileHandler = (
|
||||||
|
lambda filename, *a, **kw: _real_file_handler(
|
||||||
|
os.path.join(_LOG_DIR, os.path.basename(filename)), *a, **kw)
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
import haproxy_manager as hm # noqa: E402
|
||||||
|
finally:
|
||||||
|
logging.FileHandler = _real_file_handler
|
||||||
|
|
||||||
|
# The application logs a lot at INFO during a render, and legitimately logs at
|
||||||
|
# ERROR about things that are only true in this harness ("no existing HAProxy
|
||||||
|
# config on disk ... ROLLBACK IS NOT AVAILABLE" - correct, there is no live
|
||||||
|
# config during a build). Silence it so the build log carries the gate's own
|
||||||
|
# verdict and haproxy's output, which is what matters.
|
||||||
|
logging.getLogger('haproxy_manager').setLevel(logging.CRITICAL)
|
||||||
|
|
||||||
|
|
||||||
|
# _REAL_PATH_NOTE
|
||||||
|
# ---------------
|
||||||
|
# Most paths haproxy_manager writes to are module-level constants and are
|
||||||
|
# redirected into a temp dir below. Two cannot be:
|
||||||
|
#
|
||||||
|
# /etc/haproxy/blocked_ips.map - hardcoded inside hap_listener.tpl's
|
||||||
|
# map_ip() converter
|
||||||
|
# /etc/haproxy/coraza-spoe.cfg - hardcoded in the `filter spoe engine`
|
||||||
|
# line, and parsed by haproxy -c
|
||||||
|
#
|
||||||
|
# Redirecting the constants without editing the templates would just make
|
||||||
|
# haproxy read a different (missing) file, so those two are left at their real
|
||||||
|
# paths. Everything this script creates under /etc/haproxy is removed again on
|
||||||
|
# exit; pre-existing files (the baked trusted_ips.*) are never touched.
|
||||||
|
ETC_HAPROXY = '/etc/haproxy'
|
||||||
|
|
||||||
|
# Files referenced with `-f` / map_ip() from the templates. A missing `-f` file
|
||||||
|
# is a FATAL haproxy error, so a gate that didn't create these would fail for
|
||||||
|
# reasons that have nothing to do with the config being tested.
|
||||||
|
STUB_FILES = {
|
||||||
|
os.path.join(ETC_HAPROXY, 'trusted_ips.list'): '# validation stub\n203.0.113.10\n',
|
||||||
|
os.path.join(ETC_HAPROXY, 'trusted_ips.map'): '# validation stub\n203.0.113.11 1\n',
|
||||||
|
os.path.join(ETC_HAPROXY, 'cloudflare_ips.list'): '# validation stub\n198.51.100.0/24\n',
|
||||||
|
os.path.join(ETC_HAPROXY, 'trusted_proxies.list'): '# validation stub\n192.0.2.0/24\n',
|
||||||
|
os.path.join(ETC_HAPROXY, 'wpadmin_gate_exempt.list'): '# validation stub\nexempt.example.test\n',
|
||||||
|
os.path.join(ETC_HAPROXY, 'suspended_domains.list'): 'suspended.example.test\n',
|
||||||
|
# `lf-file` on the Coraza deny rule; loaded at parse time. Present in the
|
||||||
|
# image (COPY errors /haproxy/errors), stubbed for anything else.
|
||||||
|
'/haproxy/errors/403-waf.html': '<html><body>blocked %[unique-id]</body></html>\n',
|
||||||
|
}
|
||||||
|
|
||||||
|
# (suspension_enabled, coraza_spoe_backend) combinations to render + validate.
|
||||||
|
SCENARIOS = (
|
||||||
|
('default', {}),
|
||||||
|
('full', {
|
||||||
|
'HAPROXY_SUSPENSION_ENABLED': 'true',
|
||||||
|
'HAPROXY_CORAZA_SPOE_BACKEND': '127.0.0.1:9000',
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def log(msg):
|
||||||
|
sys.stdout.write(f'[validate-config] {msg}\n')
|
||||||
|
sys.stdout.flush()
|
||||||
|
|
||||||
|
|
||||||
|
def fail(msg):
|
||||||
|
sys.stderr.write(f'[validate-config] FAIL: {msg}\n')
|
||||||
|
sys.stderr.flush()
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
|
||||||
|
class CreatedFiles:
|
||||||
|
"""Tracks what we put on disk outside the temp dir so it can be removed.
|
||||||
|
|
||||||
|
Two sources: files we create explicitly, and files generate_config() itself
|
||||||
|
writes into /etc/haproxy (blocked_ips.map, coraza-spoe.cfg and their
|
||||||
|
.backup copies). The latter are caught by diffing the directory listing,
|
||||||
|
which also picks up anything a future change starts writing there.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.explicit = []
|
||||||
|
self.etc_before = self._listdir(ETC_HAPROXY)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _listdir(path):
|
||||||
|
try:
|
||||||
|
return set(os.listdir(path))
|
||||||
|
except OSError:
|
||||||
|
return set()
|
||||||
|
|
||||||
|
def ensure(self, path, content):
|
||||||
|
"""Create path with content if it does not already exist."""
|
||||||
|
if os.path.exists(path):
|
||||||
|
return
|
||||||
|
os.makedirs(os.path.dirname(path), exist_ok=True)
|
||||||
|
with open(path, 'w') as fh:
|
||||||
|
fh.write(content)
|
||||||
|
os.chmod(path, 0o644)
|
||||||
|
self.explicit.append(path)
|
||||||
|
|
||||||
|
def cleanup(self):
|
||||||
|
for path in self.explicit:
|
||||||
|
try:
|
||||||
|
os.unlink(path)
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
for name in self._listdir(ETC_HAPROXY) - self.etc_before:
|
||||||
|
try:
|
||||||
|
os.unlink(os.path.join(ETC_HAPROXY, name))
|
||||||
|
except OSError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def require_haproxy_binary():
|
||||||
|
"""Fail closed. A gate that skips itself when the binary is missing is a
|
||||||
|
gate that would have let the 2026-08-14 change through."""
|
||||||
|
path = shutil.which('haproxy')
|
||||||
|
if not path:
|
||||||
|
fail('no `haproxy` binary on PATH - this gate cannot validate anything. '
|
||||||
|
'Run it inside the image (the Dockerfile installs haproxy).')
|
||||||
|
version = subprocess.run([path, '-v'], capture_output=True, text=True)
|
||||||
|
log(f'using {path}: {version.stdout.strip().splitlines()[0] if version.stdout else "unknown version"}')
|
||||||
|
|
||||||
|
|
||||||
|
def make_self_signed_cert(certs_dir):
|
||||||
|
"""HAProxy loads every file in the `bind ... ssl crt <dir>` directory at
|
||||||
|
parse time, so the directory has to hold a real, loadable bundle."""
|
||||||
|
os.makedirs(certs_dir, exist_ok=True)
|
||||||
|
cert = os.path.join(certs_dir, 'cert.tmp')
|
||||||
|
key = os.path.join(certs_dir, 'key.tmp')
|
||||||
|
subprocess.run(
|
||||||
|
['openssl', 'req', '-x509', '-newkey', 'rsa:2048', '-nodes',
|
||||||
|
'-keyout', key, '-out', cert, '-days', '1',
|
||||||
|
'-subj', '/CN=validate.example.test'],
|
||||||
|
check=True, capture_output=True,
|
||||||
|
)
|
||||||
|
bundle = os.path.join(certs_dir, 'validate.example.test.pem')
|
||||||
|
with open(bundle, 'w') as out:
|
||||||
|
for part in (cert, key):
|
||||||
|
with open(part) as fh:
|
||||||
|
out.write(fh.read())
|
||||||
|
os.unlink(cert)
|
||||||
|
os.unlink(key)
|
||||||
|
os.chmod(bundle, 0o600)
|
||||||
|
|
||||||
|
|
||||||
|
def seed_database(db_path):
|
||||||
|
"""A representative fleet: SSL + backend, wildcard, cert-only, overrides."""
|
||||||
|
hm.DB_FILE = db_path
|
||||||
|
hm.init_db()
|
||||||
|
with sqlite3.connect(db_path) as conn:
|
||||||
|
cur = conn.cursor()
|
||||||
|
|
||||||
|
def add_site(domain, backend, ssl_enabled=1, wildcard=0, override=None,
|
||||||
|
servers=(('web1', '10.0.0.10', 8080, 'check'),)):
|
||||||
|
cur.execute(
|
||||||
|
'INSERT INTO domains (domain, ssl_enabled, ssl_cert_path, '
|
||||||
|
'template_override, is_wildcard) VALUES (?, ?, ?, ?, ?)',
|
||||||
|
(domain, ssl_enabled, f'/etc/haproxy/certs/{domain}.pem',
|
||||||
|
override, wildcard),
|
||||||
|
)
|
||||||
|
domain_id = cur.lastrowid
|
||||||
|
cur.execute('INSERT INTO backends (name, domain_id, settings) '
|
||||||
|
'VALUES (?, ?, ?)', (backend, domain_id, None))
|
||||||
|
backend_id = cur.lastrowid
|
||||||
|
for name, addr, port, opts in servers:
|
||||||
|
cur.execute(
|
||||||
|
'INSERT INTO backend_servers (backend_id, server_name, '
|
||||||
|
'server_address, server_port, server_options) '
|
||||||
|
'VALUES (?, ?, ?, ?, ?)',
|
||||||
|
(backend_id, name, addr, port, opts),
|
||||||
|
)
|
||||||
|
|
||||||
|
add_site('site-one.example.test', 'site-one',
|
||||||
|
servers=(('web1', '10.0.0.10', 8080, 'check'),
|
||||||
|
('web2', '10.0.0.11', 8080, 'check backup')))
|
||||||
|
add_site('site-two.example.test', 'site-two', ssl_enabled=0)
|
||||||
|
add_site('*.wildcard.example.test', 'wildcard-site', wildcard=1)
|
||||||
|
add_site('ws.example.test', 'ws-site', override='hap_backend_websocket')
|
||||||
|
add_site('sse.example.test', 'sse-site', override='hap_backend_longlived')
|
||||||
|
|
||||||
|
# Cert/management-only domain: registered for certificates, no backend.
|
||||||
|
# generate_config() has an explicit branch for this.
|
||||||
|
cur.execute(
|
||||||
|
'INSERT INTO domains (domain, ssl_enabled, ssl_cert_path, '
|
||||||
|
'template_override, is_wildcard) VALUES (?, ?, ?, ?, ?)',
|
||||||
|
('panel.example.test', 1, '/etc/haproxy/certs/panel.pem', None, 0),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Both map_ip() shapes: a single address and a CIDR.
|
||||||
|
for ip in ('203.0.113.66', '198.51.100.0/24'):
|
||||||
|
cur.execute('INSERT INTO blocked_ips (ip_address, reason, blocked_by) '
|
||||||
|
'VALUES (?, ?, ?)', (ip, 'validation fixture', 'gate'))
|
||||||
|
conn.commit()
|
||||||
|
|
||||||
|
|
||||||
|
def render(scenario_name, env_overrides, workdir):
|
||||||
|
"""Render via generate_config() and return the path to the assembled config.
|
||||||
|
|
||||||
|
generate_config() is the real production entry point: it takes the rollback
|
||||||
|
snapshot, writes the blocked-IP map, renders every template, and writes
|
||||||
|
haproxy.cfg. Only the reload is stubbed - there is no HAProxy process to
|
||||||
|
reload during a build, and validating the file is the whole point.
|
||||||
|
"""
|
||||||
|
scenario_dir = os.path.join(workdir, scenario_name)
|
||||||
|
certs_dir = os.path.join(scenario_dir, 'certs')
|
||||||
|
os.makedirs(scenario_dir)
|
||||||
|
make_self_signed_cert(certs_dir)
|
||||||
|
|
||||||
|
hm.HAPROXY_CONFIG_PATH = os.path.join(scenario_dir, 'haproxy.cfg')
|
||||||
|
hm.HAPROXY_BACKUP_PATH = os.path.join(scenario_dir, 'haproxy.cfg.backup')
|
||||||
|
hm.CLUSTER_SECRET_PATH = os.path.join(scenario_dir, 'cluster-secret')
|
||||||
|
hm.HAPROXY_SOCKET_PATH = os.path.join(scenario_dir, 'haproxy.sock')
|
||||||
|
hm.SSL_CERTS_DIR = certs_dir
|
||||||
|
seed_database(os.path.join(scenario_dir, 'haproxy_config.db'))
|
||||||
|
|
||||||
|
saved_env = {}
|
||||||
|
for key in ('HAPROXY_SUSPENSION_ENABLED', 'HAPROXY_CORAZA_SPOE_BACKEND'):
|
||||||
|
saved_env[key] = os.environ.pop(key, None)
|
||||||
|
os.environ.update(env_overrides)
|
||||||
|
|
||||||
|
real_reload = hm.reload_haproxy_safely
|
||||||
|
hm.reload_haproxy_safely = lambda *a, **kw: (True, 'reload skipped: build-time validation')
|
||||||
|
try:
|
||||||
|
hm.generate_config()
|
||||||
|
finally:
|
||||||
|
hm.reload_haproxy_safely = real_reload
|
||||||
|
for key, value in saved_env.items():
|
||||||
|
os.environ.pop(key, None)
|
||||||
|
if value is not None:
|
||||||
|
os.environ[key] = value
|
||||||
|
|
||||||
|
return hm.HAPROXY_CONFIG_PATH
|
||||||
|
|
||||||
|
|
||||||
|
def assert_scenario_branches(scenario_name, config_path, env_overrides):
|
||||||
|
"""Cheap sanity check that the conditional blocks actually rendered.
|
||||||
|
|
||||||
|
Without this, a template refactor that silently stopped emitting the
|
||||||
|
suspension or Coraza block would leave the gate passing while covering
|
||||||
|
less than it claims to.
|
||||||
|
"""
|
||||||
|
with open(config_path) as fh:
|
||||||
|
text = fh.read()
|
||||||
|
expected = {
|
||||||
|
'suspension': ('acl is_suspended_domain',
|
||||||
|
'HAPROXY_SUSPENSION_ENABLED' in env_overrides),
|
||||||
|
'coraza': ('filter spoe engine coraza',
|
||||||
|
'HAPROXY_CORAZA_SPOE_BACKEND' in env_overrides),
|
||||||
|
}
|
||||||
|
for label, (needle, should_be_present) in expected.items():
|
||||||
|
present = needle in text
|
||||||
|
if present != should_be_present:
|
||||||
|
fail(f'[{scenario_name}] {label} block {"missing" if should_be_present else "unexpectedly present"} '
|
||||||
|
f'in the rendered config (looked for {needle!r}). The gate is '
|
||||||
|
f'not covering what it thinks it is.')
|
||||||
|
|
||||||
|
|
||||||
|
def _dump_context(config_path, output):
|
||||||
|
"""Print the rendered lines HAProxy complained about.
|
||||||
|
|
||||||
|
The temp dir is deleted on the way out, so the build log has to carry the
|
||||||
|
evidence. HAProxy reports `parsing [<file>:<line>]`; show a window around
|
||||||
|
each reported line rather than dumping ~1500 lines of config.
|
||||||
|
"""
|
||||||
|
line_numbers = sorted({
|
||||||
|
int(n) for n in re.findall(
|
||||||
|
r'parsing \[' + re.escape(config_path) + r':(\d+)\]', output)
|
||||||
|
})
|
||||||
|
if not line_numbers:
|
||||||
|
return
|
||||||
|
with open(config_path) as fh:
|
||||||
|
lines = fh.read().splitlines()
|
||||||
|
sys.stderr.write('[validate-config] --- rendered config around the error ---\n')
|
||||||
|
for number in line_numbers:
|
||||||
|
start = max(1, number - 6)
|
||||||
|
end = min(len(lines), number + 4)
|
||||||
|
for index in range(start, end + 1):
|
||||||
|
marker = '>>' if index == number else ' '
|
||||||
|
sys.stderr.write(f'{marker}{index:6d}| {lines[index - 1]}\n')
|
||||||
|
sys.stderr.write('[validate-config] ---\n')
|
||||||
|
|
||||||
|
|
||||||
|
def validate(scenario_name, config_path):
|
||||||
|
result = subprocess.run(['haproxy', '-c', '-f', config_path],
|
||||||
|
capture_output=True, text=True)
|
||||||
|
if result.returncode != 0:
|
||||||
|
output = result.stdout + result.stderr
|
||||||
|
sys.stderr.write(
|
||||||
|
f'\n[validate-config] ===== {scenario_name}: haproxy REJECTED the '
|
||||||
|
f'rendered configuration (exit {result.returncode}) =====\n')
|
||||||
|
sys.stderr.write(output if output.endswith('\n') else output + '\n')
|
||||||
|
_dump_context(config_path, output)
|
||||||
|
sys.stderr.write(
|
||||||
|
'[validate-config] This is a real HAProxy parse failure. Shipping it '
|
||||||
|
'would leave the container Up with ports 80/443 unbound and every '
|
||||||
|
'site on the host down, while /health still returns 200.\n')
|
||||||
|
sys.stderr.flush()
|
||||||
|
raise SystemExit(1)
|
||||||
|
|
||||||
|
# Exit code 0 is the verdict. Warnings are expected and are NOT failures:
|
||||||
|
# "Can't load stats file" always fires at build time, and HAProxy emits
|
||||||
|
# path_reg/ACL advisories on a perfectly valid config.
|
||||||
|
noise = (result.stdout + result.stderr).strip()
|
||||||
|
log(f'{scenario_name}: haproxy -c OK (exit 0)')
|
||||||
|
if noise:
|
||||||
|
for line in noise.splitlines():
|
||||||
|
log(f' {scenario_name}: haproxy said: {line}')
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
require_haproxy_binary()
|
||||||
|
|
||||||
|
if not os.path.isdir(ETC_HAPROXY) or not os.access(ETC_HAPROXY, os.W_OK):
|
||||||
|
fail(f'{ETC_HAPROXY} must exist and be writable - several templates '
|
||||||
|
'reference files there by absolute path. Run this inside the image.')
|
||||||
|
|
||||||
|
created = CreatedFiles()
|
||||||
|
workdir = tempfile.mkdtemp(prefix='haproxy-validate-')
|
||||||
|
try:
|
||||||
|
for path, content in STUB_FILES.items():
|
||||||
|
created.ensure(path, content)
|
||||||
|
|
||||||
|
for scenario_name, env_overrides in SCENARIOS:
|
||||||
|
log(f'rendering scenario "{scenario_name}" '
|
||||||
|
f'({env_overrides or "no optional features"})')
|
||||||
|
config_path = render(scenario_name, env_overrides, workdir)
|
||||||
|
assert_scenario_branches(scenario_name, config_path, env_overrides)
|
||||||
|
validate(scenario_name, config_path)
|
||||||
|
finally:
|
||||||
|
created.cleanup()
|
||||||
|
shutil.rmtree(workdir, ignore_errors=True)
|
||||||
|
shutil.rmtree(_LOG_DIR, ignore_errors=True)
|
||||||
|
|
||||||
|
log('all scenarios accepted by the real haproxy binary')
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
raise SystemExit(main())
|
||||||
@@ -37,7 +37,22 @@ spoe-agent coraza
|
|||||||
timeout processing 100ms
|
timeout processing 100ms
|
||||||
|
|
||||||
use-backend coraza-spoa-backend
|
use-backend coraza-spoa-backend
|
||||||
log global
|
|
||||||
|
# NO `log global` here, deliberately.
|
||||||
|
#
|
||||||
|
# `log global` in a spoe-agent emits one line PER INSPECTED REQUEST, e.g.
|
||||||
|
# SPOE: [coraza] <GROUP:coraza-req> sid=537 st=0 0/0/0/0/0 32/32 0/0 0/467
|
||||||
|
# Measured on whp01 immediately after access logging started working:
|
||||||
|
# 618 SPOE lines vs 669 real access lines -- it was ~48% of the log volume,
|
||||||
|
# i.e. it would roughly DOUBLE the edge's log footprint (~400 MB/day extra)
|
||||||
|
# to record `st=0` over and over.
|
||||||
|
#
|
||||||
|
# It carries nothing incident response needs: the WAF's verdict is already
|
||||||
|
# visible in the access log line (status 403 + the `id=` UUID, which joins
|
||||||
|
# to /var/log/coraza/audit.log for the rule_id), and per-transaction WAF
|
||||||
|
# detail is written by the SPOA itself to /var/log/coraza/spoa.log.
|
||||||
|
# Agent-level failures still surface via `option set-on-error error` ->
|
||||||
|
# var(txn.coraza.error) and the fail-open path in hap_listener.tpl.
|
||||||
|
|
||||||
# Per-request inspection message. No `event` directive — fires only when
|
# Per-request inspection message. No `event` directive — fires only when
|
||||||
# explicitly invoked from haproxy.cfg via `http-request send-spoe-group`.
|
# explicitly invoked from haproxy.cfg via `http-request send-spoe-group`.
|
||||||
|
|||||||
+71
-11
@@ -2,20 +2,46 @@
|
|||||||
# Global settings
|
# Global settings
|
||||||
#---------------------------------------------------------------------
|
#---------------------------------------------------------------------
|
||||||
global
|
global
|
||||||
# to have these messages end up in /var/log/haproxy.log you will
|
# ACCESS LOG DESTINATION.
|
||||||
# need to:
|
|
||||||
#
|
#
|
||||||
# 1) configure syslog to accept network log events. This is done
|
# This used to be `log 127.0.0.1 local2`, which was a silent black hole:
|
||||||
# by adding the '-r' option to the SYSLOGD_OPTIONS in
|
# 127.0.0.1 is the CONTAINER's own loopback, nothing has ever listened on
|
||||||
# /etc/sysconfig/syslog
|
# udp/514 in the container netns, and there is no /dev/log in the image.
|
||||||
|
# Every access log line -- ~1.5M/day across the whole edge -- was written
|
||||||
|
# to a socket with no receiver and dropped. Nothing errored, nothing
|
||||||
|
# warned, and `haproxy -c` was perfectly happy. The cost only shows up
|
||||||
|
# during an incident: per-IP 429s, tarpits, wp-admin gate redirects,
|
||||||
|
# WAF 403s and `silent-drop`s left no record anywhere, so the edge could
|
||||||
|
# not be asked what it had rejected. Only aggregate stick-table counters
|
||||||
|
# survived.
|
||||||
#
|
#
|
||||||
# 2) configure local2 events to go to the /var/log/haproxy.log
|
# Now points at the DOCKER BRIDGE GATEWAY, where the host's rsyslog has an
|
||||||
# file. A line like the following can be added to
|
# imudp listener bound (installed idempotently by WHP's
|
||||||
# /etc/sysconfig/syslog
|
# setup-haproxy-logrotate.sh, which also writes the logrotate stanza).
|
||||||
|
# The host writes local2 to /var/log/haproxy.log and stops it there, so it
|
||||||
|
# does not also flood /var/log/messages or the Graylog forwarder.
|
||||||
#
|
#
|
||||||
# local2.* /var/log/haproxy.log
|
# WHY NOT `log stdout format raw local0`: it is INCOMPATIBLE with the
|
||||||
|
# `daemon` keyword below, and incompatible SILENTLY. Verified on the
|
||||||
|
# pinned 3.0.11 binary: with `daemon` set, a `log stdout` config serves
|
||||||
|
# traffic normally and emits ZERO log lines, and `haproxy -c` returns 0
|
||||||
|
# with no error and no warning -- so the CI config gate
|
||||||
|
# (scripts/validate-rendered-config.py) cannot catch it either. Making it
|
||||||
|
# work means dropping `daemon` / adding -db so haproxy stays in the
|
||||||
|
# foreground, which in turn breaks the three synchronous
|
||||||
|
# `subprocess.run(['haproxy', '-W', ...], check=True)` launch sites in
|
||||||
|
# haproxy_manager.py (they would block until the 180s timeout and then be
|
||||||
|
# killed). That is a change to the exact code path whose failure mode is
|
||||||
|
# "container Up, ports 80/443 never bound, every site down, /health still
|
||||||
|
# 200". Not worth it for a logging change.
|
||||||
#
|
#
|
||||||
log 127.0.0.1 local2
|
# UDP means a dead listener degrades to dropped log lines, never to a
|
||||||
|
# stalled or failing request path -- the correct failure direction for an
|
||||||
|
# edge fronting ~60 customer sites.
|
||||||
|
#
|
||||||
|
# len 2048 accommodates the enriched log-format in hap_listener.tpl
|
||||||
|
# (URL + User-Agent + UUID); the default 1024 would truncate long ones.
|
||||||
|
log {{ syslog_target }} len 2048 format rfc5424 local2 info
|
||||||
|
|
||||||
chroot /var/lib/haproxy
|
chroot /var/lib/haproxy
|
||||||
pidfile /var/run/haproxy.pid
|
pidfile /var/run/haproxy.pid
|
||||||
@@ -27,6 +53,36 @@ global
|
|||||||
# SSL and Performance
|
# SSL and Performance
|
||||||
tune.ssl.default-dh-param 2048
|
tune.ssl.default-dh-param 2048
|
||||||
|
|
||||||
|
# Required by the `http-request normalize-uri` chain at the top of the
|
||||||
|
# `web` frontend (hap_listener.tpl). normalize-uri is still flagged
|
||||||
|
# EXPERIMENTAL in HAProxy 3.0, and HAProxy REFUSES TO START without this
|
||||||
|
# opt-in -- not a warning, a fatal:
|
||||||
|
# [ALERT] config : parsing [...] : 'normalize-uri' action is
|
||||||
|
# experimental, must be allowed via a global
|
||||||
|
# 'expose-experimental-directives'
|
||||||
|
# (verified against real haproxy 3.0.11-9e587df: `haproxy -c` exits 1).
|
||||||
|
# So this line and the normalize-uri rules must be added/removed together.
|
||||||
|
#
|
||||||
|
# Dropping this one alone does NOT crash-loop the container -- the truth
|
||||||
|
# is worse: it is a SILENT TOTAL OUTAGE that nothing escalates. Container
|
||||||
|
# init (scripts/init.py -> haproxy_manager.do_initial_setup()) calls
|
||||||
|
# generate_config() (which still succeeds -- Jinja doesn't validate
|
||||||
|
# HAProxy semantics) and then start_haproxy(), which runs `haproxy -c`,
|
||||||
|
# sees it fail, logs an error, and RETURNS WITHOUT RAISING. init.py exits
|
||||||
|
# 0. scripts/start-up.sh then execs gunicorn as PID 1 regardless. Result:
|
||||||
|
# the container stays "Up", ports 80/443 are never bound, EVERY SITE ON
|
||||||
|
# THE HOST IS DOWN, and the in-container supervisor loop
|
||||||
|
# (ensure_haproxy.py, every HAPROXY_SUPERVISOR_INTERVAL seconds) retries
|
||||||
|
# the identical failing render forever without ever escalating. Worse
|
||||||
|
# still, GET /health keeps returning HTTP 200 -- health_check() only
|
||||||
|
# answers 500 on a database error; a dead haproxy just flips the JSON
|
||||||
|
# body's "haproxy_status" to "stopped" while the status code a naive
|
||||||
|
# monitor checks never changes. Do not trust /health alone to catch this.
|
||||||
|
#
|
||||||
|
# This exposes ONLY the experimental directives that are actually used --
|
||||||
|
# it does not change the behaviour of anything else in this file.
|
||||||
|
expose-experimental-directives
|
||||||
|
|
||||||
# HTTP/3 over QUIC. The Debian haproxy package is built against system
|
# HTTP/3 over QUIC. The Debian haproxy package is built against system
|
||||||
# OpenSSL via the compatibility shim (USE_QUIC_OPENSSL_COMPAT), which is
|
# OpenSSL via the compatibility shim (USE_QUIC_OPENSSL_COMPAT), which is
|
||||||
# not a native QUIC TLS stack. HAProxy therefore rejects `quic*@` binds
|
# not a native QUIC TLS stack. HAProxy therefore rejects `quic*@` binds
|
||||||
@@ -92,7 +148,11 @@ defaults
|
|||||||
maxconn 3000
|
maxconn 3000
|
||||||
|
|
||||||
# Per-request unique reference, used:
|
# Per-request unique reference, used:
|
||||||
# - in the log line (httplog includes %ID)
|
# - in the access log line, as the `id=` field of the custom log-format
|
||||||
|
# in hap_listener.tpl. NOTE: `option httplog` does NOT include %ID
|
||||||
|
# (verified against haproxy 3.0.11) -- this comment used to claim it
|
||||||
|
# did, which made the support workflow below look supported when it
|
||||||
|
# was not. The explicit log-format is what actually carries it.
|
||||||
# - echoed to clients in the X-Request-Reference response header on
|
# - echoed to clients in the X-Request-Reference response header on
|
||||||
# WAF blocks so a customer can quote it when opening a support ticket
|
# WAF blocks so a customer can quote it when opening a support ticket
|
||||||
# - embedded in /etc/haproxy/errors/403-waf.html so a blocked visitor
|
# - embedded in /etc/haproxy/errors/403-waf.html so a blocked visitor
|
||||||
|
|||||||
+456
-1
@@ -19,9 +19,171 @@ frontend web
|
|||||||
# response, including haproxy-generated ones (blocks, default page).
|
# response, including haproxy-generated ones (blocks, default page).
|
||||||
http-after-response set-header alt-svc "h3=\":443\"; ma=86400"
|
http-after-response set-header alt-svc "h3=\":443\"; ma=86400"
|
||||||
|
|
||||||
# Capture Host header so it appears in httplog output (in %hr field)
|
# Capture Host header so it appears in httplog output (in %hr field).
|
||||||
|
# ORDER IS LOAD-BEARING: this is capture slot 0, referenced by the
|
||||||
|
# access log-format below as %[capture.req.hdr(0)].
|
||||||
http-request capture req.hdr(Host) len 64
|
http-request capture req.hdr(Host) len 64
|
||||||
|
|
||||||
|
# Capture slot 1 = User-Agent. Incident response needs it to tell a
|
||||||
|
# scanner from a browser, and it is not in `option httplog` output.
|
||||||
|
# Any new capture MUST be appended AFTER this line, never inserted
|
||||||
|
# above it, or the slot indices in the log-format silently shift and
|
||||||
|
# the access log starts attributing the wrong string to the wrong field.
|
||||||
|
# req.fhdr(), NOT req.hdr(): req.hdr() treats the header as a comma-
|
||||||
|
# separated list and returns only the LAST element. Real User-Agent strings
|
||||||
|
# contain commas -- "Mozilla/5.0 (Windows NT 10.0; Win64; x64)
|
||||||
|
# AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36"
|
||||||
|
# captured with req.hdr() logs as just "like Gecko) Chrome/131.0.0.0
|
||||||
|
# Safari/537.36", silently losing the platform half -- which is exactly the
|
||||||
|
# half you need to tell a spoofed crawler from a real browser.
|
||||||
|
# Observed in production on whp01 before this was corrected.
|
||||||
|
http-request capture req.fhdr(User-Agent) len 200
|
||||||
|
|
||||||
|
# --- Access logging -----------------------------------------------------
|
||||||
|
# Scoped to THIS frontend on purpose: it references capture slots and
|
||||||
|
# var(txn.real_ip), which only exist here. Putting it in `defaults` would
|
||||||
|
# apply it to the stats frontend and every backend too, where those
|
||||||
|
# samples are undefined.
|
||||||
|
#
|
||||||
|
# `log-format` overrides `option httplog` for this proxy (haproxy emits a
|
||||||
|
# harmless warning saying so). The first 16 fields are byte-identical to
|
||||||
|
# the 3.0 httplog default, so anything that already parses httplog keeps
|
||||||
|
# working; the `key=value` tail is additive.
|
||||||
|
#
|
||||||
|
# Why the default httplog is not enough for incident response:
|
||||||
|
# %ci is the PROXY's address for Cloudflare-fronted sites, not the
|
||||||
|
# visitor. The real client is var(txn.real_ip), resolved further
|
||||||
|
# down from CF-Connecting-IP / X-Real-IP / X-Forwarded-For and only
|
||||||
|
# honoured from trusted proxies. BOTH are logged: cip= is who to
|
||||||
|
# rate-limit or block, %ci is which edge it arrived through.
|
||||||
|
# %ID is NOT included by `option httplog` (verified against
|
||||||
|
# haproxy 3.0.11). Without it the documented support workflow
|
||||||
|
# -- X-Request-Reference -> access log -> coraza audit.log -> rule_id
|
||||||
|
# -- cannot be completed. id= is what makes that join possible.
|
||||||
|
# host=/ua= identify the vhost and client; %ST/%B/%tsc give status,
|
||||||
|
# bytes and the termination state that distinguishes a rate-limit
|
||||||
|
# deny (PR--) from a tarpit (PT--) from a normal close.
|
||||||
|
log-format "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r cip=%[var(txn.real_ip)] id=%ID host=%[capture.req.hdr(0)] ua=%[capture.req.hdr(1)] sni=%[ssl_fc_sni] hv=%[fc_http_major]"
|
||||||
|
|
||||||
|
# --- URI normalisation (MUST be the first path-touching block here) ---
|
||||||
|
# Every path-based control in this frontend (the ACME health-check bypass,
|
||||||
|
# wp-login, xmlrpc, the wp-json/batch virtual patch, the wp-admin gate, the
|
||||||
|
# blocked-IP and suspension set-path rules, and everything Coraza inspects)
|
||||||
|
# matched the RAW request-target while the backend NORMALISED and DECODED
|
||||||
|
# it before resolving a file. Every gap between those two behaviours is a
|
||||||
|
# bypass, and each one had to be patched individually. Five were found in
|
||||||
|
# the wp-admin gate alone, all the same class:
|
||||||
|
#
|
||||||
|
# //wp-admin/plugins.php raw path starts "//" -> the safe-path
|
||||||
|
# guard failed -> request fell through
|
||||||
|
# ungated, backend served it
|
||||||
|
# /wp-admin/css/../plugins.php matched the css/js/images asset
|
||||||
|
# bypass; backend resolved ".." and
|
||||||
|
# booted plugins.php
|
||||||
|
# /wp-admin/js/%2e%2e/plugins.php same, with the ".." percent-encoded
|
||||||
|
# /wp%2Dadmin/plugins.php "wp-admin" spelled with %2D never
|
||||||
|
# matched any wp-admin ACL at all
|
||||||
|
# /wp-admin%2Fplugins.php encoded separator; see the dedicated
|
||||||
|
# rule in the wp-admin gate below
|
||||||
|
#
|
||||||
|
# Rather than keep bolting a counter-pattern onto each rule, normalise the
|
||||||
|
# URI once, here, so every rule below matches the SAME string the backend
|
||||||
|
# will resolve. HAProxy rewrites the request-target in place, so the
|
||||||
|
# backend receives the normalised form too.
|
||||||
|
#
|
||||||
|
# ORDER IS LOAD-BEARING and was determined empirically against real
|
||||||
|
# haproxy 3.0.11, not from the docs. The decoders must run BEFORE the path
|
||||||
|
# walkers: with the reverse order, /wp-admin/js/%2e%2e/plugins.php ends up
|
||||||
|
# as /wp-admin/js/../plugins.php -- decoded, but the ".." left unresolved,
|
||||||
|
# because path-strip-dotdot had already run by the time the "%2e%2e"
|
||||||
|
# became "..". Verified both directions side by side.
|
||||||
|
#
|
||||||
|
# percent-to-uppercase %2f -> %2F. Canonicalises the spelling of
|
||||||
|
# whatever stays encoded, so downstream rules
|
||||||
|
# need one case of each escape, not two.
|
||||||
|
# percent-decode-unreserved Decodes ONLY RFC 3986 unreserved chars
|
||||||
|
# (A-Za-z0-9-._~). This is what turns %2e%2e
|
||||||
|
# into .. and wp%2Dadmin into wp-admin.
|
||||||
|
# Reserved escapes are deliberately left
|
||||||
|
# alone -- %2F in particular, which is why
|
||||||
|
# the wp-admin gate needs its own encoded-
|
||||||
|
# slash rule (see below).
|
||||||
|
# path-merge-slashes //x -> /x. Also removes the entire class of
|
||||||
|
# "leading // defeats an anchored regex".
|
||||||
|
# path-strip-dot /a/./b -> /a/b.
|
||||||
|
# path-strip-dotdot full /a/b/../c -> /a/c. "full" additionally
|
||||||
|
# resolves ".." segments that would climb
|
||||||
|
# above the root (/../../wp-admin/x.php ->
|
||||||
|
# /wp-admin/x.php); without "full" HAProxy
|
||||||
|
# leaves those in place and the vector
|
||||||
|
# survives -- measured, both forms tested.
|
||||||
|
#
|
||||||
|
# DELIBERATELY NOT ENABLED: query-sort-by-name. Reordering query-string
|
||||||
|
# parameters would silently break anything that signs or caches on the
|
||||||
|
# exact query string (signed asset URLs, HMAC'd callbacks, CDN cache
|
||||||
|
# keys). This is NOT because the enabled normalizers already leave the
|
||||||
|
# query alone -- see BLAST RADIUS just below, they don't -- it is a
|
||||||
|
# deliberate line drawn between "case-fold / decode", which RFC 3986
|
||||||
|
# defines as no-ops, and "reorder", which is not a no-op for a caller
|
||||||
|
# treating the query as an opaque signed string.
|
||||||
|
#
|
||||||
|
# BLAST RADIUS: this block applies to EVERY request for EVERY site on
|
||||||
|
# EVERY tier, so the decoding was kept minimal on purpose -- and it is
|
||||||
|
# NOT scoped to the path. percent-to-uppercase and percent-decode-
|
||||||
|
# unreserved normalise the WHOLE request-target as HAProxy parses it --
|
||||||
|
# query string included, not just the path component the ACLs below
|
||||||
|
# match on -- and the BACKEND receives the rewritten query on the wire,
|
||||||
|
# not just an internal haproxy view of it. Measured against real HAProxy
|
||||||
|
# 3.0.11:
|
||||||
|
# /a?sig=%2babc%2fdef -> /a?sig=%2Babc%2Fdef (percent-hex upper-cased)
|
||||||
|
# /a?b=%41%42%43 -> /a?b=ABC (unreserved chars decoded)
|
||||||
|
# /a?tok=%7e%2d%5f%2e -> /a?tok=~-_. (unreserved chars decoded)
|
||||||
|
# Only parameter ORDER is preserved -- that guarantee is exactly why
|
||||||
|
# query-sort-by-name above is the one normalizer in this family left
|
||||||
|
# disabled. Per RFC 3986 both enabled rewrites are defined as the same
|
||||||
|
# URI (case in a percent-escape, and an unreserved character vs. its
|
||||||
|
# escape, carry no distinct meaning), but "the same URI" is not "the
|
||||||
|
# same bytes": an application that HMACs or otherwise signs the RAW
|
||||||
|
# query string, rather than parsing it first, could see a mutated value
|
||||||
|
# and fail to verify an otherwise-legitimate request. Checked against
|
||||||
|
# this fleet: no .NET backends (.NET's UrlEncode emits lowercase
|
||||||
|
# percent-hex, which percent-to-uppercase would rewrite) and no
|
||||||
|
# URL-in-path proxies, so there is no known victim today -- but do not
|
||||||
|
# assume "path only" from this block; that was the actual bug in an
|
||||||
|
# earlier draft of this comment.
|
||||||
|
#
|
||||||
|
# normalize-uri is EXPERIMENTAL in 3.0 and requires
|
||||||
|
# `expose-experimental-directives` in the global section
|
||||||
|
# (hap_header.tpl). Without it HAProxy does not start. Remove one and you
|
||||||
|
# must remove the other.
|
||||||
|
http-request normalize-uri percent-to-uppercase
|
||||||
|
http-request normalize-uri percent-decode-unreserved
|
||||||
|
http-request normalize-uri path-merge-slashes
|
||||||
|
http-request normalize-uri path-strip-dot
|
||||||
|
http-request normalize-uri path-strip-dotdot full
|
||||||
|
|
||||||
|
# --- Trusted-proxy gate (MUST precede real-IP resolution below) ---
|
||||||
|
# CF-Connecting-IP / X-Real-IP / X-Forwarded-For are client-supplied. Any
|
||||||
|
# peer that is not a known reverse proxy gets them stripped, so the
|
||||||
|
# set-var chain below falls through to `src` -- the real TCP peer.
|
||||||
|
#
|
||||||
|
# Without this, a direct client dictates txn.real_ip, and every control
|
||||||
|
# keyed on that variable trusts the attacker's own claim: rate limiting
|
||||||
|
# (track-sc0), the trusted-IP whitelist, the wp-login brute-force table and
|
||||||
|
# cookie challenge, the wp-json/batch/v1 virtual patch, IP blocking, and
|
||||||
|
# Coraza's src-ip. Spoofing a whitelisted IP bypassed all of them.
|
||||||
|
#
|
||||||
|
# ORDER MATTERS: these must come before the set-var lines. HAProxy applies
|
||||||
|
# http-request rules in file order, so a strip placed afterwards would
|
||||||
|
# validate cleanly and accomplish nothing.
|
||||||
|
#
|
||||||
|
# Cloudflare-fronted domains keep working: CF's edge matches
|
||||||
|
# from_trusted_proxy, so its CF-Connecting-IP survives.
|
||||||
|
acl from_trusted_proxy src -f /etc/haproxy/cloudflare_ips.list -f /etc/haproxy/trusted_proxies.list
|
||||||
|
http-request del-header CF-Connecting-IP if !from_trusted_proxy
|
||||||
|
http-request del-header X-Real-IP if !from_trusted_proxy
|
||||||
|
http-request del-header X-Forwarded-For if !from_trusted_proxy
|
||||||
|
|
||||||
# Detect real client IP from proxy headers if they exist
|
# Detect real client IP from proxy headers if they exist
|
||||||
# Priority: CF-Connecting-IP (Cloudflare) > X-Real-IP > X-Forwarded-For > src
|
# Priority: CF-Connecting-IP (Cloudflare) > X-Real-IP > X-Forwarded-For > src
|
||||||
acl has_cf_connecting_ip req.hdr(CF-Connecting-IP) -m found
|
acl has_cf_connecting_ip req.hdr(CF-Connecting-IP) -m found
|
||||||
@@ -96,6 +258,42 @@ frontend web
|
|||||||
acl has_login_cookie req.cook(whplc) -m found
|
acl has_login_cookie req.cook(whplc) -m found
|
||||||
http-request deny deny_status 403 if METH_POST wp_login_path !has_login_cookie !is_local !is_trusted_ip !is_whitelisted
|
http-request deny deny_status 403 if METH_POST wp_login_path !has_login_cookie !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
|
||||||
|
# --- WordPress xmlrpc.php flood protection ---
|
||||||
|
# xmlrpc.php floods are a common, sustained abuse pattern that the generic
|
||||||
|
# limits above don't catch: those trigger at 3000/5000 req/10s (300-500
|
||||||
|
# req/s, sized for media-heavy pageloads), while observed xmlrpc floods run
|
||||||
|
# at just a few req/s for hours -- comfortably under that ceiling but still
|
||||||
|
# enough to pin PHP-FPM workers and show up as 503s for the rest of the
|
||||||
|
# site. Same shape of problem as wp-login credential stuffing, so it gets
|
||||||
|
# the same fix: track POSTs to xmlrpc.php per real client IP in a DEDICATED
|
||||||
|
# 60s table (sc2 / backend xmlrpc_bruteforce, defined in
|
||||||
|
# hap_security_tables.tpl -- kept separate from wp_bruteforce so the two
|
||||||
|
# endpoints' traffic can't inflate each other's counter, see that file for
|
||||||
|
# the reasoning) and tarpit once an IP exceeds the threshold.
|
||||||
|
#
|
||||||
|
# Threshold is 60/min (double wp-login's 30/min), not because xmlrpc abuse
|
||||||
|
# is less severe but because legitimate traffic here is machine-to-machine
|
||||||
|
# rather than a human filling out a form: Jetpack sync, the WordPress
|
||||||
|
# mobile app, and remote-publishing clients (e.g. an offline blog editor)
|
||||||
|
# can legitimately burst several xmlrpc calls in quick succession. 60/min
|
||||||
|
# (1 req/s average over the window) comfortably absorbs that burst while
|
||||||
|
# still tripping well before an hours-long few-req/s flood does real
|
||||||
|
# damage -- at 2 req/s sustained the 60s counter clears the threshold in
|
||||||
|
# under a minute.
|
||||||
|
#
|
||||||
|
# Tarpit (not deny), matching the wp-login rule: this is per-IP tracking
|
||||||
|
# of a bounded set of offenders, not the wp-login cookie challenge's
|
||||||
|
# distributed hundreds-of-thousands-of-IPs scenario where holding
|
||||||
|
# connections would exhaust HAProxy itself, so tying up the flooding IP's
|
||||||
|
# connections is the cheaper and more effective response. path_end (not
|
||||||
|
# path_beg) covers subdirectory WP installs, same reasoning as wp-login.
|
||||||
|
# Honors the same whitelist (RFC1918 / trusted_ips.list / trusted_ips.map)
|
||||||
|
# so health checks and trusted infrastructure are unaffected, and legit
|
||||||
|
# clients under the threshold are never blocked outright.
|
||||||
|
acl xmlrpc_path path_end /xmlrpc.php
|
||||||
|
http-request track-sc2 var(txn.real_ip) table xmlrpc_bruteforce if METH_POST xmlrpc_path
|
||||||
|
http-request tarpit deny_status 429 if METH_POST xmlrpc_path { sc_http_req_rate(2) gt 60 } !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
|
||||||
# WordPress REST batch endpoint lockdown ("wp2shell": CVE-2026-63030 +
|
# WordPress REST batch endpoint lockdown ("wp2shell": CVE-2026-63030 +
|
||||||
# CVE-2026-60137). Chaining a core SQL injection with REST batch-route
|
# CVE-2026-60137). Chaining a core SQL injection with REST batch-route
|
||||||
# confusion gives unauthenticated RCE on WP 6.9.0-6.9.4 and 7.0.0-7.0.1
|
# confusion gives unauthenticated RCE on WP 6.9.0-6.9.4 and 7.0.0-7.0.1
|
||||||
@@ -125,6 +323,263 @@ frontend web
|
|||||||
http-request deny deny_status 403 if wp_batch_route !has_wp_logged_in !is_local !is_trusted_ip !is_whitelisted
|
http-request deny deny_status 403 if wp_batch_route !has_wp_logged_in !is_local !is_trusted_ip !is_whitelisted
|
||||||
http-request deny deny_status 403 if wp_batch_route_enc !has_wp_logged_in !is_local !is_trusted_ip !is_whitelisted
|
http-request deny deny_status 403 if wp_batch_route_enc !has_wp_logged_in !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
|
||||||
|
# --- WordPress admin edge gate ---
|
||||||
|
# Measured on whp02, 2026-08-14: distributed unauthenticated GETs booting
|
||||||
|
# WordPress just to bounce back a login redirect --
|
||||||
|
# 2801 GET /wp-admin/profile.php 2781 GET /wp-admin/edit.php 2761 GET /wp-admin/plugins.php
|
||||||
|
# -- spread across many source IPs at roughly 4 req/min per IP, each hit
|
||||||
|
# burning a PHP-FPM/lsphp worker. Two sites absorbed 1,243 resulting 503s
|
||||||
|
# in nine hours as their pools saturated.
|
||||||
|
#
|
||||||
|
# IDENTITY, NOT RATE. This is the one rule in this file that tracks
|
||||||
|
# nothing and has no stick-table counter or threshold. Every rate-based
|
||||||
|
# control above (the generic limits, wp_bruteforce, xmlrpc_bruteforce) is
|
||||||
|
# per-IP, and per-IP rate is exactly what this attack is engineered to
|
||||||
|
# stay under: ~4 req/min from any single IP is indistinguishable from a
|
||||||
|
# slow human, and the source set is large enough that no threshold can be
|
||||||
|
# lowered to catch it without also catching real visitors. There is also
|
||||||
|
# no free stick-table slot left to try anyway -- sc0/sc1/sc2 are already
|
||||||
|
# used above and HAProxy's default tune.stick-counters is 3, so a fourth
|
||||||
|
# tracked counter is not an option here. DO NOT "simplify" this into a
|
||||||
|
# rate/threshold rule later: the whole point is that a threshold cannot
|
||||||
|
# see this traffic. Instead we gate on identity -- a real logged-in
|
||||||
|
# WordPress user always carries a wordpress_logged_in_* cookie (the same
|
||||||
|
# ACL the wp2shell block above already declares), and an unauthenticated
|
||||||
|
# request to a wp-admin page has no legitimate reason to boot PHP at all.
|
||||||
|
#
|
||||||
|
# 302, not 403. WordPress itself redirects an unauthenticated /wp-admin/
|
||||||
|
# request to wp-login.php, so replicating that at the edge means an admin
|
||||||
|
# whose session merely expired lands on the normal login screen instead
|
||||||
|
# of an error page -- we are not trading a bot problem for a support
|
||||||
|
# ticket. Bots get a cheap redirect they ignore.
|
||||||
|
#
|
||||||
|
# path_reg, not path_beg. A subdirectory install at /blog/wp-admin/ slips
|
||||||
|
# past a prefix match; path_reg with an optional leading "/" catches both
|
||||||
|
# root and subdirectory installs, same reasoning as the wp-login and
|
||||||
|
# xmlrpc path_end rules above.
|
||||||
|
#
|
||||||
|
# regsub rewrites the redirect target itself, so /blog/wp-admin/x.php
|
||||||
|
# redirects to /blog/wp-login.php rather than 404ing at the site root.
|
||||||
|
#
|
||||||
|
# DO NOT write regsub's regex argument with a capturing group / literal
|
||||||
|
# parentheses, e.g. regsub((^|/)wp-admin/.*,\1wp-login.php) -- neither
|
||||||
|
# inlined into the redirect's `location` nor in a standalone set-var.
|
||||||
|
# HAProxy 3.0.11's converter-argument parser counts parens to find the
|
||||||
|
# end of the regsub(...) call itself, so the *inner* "(^|/)" grouping
|
||||||
|
# parens are misread as closing the outer call early -- it does not
|
||||||
|
# matter whether the argument is quoted ("...": still fails) or the
|
||||||
|
# parens are backslash-escaped (\(...\): still fails). Every such form
|
||||||
|
# was verified against real HAProxy 3.0.11-1+deb13u3 and all produce the
|
||||||
|
# same ALERT: "invalid arg 2 in converter 'regsub' : missing arguments
|
||||||
|
# (got 1/2)". This is a converter-argument-parsing limitation, not a
|
||||||
|
# log-format/`%[...]` issue -- the identical failure reproduces in a
|
||||||
|
# plain set-var (outside any log-format string), which rules out the
|
||||||
|
# `location` value's log-format context as the cause.
|
||||||
|
#
|
||||||
|
# The fix sidesteps groups/backreferences entirely: HTTP paths always
|
||||||
|
# start with "/", so the leading "(^|/)" alternation is redundant --
|
||||||
|
# matching the literal substring "/wp-admin/" (both slashes, no group)
|
||||||
|
# is sufficient to anchor to a real path segment (a false match like
|
||||||
|
# "/somewp-admin/" doesn't contain "/wp-admin/" as a substring, since
|
||||||
|
# there's no "/" directly before "wp-admin"). No backreference is
|
||||||
|
# needed either: regsub only replaces the matched substring, so
|
||||||
|
# replacing "/wp-admin/.*" with a literal "/wp-login.php" leaves
|
||||||
|
# whatever precedes it (the subdirectory-install prefix, if any)
|
||||||
|
# untouched. Computed in its own set-var so it is a plain sample
|
||||||
|
# expression, not something baked into the redirect's log-format
|
||||||
|
# string. Behaviorally verified live against real HAProxy 3.0.11:
|
||||||
|
# /wp-admin/edit.php -> /wp-login.php and
|
||||||
|
# /blog/wp-admin/plugins.php -> /blog/wp-login.php, both with
|
||||||
|
# redirect_to preserved. See
|
||||||
|
# .superpowers/sdd/2026-08-14-wpadmin-edge-gate/task-3b-report.md.
|
||||||
|
#
|
||||||
|
# redirect_to carries the path only (%[path,url_enc]), not the query
|
||||||
|
# string -- deliberate, see design spec. An admin bounced off
|
||||||
|
# post.php?post=123&action=edit lands back on a blank post.php rather
|
||||||
|
# than that exact post. Capturing the full URI needs capture.req.uri
|
||||||
|
# (extra config, and the captured value is length-capped) for a benefit
|
||||||
|
# that only matters on session expiry, so it was not worth it.
|
||||||
|
#
|
||||||
|
# THE ALLOWLIST IS MEASURED, NOT GUESSED -- taken from actual fleet
|
||||||
|
# traffic returning 200 on /wp-admin/*. admin-ajax.php and admin-post.php
|
||||||
|
# are the standard front-end AJAX/form-handler endpoints real themes and
|
||||||
|
# plugins call while logged out. Critically, wp-login.php loads its OWN
|
||||||
|
# css/js FROM /wp-admin/ (load-styles.php, load-scripts.php, and the
|
||||||
|
# static wp_admin_asset dirs below) -- miss those and every login page on
|
||||||
|
# the fleet renders unstyled with a broken password-strength meter, while
|
||||||
|
# wp-login.php itself still returns 200, making it a silent regression
|
||||||
|
# that "looks like" the gate is working.
|
||||||
|
#
|
||||||
|
# Each allowlist entry is anchored to /wp-admin/<file>, not a bare
|
||||||
|
# filename suffix. A bare `path_end /admin-ajax.php` also matches
|
||||||
|
# /wp-admin/evil/admin-ajax.php -- which ALSO matches wp_admin_path
|
||||||
|
# (path_reg only requires /wp-admin/ to appear somewhere), so an
|
||||||
|
# attacker-inserted path segment would sail through this allowlist
|
||||||
|
# ungated and boot full WordPress, exactly the resource exhaustion this
|
||||||
|
# gate exists to stop. Anchoring still covers subdirectory installs via
|
||||||
|
# suffix matching (/blog/wp-admin/admin-ajax.php ends with
|
||||||
|
# /wp-admin/admin-ajax.php) while rejecting an inserted directory.
|
||||||
|
#
|
||||||
|
# install.php is DELIBERATELY NOT allowlisted. It is legitimately
|
||||||
|
# reachable without a cookie during a fresh install, but it is also a
|
||||||
|
# standing scanner target and a real takeover vector on a site that was
|
||||||
|
# half-installed and then abandoned. Anyone genuinely installing uses the
|
||||||
|
# per-site exempt-list opt-out below instead.
|
||||||
|
#
|
||||||
|
# Honors the same whitelist as every other rule in this frontend
|
||||||
|
# (RFC1918 / trusted_ips.list / trusted_ips.map), and a per-site opt-out
|
||||||
|
# via /etc/haproxy/wpadmin_gate_exempt.list (operator-managed, seeded
|
||||||
|
# empty by start-up.sh) for sites where a plugin legitimately serves
|
||||||
|
# unauthenticated visitors from a /wp-admin/ URL outside this allowlist.
|
||||||
|
# EVERY ACL BELOW MATCHES THE NORMALISED PATH. The normalize-uri chain at
|
||||||
|
# the top of this frontend has already merged duplicate slashes, resolved
|
||||||
|
# "." / ".." segments (including percent-encoded ones) and decoded
|
||||||
|
# unreserved escapes by the time these run, so these patterns only have to
|
||||||
|
# describe the ONE canonical spelling the backend will resolve -- they do
|
||||||
|
# not have to anticipate every encoding of it. That is the whole point of
|
||||||
|
# the normalisation block; do not "harden" these regexes by re-adding
|
||||||
|
# encoding variants, fix the normalisation instead.
|
||||||
|
#
|
||||||
|
# wp_admin_safe_path guards against an OPEN REDIRECT this gate would
|
||||||
|
# otherwise introduce. The redirect target below is built by rewriting
|
||||||
|
# `path` with regsub -- regsub only replaces the matched substring, so
|
||||||
|
# everything BEFORE the matched "/wp-admin/" survives untouched in the
|
||||||
|
# output. `path` is not guaranteed to be a clean site-relative string;
|
||||||
|
# three concrete requests turn that survival into an off-site
|
||||||
|
# `Location:` header:
|
||||||
|
# //evil.example.com/wp-admin/x.php -> //evil.example.com/wp-login.php
|
||||||
|
# (protocol-relative -- browsers resolve "//host/path" to
|
||||||
|
# "https://host/path", so this redirects off-site with no scheme
|
||||||
|
# needed). NOW NEUTRALISED UPSTREAM: path-merge-slashes rewrites this
|
||||||
|
# to /evil.example.com/wp-admin/x.php before any ACL sees it, so the
|
||||||
|
# Location becomes the same-origin /evil.example.com/wp-login.php.
|
||||||
|
# Verified live.
|
||||||
|
# /\evil.example.com/wp-admin/x.php -> /\evil.example.com/wp-login.php
|
||||||
|
# (browsers normalise a leading "/\" the same as "//"). STILL LIVE
|
||||||
|
# after normalisation -- a backslash is not a slash, so no normalizer
|
||||||
|
# touches it. This ACL is the only thing that stops it.
|
||||||
|
# https://evil.example.com/wp-admin/x.php -> https://evil.example.com/wp-login.php
|
||||||
|
# (RFC 7230 absolute-form request targets can make HAProxy's `path`
|
||||||
|
# fetch return a full URI, not just the path component). HAProxy's own
|
||||||
|
# H1 parser answers 400 on this frontend; this ACL is the backstop.
|
||||||
|
# So wp_admin_safe_path is NOT redundant with the normalisation and must
|
||||||
|
# not be deleted as such -- one of its three vectors survives normalisation
|
||||||
|
# untouched.
|
||||||
|
#
|
||||||
|
# It is used TWO ways, and the pair matters:
|
||||||
|
# - as a POSITIVE condition on the redirect, so a pathological path can
|
||||||
|
# never produce a `Location:` header at all; and
|
||||||
|
# - as an explicit deny, so such a path is not merely un-redirected.
|
||||||
|
# The deny is what closes the failure mode the positive-condition form
|
||||||
|
# introduced on its own: "not redirected" used to mean "falls through to
|
||||||
|
# the backend UNGATED", i.e. the exact PHP-booting request this gate
|
||||||
|
# exists to stop, reachable by prefixing "//" (that specific spelling is
|
||||||
|
# now normalised away, but "/\" is not). Post-normalisation the only
|
||||||
|
# paths that reach the deny are "/\..." ones, which cannot resolve to a
|
||||||
|
# real file on any tier, so nothing legitimate is denied.
|
||||||
|
# -i (case-insensitive) and the matching ",i" flag on the regsub below are
|
||||||
|
# a PAIR -- adding one without the other produces an infinite redirect
|
||||||
|
# loop, because a case-sensitive regsub finds no "/wp-admin/" in
|
||||||
|
# "/WP-ADMIN/plugins.php", returns `path` UNCHANGED, and the Location then
|
||||||
|
# points at the request's own URL. Verified live that the pair is correct:
|
||||||
|
# /WP-ADMIN/plugins.php -> /wp-login.php and /blog/WP-Admin/plugins.php ->
|
||||||
|
# /blog/wp-login.php.
|
||||||
|
#
|
||||||
|
# On this fleet's Linux backends /WP-ADMIN/plugins.php 404s without booting
|
||||||
|
# PHP, so this is hardening rather than a live-bypass fix; it matters if a
|
||||||
|
# docroot ever sits on a case-insensitive mount, where that same request
|
||||||
|
# WOULD boot PHP. The cost is that a site with a real directory literally
|
||||||
|
# named e.g. /docs/WP-Admin/ now gets gated -- the same false positive the
|
||||||
|
# lowercase pattern already has, which is what the per-site exempt list
|
||||||
|
# exists to resolve.
|
||||||
|
acl wp_admin_path path_reg -i (^|/)wp-admin/
|
||||||
|
# Four literal backslashes here is NOT a typo. HAProxy's config-line word
|
||||||
|
# parser treats backslash as its OWN escape character before the value
|
||||||
|
# ever reaches the regex engine: "\\" (two backslashes) in the config
|
||||||
|
# collapses to one literal backslash by the time PCRE compiles it, which
|
||||||
|
# leaves an unterminated character class ("[^/\]") and fails with
|
||||||
|
# "missing terminating ] for character class" -- verified against real
|
||||||
|
# HAProxy 3.0.11. Four backslashes ("\\\\") collapse to two ("\\"),
|
||||||
|
# which PCRE then reads as a single escaped-backslash class member --
|
||||||
|
# the intended "reject a literal backslash" semantics.
|
||||||
|
acl wp_admin_safe_path path_reg ^/[^/\\\\]
|
||||||
|
acl wp_admin_allowed path_end /wp-admin/admin-ajax.php /wp-admin/admin-post.php /wp-admin/load-styles.php /wp-admin/load-scripts.php
|
||||||
|
# The (?!.*\.php) lookahead is DEFENCE IN DEPTH, not the primary fix. This
|
||||||
|
# ACL grants an un-gated bypass to everything under wp-admin/css|js|images,
|
||||||
|
# and it used to anchor its prefix but not its suffix, so
|
||||||
|
# /wp-admin/css/../plugins.php took the bypass and the backend then
|
||||||
|
# resolved ".." and booted plugins.php. path-strip-dotdot now rewrites that
|
||||||
|
# to /wp-admin/plugins.php before this ACL runs, which is the real fix; the
|
||||||
|
# lookahead additionally makes the bypass structurally incapable of
|
||||||
|
# covering a PHP entrypoint even if a future encoding trick survives
|
||||||
|
# normalisation. It excludes ".php" ONLY -- no static asset contains that
|
||||||
|
# substring, so it cannot cause the silent "login page renders unstyled"
|
||||||
|
# regression that an extension allowlist would risk. Requires PCRE2, which
|
||||||
|
# both the Debian (deployed) and Alpine haproxy builds have (+PCRE2).
|
||||||
|
#
|
||||||
|
# THE "--" IS LOAD-BEARING, DO NOT DELETE IT. HAProxy warns on any pattern
|
||||||
|
# whose first character is "(", because it cannot tell an intended regex
|
||||||
|
# from a fetch-argument list someone typo'd a space into:
|
||||||
|
# parsing acl 'wp_admin_asset' : matching 'path_reg' for pattern
|
||||||
|
# '(^|/)wp-admin/...' is likely a mistake and probably not what you want.
|
||||||
|
# Maybe you need to remove the extraneous space before '('.
|
||||||
|
# "--" is HAProxy's documented end-of-flags marker and is the fix it names
|
||||||
|
# itself ("please insert '--' between the match and the pattern"). It changes
|
||||||
|
# no matching semantics -- verified live on whp02: /wp-admin/css/login.min.css
|
||||||
|
# still passes and /wp-admin/css/x.php is still gated, before and after.
|
||||||
|
# Left unsilenced this fires on EVERY config load and reload on every host,
|
||||||
|
# where it trains operators to skim past warnings and can bury a real one.
|
||||||
|
# wp_admin_path escapes the warning only because its "-i" flag happens to
|
||||||
|
# consume the flag slot first; it is not otherwise special.
|
||||||
|
acl wp_admin_asset path_reg -- (^|/)wp-admin/(css|js|images)/(?!.*\.php).*$
|
||||||
|
acl wp_gate_exempt hdr(host),lower -f /etc/haproxy/wpadmin_gate_exempt.list
|
||||||
|
# ENCODED SEPARATOR. percent-decode-unreserved deliberately does NOT decode
|
||||||
|
# %2F -- "/" is a reserved character, and decoding it in the normalizer
|
||||||
|
# would change the path's structure (it would invent new segments), which
|
||||||
|
# is precisely why HAProxy refuses to. But OpenLiteSpeed DOES decode it and
|
||||||
|
# then serves the file: /wp-admin%2Fplugins.php was measured returning 302
|
||||||
|
# from a real WordPress site on the OLS tier, i.e. full PHP boot, while
|
||||||
|
# matching none of the ACLs above. Apache returns 404 for the same request
|
||||||
|
# (AllowEncodedSlashes Off), so this is an OLS-tier defect -- and OLS is the
|
||||||
|
# tier currently saturating.
|
||||||
|
#
|
||||||
|
# DENY, not "treat it as a wp-admin path and redirect". Two reasons:
|
||||||
|
# 1. The redirect target is computed by regsub(/wp-admin/.*) which finds
|
||||||
|
# no "/wp-admin/" in "/wp-admin%2Fplugins.php", so `path` would come
|
||||||
|
# back UNCHANGED and the Location would point at the request's own
|
||||||
|
# URL -- an infinite redirect loop, not a gate.
|
||||||
|
# 2. Nothing legitimate emits it. A path segment cannot contain a literal
|
||||||
|
# "/", so %2F inside a path is always either a probe or a proxy-
|
||||||
|
# confusion attempt, and the Apache tier has been 404ing it all along,
|
||||||
|
# so no site on the fleet can depend on it.
|
||||||
|
#
|
||||||
|
# SCOPED to paths that mention wp-admin, not all paths. A blanket "deny any
|
||||||
|
# %2F in any path" would also hit REST/API-style routes on non-WordPress
|
||||||
|
# customer apps that legitimately pass an encoded slash inside a path
|
||||||
|
# parameter. Scoping keeps the blast radius inside the attack surface this
|
||||||
|
# gate owns.
|
||||||
|
#
|
||||||
|
# Matching is on the SUBSTRING, not an anchored pattern, on purpose:
|
||||||
|
# /blog%2Fwp-admin/plugins.php hides the separator BEFORE "wp-admin", where
|
||||||
|
# an anchored (^|/)wp-admin/ never matches, and OLS still resolves it to
|
||||||
|
# /blog/wp-admin/plugins.php. Substring matching catches the separator
|
||||||
|
# wherever it is. percent-to-uppercase has already folded %2f into %2F;
|
||||||
|
# the -i is belt and braces so this rule stands on its own if the
|
||||||
|
# normalizer is ever reordered.
|
||||||
|
#
|
||||||
|
# %5C (encoded backslash) is denied on the same terms. On this fleet's
|
||||||
|
# Linux backends a backslash is an ordinary filename character, so
|
||||||
|
# /wp-admin%5Cplugins.php 404s rather than booting PHP -- measured, it is
|
||||||
|
# not a live bypass today. It is included because it is the same
|
||||||
|
# encoded-separator trick against a backend that happens to treat "\" as
|
||||||
|
# one, it costs nothing, and no legitimate path contains it.
|
||||||
|
acl wp_admin_word path -i -m sub wp-admin
|
||||||
|
acl path_has_encoded_sep path -i -m sub %2f %5c
|
||||||
|
http-request deny deny_status 403 if wp_admin_word path_has_encoded_sep !has_wp_logged_in !wp_gate_exempt !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
http-request deny deny_status 403 if wp_admin_path !wp_admin_safe_path !has_wp_logged_in !wp_gate_exempt !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
http-request set-var(txn.wp_login_url) path,regsub(/wp-admin/.*,/wp-login.php,i) if wp_admin_path
|
||||||
|
http-request redirect code 302 location %[var(txn.wp_login_url)]?redirect_to=%[path,url_enc] if wp_admin_path wp_admin_safe_path !wp_admin_allowed !wp_admin_asset !has_wp_logged_in !wp_gate_exempt !is_local !is_trusted_ip !is_whitelisted
|
||||||
|
|
||||||
# IP blocking using map file (manual blocks only)
|
# IP blocking using map file (manual blocks only)
|
||||||
# Map file format: /etc/haproxy/blocked_ips.map contains "<ip_or_cidr> 1" per line
|
# Map file format: /etc/haproxy/blocked_ips.map contains "<ip_or_cidr> 1" per line
|
||||||
# Runtime updates: echo "add map #0 IP_ADDRESS 1" | socat stdio /var/run/haproxy.sock
|
# Runtime updates: echo "add map #0 IP_ADDRESS 1" | socat stdio /var/run/haproxy.sock
|
||||||
|
|||||||
@@ -14,3 +14,18 @@ frontend stats
|
|||||||
# the (much higher) flood thresholds.
|
# the (much higher) flood thresholds.
|
||||||
backend wp_bruteforce
|
backend wp_bruteforce
|
||||||
stick-table type ip size 100k expire 30m store http_req_rate(60s)
|
stick-table type ip size 100k expire 30m store http_req_rate(60s)
|
||||||
|
|
||||||
|
# Dedicated stick-table for POST /xmlrpc.php flood tracking.
|
||||||
|
# Tracked via track-sc2 from the `web` frontend (hap_listener.tpl); counts
|
||||||
|
# only xmlrpc POSTs per real client IP over a 60s window. This is a SEPARATE
|
||||||
|
# table/counter from wp_bruteforce (sc1) rather than a shared one: both are
|
||||||
|
# machine-to-machine WordPress endpoints an attacker could hit from the same
|
||||||
|
# IP, and sharing a counter would let one endpoint's traffic inflate the
|
||||||
|
# other's rate -- an IP credential-stuffing wp-login while also flooding
|
||||||
|
# xmlrpc would trip the wp-login threshold early on xmlrpc volume alone (or
|
||||||
|
# vice versa). track-sc1 (wp-login) and track-sc2 (xmlrpc) are each gated on
|
||||||
|
# mutually exclusive path ACLs, so at most one of them ever fires per
|
||||||
|
# request -- HAProxy's "one track-sc<N> per counter per request" limit is
|
||||||
|
# never in play here since they're different counters anyway.
|
||||||
|
backend xmlrpc_bruteforce
|
||||||
|
stick-table type ip size 100k expire 30m store http_req_rate(60s)
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
# Additional trusted reverse proxies — peers permitted to set CF-Connecting-IP,
|
||||||
|
# X-Real-IP and X-Forwarded-For. Anything NOT matched here or in
|
||||||
|
# cloudflare_ips.list has those headers stripped before real-IP resolution.
|
||||||
|
#
|
||||||
|
# Referenced by templates/hap_listener.tpl.
|
||||||
|
#
|
||||||
|
# Leave EMPTY unless a real proxy sits in front of HAProxy on this host. Adding
|
||||||
|
# a range here lets that peer assert any client identity, which bypasses rate
|
||||||
|
# limits, IP blocks and the WAF for it.
|
||||||
|
#
|
||||||
|
# Do NOT commit real IPs — this repo is mirrored publicly. Add entries directly
|
||||||
|
# on the server; the file lives in the /etc/haproxy named volume and persists
|
||||||
|
# across container recreates.
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# Per-site opt-out from the WordPress admin edge gate.
|
||||||
|
#
|
||||||
|
# Hostnames listed here are EXEMPT: unauthenticated /wp-admin/* requests for
|
||||||
|
# these sites pass through to PHP instead of being redirected to wp-login.php.
|
||||||
|
# One hostname per line, lowercase. Matched against the Host header.
|
||||||
|
#
|
||||||
|
# Referenced by templates/hap_listener.tpl:
|
||||||
|
# acl wp_gate_exempt hdr(host),lower -f /etc/haproxy/wpadmin_gate_exempt.list
|
||||||
|
#
|
||||||
|
# Add a site here when a plugin legitimately serves unauthenticated visitors
|
||||||
|
# from a /wp-admin/ URL that is not in the rule's allowlist. Symptom: "my
|
||||||
|
# plugin's admin page redirects to login".
|
||||||
|
#
|
||||||
|
# Do NOT commit real customer domains — this repo is mirrored publicly. Add
|
||||||
|
# entries directly on the server; the file lives in the /etc/haproxy named
|
||||||
|
# volume and persists across container recreates.
|
||||||
Reference in New Issue
Block a user