Default splash for unrouted hosts (404+noindex, answered before the WAF) and in-container access log (2026.11.2) (#15)
HAProxy Manager Build and Push / Build-and-Push (push) Successful in 3m36s
HAProxy Manager Build and Push / Build-and-Push (push) Successful in 3m36s
This commit was merged in pull request #15.
This commit is contained in:
1 parent
1ee5760c1b
commit
50c58c4e9e
16 files changed
+1078
-59
No files matched your search
@@ -0,0 +1,264 @@
|
||||
#!/usr/bin/env python3
|
||||
"""In-container receiver for the HAProxy access log.
|
||||
|
||||
HAProxy sends its access log (`log <socket> ... format rfc5424`, hap_header.tpl)
|
||||
as datagrams to a UNIX socket inside this container. This process is the only
|
||||
reader: it writes one line per datagram to a size-capped, rotating file in the
|
||||
haproxy-logs volume (default /var/log/haproxy/access.log).
|
||||
|
||||
Why it looks the way it does
|
||||
----------------------------
|
||||
* UNIX DATAGRAM socket, no network listener. Nothing is exposed on the host
|
||||
or on client-net (the old target was the host's rsyslog on the docker
|
||||
bridge, 172.18.0.1:514, which had no listener on the fleet).
|
||||
* HAProxy never waits for us. Its log sends are non-blocking: a dead receiver
|
||||
(ECONNREFUSED/ENOENT) or a full socket buffer (EAGAIN) drops that line and
|
||||
HAProxy carries on. So a crash, a stall or a full disk here can only lose
|
||||
log lines, never slow or fail a request. That is the intended direction.
|
||||
* Bounded on disk: the live file is rotated at MAX_BYTES and BACKUPS gzip
|
||||
generations are kept, so the worst case (incompressible data) is
|
||||
(1 + BACKUPS) * MAX_BYTES -- 5 * 40 MB = 200 MB by default. Compression runs
|
||||
in a thread so a rotation does not stall reading.
|
||||
* A full disk (ENOSPC) or any write error drops lines and is reported at most
|
||||
once a minute; the file is reopened on the next attempt.
|
||||
* Lines go to the FILE ONLY, never stdout: `docker logs haproxy-manager` is a
|
||||
source of WHP's AI log monitor, and a per-request firehose there would storm
|
||||
it (see the WHP note on audit/firehose sources). Our own status messages are
|
||||
rare and go to stderr.
|
||||
* Control characters inside a datagram are replaced so one datagram is always
|
||||
exactly one line (a crafted header cannot forge extra log lines).
|
||||
|
||||
Supervised by start-up.sh (restart loop), started before HAProxy.
|
||||
|
||||
Environment
|
||||
-----------
|
||||
HAPROXY_LOG_SOCKET socket path (default /var/lib/haproxy/log.sock)
|
||||
HAPROXY_ACCESS_LOG file path (default /var/log/haproxy/access.log)
|
||||
HAPROXY_ACCESS_LOG_MAX_BYTES rotate size (default 41943040 = 40 MiB)
|
||||
HAPROXY_ACCESS_LOG_BACKUPS gzip generations kept (default 4)
|
||||
"""
|
||||
|
||||
import gzip
|
||||
import os
|
||||
import shutil
|
||||
import socket
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
|
||||
# HAProxy sends at most `len` (2048) bytes per line; leave headroom.
|
||||
MAX_DATAGRAM = 65535
|
||||
FLUSH_INTERVAL = 1.0
|
||||
ERROR_REPORT_INTERVAL = 60.0
|
||||
# Kernel receive buffer to absorb bursts while a write is slow.
|
||||
RCVBUF = 4 * 1024 * 1024
|
||||
|
||||
_CTRL = {c: ' ' for c in range(0x20) if c != 0x09}
|
||||
_CTRL[0x7f] = ' '
|
||||
|
||||
|
||||
def _env_int(name, default, minimum):
|
||||
try:
|
||||
value = int(os.environ.get(name, default))
|
||||
except ValueError:
|
||||
value = default
|
||||
return max(minimum, value)
|
||||
|
||||
|
||||
def clean_line(datagram):
|
||||
"""One datagram -> one log line (str, no trailing newline).
|
||||
|
||||
Drops the RFC 5424 `<PRI>` prefix (constant for our single facility) and
|
||||
replaces any control character so the datagram cannot span lines.
|
||||
"""
|
||||
text = datagram.decode('utf-8', 'replace').rstrip('\r\n\x00')
|
||||
if text.startswith('<'):
|
||||
end = text.find('>', 1, 6)
|
||||
if end > 0 and text[1:end].isdigit():
|
||||
text = text[end + 1:]
|
||||
return text.translate(_CTRL)
|
||||
|
||||
|
||||
class RotatingWriter:
|
||||
"""Size-capped writer: live file + `backups` gzip generations."""
|
||||
|
||||
def __init__(self, path, max_bytes, backups, report=None):
|
||||
self.path = path
|
||||
self.max_bytes = max_bytes
|
||||
self.backups = backups
|
||||
self.report = report or (lambda msg: None)
|
||||
self.fh = None
|
||||
self.size = 0
|
||||
self.dirty = False
|
||||
self.dropped = 0
|
||||
self._compressor = None
|
||||
self._last_error = 0.0
|
||||
|
||||
# -- file handling --------------------------------------------------
|
||||
def _open(self):
|
||||
os.makedirs(os.path.dirname(self.path) or '.', exist_ok=True)
|
||||
self.fh = open(self.path, 'a', encoding='utf-8', buffering=65536)
|
||||
os.chmod(self.path, 0o640)
|
||||
self.size = self.fh.tell()
|
||||
|
||||
def _error(self, what, exc):
|
||||
self.dropped += 1
|
||||
try:
|
||||
if self.fh:
|
||||
self.fh.close()
|
||||
except OSError:
|
||||
pass
|
||||
self.fh = None
|
||||
now = time.monotonic()
|
||||
if now - self._last_error >= ERROR_REPORT_INTERVAL:
|
||||
self._last_error = now
|
||||
self.report(f'{what} failed ({exc}); dropping access-log lines '
|
||||
f'(dropped so far: {self.dropped})')
|
||||
|
||||
def _gen(self, n):
|
||||
return f'{self.path}.{n}.gz'
|
||||
|
||||
def _compress(self, src, dst):
|
||||
tmp = dst + '.tmp'
|
||||
try:
|
||||
with open(src, 'rb') as fin, gzip.open(tmp, 'wb', compresslevel=6) as fout:
|
||||
shutil.copyfileobj(fin, fout, 1024 * 1024)
|
||||
os.replace(tmp, dst)
|
||||
os.chmod(dst, 0o640)
|
||||
except OSError as exc:
|
||||
self.report(f'compressing {src} failed ({exc}); removing it to keep the size cap')
|
||||
for leftover in (tmp,):
|
||||
try:
|
||||
os.unlink(leftover)
|
||||
except OSError:
|
||||
pass
|
||||
finally:
|
||||
try:
|
||||
os.unlink(src)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
def rotate(self):
|
||||
if self._compressor is not None:
|
||||
self._compressor.join()
|
||||
self._compressor = None
|
||||
if self.fh:
|
||||
try:
|
||||
self.fh.close()
|
||||
except OSError:
|
||||
pass
|
||||
self.fh = None
|
||||
if self.backups <= 0:
|
||||
try:
|
||||
os.unlink(self.path)
|
||||
except OSError:
|
||||
pass
|
||||
else:
|
||||
try:
|
||||
os.unlink(self._gen(self.backups))
|
||||
except OSError:
|
||||
pass
|
||||
for n in range(self.backups - 1, 0, -1):
|
||||
if os.path.exists(self._gen(n)):
|
||||
os.replace(self._gen(n), self._gen(n + 1))
|
||||
staged = f'{self.path}.1'
|
||||
if os.path.exists(self.path):
|
||||
os.replace(self.path, staged)
|
||||
self._compressor = threading.Thread(
|
||||
target=self._compress, args=(staged, self._gen(1)), daemon=True)
|
||||
self._compressor.start()
|
||||
self.size = 0
|
||||
|
||||
# -- public ---------------------------------------------------------
|
||||
def write(self, line):
|
||||
data = line + '\n'
|
||||
try:
|
||||
if self.fh is None:
|
||||
self._open()
|
||||
if self.size and self.size + len(data) > self.max_bytes:
|
||||
self.rotate()
|
||||
self._open()
|
||||
self.fh.write(data)
|
||||
self.size += len(data.encode('utf-8'))
|
||||
self.dirty = True
|
||||
except OSError as exc:
|
||||
self._error('writing ' + self.path, exc)
|
||||
|
||||
def flush(self):
|
||||
if self.fh and self.dirty:
|
||||
try:
|
||||
self.fh.flush()
|
||||
self.dirty = False
|
||||
except OSError as exc:
|
||||
self._error('flushing ' + self.path, exc)
|
||||
|
||||
def close(self):
|
||||
self.flush()
|
||||
if self._compressor is not None:
|
||||
self._compressor.join()
|
||||
if self.fh:
|
||||
try:
|
||||
self.fh.close()
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def bind_socket(path):
|
||||
sock = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
|
||||
try:
|
||||
sock.setsockopt(socket.SOL_SOCKET, socket.SO_RCVBUF, RCVBUF)
|
||||
except OSError:
|
||||
pass
|
||||
os.makedirs(os.path.dirname(path) or '.', exist_ok=True)
|
||||
try:
|
||||
os.unlink(path) # stale socket from a previous (crashed) receiver
|
||||
except FileNotFoundError:
|
||||
pass
|
||||
sock.bind(path)
|
||||
# HAProxy's workers run as user haproxy (hap_header.tpl `user haproxy`).
|
||||
os.chmod(path, 0o666)
|
||||
sock.settimeout(FLUSH_INTERVAL)
|
||||
return sock
|
||||
|
||||
|
||||
def serve(sock, writer, stop=None):
|
||||
last_flush = time.monotonic()
|
||||
while stop is None or not stop.is_set():
|
||||
try:
|
||||
datagram = sock.recv(MAX_DATAGRAM)
|
||||
except socket.timeout:
|
||||
datagram = None
|
||||
except OSError:
|
||||
if stop is not None and stop.is_set():
|
||||
break
|
||||
raise
|
||||
if datagram:
|
||||
writer.write(clean_line(datagram))
|
||||
now = time.monotonic()
|
||||
if now - last_flush >= FLUSH_INTERVAL:
|
||||
writer.flush()
|
||||
last_flush = now
|
||||
|
||||
|
||||
def main():
|
||||
sock_path = os.environ.get('HAPROXY_LOG_SOCKET', '/var/lib/haproxy/log.sock')
|
||||
log_path = os.environ.get('HAPROXY_ACCESS_LOG', '/var/log/haproxy/access.log')
|
||||
max_bytes = _env_int('HAPROXY_ACCESS_LOG_MAX_BYTES', 40 * 1024 * 1024, 64 * 1024)
|
||||
backups = _env_int('HAPROXY_ACCESS_LOG_BACKUPS', 4, 0)
|
||||
|
||||
def report(msg):
|
||||
sys.stderr.write(f'haproxy-log-receiver: {msg}\n')
|
||||
sys.stderr.flush()
|
||||
|
||||
writer = RotatingWriter(log_path, max_bytes, backups, report)
|
||||
sock = bind_socket(sock_path)
|
||||
report(f'listening on {sock_path} -> {log_path} '
|
||||
f'(rotate at {max_bytes} bytes, keep {backups} gz)')
|
||||
try:
|
||||
serve(sock, writer)
|
||||
finally:
|
||||
writer.close()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@@ -20,13 +20,13 @@
|
||||
# against.
|
||||
#
|
||||
# Usage: monitor-attacks.sh [live]
|
||||
# Env: LOG_FILE=<path> access log to read (default /var/log/haproxy.log)
|
||||
# Env: LOG_FILE=<path> access log to read (default /var/log/haproxy/access.log)
|
||||
# LOG_LINES=<n> how many trailing log lines to scan (default 500)
|
||||
|
||||
set -uo pipefail
|
||||
|
||||
SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
|
||||
LOG_FILE="${LOG_FILE:-/var/log/haproxy.log}"
|
||||
LOG_FILE="${LOG_FILE:-/var/log/haproxy/access.log}"
|
||||
LOG_LINES="${LOG_LINES:-500}"
|
||||
|
||||
# --- Section 1: current rates (real stick-table data) -----------------------
|
||||
@@ -47,12 +47,12 @@ show_recent_blocks() {
|
||||
syslog on the DOCKER HOST, and the file lives on the host, not in here.
|
||||
Read it from the host instead:
|
||||
|
||||
grep -aE ' (PT|PR)--' /var/log/haproxy.log | tail -20 # tarpit / deny
|
||||
grep -aE ' (429|403) ' /var/log/haproxy.log | tail -20 # rate-limited / blocked
|
||||
grep -a 'cip=<IP>' /var/log/haproxy.log | tail -50 # one client IP
|
||||
grep -a 'id=<uuid>' /var/log/haproxy.log # one request reference
|
||||
grep -aE ' (PT|PR)--' /var/log/haproxy/access.log | tail -20 # tarpit / deny
|
||||
grep -aE ' (429|403) ' /var/log/haproxy/access.log | tail -20 # rate-limited / blocked
|
||||
grep -a 'cip=<IP>' /var/log/haproxy/access.log | tail -50 # one client IP
|
||||
grep -a 'id=<uuid>' /var/log/haproxy/access.log # one request reference
|
||||
# (the UUID on the block page)
|
||||
tail -f /var/log/haproxy.log | grep -aE ' (PT|PR)--' # live
|
||||
tail -f /var/log/haproxy/access.log | grep -aE ' (PT|PR)--' # live
|
||||
|
||||
Or point this script at a copy: LOG_FILE=/path/to/haproxy.log $0
|
||||
MSG
|
||||
|
||||
@@ -12,9 +12,9 @@
|
||||
#
|
||||
# The stick table also keeps NO history, so nothing in it can identify who was
|
||||
# tarpitted. Real enforcement events live in the access log ON THE DOCKER HOST
|
||||
# at /var/log/haproxy.log (it does not exist inside this container):
|
||||
# grep -aE ' (PT|PR)--' /var/log/haproxy.log | tail -20 # tarpit / deny
|
||||
# grep -aE ' (429|403) ' /var/log/haproxy.log | tail -20 # rate-limit / block
|
||||
# at /var/log/haproxy/access.log (inside this container since 2026.11.2):
|
||||
# grep -aE ' (PT|PR)--' /var/log/haproxy/access.log | tail -20 # tarpit / deny
|
||||
# grep -aE ' (429|403) ' /var/log/haproxy/access.log | tail -20 # rate-limit / block
|
||||
#
|
||||
# What IS knowable from the stick table — the current per-IP rates — is printed
|
||||
# by show-edge-ip-rates.sh, which this shim now runs.
|
||||
@@ -25,8 +25,8 @@ cat >&2 <<'NOTE'
|
||||
NOTE: show-tarpit-ips.sh is deprecated and cannot report tarpits.
|
||||
The HAProxy stick table stores no history and no gpc0/gpc1 counters, so
|
||||
the old "Scan Count"/"BLOCKED" columns were fabricated numbers.
|
||||
Actual tarpit/deny events are in /var/log/haproxy.log ON THE HOST:
|
||||
grep -aE ' (PT|PR)--' /var/log/haproxy.log | tail -20
|
||||
Actual tarpit/deny events are in /var/log/haproxy/access.log (in this container since 2026.11.2):
|
||||
grep -aE ' (PT|PR)--' /var/log/haproxy/access.log | tail -20
|
||||
Running show-edge-ip-rates.sh instead (current rates, real values):
|
||||
|
||||
NOTE
|
||||
|
||||
@@ -55,6 +55,24 @@ if [ ! -f /etc/haproxy/wpadmin_gate_exempt.list ]; then
|
||||
fi
|
||||
fi
|
||||
|
||||
# HAProxy access log receiver (see scripts/haproxy-log-receiver.py and the
|
||||
# `log` line in hap_header.tpl). HAProxy sends datagrams to a UNIX socket
|
||||
# inside its chroot; this process writes them to a size-capped, rotating
|
||||
# /var/log/haproxy/access.log (WHP mounts the haproxy-logs volume there).
|
||||
# Started BEFORE init.py so haproxy's first lines land. Supervised by a
|
||||
# restart loop: if it dies it is back within 2s, and while it is down HAProxy
|
||||
# just drops log lines (non-blocking sends), it never blocks on them.
|
||||
# stdout is discarded on purpose -- it never prints log lines, and
|
||||
# `docker logs` must not carry a per-request firehose (WHP's AI monitor reads
|
||||
# it); its rare status/error lines go to stderr.
|
||||
mkdir -p /var/log/haproxy /var/lib/haproxy
|
||||
(
|
||||
while true; do
|
||||
python /haproxy/scripts/haproxy-log-receiver.py >/dev/null || true
|
||||
sleep 2
|
||||
done
|
||||
) &
|
||||
|
||||
cron &
|
||||
|
||||
# Phase 1: container init
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Tests for scripts/haproxy-log-receiver.py (in-container access log).
|
||||
|
||||
Pins: one datagram == one line (PRI stripped, control chars neutralised),
|
||||
the size cap (live file + N gzip generations, oldest dropped), a write error
|
||||
(full disk / unwritable dir) drops lines without raising, and an end-to-end
|
||||
datagram path through a real UNIX socket.
|
||||
|
||||
Running
|
||||
-------
|
||||
python3 scripts/test-access-log-receiver.py
|
||||
"""
|
||||
|
||||
import gzip
|
||||
import importlib.util
|
||||
import os
|
||||
import shutil
|
||||
import socket
|
||||
import tempfile
|
||||
import threading
|
||||
import time
|
||||
import unittest
|
||||
|
||||
HERE = os.path.dirname(os.path.abspath(__file__))
|
||||
_spec = importlib.util.spec_from_file_location(
|
||||
'haproxy_log_receiver', os.path.join(HERE, 'haproxy-log-receiver.py'))
|
||||
rx = importlib.util.module_from_spec(_spec)
|
||||
_spec.loader.exec_module(rx)
|
||||
|
||||
|
||||
class CleanLine(unittest.TestCase):
|
||||
|
||||
def test_strips_pri_and_trailing_newline(self):
|
||||
self.assertEqual(rx.clean_line(b'<150>1 2026-11-08T00:00:00Z h haproxy 7 - - GET /\n'),
|
||||
'1 2026-11-08T00:00:00Z h haproxy 7 - - GET /')
|
||||
|
||||
def test_embedded_newlines_cannot_forge_lines(self):
|
||||
out = rx.clean_line(b'<150>1 x ua=evil\r\nFAKE 200 line\x1b[2J')
|
||||
self.assertNotIn('\n', out)
|
||||
self.assertNotIn('\r', out)
|
||||
self.assertNotIn('\x1b', out)
|
||||
self.assertIn('FAKE 200 line', out)
|
||||
|
||||
def test_invalid_utf8_does_not_raise(self):
|
||||
self.assertIn('�', rx.clean_line(b'<150>1 \xff\xfe'))
|
||||
|
||||
def test_non_pri_angle_bracket_kept(self):
|
||||
self.assertEqual(rx.clean_line(b'<html> x'), '<html> x')
|
||||
|
||||
|
||||
class Rotation(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.dir = tempfile.mkdtemp(prefix='hlr-test-')
|
||||
self.path = os.path.join(self.dir, 'access.log')
|
||||
|
||||
def tearDown(self):
|
||||
shutil.rmtree(self.dir, ignore_errors=True)
|
||||
|
||||
def _files(self):
|
||||
return sorted(os.listdir(self.dir))
|
||||
|
||||
def test_size_cap_and_generations(self):
|
||||
max_bytes, backups = 4096, 3
|
||||
w = rx.RotatingWriter(self.path, max_bytes, backups)
|
||||
line = 'x' * 99 # 100 bytes with newline
|
||||
for i in range(1000): # ~100 KB -> ~24 rotations
|
||||
w.write(f'{i:05d}' + line[5:])
|
||||
w.close()
|
||||
files = self._files()
|
||||
self.assertEqual(files, ['access.log', 'access.log.1.gz',
|
||||
'access.log.2.gz', 'access.log.3.gz'], files)
|
||||
self.assertLessEqual(os.path.getsize(self.path), max_bytes)
|
||||
total = sum(os.path.getsize(os.path.join(self.dir, f)) for f in files)
|
||||
self.assertLessEqual(total, (1 + backups) * max_bytes)
|
||||
# newest generation holds the lines written just before the live file
|
||||
with gzip.open(os.path.join(self.dir, 'access.log.1.gz'), 'rt') as fh:
|
||||
gen1 = fh.read().splitlines()
|
||||
with open(self.path) as fh:
|
||||
live = fh.read().splitlines()
|
||||
self.assertEqual(int(gen1[-1][:5]) + 1, int(live[0][:5]))
|
||||
self.assertEqual(live[-1][:5], '00999')
|
||||
for l in gen1:
|
||||
self.assertEqual(len(l), 99)
|
||||
|
||||
def test_zero_backups_keeps_only_live_file(self):
|
||||
w = rx.RotatingWriter(self.path, 1024, 0)
|
||||
for _ in range(100):
|
||||
w.write('y' * 63)
|
||||
w.close()
|
||||
self.assertEqual(self._files(), ['access.log'])
|
||||
self.assertLessEqual(os.path.getsize(self.path), 1024)
|
||||
|
||||
def test_reopens_existing_file_and_counts_its_size(self):
|
||||
with open(self.path, 'w') as fh:
|
||||
fh.write('z' * 1000 + '\n')
|
||||
w = rx.RotatingWriter(self.path, 1500, 2)
|
||||
w.write('a' * 600) # 1001 + 601 > 1500 -> rotate first
|
||||
w.close()
|
||||
self.assertIn('access.log.1.gz', self._files())
|
||||
with open(self.path) as fh:
|
||||
self.assertEqual(fh.read(), 'a' * 600 + '\n')
|
||||
|
||||
def test_write_error_drops_and_never_raises(self):
|
||||
blocker = os.path.join(self.dir, 'not-a-dir')
|
||||
with open(blocker, 'w') as fh:
|
||||
fh.write('')
|
||||
msgs = []
|
||||
w = rx.RotatingWriter(os.path.join(blocker, 'access.log'), 4096, 2, msgs.append)
|
||||
for _ in range(50):
|
||||
w.write('line')
|
||||
w.flush()
|
||||
w.close()
|
||||
self.assertEqual(w.dropped, 50)
|
||||
self.assertEqual(len(msgs), 1, msgs) # rate-limited report
|
||||
|
||||
|
||||
class EndToEnd(unittest.TestCase):
|
||||
|
||||
def test_datagrams_become_lines(self):
|
||||
d = tempfile.mkdtemp(prefix='hlr-e2e-')
|
||||
try:
|
||||
sock_path = os.path.join(d, 'log.sock')
|
||||
log_path = os.path.join(d, 'logs', 'access.log')
|
||||
sock = rx.bind_socket(sock_path)
|
||||
self.assertEqual(os.stat(sock_path).st_mode & 0o777, 0o666)
|
||||
w = rx.RotatingWriter(log_path, 1 << 20, 2)
|
||||
stop = threading.Event()
|
||||
t = threading.Thread(target=rx.serve, args=(sock, w, stop), daemon=True)
|
||||
t.start()
|
||||
cl = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
|
||||
cl.setblocking(False)
|
||||
for i in range(20):
|
||||
msg = f'<150>1 t h haproxy 1 - - req {i} host=a.example cip=192.0.2.1'.encode()
|
||||
# The default net.unix.max_dgram_qlen is 10 per netns: a full
|
||||
# queue is EAGAIN (HAProxy drops the line); here, retry.
|
||||
for _ in range(100):
|
||||
try:
|
||||
cl.sendto(msg, sock_path)
|
||||
break
|
||||
except BlockingIOError:
|
||||
time.sleep(0.01)
|
||||
deadline = time.time() + 5
|
||||
lines = []
|
||||
while time.time() < deadline:
|
||||
time.sleep(0.2)
|
||||
w.flush()
|
||||
if os.path.exists(log_path):
|
||||
with open(log_path) as fh:
|
||||
lines = fh.read().splitlines()
|
||||
if len(lines) == 20:
|
||||
break
|
||||
stop.set()
|
||||
t.join(3)
|
||||
sock.close()
|
||||
w.close()
|
||||
self.assertEqual(len(lines), 20, lines)
|
||||
self.assertTrue(lines[0].startswith('1 t h haproxy 1 - - req 0 host=a.example'))
|
||||
finally:
|
||||
shutil.rmtree(d, ignore_errors=True)
|
||||
|
||||
def test_sender_to_dead_receiver_fails_fast_nonblocking(self):
|
||||
"""What HAProxy sees when the receiver is down: an immediate error,
|
||||
never a block (HAProxy then just counts a dropped log line)."""
|
||||
d = tempfile.mkdtemp(prefix='hlr-dead-')
|
||||
try:
|
||||
cl = socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM)
|
||||
cl.setblocking(False)
|
||||
start = time.monotonic()
|
||||
with self.assertRaises(OSError):
|
||||
cl.sendto(b'x', os.path.join(d, 'log.sock'))
|
||||
self.assertLess(time.monotonic() - start, 0.5)
|
||||
finally:
|
||||
shutil.rmtree(d, ignore_errors=True)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main(verbosity=2)
|
||||
@@ -0,0 +1,304 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Regression tests for the default splash (unrouted hosts answered pre-WAF).
|
||||
|
||||
Why this file exists
|
||||
--------------------
|
||||
Visiting a WHP server's own hostname (https://whpNN.<domain>/ on 80/443, not
|
||||
the panel port), its bare IP, or any name with no site behind it used to fall
|
||||
through to `default_backend default-backend` -- but only AFTER every
|
||||
http-request rule had run, Coraza's send-spoe-group included. `use_backend`
|
||||
does not short-circuit http-request processing. So the catch-all was WAF
|
||||
inspected with the server-wide rule set, and a browser on the server hostname
|
||||
also carries the control panel's cookies (cookies are not port-scoped), which
|
||||
produced the WAF block page for a host that has nothing behind it to protect.
|
||||
|
||||
The splash answers those requests with `http-request return` BEFORE the SPOE
|
||||
call. Its safety property is that it must NEVER answer a host that routes to
|
||||
a site. That is held by:
|
||||
- routed_hosts.list / routed_wildcards.list being written from the same
|
||||
rows, in the same generate_config() call, as the routing ACLs
|
||||
- the lists being port-stripped + lowercased (a superset of the raw-Host
|
||||
routing ACLs)
|
||||
- the lists being part of the rollback set
|
||||
and it must keep ACME http-01, the blocked-IP page and the suspended page.
|
||||
|
||||
Running
|
||||
-------
|
||||
python3 scripts/test-default-splash.py
|
||||
"""
|
||||
|
||||
import logging
|
||||
import os
|
||||
import re
|
||||
import sqlite3
|
||||
import sys
|
||||
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)
|
||||
)
|
||||
try:
|
||||
import haproxy_manager as hm # noqa: E402
|
||||
finally:
|
||||
logging.FileHandler = _real_file_handler
|
||||
logging.getLogger('haproxy_manager').setLevel(logging.CRITICAL)
|
||||
|
||||
SPLASH_FILE = os.path.join(MODULE_DIR, 'errors', 'default-splash.html')
|
||||
|
||||
|
||||
def render_listener(**kw):
|
||||
args = dict(crt_path='/etc/haproxy/certs', suspension_enabled=False,
|
||||
coraza_spoe_backend='127.0.0.1:9000', default_splash=True)
|
||||
args.update(kw)
|
||||
return hm.template_env.get_template('hap_listener.tpl').render(**args)
|
||||
|
||||
|
||||
def return_rules(cfg):
|
||||
return [l.strip() for l in cfg.splitlines()
|
||||
if l.strip().startswith('http-request return')
|
||||
and ('default-splash.html' in l or 'robots-unrouted.txt' in l)]
|
||||
|
||||
|
||||
class Template(unittest.TestCase):
|
||||
|
||||
def test_off_renders_nothing(self):
|
||||
cfg = render_listener(default_splash=False)
|
||||
self.assertNotIn('default-splash', cfg)
|
||||
self.assertNotIn('splash_routed_host', cfg)
|
||||
|
||||
def test_404_everywhere_robots_txt_200(self):
|
||||
"""Josh 2026-11-08: unrouted hosts are 404 on EVERY path (incl. "/")
|
||||
so search engines never index the server IP/hostname; /robots.txt is
|
||||
the one 200 and disallows everything."""
|
||||
rules = return_rules(render_listener())
|
||||
self.assertEqual(len(rules), 2, rules)
|
||||
robots, splash = rules
|
||||
self.assertTrue(robots.startswith('http-request return status 200 content-type "text/plain'))
|
||||
self.assertIn(' file /haproxy/errors/robots-unrouted.txt ', robots)
|
||||
self.assertTrue(robots.endswith(' splash_robots'))
|
||||
self.assertTrue(splash.startswith('http-request return status 404 content-type "text/html'))
|
||||
self.assertTrue(splash.endswith(' !splash_robots'))
|
||||
self.assertNotIn('splash_root', render_listener())
|
||||
self.assertRegex(render_listener(), r'acl splash_robots path /robots\.txt\n')
|
||||
|
||||
def test_noindex_and_no_store_headers_on_both(self):
|
||||
for rule in return_rules(render_listener()):
|
||||
self.assertIn('hdr x-robots-tag "noindex, nofollow, noarchive"', rule)
|
||||
self.assertIn('hdr cache-control "no-store"', rule)
|
||||
self.assertIn('hdr x-content-type-options "nosniff"', rule)
|
||||
|
||||
def test_static_file_not_lf_file(self):
|
||||
"""`file` (verbatim), never `lf-file`: nothing from the request may be
|
||||
expanded into the page (Host echo, unique-id, ...)."""
|
||||
for rule in return_rules(render_listener()):
|
||||
self.assertRegex(rule, r' file /haproxy/errors/(default-splash\.html|robots-unrouted\.txt) ')
|
||||
self.assertNotIn('lf-file', rule)
|
||||
|
||||
def test_conditions_keep_acme_blocked_and_suspended_out(self):
|
||||
for susp in (False, True):
|
||||
for rule in return_rules(render_listener(suspension_enabled=susp)):
|
||||
cond = rule.split(' if ', 1)[1].split()
|
||||
self.assertIn('!splash_routed_host', cond)
|
||||
self.assertIn('!splash_acme', cond)
|
||||
self.assertIn('!is_blocked_ip', cond)
|
||||
if susp:
|
||||
self.assertIn('!is_suspended_domain', cond)
|
||||
else:
|
||||
self.assertNotIn('!is_suspended_domain', cond)
|
||||
|
||||
def test_acme_acl_is_the_challenge_prefix(self):
|
||||
self.assertRegex(render_listener(),
|
||||
r'acl splash_acme path_beg /\.well-known/acme-challenge/\n')
|
||||
|
||||
def test_routed_acls_strip_port_and_lowercase(self):
|
||||
cfg = render_listener()
|
||||
self.assertIn('acl splash_routed_host req.hdr(host),field(1,:),lower '
|
||||
'-f /etc/haproxy/routed_hosts.list', cfg)
|
||||
self.assertIn('acl splash_routed_host req.hdr(host),field(1,:),lower '
|
||||
'-m end -f /etc/haproxy/routed_wildcards.list', cfg)
|
||||
|
||||
def test_splash_runs_before_waf_and_after_ip_block_and_suspension(self):
|
||||
for susp in (False, True):
|
||||
cfg = render_listener(suspension_enabled=susp)
|
||||
first_return = cfg.index('file /haproxy/errors/robots-unrouted.txt')
|
||||
self.assertLess(first_return, cfg.index('http-request send-spoe-group coraza'))
|
||||
self.assertLess(first_return, cfg.index('filter spoe engine coraza'))
|
||||
self.assertGreater(first_return, cfg.index('acl is_blocked_ip'))
|
||||
self.assertGreater(first_return, cfg.index('http-request track-sc0'))
|
||||
if susp:
|
||||
self.assertGreater(first_return, cfg.index('acl is_suspended_domain'))
|
||||
|
||||
|
||||
class Page(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
with open(SPLASH_FILE, 'rb') as fh:
|
||||
self.raw = fh.read()
|
||||
self.text = self.raw.decode('utf-8')
|
||||
|
||||
def test_small_enough_for_one_buffer(self):
|
||||
# http-request return payload must fit tune.bufsize (16384) with headers.
|
||||
self.assertLess(len(self.raw), 8192)
|
||||
|
||||
def test_no_links_scripts_or_external_resources(self):
|
||||
low = self.text.lower()
|
||||
for needle in ('href', 'src=', '<script', '<form', '<a ', 'http://', 'https://',
|
||||
'8443', '@import', 'url('):
|
||||
self.assertNotIn(needle, low, needle)
|
||||
|
||||
def test_no_version_or_template_expansions(self):
|
||||
self.assertNotRegex(self.text, r'20\d\d\.\d+\.\d+')
|
||||
self.assertNotIn('{{', self.text)
|
||||
self.assertNotIn('%[', self.text)
|
||||
|
||||
|
||||
class Robots(unittest.TestCase):
|
||||
|
||||
def test_robots_disallows_everything(self):
|
||||
with open(os.path.join(MODULE_DIR, 'errors', 'robots-unrouted.txt')) as fh:
|
||||
self.assertEqual(fh.read(), 'User-agent: *\nDisallow: /\n')
|
||||
|
||||
|
||||
class RoutedLists(unittest.TestCase):
|
||||
|
||||
def test_render_sorted_dedup_lower(self):
|
||||
body = hm.render_routed_list(['B.example.com', 'a.example.com', 'b.example.com ', ''])
|
||||
lines = [l for l in body.splitlines() if not l.startswith('#')]
|
||||
self.assertEqual(lines, ['a.example.com', 'b.example.com'])
|
||||
|
||||
def test_name_with_whitespace_is_dropped_not_split(self):
|
||||
body = hm.render_routed_list(['ok.example.com', 'bad\nevil.example.com', 'a b'])
|
||||
lines = [l for l in body.splitlines() if not l.startswith('#')]
|
||||
self.assertEqual(lines, ['ok.example.com'])
|
||||
|
||||
def test_lists_are_in_the_rollback_set(self):
|
||||
pairs = dict(hm._config_backup_pairs())
|
||||
self.assertIn(hm.ROUTED_HOSTS_PATH, pairs)
|
||||
self.assertIn(hm.ROUTED_WILDCARDS_PATH, pairs)
|
||||
|
||||
|
||||
class GenerateConfigWritesLists(unittest.TestCase):
|
||||
"""Run the real generate_config() with paths redirected and reload stubbed."""
|
||||
|
||||
def setUp(self):
|
||||
self.tmp = tempfile.mkdtemp(prefix='splash-test-')
|
||||
self.saved = {k: getattr(hm, k) for k in (
|
||||
'DB_FILE', 'HAPROXY_CONFIG_PATH', 'HAPROXY_BACKUP_PATH',
|
||||
'CLUSTER_SECRET_PATH', 'HAPROXY_SOCKET_PATH', 'SSL_CERTS_DIR',
|
||||
'BLOCKED_IPS_MAP_PATH', 'BLOCKED_IPS_MAP_BACKUP_PATH',
|
||||
'CORAZA_SPOE_CONFIG_PATH', 'CORAZA_SPOE_BACKUP_PATH',
|
||||
'ROUTED_HOSTS_PATH', 'ROUTED_HOSTS_BACKUP_PATH',
|
||||
'ROUTED_WILDCARDS_PATH', 'ROUTED_WILDCARDS_BACKUP_PATH',
|
||||
'reload_haproxy_safely', 'create_backup')}
|
||||
j = lambda n: os.path.join(self.tmp, n) # noqa: E731
|
||||
hm.DB_FILE = j('db.sqlite')
|
||||
hm.HAPROXY_CONFIG_PATH = j('haproxy.cfg')
|
||||
hm.HAPROXY_BACKUP_PATH = j('haproxy.cfg.backup')
|
||||
hm.CLUSTER_SECRET_PATH = j('cluster-secret')
|
||||
hm.HAPROXY_SOCKET_PATH = j('haproxy.sock')
|
||||
hm.SSL_CERTS_DIR = j('certs')
|
||||
hm.BLOCKED_IPS_MAP_PATH = j('blocked_ips.map')
|
||||
hm.BLOCKED_IPS_MAP_BACKUP_PATH = j('blocked_ips.map.backup')
|
||||
hm.CORAZA_SPOE_CONFIG_PATH = j('coraza-spoe.cfg')
|
||||
hm.CORAZA_SPOE_BACKUP_PATH = j('coraza-spoe.cfg.backup')
|
||||
hm.ROUTED_HOSTS_PATH = j('routed_hosts.list')
|
||||
hm.ROUTED_HOSTS_BACKUP_PATH = j('routed_hosts.list.backup')
|
||||
hm.ROUTED_WILDCARDS_PATH = j('routed_wildcards.list')
|
||||
hm.ROUTED_WILDCARDS_BACKUP_PATH = j('routed_wildcards.list.backup')
|
||||
hm.reload_haproxy_safely = lambda *a, **kw: (True, 'stubbed')
|
||||
hm.create_backup = lambda *a, **kw: (True, 'unavailable')
|
||||
self.env = {k: os.environ.pop(k, None) for k in (
|
||||
'HAPROXY_DEFAULT_SPLASH', 'HAPROXY_SUSPENSION_ENABLED',
|
||||
'HAPROXY_CORAZA_SPOE_BACKEND')}
|
||||
hm.init_db()
|
||||
with sqlite3.connect(hm.DB_FILE) as conn:
|
||||
cur = conn.cursor()
|
||||
|
||||
def add(domain, backend, wildcard=0):
|
||||
cur.execute('INSERT INTO domains (domain, ssl_enabled, ssl_cert_path, '
|
||||
'template_override, is_wildcard) VALUES (?, 1, NULL, NULL, ?)',
|
||||
(domain, wildcard))
|
||||
did = cur.lastrowid
|
||||
if backend:
|
||||
cur.execute('INSERT INTO backends (name, domain_id, settings) VALUES (?, ?, NULL)',
|
||||
(backend, did))
|
||||
cur.execute('INSERT INTO backend_servers (backend_id, server_name, '
|
||||
'server_address, server_port, server_options) VALUES (?, ?, ?, ?, ?)',
|
||||
(cur.lastrowid, 'web1', '10.0.0.10', 80, 'check'))
|
||||
add('Site.Example.com', 'site')
|
||||
add('*.wild.example.com', 'wild', wildcard=1)
|
||||
add('whp01.example.net', None) # server hostname: cert-only
|
||||
conn.commit()
|
||||
|
||||
def tearDown(self):
|
||||
for k, v in self.saved.items():
|
||||
setattr(hm, k, v)
|
||||
for k, v in self.env.items():
|
||||
os.environ.pop(k, None)
|
||||
if v is not None:
|
||||
os.environ[k] = v
|
||||
import shutil
|
||||
shutil.rmtree(self.tmp, ignore_errors=True)
|
||||
|
||||
def _lines(self, path):
|
||||
with open(path) as fh:
|
||||
return [l for l in fh.read().splitlines() if l and not l.startswith('#')]
|
||||
|
||||
def test_lists_written_from_routed_rows_only(self):
|
||||
hm.generate_config()
|
||||
self.assertEqual(self._lines(hm.ROUTED_HOSTS_PATH), ['site.example.com'])
|
||||
self.assertEqual(self._lines(hm.ROUTED_WILDCARDS_PATH), ['.wild.example.com'])
|
||||
with open(hm.HAPROXY_CONFIG_PATH) as fh:
|
||||
cfg = fh.read()
|
||||
# every exact routing ACL name is in the list (superset property)
|
||||
for name in re.findall(r'acl \S+-acl hdr\(host\) -i (\S+)', cfg):
|
||||
self.assertIn(name.lower(), self._lines(hm.ROUTED_HOSTS_PATH))
|
||||
for base in re.findall(r'acl \S+-acl hdr_end\(host\) -i (\S+)', cfg):
|
||||
self.assertIn(base.lower(), self._lines(hm.ROUTED_WILDCARDS_PATH))
|
||||
self.assertIn('default-splash.html', cfg)
|
||||
|
||||
def test_default_log_target_is_the_in_container_socket(self):
|
||||
"""Access log goes to the receiver's UNIX socket (chroot-relative),
|
||||
never the old host bridge target 172.18.0.1:514."""
|
||||
os.environ.pop('HAPROXY_SYSLOG_TARGET', None)
|
||||
hm.generate_config()
|
||||
with open(hm.HAPROXY_CONFIG_PATH) as fh:
|
||||
cfg = fh.read()
|
||||
self.assertRegex(cfg, r'\n log /log\.sock len 2048 format rfc5424 local2 info\n')
|
||||
self.assertIn('chroot /var/lib/haproxy', cfg)
|
||||
log_lines = [l for l in cfg.splitlines() if l.strip().startswith('log ')
|
||||
and 'global' not in l]
|
||||
self.assertEqual(len(log_lines), 1, log_lines)
|
||||
self.assertNotIn('172.18.0.1', log_lines[0])
|
||||
|
||||
def test_log_target_env_override(self):
|
||||
os.environ['HAPROXY_SYSLOG_TARGET'] = '192.0.2.5:514'
|
||||
try:
|
||||
hm.generate_config()
|
||||
finally:
|
||||
os.environ.pop('HAPROXY_SYSLOG_TARGET', None)
|
||||
with open(hm.HAPROXY_CONFIG_PATH) as fh:
|
||||
self.assertIn('log 192.0.2.5:514 len 2048', fh.read())
|
||||
|
||||
def test_lists_written_even_with_splash_off(self):
|
||||
os.environ['HAPROXY_DEFAULT_SPLASH'] = 'off'
|
||||
hm.generate_config()
|
||||
self.assertTrue(os.path.exists(hm.ROUTED_HOSTS_PATH))
|
||||
self.assertTrue(os.path.exists(hm.ROUTED_WILDCARDS_PATH))
|
||||
with open(hm.HAPROXY_CONFIG_PATH) as fh:
|
||||
self.assertNotIn('default-splash.html', fh.read())
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main(verbosity=2)
|
||||
@@ -128,6 +128,9 @@ STUB_FILES = {
|
||||
# `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',
|
||||
# `file` on the default-splash return rules; loaded at parse time too.
|
||||
'/haproxy/errors/default-splash.html': '<html><body>splash</body></html>\n',
|
||||
'/haproxy/errors/robots-unrouted.txt': 'User-agent: *\nDisallow: /\n',
|
||||
}
|
||||
|
||||
# (suspension_enabled, coraza_spoe_backend) combinations to render + validate.
|
||||
@@ -137,6 +140,12 @@ SCENARIOS = (
|
||||
'HAPROXY_SUSPENSION_ENABLED': 'true',
|
||||
'HAPROXY_CORAZA_SPOE_BACKEND': '127.0.0.1:9000',
|
||||
}),
|
||||
# The default splash is ON unless switched off; render the off shape too.
|
||||
('splash-off', {
|
||||
'HAPROXY_SUSPENSION_ENABLED': 'true',
|
||||
'HAPROXY_CORAZA_SPOE_BACKEND': '127.0.0.1:9000',
|
||||
'HAPROXY_DEFAULT_SPLASH': 'off',
|
||||
}),
|
||||
)
|
||||
|
||||
|
||||
@@ -298,7 +307,8 @@ def render(scenario_name, env_overrides, workdir):
|
||||
seed_database(os.path.join(scenario_dir, 'haproxy_config.db'))
|
||||
|
||||
saved_env = {}
|
||||
for key in ('HAPROXY_SUSPENSION_ENABLED', 'HAPROXY_CORAZA_SPOE_BACKEND'):
|
||||
for key in ('HAPROXY_SUSPENSION_ENABLED', 'HAPROXY_CORAZA_SPOE_BACKEND',
|
||||
'HAPROXY_DEFAULT_SPLASH'):
|
||||
saved_env[key] = os.environ.pop(key, None)
|
||||
os.environ.update(env_overrides)
|
||||
|
||||
@@ -330,6 +340,8 @@ def assert_scenario_branches(scenario_name, config_path, env_overrides):
|
||||
'HAPROXY_SUSPENSION_ENABLED' in env_overrides),
|
||||
'coraza': ('filter spoe engine coraza',
|
||||
'HAPROXY_CORAZA_SPOE_BACKEND' in env_overrides),
|
||||
'splash': ('file /haproxy/errors/default-splash.html',
|
||||
env_overrides.get('HAPROXY_DEFAULT_SPLASH') != 'off'),
|
||||
}
|
||||
for label, (needle, should_be_present) in expected.items():
|
||||
present = needle in text
|
||||
|
||||
Reference in new issue
Block a user