deer-flow/scripts/nginx-local-conf.sh
Hyeonsang Cho b9b74d2338
fix(scripts): reject local BIND_HOST values nginx would misread (#6635)
* fix(scripts): reject local BIND_HOST values nginx would misread

nginx-local-conf.sh checked only for address and hostname characters.
BIND_HOST=0 rendered `listen 0:2026;`, which nginx resolves to 0.0.0.0 and
binds on every IPv4 interface, and 1.2.3 bound 1.2.0.3. Values nginx rejects
outright ([[fd00::1]], -foo) passed the serve.sh preflight and failed only
after stop_all had torn down the running stack.

Accept exactly a dotted-quad IPv4 address, an IPv6 address (brackets
allowed around IPv6 only), or an RFC 1123 hostname. Returning to the
loopback default removes a temp/nginx.local.conf rendered for an earlier
value, and stop_all now says why it can quit a rendered-config nginx
through the tracked config; a test pins the shared pid directive.

* docs(changelog): reference #6635

* docs(changelog): match the zh reference spacing

* fix(scripts): check every BIND_HOST hostname character before splitting labels

read -r -a stops at the first newline, so is_hostname validated only the
first line of a value like $'localhost\nbad' and the rest reached the
rendered listen directive. Check the allowed characters across the whole
value first, and cover multi-line, CR and tab values for each validator.
2026-10-11 10:48:31 +08:00

124 lines
4.4 KiB
Bash
Executable File

#!/usr/bin/env bash
#
# nginx-local-conf.sh — Print the nginx config path for local (non-Docker) runs.
#
# docker/nginx/nginx.local.conf listens on loopback only, matching the Docker
# stack's default BIND_HOST. When BIND_HOST names another address, render a
# copy under temp/ that listens there instead and print that path, so local
# runs honor the same opt-in as the Docker stack. Gateway and frontend stay on
# loopback either way: nginx is the only entry point.
#
# Usage: NGINX_CONF="$(bash ./scripts/nginx-local-conf.sh)"
set -e
REPO_ROOT="$(builtin cd "$(dirname "${BASH_SOURCE[0]}")/.." >/dev/null 2>&1 && pwd -P)"
SOURCE_CONF="$REPO_ROOT/docker/nginx/nginx.local.conf"
RENDERED_CONF="$REPO_ROOT/temp/nginx.local.conf"
bind_host="${BIND_HOST:-127.0.0.1}"
if [ "$bind_host" = "127.0.0.1" ]; then
# Drop a copy rendered for an earlier BIND_HOST so its listen lines do not linger.
rm -f "$RENDERED_CONF"
printf '%s\n' "$SOURCE_CONF"
exit 0
fi
# Dotted-quad IPv4, every octet 0-255 without leading zeros. nginx resolves
# shorthand forms itself ("0" binds 0.0.0.0, "1.2.3" binds 1.2.0.3).
is_ipv4() {
local IFS=. octet
local -a octets
case "$1" in ''|*[!0-9.]*|.*|*.|*..*) return 1 ;; esac
read -r -a octets <<< "$1"
[ "${#octets[@]}" -eq 4 ] || return 1
for octet in "${octets[@]}"; do
case "$octet" in 0|[1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]) ;; *) return 1 ;; esac
done
}
# IPv6 literal: up to eight 1-4 digit hex groups, at most one "::", and an
# optional trailing dotted-quad that counts as two groups. No zone index:
# nginx rejects "%eth0" in listen.
is_ipv6() {
local addr="$1" groups=0 group rest
case "$addr" in *:*) ;; *) return 1 ;; esac
case "$addr" in *[!0-9A-Fa-f:.]*|*:::*|*::*::*) return 1 ;; esac
case "$addr" in :[!:]*|*[!:]:) return 1 ;; esac
if [ "${addr%.*}" != "$addr" ]; then
is_ipv4 "${addr##*:}" || return 1
addr="${addr%:*}:0:0"
fi
rest="$addr:"
while [ -n "$rest" ]; do
group="${rest%%:*}"
rest="${rest#*:}"
case "$group" in
'') ;;
?|??|???|????) case "$group" in *[!0-9A-Fa-f]*) return 1 ;; esac; groups=$((groups + 1)) ;;
*) return 1 ;;
esac
done
case "$addr" in
*::*) [ "$groups" -le 7 ] ;;
*) [ "$groups" -eq 8 ] ;;
esac
}
# RFC 1123 hostname: dot-separated labels of letters, digits and inner hyphens,
# 1-63 characters each, 253 in all. All-numeric values are IPv4 or nothing.
# The character check covers the whole value: read below stops at a newline.
is_hostname() {
local IFS=. label
local -a labels
[ "${#1}" -le 253 ] || return 1
case "$1" in ''|*[!A-Za-z0-9.-]*|.*|*.|*..*) return 1 ;; esac
case "$1" in *[!0-9.]*) ;; *) return 1 ;; esac
read -r -a labels <<< "$1"
for label in "${labels[@]}"; do
[ "${#label}" -le 63 ] || return 1
case "$label" in -*|*-) return 1 ;; esac
done
}
# The value is written into an nginx listen directive, so it must be exactly
# one address or hostname; brackets are accepted around an IPv6 address only.
invalid_bind_host() {
echo "BIND_HOST must be an IP address or hostname: ${BIND_HOST}" >&2
exit 1
}
case "$bind_host" in
\[*\]) bind_host="${bind_host#\[}"; bind_host="${bind_host%\]}"; is_ipv6 "$bind_host" || invalid_bind_host ;;
*[][]*) invalid_bind_host ;;
*:*) is_ipv6 "$bind_host" || invalid_bind_host ;;
*) is_ipv4 "$bind_host" || is_hostname "$bind_host" || invalid_bind_host ;;
esac
case "$bind_host" in
0.0.0.0) listen_lines='listen 2026;\nlisten [::]:2026;' ;;
*:*) listen_lines="listen [$bind_host]:2026;" ;;
*) listen_lines="listen $bind_host:2026;" ;;
esac
# awk -v expands the \n separator; BSD awk rejects a literal newline there.
mkdir -p "$REPO_ROOT/temp"
awk -v listen_lines="$listen_lines" '
/^[[:space:]]*listen 127\.0\.0\.1:2026;[[:space:]]*$/ {
match($0, /^[[:space:]]*/)
indent = substr($0, 1, RLENGTH)
n = split(listen_lines, lines, "\n")
for (i = 1; i <= n; i++) print indent lines[i]
replaced++
next
}
/^[[:space:]]*listen \[::1\]:2026;[[:space:]]*$/ { next }
{ print }
END { if (replaced != 1) exit 1 }
' "$SOURCE_CONF" > "$RENDERED_CONF.tmp" || {
rm -f "$RENDERED_CONF.tmp"
echo "Could not find the loopback listen directive in $SOURCE_CONF" >&2
exit 1
}
mv "$RENDERED_CONF.tmp" "$RENDERED_CONF"
printf '%s\n' "$RENDERED_CONF"