installer: harden the Node provisioning path against its own inputs
ci/woodpecker/pr/ci Pipeline is pending approval
ci/woodpecker/pr/ci Pipeline is pending approval
Answers the review on #1228. Each item below was measured against the pre-change code, and where the review's stated consequence did not reproduce, that is recorded rather than repeated. BLOCKER -- `mapfile` is a Bash 4 builtin and macOS ships Bash 3.2, which this installer supports (node_platform names Darwin). newest_matching_file was therefore unavailable on macOS, and an empty answer is exactly what sends the uninstaller down its delete-the-destination branch. The lookup no longer renders candidates as text at all: the glob output is compared in-shell by mtime, via a stat helper that probes for GNU -c vs BSD -f once. That removes the Bash 4 dependency, the `ls | head` SIGPIPE failure, and the newline-splitting bug together, because all three came from turning filenames into lines. The function now distinguishes three outcomes instead of two: found, nothing matched, and could-not-tell. Callers act destructively on the answer, so the third case had to stop being indistinguishable from the second. The uninstaller leaves the file in place on an unanswerable lookup, and the manifest builder refuses to record a null backup it cannot vouch for. HIGH -- writing ~/.profile does not reach the shells that matter. A bash login shell reads the first of .bash_profile / .bash_login / .profile that exists and never looks at the rest, so on a host with either of the first two the entry was a silent no-op; a non-interactive remote zsh reads .zshenv and neither .zprofile nor .zshrc, which is what the previous version wrote; and a systemd --user unit reads no shell file at all, which is how a Mosaic agent seat starts. All four are now covered, with .bash_profile and .bash_login appended to only when they already exist -- creating one would itself start shadowing .profile. The systemd case is an environment.d drop-in. MEDIUM -- the checksum lookup interpolated the filename into a grep pattern. A Node tarball name is mostly dots, and a dot matches any character, so a manifest line for a different-but-regex-equivalent name was accepted as this file's checksum. Confirmed against the old function: it accepted the decoy. Filenames are now compared exactly, every line is read so a duplicate entry is refused rather than silently resolved, and the digest must look like a SHA-256. MEDIUM -- the PATH line is executed by every future shell that reads the file, and the directory was interpolated unescaped. A path containing shell syntax is now refused with a message instead of written. MEDIUM -- the idempotence check was an unanchored substring match, so a commented-out example of the same export made the installer skip the real entry. Reproduced against the old function, and now anchored with grep -Fqx. MEDIUM -- MOSAIC_NODE_DIST accepted any scheme. https:// and file:// only. The narrower point in the review stands and is not fixed by this: when the dist is overridden, the tarball and the checksum that vouches for it come from the same place, so the gate is integrity and not authenticity. HIGH, with a correction -- MOSAIC_NODE_VERSION is now validated before it becomes a path, but the review's specific consequence does not reproduce. `rm -rf` on a path ending in `..` is refused by rm itself, and a traversal version mangles the download URL so the run dies at curl long before the removal. Both were measured. The check is defence in depth and a clearer error, not a demonstrated hole being closed. Also removed a second `| head -1` in node_resolve_version, the same SIGPIPE shape as the one this PR already fixed, and the index result is validated before it becomes a path. Tests. The review was right that several existing cases passed on the unpatched code. The version-selection case now lists a higher major first and an older release of the right major after the right answer, so "first entry" and "last match" both fail it. The PATH case starts a real login shell and asks it to resolve node, rather than grepping for text the installer just wrote. The checksum-failure case asserts nothing survives, including the staging directory. New cases cover the empty manifest, the regex-equivalent decoy, the duplicate entry, the invalid version, the non-https dist, the shell-syntax path, the commented-out profile line, the .bash_profile shadow, and the environment.d drop-in. Each new case was run against the pre-change installer: the decoy, the commented-out line, the .bash_profile shadow and environment.d all go red there, which is the evidence that they test something. Bash 3.2 cannot be executed here, so the portability guard is a lint over install.sh for Bash 4 syntax. It is a weaker instrument than a run and is not claimed otherwise -- but every Bash 4 construct that has broken macOS in this file was added by someone who was not running it there either. test:installer passes.
This commit is contained in:
+200
-35
@@ -159,6 +159,43 @@ fi
|
||||
WORK_DIR=""
|
||||
EXTRACTED_DIR=""
|
||||
|
||||
# Modification time of one file, as an integer. GNU/BusyBox stat takes -c, BSD/macOS
|
||||
# stat takes -f, and there is no flag both accept -- so probe once and remember.
|
||||
_MTIME_STYLE=""
|
||||
file_mtime() {
|
||||
if [[ -z "$_MTIME_STYLE" ]]; then
|
||||
if stat -c %Y . >/dev/null 2>&1; then
|
||||
_MTIME_STYLE=gnu
|
||||
elif stat -f %m . >/dev/null 2>&1; then
|
||||
_MTIME_STYLE=bsd
|
||||
else
|
||||
_MTIME_STYLE=none
|
||||
fi
|
||||
fi
|
||||
case "$_MTIME_STYLE" in
|
||||
gnu) stat -c %Y -- "$1" 2>/dev/null ;;
|
||||
bsd) stat -f %m -- "$1" 2>/dev/null ;;
|
||||
*) return 1 ;;
|
||||
esac
|
||||
}
|
||||
|
||||
# The most recently modified file in "$dir" matching "$pattern".
|
||||
#
|
||||
# Three separate contracts, and callers must tell them apart:
|
||||
# rc=0 with output — this is the newest match
|
||||
# rc=0, no output — the directory or the pattern matched nothing
|
||||
# rc=1 — the answer could not be determined
|
||||
#
|
||||
# The third one exists because the uninstall path treats "no backup" as licence to
|
||||
# delete the destination. A lookup that fails must never be mistaken for a lookup
|
||||
# that succeeded and found nothing.
|
||||
#
|
||||
# The candidates come from a glob and are compared in-shell, never rendered as text.
|
||||
# That is deliberate, and it closes three bugs at once: `mapfile` is a Bash 4 builtin
|
||||
# and macOS ships Bash 3.2, which this installer supports (see node_platform); piping
|
||||
# `ls` into `head` dies on SIGPIPE under `set -o pipefail` once the listing fills a
|
||||
# pipe buffer, returning 141 with no output; and any line-based parse of `ls` splits a
|
||||
# filename that contains a newline into two wrong answers.
|
||||
newest_matching_file() {
|
||||
local dir="$1"
|
||||
local pattern="$2"
|
||||
@@ -169,16 +206,17 @@ newest_matching_file() {
|
||||
matches=("$dir"/$pattern)
|
||||
shopt -u nullglob
|
||||
[[ "${#matches[@]}" -gt 0 ]] || return 0
|
||||
# Read the whole listing and take the first entry, rather than piping into
|
||||
# `head -1`. Under `set -o pipefail`, head closes the pipe after one line, ls
|
||||
# dies on SIGPIPE, and the function returns 141 -- so on the day the directory
|
||||
# holds enough files to fill a pipe buffer, finding the newest one starts
|
||||
# failing the install. Process substitution has no pipeline to fail.
|
||||
local -a sorted=()
|
||||
# shellcheck disable=SC2012 # Need portable mtime sorting across Linux/macOS.
|
||||
mapfile -t sorted < <(ls -1t "${matches[@]}" 2>/dev/null)
|
||||
[[ "${#sorted[@]}" -gt 0 ]] || return 0
|
||||
printf '%s\n' "${sorted[0]}"
|
||||
|
||||
local newest="" newest_t="" candidate t
|
||||
for candidate in "${matches[@]}"; do
|
||||
t="$(file_mtime "$candidate")" || return 1
|
||||
[[ -n "$t" ]] || return 1
|
||||
if [[ -z "$newest_t" ]] || [[ "$t" -gt "$newest_t" ]]; then
|
||||
newest="$candidate"
|
||||
newest_t="$t"
|
||||
fi
|
||||
done
|
||||
printf '%s\n' "$newest"
|
||||
}
|
||||
|
||||
# ─── uninstall path ───────────────────────────────────────────────────────────
|
||||
@@ -241,12 +279,17 @@ if [[ "$FLAG_UNINSTALL" == "true" ]]; then
|
||||
for dest in "${RUNTIME_DESTS[@]}"; do
|
||||
base="$(basename "$dest")"
|
||||
dir="$(dirname "$dest")"
|
||||
# Find most recent backup
|
||||
# Find most recent backup. A lookup that could not answer is not the same as
|
||||
# "there is no backup": removing the destination on a failed lookup would destroy
|
||||
# the file the backup exists to restore.
|
||||
backup=""
|
||||
backup_lookup_ok=true
|
||||
if [[ -d "$dir" ]]; then
|
||||
backup="$(newest_matching_file "$dir" "${base}.mosaic-bak-*")"
|
||||
backup="$(newest_matching_file "$dir" "${base}.mosaic-bak-*")" || backup_lookup_ok=false
|
||||
fi
|
||||
if [[ -n "$backup" ]] && [[ -f "$backup" ]]; then
|
||||
if [[ "$backup_lookup_ok" != "true" ]]; then
|
||||
echo " Skipped: $dest (could not check for a backup; left in place)"
|
||||
elif [[ -n "$backup" ]] && [[ -f "$backup" ]]; then
|
||||
cp "$backup" "$dest"
|
||||
rm -f "$backup"
|
||||
echo " Restored: $dest"
|
||||
@@ -345,6 +388,27 @@ if [[ "${MOSAIC_NO_NODE_INSTALL:-0}" == "1" ]]; then
|
||||
FLAG_NO_NODE_INSTALL=true
|
||||
fi
|
||||
|
||||
# A Node version string is about to become a directory name under NODE_HOME, and that
|
||||
# directory is passed to `rm -rf`. Nothing reaches a filesystem operation until it has
|
||||
# matched this. `v..` is the case that matters: it resolves to NODE_HOME's parent.
|
||||
node_valid_version() {
|
||||
[[ "$1" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]
|
||||
}
|
||||
|
||||
# The download location is executable code. Refuse a scheme that carries no transport
|
||||
# integrity at all, and say plainly what an override does and does not buy, since the
|
||||
# tarball and the checksum that vouches for it then come from the same place.
|
||||
case "$NODE_DIST" in
|
||||
https://*) ;;
|
||||
file://*) ;;
|
||||
*)
|
||||
if [[ -n "${MOSAIC_NODE_DIST:-}" ]]; then
|
||||
fail "MOSAIC_NODE_DIST must be an https:// or file:// URL; got '${NODE_DIST}'"
|
||||
exit 1
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
node_major_of() {
|
||||
# Read the major from the binary rather than parsing `node --version` text, so a
|
||||
# build with a suffix (v22.1.0-nightly…) does not read as a different major.
|
||||
@@ -376,27 +440,67 @@ node_platform() {
|
||||
# Newest release of the wanted major. Resolved rather than pinned so a fresh install
|
||||
# picks up security releases; MOSAIC_NODE_VERSION pins it when reproducibility matters.
|
||||
node_resolve_version() {
|
||||
local want="$1" index
|
||||
local want="$1" index resolved
|
||||
if [[ -n "${MOSAIC_NODE_VERSION:-}" ]]; then
|
||||
if ! node_valid_version "$MOSAIC_NODE_VERSION"; then
|
||||
fail "MOSAIC_NODE_VERSION must look like v22.11.0; got '${MOSAIC_NODE_VERSION}'"
|
||||
return 1
|
||||
fi
|
||||
printf '%s' "$MOSAIC_NODE_VERSION"
|
||||
return 0
|
||||
fi
|
||||
index="$(curl -fsSL --retry 3 "${NODE_DIST}/index.json" 2>/dev/null)" || return 1
|
||||
# index.json is newest-first, so the first match is the latest of that major.
|
||||
# grep/sed rather than a JSON parser because node is the thing we do not have yet.
|
||||
printf '%s' "$index" \
|
||||
| grep -o "\"version\":\"v${want}\.[0-9]\+\.[0-9]\+\"" \
|
||||
| head -1 \
|
||||
| sed 's/.*"v/v/; s/"$//'
|
||||
# No `| head -1` here: head closes the pipe, grep takes SIGPIPE, and under
|
||||
# `set -o pipefail` the whole substitution returns 141 -- the bug already fixed in
|
||||
# newest_matching_file. Take the first line in the shell instead.
|
||||
local found
|
||||
found="$(printf '%s' "$index" | grep -o "\"version\":\"v${want}\.[0-9]\+\.[0-9]\+\"")" || return 1
|
||||
found="${found%%$'\n'*}"
|
||||
resolved="${found#\"version\":\"}"
|
||||
resolved="${resolved%\"}"
|
||||
# The index is remote input, and what comes out of it becomes a path.
|
||||
[[ -n "$resolved" ]] || return 1
|
||||
node_valid_version "$resolved" || return 1
|
||||
printf '%s' "$resolved"
|
||||
}
|
||||
|
||||
node_verify_checksum() {
|
||||
local dir="$1" file="$2" expected
|
||||
expected="$(grep " ${file}\$" "${dir}/SHASUMS256.txt" | awk '{print $1}')"
|
||||
if [[ -z "$expected" ]]; then
|
||||
local dir="$1" file="$2" expected="" line name matched=0
|
||||
local manifest="${dir}/SHASUMS256.txt"
|
||||
|
||||
if [[ ! -f "$manifest" ]]; then
|
||||
fail "No checksum manifest was downloaded for ${file}"
|
||||
return 1
|
||||
fi
|
||||
|
||||
# Compare filenames exactly rather than `grep " ${file}$"`. A Node tarball name is
|
||||
# mostly dots, and in a regex a dot matches any character -- so a manifest line for
|
||||
# a name that merely looks like this one would be accepted as this one's checksum.
|
||||
#
|
||||
# Every line is read, not just the first match: two entries for the same file mean
|
||||
# the manifest is not trustworthy, and picking either one is a decision this code
|
||||
# has no basis to make.
|
||||
while IFS= read -r line || [[ -n "$line" ]]; do
|
||||
name="${line#* }"
|
||||
[[ "$name" == "$file" ]] || continue
|
||||
expected="${line%% *}"
|
||||
matched=$(( matched + 1 ))
|
||||
done < "$manifest"
|
||||
|
||||
if [[ "$matched" -eq 0 ]]; then
|
||||
fail "No checksum published for ${file}"
|
||||
return 1
|
||||
fi
|
||||
if [[ "$matched" -gt 1 ]]; then
|
||||
fail "Checksum manifest lists ${file} ${matched} times; refusing to guess."
|
||||
return 1
|
||||
fi
|
||||
if [[ ! "$expected" =~ ^[0-9a-fA-F]{64}$ ]]; then
|
||||
fail "Checksum for ${file} is not a SHA-256 digest: '${expected}'"
|
||||
return 1
|
||||
fi
|
||||
local actual
|
||||
if command -v sha256sum &>/dev/null; then
|
||||
actual="$(sha256sum "${dir}/${file}" | awk '{print $1}')"
|
||||
@@ -452,6 +556,14 @@ node_install() {
|
||||
local version="$1" platform="$2"
|
||||
local dest="${NODE_HOME}/${version}"
|
||||
|
||||
# Re-checked here, not only where the version was resolved: `dest` is about to be
|
||||
# handed to `rm -rf`, and this is the last place before that happens. A version of
|
||||
# `..` would point the removal at NODE_HOME's parent.
|
||||
if ! node_valid_version "$version"; then
|
||||
fail "Refusing to install Node from an unexpected version string: '${version}'"
|
||||
return 1
|
||||
fi
|
||||
|
||||
if [[ -x "${dest}/bin/node" ]]; then
|
||||
info "Reusing Node ${version} already at ${dest}"
|
||||
return 0
|
||||
@@ -464,26 +576,59 @@ node_install() {
|
||||
return "$rc"
|
||||
}
|
||||
|
||||
# Put a directory on PATH for future shells, once. A user-local Node and a
|
||||
# user-local npm prefix are only useful if the next shell can still find them, and
|
||||
# Put a directory on PATH for future processes, once. A user-local Node and a
|
||||
# user-local npm prefix are only useful if the next process can still find them, and
|
||||
# the installer used to do no more than warn about it.
|
||||
#
|
||||
# Both the login profile and the interactive rc get the line, because neither one
|
||||
# alone covers the shells that matter. Debian's ~/.bashrc returns early when the
|
||||
# shell is not interactive, so a line there is invisible to `bash -lc`, to an ssh
|
||||
# command, and to a systemd unit -- which is exactly how an agent seat starts.
|
||||
# There is no one file that covers this. Each target below is the only thing that
|
||||
# works for some way a user -- or an agent seat -- actually starts a process:
|
||||
#
|
||||
# ~/.profile POSIX login shells, and `bash -lc` when no bash-specific
|
||||
# profile exists.
|
||||
# ~/.bash_profile A bash login shell reads the first of these that exists and
|
||||
# ~/.bash_login then never reads ~/.profile. On a host with one of them,
|
||||
# writing only ~/.profile is a silent no-op. Appended to when
|
||||
# present, never created -- creating one would itself start
|
||||
# shadowing ~/.profile for everything else the user has there.
|
||||
# ~/.bashrc Interactive non-login shells. Debian's returns early when the
|
||||
# shell is not interactive, so it cannot stand in for a profile.
|
||||
# ~/.zshenv Every zsh invocation, including `ssh host cmd`. A remote
|
||||
# non-interactive zsh reads neither ~/.zprofile nor ~/.zshrc,
|
||||
# which is what the previous version of this function wrote.
|
||||
# environment.d systemd --user units, which read no shell file at all. A
|
||||
# Mosaic agent seat starts as a unit, so this one is the point.
|
||||
persist_path_line() {
|
||||
local dir="$1" line rc wrote=""
|
||||
|
||||
# This text is written into files that a future shell will execute, so a directory
|
||||
# containing shell syntax would run there as code. Refuse rather than escape: such
|
||||
# a path can only arrive through MOSAIC_NODE_HOME or MOSAIC_PREFIX, and a real
|
||||
# install directory never needs these characters.
|
||||
if [[ "$dir" =~ [\"\$\`\\] ]] || [[ "$dir" == *"'"* ]] || [[ "$dir" == *$'\n'* ]]; then
|
||||
warn "Not adding ${dir} to PATH automatically: the path contains shell syntax."
|
||||
dim " Put it on PATH by hand, or reinstall to a path without those characters."
|
||||
return 0
|
||||
fi
|
||||
|
||||
line="export PATH=\"${dir}:\$PATH\""
|
||||
|
||||
local files=()
|
||||
local files=("$HOME/.profile")
|
||||
case "$(basename "${SHELL:-/bin/bash}")" in
|
||||
zsh) files=("$HOME/.zprofile" "$HOME/.zshrc") ;;
|
||||
*) files=("$HOME/.profile" "$HOME/.bashrc") ;;
|
||||
zsh)
|
||||
files+=("$HOME/.zshenv")
|
||||
;;
|
||||
*)
|
||||
files+=("$HOME/.bashrc")
|
||||
if [[ -f "$HOME/.bash_profile" ]]; then files+=("$HOME/.bash_profile"); fi
|
||||
if [[ -f "$HOME/.bash_login" ]]; then files+=("$HOME/.bash_login"); fi
|
||||
;;
|
||||
esac
|
||||
|
||||
for rc in "${files[@]}"; do
|
||||
if [[ -f "$rc" ]] && grep -Fq "$line" "$rc"; then
|
||||
# -x anchors the match to a whole line. Without it, a commented-out example of
|
||||
# this same export counts as already present and the real entry never gets
|
||||
# written -- the failure then looks like the installer simply did nothing.
|
||||
if [[ -f "$rc" ]] && grep -Fqx "$line" "$rc"; then
|
||||
continue
|
||||
fi
|
||||
{
|
||||
@@ -493,9 +638,21 @@ persist_path_line() {
|
||||
wrote+="${wrote:+, }${rc}"
|
||||
done
|
||||
|
||||
# systemd --user units inherit from the user manager, not from any shell.
|
||||
local envd="$HOME/.config/environment.d"
|
||||
local envd_file="$envd/50-mosaic-path.conf"
|
||||
local envd_line="PATH=${dir}:\${PATH}"
|
||||
if mkdir -p "$envd" 2>/dev/null; then
|
||||
if [[ ! -f "$envd_file" ]] || ! grep -Fqx "$envd_line" "$envd_file"; then
|
||||
printf '%s\n' "$envd_line" >> "$envd_file"
|
||||
wrote+="${wrote:+, }${envd_file}"
|
||||
fi
|
||||
fi
|
||||
|
||||
if [[ -n "$wrote" ]]; then
|
||||
ok "Added ${dir} to PATH in ${wrote}"
|
||||
dim " This shell: export PATH=\"${dir}:\$PATH\""
|
||||
dim " This shell: export PATH=\"${dir}:\$PATH\""
|
||||
dim " systemd --user: systemctl --user daemon-reload (or log in again)"
|
||||
fi
|
||||
}
|
||||
|
||||
@@ -725,8 +882,10 @@ install_cli_from_source() {
|
||||
( cd "$src/apps/gateway" && pnpm pack --pack-destination "$out_dir" ) 2>&1 | sed 's/^/ /'
|
||||
|
||||
local cli_tgz gw_tgz
|
||||
cli_tgz="$(newest_matching_file "$out_dir" 'mosaicstack-mosaic-*.tgz')"
|
||||
gw_tgz="$(newest_matching_file "$out_dir" 'mosaicstack-gateway-*.tgz')"
|
||||
# An unanswerable lookup becomes an empty path, which the -f guards below report
|
||||
# properly. Nothing destructive happens on this path, so failing soft is safe here.
|
||||
cli_tgz="$(newest_matching_file "$out_dir" 'mosaicstack-mosaic-*.tgz')" || cli_tgz=""
|
||||
gw_tgz="$(newest_matching_file "$out_dir" 'mosaicstack-gateway-*.tgz')" || gw_tgz=""
|
||||
|
||||
if [[ ! -f "$cli_tgz" ]]; then
|
||||
fail "CLI tarball was not produced by pnpm pack."
|
||||
@@ -1082,7 +1241,13 @@ if [[ "$FLAG_CHECK" == "false" ]]; then
|
||||
local base dir backup_path backup_val
|
||||
base="$(basename "$dest")"
|
||||
dir="$(dirname "$dest")"
|
||||
backup_path="$(newest_matching_file "$dir" "${base}.mosaic-bak-*")"
|
||||
# Recording null here would tell a later uninstall that no backup exists, and
|
||||
# it would then delete the destination instead of restoring it. An unanswerable
|
||||
# lookup must stop the manifest, not guess at it.
|
||||
if ! backup_path="$(newest_matching_file "$dir" "${base}.mosaic-bak-*")"; then
|
||||
fail "Could not determine the backup state of ${dest}; refusing to write a manifest."
|
||||
return 1
|
||||
fi
|
||||
if [[ -n "$backup_path" ]]; then
|
||||
backup_val="\"$backup_path\""
|
||||
else
|
||||
|
||||
Reference in New Issue
Block a user