fix(10-03): unify secret generation to a single producer + self-heal (F-03)
Unify rather than delete. The defect in F-03 was never "a second attempt to
create a key exists" — it was that failure was silent and the completion marker
lied about it. A second attempt is only dangerous when it is an unaudited second
PRODUCER carrying its own idea of success, its own absent retry policy and its
own absent failure record.
Single producer. gen_tls() is now the only code in the ISO build that creates
/etc/archipelago/ssl/archipelago.{key,crt}; gen_ssh() the only code that creates
/etc/ssh/ssh_host_*. Two secondary producers are gone:
- the Dockerfile's `openssl req` layer, which baked a keypair the strip layer
deleted moments later in the same build;
- the installer's "ensure SSL cert exists for nginx HTTPS" block, which before
the strip almost never fired and after it would have fired on every install.
Proof is mechanical, not a claim: every executable `openssl req` / `ssh-keygen
-A` invocation in the builder now lives inside the generator heredoc, and the
test suite fails if one appears outside it.
Build-time assertion. The one realistic total failure is a missing generator
binary, which is deterministic — no retry or reboot fixes it. A rootfs RUN layer
now fails the build if openssl or ssh-keygen is missing or non-executable.
openssl and openssh-server are both already in the package list (and
openssh-server hard-depends openssh-client, which ships ssh-keygen), so today
this is cheap insurance; it earns its place the first time someone edits that
list.
Self-heal, never dead-end. Fail-closed governs SERVING; retry governs
RECOVERING, and they are different things. Adds
archipelago-first-boot-secrets.timer (OnBootSec=5min, OnUnitActiveSec=15min),
installed and enabled with a hand-written symlink fallback because chroot
systemctl enable can fail silently. The service's own ConditionPathExists=!
makes every trigger a no-op once the marker exists, so a healthy node pays
nothing. On success the script now restarts consumers that are in `failed` —
try-reload-or-restart is a no-op on a failed unit, so without this a recovered
node would have valid keys on disk and nginx still down.
Never serve a bogus key. gen_tls parses both halves back with `openssl pkey`
and `openssl x509` before the swap, so a truncated or half-written artefact is
never what nginx reads.
Tests: 6 cases, each with an isolated negative control (transcripts in SUMMARY).
- case 4, TLS fails every attempt on a stripped root -> no key from any source.
Control: reintroduce a fallback key creation -> only case 4 red.
- case 5, self-heal: a failed run then a later successful run -> key present,
marker set, failed units restarted. Control: dead-end on a node that already
failed -> only case 5 red.
- case 6, single-producer invariant. Control: reintroduce the installer block
-> only case 6 red, naming the line.
Residual risk, stated plainly: a machine where generation can never succeed
still ends up with no SSH and no TLS. Build-time assertion removes the
deterministic cause, retry plus timer removes the transient ones, so what
remains is genuinely broken hardware — and it says so on the console and in
/var/lib/archipelago/first-boot-secrets.failed rather than quietly serving a
key nobody audited.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
archipelago
co-authored by
Claude Opus 5
Claude Opus 5
parent
ff6902dd9d
commit
2efab5f219
@@ -62,17 +62,41 @@ fi
|
||||
# systemctl / logger calls hit these instead of the real tools. Behaviour is
|
||||
# driven by env vars the stubs read at call time.
|
||||
#
|
||||
# STUB_OPENSSL_MODE ok | fail
|
||||
# STUB_SSHKEYGEN_MODE ok | fail | fail-twice (fail-twice uses a counter file)
|
||||
# STUB_COUNTER_DIR where the counter file lives
|
||||
# STUB_OPENSSL_MODE ok | fail (fail affects `req` only —
|
||||
# `pkey`/`x509` validation still
|
||||
# works, so a failed generation
|
||||
# cannot be mistaken for a failed
|
||||
# validation)
|
||||
# STUB_SSHKEYGEN_MODE ok | fail | fail-twice (uses a counter file)
|
||||
# STUB_COUNTER_DIR where the counter file lives
|
||||
# STUB_SYSTEMCTL_FAILED_UNITS units `systemctl is-failed` should report failed
|
||||
# STUB_SYSTEMCTL_LOG file the systemctl stub appends its args to
|
||||
make_stubs() {
|
||||
local dir="$1"
|
||||
mkdir -p "$dir"
|
||||
|
||||
cat > "$dir/openssl" <<'STUB'
|
||||
#!/bin/bash
|
||||
# Stub openssl: honours -keyout/-out so the script's staging-then-swap and its
|
||||
# non-empty checks are exercised for real.
|
||||
# Stub openssl. Honours -keyout/-out so the script's staging-then-swap and its
|
||||
# non-empty checks are exercised for real, and implements the `pkey`/`x509`
|
||||
# parse-back validation the generator does before it swaps.
|
||||
sub="${1:-}"
|
||||
case "$sub" in
|
||||
pkey|x509)
|
||||
# Validation: succeed iff the file exists and is non-empty. This is what
|
||||
# lets the harness prove a truncated artefact is never swapped in.
|
||||
f=""
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
-in) f="$2"; shift 2 ;;
|
||||
*) shift ;;
|
||||
esac
|
||||
done
|
||||
[ -n "$f" ] && [ -s "$f" ] || exit 1
|
||||
exit 0
|
||||
;;
|
||||
esac
|
||||
|
||||
[ "${STUB_OPENSSL_MODE:-ok}" = "fail" ] && exit 1
|
||||
keyout="" out=""
|
||||
while [ $# -gt 0 ]; do
|
||||
@@ -119,8 +143,23 @@ done
|
||||
exit 0
|
||||
STUB
|
||||
|
||||
# Neither of these must be allowed to touch the host during a test run.
|
||||
printf '#!/bin/bash\nexit 0\n' > "$dir/systemctl"
|
||||
cat > "$dir/systemctl" <<'STUB'
|
||||
#!/bin/bash
|
||||
# Stub systemctl. Records every invocation so the harness can prove the
|
||||
# self-heal path actually restarts a unit that failed for want of a key, and
|
||||
# reports is-failed honestly so first-boot and self-heal take different paths.
|
||||
[ -n "${STUB_SYSTEMCTL_LOG:-}" ] && echo "$*" >> "$STUB_SYSTEMCTL_LOG"
|
||||
if [ "${1:-}" = "is-failed" ]; then
|
||||
unit="${!#}"
|
||||
for u in ${STUB_SYSTEMCTL_FAILED_UNITS:-}; do
|
||||
[ "$u" = "$unit" ] && exit 0
|
||||
done
|
||||
exit 1
|
||||
fi
|
||||
exit 0
|
||||
STUB
|
||||
|
||||
# Must not be allowed to touch the host journal during a test run.
|
||||
printf '#!/bin/bash\nexit 0\n' > "$dir/logger"
|
||||
|
||||
chmod +x "$dir"/openssl "$dir"/ssh-keygen "$dir"/systemctl "$dir"/logger
|
||||
@@ -130,23 +169,37 @@ STUBS="$WORK/stubs"
|
||||
make_stubs "$STUBS"
|
||||
|
||||
# ── Runner ────────────────────────────────────────────────────────────────
|
||||
# Runs the script against a fresh temp root. Echoes the exit status; the
|
||||
# caller asserts on it plus the resulting filesystem state.
|
||||
# run_case <name> <openssl_mode> <sshkeygen_mode> [prestage] [reuse]
|
||||
#
|
||||
# prestage baked — root already holds the shared keys, i.e. a pre-strip
|
||||
# rootfs. Assertions can then prove the swap replaced them.
|
||||
# stripped — root holds no key material at all, i.e. the rootfs this
|
||||
# build actually ships. This is the state in which "no key
|
||||
# may appear from anywhere but the generator" is testable.
|
||||
# reuse 1 — do not wipe the root or the counters; continue from the
|
||||
# previous run against the same node. Models a reboot or a
|
||||
# timer-triggered retry.
|
||||
CASE_ROOT=""
|
||||
CASE_RC=0
|
||||
CASE_SYSTEMCTL_LOG=""
|
||||
run_case() {
|
||||
local name="$1" openssl_mode="$2" sshkeygen_mode="$3"
|
||||
local prestage="${4:-baked}" reuse="${5:-0}"
|
||||
CASE_ROOT="$WORK/root-$name"
|
||||
rm -rf "$CASE_ROOT"
|
||||
mkdir -p "$CASE_ROOT/var/lib/archipelago" "$CASE_ROOT/var/log" \
|
||||
"$CASE_ROOT/etc/ssh" "$CASE_ROOT/etc/archipelago/ssl"
|
||||
# A pre-existing baked host key + TLS key, i.e. the pre-strip rootfs state:
|
||||
# the assertions below then also show the swap actually replaced them.
|
||||
echo "BAKED-SHARED-HOST-KEY" > "$CASE_ROOT/etc/ssh/ssh_host_rsa_key"
|
||||
echo "BAKED-SHARED-TLS-KEY" > "$CASE_ROOT/etc/archipelago/ssl/archipelago.key"
|
||||
CASE_SYSTEMCTL_LOG="$WORK/$name.systemctl"
|
||||
|
||||
rm -f "$WORK/counters-$name/ssh-keygen.count"
|
||||
mkdir -p "$WORK/counters-$name"
|
||||
if [ "$reuse" != "1" ]; then
|
||||
rm -rf "$CASE_ROOT"
|
||||
mkdir -p "$CASE_ROOT/var/lib/archipelago" "$CASE_ROOT/var/log" \
|
||||
"$CASE_ROOT/etc/ssh" "$CASE_ROOT/etc/archipelago/ssl"
|
||||
if [ "$prestage" = "baked" ]; then
|
||||
echo "BAKED-SHARED-HOST-KEY" > "$CASE_ROOT/etc/ssh/ssh_host_rsa_key"
|
||||
echo "BAKED-SHARED-TLS-KEY" > "$CASE_ROOT/etc/archipelago/ssl/archipelago.key"
|
||||
fi
|
||||
rm -f "$WORK/counters-$name/ssh-keygen.count"
|
||||
mkdir -p "$WORK/counters-$name"
|
||||
: > "$CASE_SYSTEMCTL_LOG"
|
||||
fi
|
||||
|
||||
set +e
|
||||
env PATH="$STUBS:$PATH" \
|
||||
@@ -155,6 +208,8 @@ run_case() {
|
||||
STUB_OPENSSL_MODE="$openssl_mode" \
|
||||
STUB_SSHKEYGEN_MODE="$sshkeygen_mode" \
|
||||
STUB_COUNTER_DIR="$WORK/counters-$name" \
|
||||
STUB_SYSTEMCTL_LOG="$CASE_SYSTEMCTL_LOG" \
|
||||
STUB_SYSTEMCTL_FAILED_UNITS="${STUB_SYSTEMCTL_FAILED_UNITS:-}" \
|
||||
bash "$SCRIPT" > "$WORK/$name.out" 2> "$WORK/$name.err"
|
||||
CASE_RC=$?
|
||||
set -e
|
||||
@@ -217,6 +272,98 @@ else
|
||||
bad "ssh-keygen fails twice then succeeds ->$c3"; fail_detail ssh-flaky
|
||||
fi
|
||||
|
||||
# ── Case 4: TLS fails every attempt on a STRIPPED root -> no key at all ──
|
||||
# Case 2 proves the marker is not set. This proves the stronger property that
|
||||
# replaced the installer's TLS fallback: on the rootfs we actually ship, a
|
||||
# failed generation leaves NO key, from any source. If anything ever mints a
|
||||
# key outside gen_tls — an install-time fallback, a placeholder, a zero-length
|
||||
# touch to keep nginx happy — this is the case that goes red.
|
||||
run_case tls-fail-stripped fail ok stripped
|
||||
c4=""
|
||||
[ "$CASE_RC" -ne 0 ] || c4="$c4 exit-zero-on-failure"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/.secrets-regenerated" ] && c4="$c4 MARKER-SET-ON-FAILURE"
|
||||
[ -e "$CASE_ROOT/etc/archipelago/ssl/archipelago.key" ] && c4="$c4 TLS-KEY-EXISTS-AFTER-FAILURE"
|
||||
[ -e "$CASE_ROOT/etc/archipelago/ssl/archipelago.crt" ] && c4="$c4 TLS-CRT-EXISTS-AFTER-FAILURE"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/first-boot-secrets.failed" ] || c4="$c4 no-failure-record"
|
||||
grep -q 'failed=.*TLS' "$CASE_ROOT/var/lib/archipelago/first-boot-secrets.failed" 2>/dev/null \
|
||||
|| c4="$c4 failure-record-does-not-name-TLS"
|
||||
ls "$CASE_ROOT"/etc/archipelago/ssl/*.new >/dev/null 2>&1 && c4="$c4 dotnew-leftover"
|
||||
if [ -z "$c4" ]; then
|
||||
ok "TLS fails every attempt on a stripped root -> NO key, NO marker, non-zero exit, record names TLS"
|
||||
else
|
||||
bad "TLS fails every attempt on a stripped root ->$c4"; fail_detail tls-fail-stripped
|
||||
fi
|
||||
|
||||
# ── Case 5: self-heal — a failed run, then a later run that succeeds ─────
|
||||
# The case that proves a node is not permanently dead. Run 1 is a machine whose
|
||||
# generator fails every retry; run 2 is the same machine minutes later, once the
|
||||
# transient cause cleared, driven by archipelago-first-boot-secrets.timer. It
|
||||
# must end with the key present and the marker set, with no human at a console.
|
||||
# Run 2 also declares nginx/ssh already `failed` — they tried to start without a
|
||||
# key — so the run must actively restart them, not just reload. A "recovery"
|
||||
# that leaves the services down is not a recovery.
|
||||
#
|
||||
# Run 1 asserts only enough to establish the precondition (it really did fail,
|
||||
# and it left the node eligible to retry). Whether a key exists after a failure
|
||||
# is case 4's job — asserting it here too would make a single defect light up
|
||||
# two cases and blunt the signal.
|
||||
run_case self-heal fail ok stripped
|
||||
c5=""
|
||||
[ "$CASE_RC" -ne 0 ] || c5="$c5 run1-exit-zero"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/.secrets-regenerated" ] && c5="$c5 run1-marker-set"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/first-boot-secrets.failed" ] || c5="$c5 run1-no-failure-record"
|
||||
|
||||
STUB_SYSTEMCTL_FAILED_UNITS="nginx ssh" run_case self-heal ok ok stripped 1
|
||||
[ "$CASE_RC" -eq 0 ] || c5="$c5 run2-exit-nonzero"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/.secrets-regenerated" ] || c5="$c5 run2-marker-missing"
|
||||
[ -s "$CASE_ROOT/etc/archipelago/ssl/archipelago.key" ] || c5="$c5 run2-key-missing"
|
||||
[ -s "$CASE_ROOT/etc/archipelago/ssl/archipelago.crt" ] || c5="$c5 run2-crt-missing"
|
||||
[ -s "$CASE_ROOT/etc/ssh/ssh_host_ed25519_key" ] || c5="$c5 run2-ssh-key-missing"
|
||||
[ -f "$CASE_ROOT/var/lib/archipelago/first-boot-secrets.failed" ] && c5="$c5 run2-stale-failure-record"
|
||||
grep -q 'restart nginx' "$CASE_SYSTEMCTL_LOG" 2>/dev/null || c5="$c5 run2-did-not-restart-failed-nginx"
|
||||
if [ -z "$c5" ]; then
|
||||
ok "self-heal: failed run then a later successful run -> key present, marker set, failed units restarted"
|
||||
else
|
||||
bad "self-heal ->$c5"; fail_detail self-heal
|
||||
fi
|
||||
|
||||
# ── Case 6: single-producer invariant ────────────────────────────────────
|
||||
# The regression that would silently recreate F-03 is not a broken assertion —
|
||||
# it is somebody adding a second, well-meaning place that mints a key. A second
|
||||
# producer brings its own idea of success, its own absent retry policy and its
|
||||
# own absent failure record, and that is what made F-03 silent.
|
||||
#
|
||||
# So: every executable key-creating invocation in the builder must live inside
|
||||
# the first-boot-secrets.sh heredoc, i.e. inside gen_tls/gen_ssh. Comments are
|
||||
# exempt (they discuss the history); binary-existence checks are not matched
|
||||
# because they do not carry a key-creating subcommand.
|
||||
c6=""
|
||||
SS_START=$(grep -n '^cat > "\$WORK_DIR/first-boot-secrets.sh" <<.SECRETSSCRIPT.$' "$BUILDER" | cut -d: -f1)
|
||||
SS_END=$(awk -v s="$SS_START" 'NR>s && /^SECRETSSCRIPT$/ { print NR; exit }' "$BUILDER")
|
||||
if [ -z "$SS_START" ] || [ -z "$SS_END" ]; then
|
||||
c6="$c6 could-not-locate-generator-heredoc"
|
||||
else
|
||||
PRODUCERS=$(grep -nE 'openssl[[:space:]]+req|ssh-keygen[[:space:]]+-A|ssh-keygen[[:space:]]+-t' "$BUILDER" \
|
||||
| grep -vE '^[0-9]+:[[:space:]]*#' || true)
|
||||
while IFS= read -r line; do
|
||||
[ -z "$line" ] && continue
|
||||
ln=${line%%:*}
|
||||
if [ "$ln" -lt "$SS_START" ] || [ "$ln" -gt "$SS_END" ]; then
|
||||
c6="$c6 SECOND-PRODUCER-at-line-$ln"
|
||||
fi
|
||||
done <<< "$PRODUCERS"
|
||||
# Sanity: the one producer we expect must actually be in there, otherwise an
|
||||
# empty result would pass this case vacuously.
|
||||
echo "$PRODUCERS" | grep -q 'openssl[[:space:]]*req' || c6="$c6 no-tls-producer-found-at-all"
|
||||
echo "$PRODUCERS" | grep -q 'ssh-keygen' || c6="$c6 no-ssh-producer-found-at-all"
|
||||
fi
|
||||
if [ -z "$c6" ]; then
|
||||
ok "single-producer invariant: every key-creating invocation is inside gen_tls/gen_ssh"
|
||||
else
|
||||
bad "single-producer invariant ->$c6"
|
||||
echo " generator heredoc spans lines $SS_START-$SS_END of $BUILDER"
|
||||
fi
|
||||
|
||||
# ── Summary ───────────────────────────────────────────────────────────────
|
||||
echo
|
||||
echo "──────── first-boot-secrets summary ────────"
|
||||
|
||||
Reference in New Issue
Block a user