#!/bin/bash # WireGuard transparent egress for Shelfmark. # # Mirrors the structure of tor.sh: it is invoked from entrypoint.sh when # USING_WIREGUARD=true, brings up a WireGuard tunnel, installs a strict # kill-switch (all non-LAN egress must leave via the tunnel or be dropped), # and supervises the tunnel with a handshake-based healthcheck. # # Required: # - container started as root with cap NET_ADMIN (and NET_RAW) # - a WireGuard config mounted at $WIREGUARD_CONFIG (default /config/wg0.conf) # # Optional env: # WIREGUARD_CONFIG path to the wg-quick config (default /config/wg0.conf) # WIREGUARD_INTERFACE interface name (default wg0) # LAN_NETWORK comma-separated CIDRs kept off the tunnel so the WebUI / # internal download clients (Prowlarr, qBittorrent) stay # reachable, e.g. "172.16.0.0/12,10.0.0.0/8" # WIREGUARD_ENFORCE_DNS when true (default), force /etc/resolv.conf so DNS # lookups use a defined resolver instead of the container's # inherited one. The resolver used is WIREGUARD_DNS if set, # otherwise the tunnel config's own DNS = line. # WIREGUARD_DNS optional explicit resolver(s) (comma/space separated) to # write into /etc/resolv.conf when WIREGUARD_ENFORCE_DNS is # true. Use this when the VPN provider's push DNS filters # domains you need (e.g. Proton NetShield NXDOMAINs # annas-archive.org). Point it at an on-LAN encrypted # resolver (kept reachable via LAN_NETWORK) so queries stay # private while book-source domains still resolve. When this # is a LAN resolver, the DNS query leaves over the LAN and # the resolver's own upstream encryption applies; the actual # download still egresses through the tunnel. # WIREGUARD_DISABLE_IPV6 when true (default), strip IPv6 Address/AllowedIPs/DNS # from the config before wg-quick. Containers frequently lack # the ip6tables 'raw' table wg-quick needs, and IPv6 egress # would be an additional leak surface. Set false only if the # host exposes ip6tables and you explicitly want IPv6. # WIREGUARD_ALLOW_WEBUI_OFFTUNNEL when false (default), the kill-switch is # strictly fail-closed: the only off-tunnel egress is # loopback, the tunnel device and the LAN allowlist. Set true # ONLY if a NON-LAN client (e.g. a public reverse proxy on a # different segment) must reach the WebUI; it permits # app-server REPLY packets (--sport FLASK_PORT, conntrack # REPLY) to leave off-tunnel. This is server replies only, # never client-initiated egress, so it cannot leak outbound # browsing/downloads or the real IP for outbound requests — # but it is still an off-tunnel path while the tunnel is down, # hence opt-in. LAN WebUI clients never need it (covered by # LAN_NETWORK). is_truthy() { case "${1,,}" in true|yes|1|y) return 0 ;; *) return 1 ;; esac } # Validate that a token is a literal IPv4 address (four 0-255 octets). Used to # sanitise resolver entries before writing them to /etc/resolv.conf so a stray # comment/hostname/malformed token can't produce a bogus `nameserver` line that # silently breaks name resolution. is_ipv4() { local ip="$1" o1 o2 o3 o4 case "$ip" in *[!0-9.]*) return 1 ;; esac IFS='.' read -r o1 o2 o3 o4 _extra <<< "$ip" || true [ -n "$o1" ] && [ -n "$o2" ] && [ -n "$o3" ] && [ -n "$o4" ] || return 1 [ -z "${_extra:-}" ] || return 1 for o in "$o1" "$o2" "$o3" "$o4"; do # Reject empty / non-numeric, and reject leading zeros (e.g. 010): glibc # inet_aton parses a leading-zero octet as OCTAL, so 010.0.0.1 != 10.0.0.1 # — refuse the ambiguous form rather than silently write a resolver the # kernel would interpret differently. Then enforce the 0-255 range. case "$o" in ''|*[!0-9]*) return 1 ;; esac case "$o" in 0[0-9]*) return 1 ;; esac [ "$o" -ge 0 ] && [ "$o" -le 255 ] || return 1 done return 0 } # Validate that a token is a literal IPv6 address. Deliberately permissive (hex # groups and ':'), but requires at least one ':' and only hex/':' characters, so # it accepts real v6 resolvers while still rejecting hostnames/comments. is_ipv6() { local ip="$1" case "$ip" in *:*) : ;; *) return 1 ;; esac case "$ip" in *[!0-9A-Fa-f:]*) return 1 ;; esac return 0 } ENABLE_LOGGING_VALUE="${ENABLE_LOGGING:-true}" LOG_DIR=${LOG_ROOT:-/var/log/}/shelfmark LOG_FILE="${LOG_DIR}/shelfmark_wireguard.log" if is_truthy "$ENABLE_LOGGING_VALUE"; then mkdir -p "$LOG_DIR" exec 3>&1 4>&2 exec > >(tee -a "$LOG_FILE") 2>&1 fi echo "Starting WireGuard script" if is_truthy "$ENABLE_LOGGING_VALUE"; then echo "Log file: $LOG_FILE" else echo "File logging disabled (ENABLE_LOGGING=$ENABLE_LOGGING_VALUE)" fi set +x set -e WIREGUARD_CONFIG="${WIREGUARD_CONFIG:-/config/wg0.conf}" WIREGUARD_INTERFACE="${WIREGUARD_INTERFACE:-wg0}" WIREGUARD_ENFORCE_DNS_VALUE="${WIREGUARD_ENFORCE_DNS:-true}" WIREGUARD_DISABLE_IPV6_VALUE="${WIREGUARD_DISABLE_IPV6:-true}" # Off-tunnel WebUI reachability is OPT-IN. When false (default), the kill-switch # is strictly fail-closed: the ONLY off-tunnel egress permitted is loopback, the # tunnel device, and the LAN allowlist. Set true only if you expose the WebUI to # a NON-LAN client (e.g. a public reverse proxy on a different segment) and # accept that server-reply packets on the app port may leave off-tunnel while # the tunnel is down. LAN clients never need this (they are covered by # LAN_NETWORK). See the WebUI-reply rule below. WIREGUARD_ALLOW_WEBUI_OFFTUNNEL_VALUE="${WIREGUARD_ALLOW_WEBUI_OFFTUNNEL:-false}" echo "Build version: $BUILD_VERSION" echo "Release version: $RELEASE_VERSION" if [ ! -f "$WIREGUARD_CONFIG" ]; then echo "[✗] WireGuard config not found at $WIREGUARD_CONFIG" echo " Mount your wg-quick config there (e.g. -v /host/wg0.conf:/config/wg0.conf:ro)" exit 1 fi # wg-quick derives the interface name from the config file's basename, so stage # the config as /etc/wireguard/.conf regardless of its mounted name. RUNTIME_CONFIG="/etc/wireguard/${WIREGUARD_INTERFACE}.conf" mkdir -p /etc/wireguard cp "$WIREGUARD_CONFIG" "$RUNTIME_CONFIG" chmod 600 "$RUNTIME_CONFIG" # Extract the DNS line (if any) before wg-quick, so we can enforce it ourselves. WG_DNS="$(grep -iE '^[[:space:]]*DNS[[:space:]]*=' "$RUNTIME_CONFIG" | head -n1 | cut -d'=' -f2- | tr ',' ' ' | xargs || true)" # wg-quick will try to manage DNS via resolvconf which is not present in this # image; strip the DNS line and enforce it ourselves below to avoid wg-quick # aborting. Keep a copy for reference. sed -i -E '/^[[:space:]]*DNS[[:space:]]*=/d' "$RUNTIME_CONFIG" # Strip IPv6 to avoid wg-quick failing on the ip6tables 'raw' table that many # container kernels don't expose, and to eliminate IPv6 as a leak path. This # removes IPv6 CIDRs from Address= and AllowedIPs= and drops all-IPv6 lines. if is_truthy "$WIREGUARD_DISABLE_IPV6_VALUE"; then echo "[*] Disabling IPv6 in tunnel config (WIREGUARD_DISABLE_IPV6=true)" # Remove IPv6 CIDRs (those containing a colon) from comma-separated # Address= and AllowedIPs= lines; drop the line entirely if nothing remains. awk ' function trim(s){ sub(/^[ \t]+/,"",s); sub(/[ \t]+$/,"",s); return s } /^[ \t]*(Address|AllowedIPs)[ \t]*=/{ eq=index($0,"="); key=substr($0,1,eq-1); val=substr($0,eq+1) n=split(val, parts, ","); out=""; sep="" for(i=1;i<=n;i++){ v=trim(parts[i]); if(v!="" && index(v,":")==0){ out=out sep v; sep=", " } } if(out==""){ next } print trim(key) " = " out; next } { print } ' "$RUNTIME_CONFIG" > "${RUNTIME_CONFIG}.v4" && mv "${RUNTIME_CONFIG}.v4" "$RUNTIME_CONFIG" chmod 600 "$RUNTIME_CONFIG" fi # Keep only IPv4 nameservers from the captured DNS list when IPv6 is disabled. if is_truthy "$WIREGUARD_DISABLE_IPV6_VALUE" && [ -n "$WG_DNS" ]; then WG_DNS_V4="" for ns in $WG_DNS; do case "$ns" in *:*) : ;; # drop IPv6 resolver *) WG_DNS_V4="$WG_DNS_V4 $ns" ;; esac done WG_DNS="$(echo "$WG_DNS_V4" | xargs || true)" fi echo "[*] Bringing up WireGuard interface '$WIREGUARD_INTERFACE' from $WIREGUARD_CONFIG..." # wg-quick unconditionally runs `sysctl -q net.ipv4.conf.all.src_valid_mark=1`, # but in a container /proc/sys is read-only, so that write fails even though the # value is already 1 (set at namespace creation via the compose `sysctls:` key / # docker --sysctl). Shim sysctl so that this single redundant write is a no-op # when the value is already correct; everything else falls through to the real # binary. This avoids needing --privileged or a writable /proc/sys. # # The shim is written to a PERSISTENT path (not a mktemp dir) so the supervised # healthcheck can reuse it when it bounces the tunnel on a stale handshake; # otherwise wg-quick would fail again on the same sysctl write and never recover. SYSCTL_SHIM_DIR="/app/wg-sysctl-shim" REAL_SYSCTL="$(command -v sysctl || echo /usr/sbin/sysctl)" mkdir -p "$SYSCTL_SHIM_DIR" cat > "${SYSCTL_SHIM_DIR}/sysctl" < 0 in the main table still wins. # A directly-connected LAN subnet therefore stays reachable (its connected # /NN route), but a LAN subnet on ANOTHER VLAN (e.g. a DNS resolver at # 10.127.222.2 when the container is only on 172.20.0.0/16) has no main-table # route, so it only matches the (suppressed) default and gets forced into the # tunnel — where a commercial VPN drops RFC1918 destinations. We record the # original gateway/dev here and add explicit per-CIDR LAN routes after the # kill-switch so off-subnet LAN (incl. the enforced resolver) stays off-tunnel. ORIG_DEFAULT="$(ip -4 route show default | head -n1)" ORIG_GW="$(printf '%s' "$ORIG_DEFAULT" | awk '{for(i=1;i<=NF;i++) if($i=="via"){print $(i+1); exit}}')" ORIG_DEV="$(printf '%s' "$ORIG_DEFAULT" | awk '{for(i=1;i<=NF;i++) if($i=="dev"){print $(i+1); exit}}')" [ -n "$ORIG_GW" ] && echo "[*] Pre-tunnel default gateway: $ORIG_GW dev ${ORIG_DEV:-?} (used to keep off-subnet LAN off the tunnel)" # wg-quick handles: interface creation, address, route for AllowedIPs, and a # fwmark-based default route when AllowedIPs=0.0.0.0/0. wg_quick_shimmed up "$WIREGUARD_INTERFACE" echo "[*] WireGuard interface state:" wg show "$WIREGUARD_INTERFACE" || true ip -o addr show "$WIREGUARD_INTERFACE" || true # --------------------------------------------------------------------------- # Kill-switch (fail-closed, IPv4 + IPv6) # --------------------------------------------------------------------------- # wg-quick (with AllowedIPs=0.0.0.0/0) already installs a fwmark + suppress # routing that sends everything except the encrypted tunnel packets through # wg0, and blocks off-tunnel traffic to AllowedIPs. We add an explicit # filter-table kill-switch as defence in depth: default DROP on OUTPUT, allow # only loopback, the tunnel device, the LAN ranges, and the handshake to the # WireGuard endpoint(s). # # Endpoints are read from the LIVE interface (`wg show endpoints`), not # the config file: after wg-quick is up these are always concrete resolved # IP:port values, so the allow rule can never fail on a hostname (which would # otherwise drop the WireGuard encapsulation and break the tunnel). Each # endpoint is added to iptables or ip6tables depending on its address family. echo "[*] Installing kill-switch (iptables + ip6tables)..." # ip6tables may be unusable in some container kernels (missing tables). Detect # once so we can fail closed on IPv6 when possible and warn otherwise. IP6TABLES_OK="true" if ! ip6tables -L OUTPUT >/dev/null 2>&1; then IP6TABLES_OK="false" echo "[!] ip6tables unavailable in this kernel; disabling IPv6 in the kernel instead so v6 egress cannot leak." # Belt-and-braces: if we cannot program an IPv6 kill-switch, drop IPv6 # entirely at the stack so non-tunnel v6 egress is impossible. sysctl -w net.ipv6.conf.all.disable_ipv6=1 >/dev/null 2>&1 || true sysctl -w net.ipv6.conf.default.disable_ipv6=1 >/dev/null 2>&1 || true # Verify IPv6 is actually off. If /proc/sys is read-only (common in # containers) the sysctl write silently no-ops and IPv6 could still leak # off-tunnel with no kill-switch. In that case fail closed: either the # operator disables IPv6 for the container (sysctls/--sysctl or the host), # or provides a kernel with a usable ip6tables. Allow an explicit override # (WIREGUARD_ALLOW_IPV6_LEAK=true) for operators who have confirmed the # container genuinely has no IPv6 connectivity. V6_DISABLED="$(cat /proc/sys/net/ipv6/conf/all/disable_ipv6 2>/dev/null || echo unknown)" # If the IPv6 stack is entirely absent, there is nothing to leak. if [ ! -e /proc/sys/net/ipv6 ]; then echo "[*] No IPv6 stack present in this namespace; nothing to fail closed on." elif [ "$V6_DISABLED" != "1" ]; then if is_truthy "${WIREGUARD_ALLOW_IPV6_LEAK:-false}"; then echo "[!] WARNING: could not disable IPv6 and ip6tables is unavailable; WIREGUARD_ALLOW_IPV6_LEAK=true set, continuing WITHOUT an IPv6 kill-switch (v6 egress may bypass the tunnel)." else echo "[✗] Cannot enforce an IPv6 kill-switch: ip6tables is unavailable AND IPv6 could not be disabled" >&2 echo " (net.ipv6.conf.all.disable_ipv6=$V6_DISABLED; /proc/sys likely read-only)." >&2 echo " Refusing to run with a potential IPv6 leak. Fix by either:" >&2 echo " - disabling IPv6 for the container (e.g. compose sysctls: net.ipv6.conf.all.disable_ipv6=1," >&2 echo " or docker run --sysctl net.ipv6.conf.all.disable_ipv6=1), or" >&2 echo " - running on a kernel with a usable ip6tables, or" >&2 echo " - setting WIREGUARD_ALLOW_IPV6_LEAK=true if the container has no IPv6 connectivity." >&2 exit 1 fi else echo "[✓] IPv6 disabled at the kernel; no IPv6 leak path." fi fi # Allow the encrypted WireGuard handshake/data out to each peer endpoint. # # We pin the allow rule to the resolved endpoint destination IP *and* UDP port # (not the port alone). Allowing any UDP to that port would leave an off-tunnel # egress hole for arbitrary UDP to that destination port during tunnel # downtime/bounces (when the fwmark routes may be gone) — weakening the # fail-closed guarantee. Pinning the destination IP closes that hole: the only # off-NIC traffic this permits is the encrypted WireGuard transport to the peer # itself. Endpoints are read from the LIVE interface, so they are always # concrete resolved IPs. If the provider rotates the endpoint IP, the tunnel # goes stale and the healthcheck bounce re-derives the new live endpoint and # re-opens the corresponding IP+port rule (see refresh_endpoint_rules), so a # rotation self-heals on recovery without ever leaving a wildcard-port hole. # Rules are de-duplicated by IP+port; this function is idempotent and # re-runnable after a bounce. # Endpoint allow rules live in their OWN chain (SHELFMARK_WG_EP) that is # FLUSHED and repopulated from the live interface on every call. This is the # key difference from a plain `-A OUTPUT` approach: if the VPN provider rotates # the peer endpoint IP/port, the stale allow rule for the OLD endpoint would # otherwise persist forever (an off-tunnel UDP hole to a no-longer-used dest) # and the OUTPUT chain would grow unbounded across rotations. By flushing the # dedicated chain each sync, ONLY the current live endpoint(s) are ever # permitted, so the "only WireGuard transport to the current peer may leave # off-tunnel" guarantee holds and the ruleset stays bounded. The OUTPUT jump to # the chain is installed once (idempotent via -C) ahead of the trailing DROP. EP_CHAIN="SHELFMARK_WG_EP" sync_endpoint_chain() { local endpoints ep ep_port ep_host ep_ip seen_v4=" " seen_v6=" " key # --- IPv4 chain: ensure exists, ensure OUTPUT jumps to it, then flush. --- # These are FATAL on genuine failure (not just warned): if the chain can't # be created, the OUTPUT jump can't be installed, or the flush fails, the # kill-switch has no path for the encrypted WireGuard UDP transport to reach # the peer, so the tunnel could never handshake and we'd surface a confusing # generic handshake timeout later instead of the real cause. The container # exits fail-closed (OUTPUT default-DROP stays in force). The `-nL`/`-C` # guards keep the idempotent "already exists" path non-fatal. iptables -nL "$EP_CHAIN" >/dev/null 2>&1 || iptables -N "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to create iptables chain $EP_CHAIN (missing NET_ADMIN / iptables error); refusing to continue." >&2; exit 1; } iptables -C OUTPUT -j "$EP_CHAIN" 2>/dev/null || iptables -I OUTPUT 1 -j "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to install OUTPUT jump to $EP_CHAIN; refusing to continue (tunnel transport would be blocked)." >&2; exit 1; } iptables -F "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to flush iptables chain $EP_CHAIN; refusing to continue." >&2; exit 1; } if [ "$IP6TABLES_OK" = "true" ]; then ip6tables -nL "$EP_CHAIN" >/dev/null 2>&1 || ip6tables -N "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to create ip6tables chain $EP_CHAIN; refusing to continue." >&2; exit 1; } ip6tables -C OUTPUT -j "$EP_CHAIN" 2>/dev/null || ip6tables -I OUTPUT 1 -j "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to install ip6tables OUTPUT jump to $EP_CHAIN; refusing to continue." >&2; exit 1; } ip6tables -F "$EP_CHAIN" 2>/dev/null \ || { echo "[✗] Failed to flush ip6tables chain $EP_CHAIN; refusing to continue." >&2; exit 1; } fi # `wg show endpoints` prints "\t" per peer, or # "\t(none)" for a peer with no endpoint yet. Keep only tokens that # look like host:port (contain a colon and are not the literal "(none)"). endpoints="$(wg show "$WIREGUARD_INTERFACE" endpoints 2>/dev/null | awk '{print $2}' | grep -F ':' | grep -v '(none)' || true)" for ep in $endpoints; do # Split host:port from the right so IPv6 colons in the host are preserved. ep_port="${ep##*:}" ep_host="${ep%:*}" # Require a numeric port and a non-empty host; skip anything malformed. case "$ep_port" in ''|*[!0-9]*) continue ;; esac [ -z "$ep_host" ] && continue if printf '%s' "$ep_host" | grep -q ':'; then # IPv6 endpoint -> ip6tables. Strip the surrounding [ ] brackets # for -d. Backslash-escape the bracket in the pattern so it is an # unambiguous literal '[' / ']' (not a glob character class) and # doesn't trip shell linters. ep_ip="${ep_host#\[}"; ep_ip="${ep_ip%\]}" key="${ep_ip}/${ep_port}" case "$seen_v6" in *" $key "*) continue ;; esac seen_v6="${seen_v6}${key} " if [ "$IP6TABLES_OK" = "true" ]; then # A failure to add the endpoint allow rule is FATAL at startup: # without it the kill-switch (default-DROP) blocks the encrypted # WireGuard transport to this peer, so the tunnel can never # handshake. Fail fast with a clear cause instead of surfacing a # generic handshake timeout later. Still fail-closed (no leak). ip6tables -A "$EP_CHAIN" -d "$ep_ip" -p udp --dport "$ep_port" -j ACCEPT 2>/dev/null \ || { echo "[✗] Failed to add IPv6 endpoint allow rule for ${ep_ip} udp/$ep_port." >&2; \ echo " The kill-switch would block the WireGuard transport to this peer; refusing to continue." >&2; \ exit 1; } else # IPv6 endpoint but no usable ip6tables: the IPv6 kill-switch # cannot permit the encrypted transport to the peer, so the # tunnel would never handshake. Fail fast with the real cause. echo "[✗] WireGuard peer endpoint is IPv6 (${ep_ip}) but ip6tables is unavailable in this kernel." >&2 echo " The IPv6 kill-switch cannot allow the encrypted transport to the peer, so the tunnel" >&2 echo " would never establish. Fix by running on a kernel with a usable ip6tables, or by" >&2 echo " using an IPv4 WireGuard endpoint." >&2 exit 1 fi else # IPv4 endpoint -> iptables. ep_ip="$ep_host" key="${ep_ip}/${ep_port}" case "$seen_v4" in *" $key "*) continue ;; esac seen_v4="${seen_v4}${key} " # As above: a failed add would strand the tunnel behind the kill- # switch. Fatal at startup, with the real cause. iptables -A "$EP_CHAIN" -d "$ep_ip" -p udp --dport "$ep_port" -j ACCEPT 2>/dev/null \ || { echo "[✗] Failed to add IPv4 endpoint allow rule for ${ep_ip} udp/$ep_port." >&2; \ echo " The kill-switch would block the WireGuard transport to this peer; refusing to continue." >&2; \ exit 1; } fi done } # Back-compat alias: the startup path historically called apply_endpoint_rules. apply_endpoint_rules() { sync_endpoint_chain; } # --- IPv4 kill-switch --- # Set the default policy CLOSED before touching rules, so the chain is fail- # closed at all times: during the (app-traffic-free) build window, and if any # `iptables -A` below fails under `set -e` leaving a partial chain. The trailing # `-j DROP` is then belt-and-braces on top of the DROP policy. iptables -P OUTPUT DROP iptables -F OUTPUT iptables -A OUTPUT -o lo -j ACCEPT iptables -A OUTPUT -o "$WIREGUARD_INTERFACE" -j ACCEPT # WebUI reply traffic (OPT-IN, default OFF): allow established replies FROM the # app's server port so a NON-LAN client (e.g. a public reverse proxy on another # segment) can reach the WebUI. This is an explicit exception to the strict # "all non-LAN egress must leave via the tunnel or be dropped" invariant: while # the tunnel is down these server-reply packets could egress off the physical # NIC. It can only ever be app-server REPLIES (scoped to --sport + # conntrack REPLY), never client-initiated egress, so it cannot leak browsing/ # download activity or the real IP for outbound requests — but it is still an # off-tunnel path, so it is gated behind WIREGUARD_ALLOW_WEBUI_OFFTUNNEL. LAN # clients never need this (they are covered by the LAN allowlist below), so the # default (false) keeps the kill-switch strictly fail-closed for non-LAN egress. if is_truthy "$WIREGUARD_ALLOW_WEBUI_OFFTUNNEL_VALUE"; then iptables -A OUTPUT -p tcp --sport "${FLASK_PORT:-8084}" -m conntrack --ctstate ESTABLISHED --ctdir REPLY -j ACCEPT 2>/dev/null \ || echo "[!] Could not add WebUI reply allow rule (conntrack unavailable?); non-LAN WebUI clients may be unreachable" echo "[*] WIREGUARD_ALLOW_WEBUI_OFFTUNNEL=true: permitting off-tunnel WebUI server replies (--sport ${FLASK_PORT:-8084})." else echo "[*] Off-tunnel WebUI replies disabled (default): non-LAN egress is strictly fail-closed. Set WIREGUARD_ALLOW_WEBUI_OFFTUNNEL=true if a non-LAN reverse proxy must reach the WebUI." fi # --- IPv6 kill-switch (fail closed) --- if [ "$IP6TABLES_OK" = "true" ]; then ip6tables -P OUTPUT DROP ip6tables -F OUTPUT ip6tables -A OUTPUT -o lo -j ACCEPT ip6tables -A OUTPUT -o "$WIREGUARD_INTERFACE" -j ACCEPT # Mirror the opt-in WebUI-reply exception on IPv6 (default OFF = fail-closed). if is_truthy "$WIREGUARD_ALLOW_WEBUI_OFFTUNNEL_VALUE"; then ip6tables -A OUTPUT -p tcp --sport "${FLASK_PORT:-8084}" -m conntrack --ctstate ESTABLISHED --ctdir REPLY -j ACCEPT 2>/dev/null \ || echo "[!] Could not add IPv6 WebUI reply allow rule (conntrack unavailable?); non-LAN WebUI clients may be unreachable over IPv6" fi fi apply_endpoint_rules # Keep LAN reachable (WebUI, Prowlarr, qBittorrent, DNS on the LAN) off-tunnel. DEFAULT_LAN="127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16" LAN_LIST="${LAN_NETWORK:-$DEFAULT_LAN}" IFS=',' read -ra LAN_CIDRS <<< "$LAN_LIST" for cidr in "${LAN_CIDRS[@]}"; do cidr="$(echo "$cidr" | xargs)" [ -z "$cidr" ] && continue if printf '%s' "$cidr" | grep -q ':'; then [ "$IP6TABLES_OK" = "true" ] && ip6tables -A OUTPUT -d "$cidr" -j ACCEPT 2>/dev/null else iptables -A OUTPUT -d "$cidr" -j ACCEPT # Firewall ACCEPT alone is not enough: a LAN subnet on another VLAN has # no route in the main table, so wg-quick's suppress-default rule pushes # it into the tunnel (where the VPN drops RFC1918). Install an explicit # route via the original gateway so it egresses over the LAN. Skip # loopback (127/8) and any directly-connected subnet (add fails -> a # more-specific connected route already exists and wins by longest # prefix, so leaving it is correct). case "$cidr" in 127.*) : ;; *) if [ -n "$ORIG_GW" ] && [ -n "$ORIG_DEV" ]; then # Distinguish EEXIST (route already present -> benign, a more- # specific connected route wins by longest prefix) from a REAL # failure (invalid gateway/onlink, EPERM, EINVAL). Swallowing # all errors as "already present" would silently drop the # resolver route and reintroduce the DNS-dead bug with no signal. add_rc=0 add_err="$(ip route add "$cidr" via "$ORIG_GW" dev "$ORIG_DEV" 2>&1)" || add_rc=$? if [ "$add_rc" -eq 0 ]; then echo "[*] LAN route added: $cidr via $ORIG_GW dev $ORIG_DEV" elif printf '%s' "$add_err" | grep -qiE 'exists|File exists'; then echo "[*] LAN route for $cidr already present (connected/explicit); leaving existing route." else echo "[!] WARNING: could not add LAN route $cidr via $ORIG_GW dev $ORIG_DEV: ${add_err}" >&2 echo " Off-VLAN LAN (incl. the enforced resolver) in $cidr may be forced into the tunnel and dropped." >&2 # Verify the resolver specifically still routes off-tunnel; warn loudly if it now points at the wg dev. if [ -n "${WIREGUARD_DNS:-}" ]; then for _r in $(echo "$WIREGUARD_DNS" | tr ',' ' '); do case "$_r" in *:*) continue ;; esac _rdev="$(ip -4 route get "$_r" 2>/dev/null | awk '{for(i=1;i<=NF;i++) if($i=="dev"){print $(i+1); exit}}')" if [ "$_rdev" = "$WIREGUARD_INTERFACE" ]; then echo "[!] WARNING: resolver $_r currently routes via the tunnel ($WIREGUARD_INTERFACE); DNS will fail (VPN drops RFC1918)." >&2 fi done fi fi else echo "[!] WARNING: no pre-tunnel default gateway/dev captured (ORIG_GW='${ORIG_GW}' ORIG_DEV='${ORIG_DEV}'); cannot install an off-VLAN LAN route for $cidr. Off-subnet LAN (incl. the enforced resolver) may be unreachable." >&2 fi ;; esac fi echo "[*] Kill-switch: LAN allowed off-tunnel -> $cidr" done # Everything else is dropped: if the tunnel drops, non-LAN egress fails closed. iptables -A OUTPUT -j DROP if [ "$IP6TABLES_OK" = "true" ]; then ip6tables -A OUTPUT -j DROP fi echo "[✓] Kill-switch active (default-drop; egress only via $WIREGUARD_INTERFACE or LAN, IPv4+IPv6)." # --------------------------------------------------------------------------- # DNS enforcement (fail-closed): pin the resolver so DNS can't silently fall # back to an off-tunnel path. # --------------------------------------------------------------------------- # NOTE: this deliberately does NOT force resolver traffic through the tunnel. # The intended model is a trusted LAN resolver kept reachable off-tunnel via # LAN_NETWORK (the query leaves over the LAN; the resolver encrypts its own # upstream, and the actual download still egresses through the tunnel). It also # preserves Docker's embedded resolver (127.0.0.11) when present so container- # name resolution keeps working, pinning the embedded resolver's upstream via # the container's compose `dns:` list. "Fail-closed" here means: refuse to run # rather than leave an inherited resolver that could leak queries off-tunnel. if is_truthy "$WIREGUARD_ENFORCE_DNS_VALUE"; then # Prefer an explicit override; fall back to the tunnel config's DNS. DNS_TO_USE="${WIREGUARD_DNS:-$WG_DNS}" # Normalise separators (commas -> spaces). DNS_TO_USE="$(echo "$DNS_TO_USE" | tr ',' ' ' | xargs || true)" # Is DNS managed by Docker's embedded resolver? When a container is created # with a `dns:`/`--dns` list (or default bridge DNS), Docker writes # /etc/resolv.conf as a single `nameserver 127.0.0.11` and runs an embedded # resolver there that (a) answers container-name lookups locally (e.g. # prowlarr, qbit) and (b) forwards everything else to the container's # configured upstream resolvers. Blindly truncating this file (the previous # behaviour) destroys container-name resolution, so app<->Prowlarr/qBittorrent # by-name integration dies even though the tunnel is perfectly healthy. # # In that case we PRESERVE the embedded resolver instead of overwriting it. # Fail-closed DNS is still satisfied because the embedded resolver's upstream # is pinned by the container's `dns:` list, which MUST be a trusted resolver # reachable off-tunnel over the LAN (the documented LAN-resolver model at the # top of this script: the DNS query leaves over the LAN to a trusted resolver # while the actual download still egresses through the tunnel). We cannot # reconfigure the embedded resolver's upstream from inside the container, so # we leave resolv.conf as Docker wrote it and rely on `dns:` for the upstream. DOCKER_EMBEDDED_DNS=false if grep -qE '^[[:space:]]*nameserver[[:space:]]+127\.0\.0\.11([[:space:]]|$)' /etc/resolv.conf 2>/dev/null; then DOCKER_EMBEDDED_DNS=true fi if is_truthy "$DOCKER_EMBEDDED_DNS"; then echo "[*] Docker embedded resolver (127.0.0.11) detected — preserving it so container-name" echo " resolution (prowlarr/qbit) keeps working. External queries are forwarded by the" echo " embedded resolver to the container's configured upstream (the compose 'dns:' list)." if [ -n "$DNS_TO_USE" ]; then echo "[!] WARNING: WIREGUARD_DNS='$DNS_TO_USE' cannot repoint the embedded resolver's upstream" >&2 echo " from inside the container. External DNS is forwarded to the container's compose 'dns:'" >&2 echo " list, NOT to WIREGUARD_DNS. If 'dns:' is unset or points at an untrusted/Proton-filtered" >&2 echo " upstream, book-source domains may NXDOMAIN or leak. Set the container 'dns:' to that same" >&2 echo " trusted off-tunnel LAN resolver ($DNS_TO_USE)." >&2 else echo "[!] NOTE: no WIREGUARD_DNS set; the embedded resolver forwards to the container's" echo " configured upstream. Ensure the container's 'dns:' is a trusted LAN resolver." fi # Leave /etc/resolv.conf untouched (127.0.0.11 stays primary). elif [ -n "$DNS_TO_USE" ]; then echo "[*] Enforcing resolver(s): $DNS_TO_USE" # Writing /etc/resolv.conf can fail if it is a read-only bind mount. # If we cannot pin the resolver, the container would fall back to its # inherited resolver, which the LAN allowlist permits and which can leak # queries off-tunnel. Fail closed. if ! { : > /etc/resolv.conf; } 2>/dev/null; then echo "[✗] Could not write /etc/resolv.conf (read-only mount?)." >&2 echo " Cannot pin the resolver, so DNS could leak off-tunnel via the inherited resolver." >&2 echo " Provide a writable /etc/resolv.conf, or set WIREGUARD_ENFORCE_DNS=false only if" >&2 echo " you have pinned the resolver another way." >&2 exit 1 fi # Validate each resolver token as a literal IP before writing it, so a # stray comment/hostname/malformed token in WIREGUARD_DNS or the config # DNS= line can't produce a bogus `nameserver` line (e.g. "nameserver #") # that silently breaks resolution. Reject IPv6 resolvers when IPv6 is # disabled (they'd be unusable). Fail closed if, after validation, no # usable resolver remains — the whole point of enforcement is to avoid # falling back to a leak-prone inherited resolver. _valid_ns="" for ns in $DNS_TO_USE; do if is_ipv4 "$ns"; then _valid_ns="$_valid_ns $ns" elif is_ipv6 "$ns"; then if is_truthy "$WIREGUARD_DISABLE_IPV6_VALUE"; then echo "[!] Ignoring IPv6 resolver '$ns' because WIREGUARD_DISABLE_IPV6=true." >&2 else _valid_ns="$_valid_ns $ns" fi else echo "[!] Ignoring invalid resolver token '$ns' (not a literal IP address)." >&2 fi done _valid_ns="$(echo "$_valid_ns" | xargs || true)" if [ -z "$_valid_ns" ]; then echo "[✗] WIREGUARD_ENFORCE_DNS=true but no VALID IP resolver remained after validation (from '$DNS_TO_USE')." >&2 echo " Refusing to run, because an empty/invalid resolv.conf would leak DNS off-tunnel via the" >&2 echo " inherited resolver. Set WIREGUARD_DNS to a literal resolver IP reachable via the tunnel" >&2 echo " or an allowed LAN resolver (or set WIREGUARD_ENFORCE_DNS=false to accept the inherited one)." >&2 exit 1 fi for ns in $_valid_ns; do echo "nameserver $ns" >> /etc/resolv.conf done else # No embedded resolver and no resolver to enforce. Leaving the inherited # resolver in place would let DNS leak off-tunnel. Fail closed. echo "[✗] WIREGUARD_ENFORCE_DNS=true but no resolver is defined (set WIREGUARD_DNS, or a DNS= line in the config)." >&2 echo " Refusing to run, because the inherited resolver could leak DNS off-tunnel." >&2 echo " Either set WIREGUARD_DNS to a resolver reachable via the tunnel (or an allowed LAN" >&2 echo " resolver), or explicitly set WIREGUARD_ENFORCE_DNS=false to accept the inherited resolver." >&2 exit 1 fi else echo "[*] Leaving /etc/resolv.conf unchanged (WIREGUARD_ENFORCE_DNS=$WIREGUARD_ENFORCE_DNS_VALUE)" fi # --------------------------------------------------------------------------- # Supervisor: keep the tunnel healthy and fail-closed on drop. # --------------------------------------------------------------------------- echo "[*] Configuring Supervisor..." mkdir -p /var/log/supervisor cat < /etc/supervisor/supervisord.conf [supervisord] nodaemon=false logfile=/var/log/supervisor/supervisord.log pidfile=/var/run/supervisord.pid user=root [unix_http_server] file=/var/run/supervisor.sock [rpcinterface:supervisor] supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface [supervisorctl] serverurl=unix:///var/run/supervisor.sock [program:wireguard-healthcheck] command=/app/wireguard_healthcheck.sh autostart=true autorestart=true stdout_logfile=/var/log/supervisor/wireguard-healthcheck.log stderr_logfile=/var/log/supervisor/wireguard-healthcheck.err.log EOF cat <<'HC' > /app/wireguard_healthcheck.sh #!/bin/bash # Monitors the WireGuard tunnel via handshake age. If the tunnel is stale, # bounce the interface. The iptables kill-switch means non-LAN egress stays # blocked while the tunnel is down, so this is recovery, not leak-prevention. WIREGUARD_INTERFACE="${WIREGUARD_INTERFACE:-wg0}" # Max seconds since last handshake before we consider the tunnel stale. # WireGuard rehandshakes roughly every 2 minutes when there is traffic. STALE_AFTER="${WIREGUARD_STALE_AFTER:-180}" # Reuse the persistent sysctl shim the main script wrote. The recovery bounce # runs `wg-quick up`, which unconditionally writes # net.ipv4.conf.all.src_valid_mark=1; in a container /proc/sys is read-only so # that write fails and wg-quick would abort, never recovering. Putting the shim # ahead on PATH makes that one redundant write a no-op, mirroring the initial # bring-up. SYSCTL_SHIM_DIR="/app/wg-sysctl-shim" if [ -x "${SYSCTL_SHIM_DIR}/sysctl" ]; then PATH="${SYSCTL_SHIM_DIR}:${PATH}" fi # Detect ip6tables usability independently (this script runs under supervisor in # its own environment and does not inherit the parent's IP6TABLES_OK). if ip6tables -L OUTPUT >/dev/null 2>&1; then IP6TABLES_OK="true" else IP6TABLES_OK="false" fi latest_handshake_epoch() { wg show "$WIREGUARD_INTERFACE" latest-handshakes 2>/dev/null \ | awk '{print $2}' | sort -nr | head -n1 } # Force a handshake by giving the kernel a packet to send over the tunnel. On an # IDLE tunnel without PersistentKeepalive, WireGuard does not rehandshake, so # latest-handshake legitimately ages out even though the tunnel is healthy. # Probing before judging staleness avoids bouncing a healthy-but-idle tunnel. # Best-effort and fully silenced: ping bound to the wg dev (encrypted into the # tunnel or dropped by the kill-switch — never leaks), curl fallback to a bare # IP so it needs no DNS; both cannot abort the loop. hc_handshake_probe() { ping -c 1 -W 1 -I "$WIREGUARD_INTERFACE" 1.1.1.1 >/dev/null 2>&1 \ || curl -s --max-time 3 -o /dev/null "https://1.1.1.1" >/dev/null 2>&1 \ || true } # Re-open the WireGuard endpoint(s) in the kill-switch from the LIVE interface. # The endpoint allow rules are first derived at startup, but a provider IP # rotation or NAT rebinding can change the peer endpoint later. We pin each rule # to the resolved endpoint destination IP *and* UDP port (not the port alone): # a wildcard-port rule would leave an off-tunnel UDP hole to that port during/ # after a bounce while the tunnel isn't fully up. # # Endpoint rules live in a DEDICATED chain (SHELFMARK_WG_EP) that we FLUSH and # repopulate from the live interface every cycle. This is deliberately not an # additive `-I OUTPUT` scheme: appending/inserting-only would leave the OLD # endpoint's allow rule in place forever after a provider rotation (a permanent # off-tunnel UDP hole to a dest we no longer use) and grow the chain unbounded. # Flushing first means only the CURRENT live endpoint(s) are ever permitted, so # a rotated endpoint IP is re-permitted on recovery while the stale one is # removed in the same pass, and everything else stays forced through the tunnel # by the default-DROP. IPv6 hosts have their [] brackets stripped for -d; IPv6 # rules only run when ip6tables is usable. Must mirror sync_endpoint_chain in the # parent script (this runs in the supervised healthcheck's own process). EP_CHAIN="${EP_CHAIN:-SHELFMARK_WG_EP}" refresh_endpoint_rules() { local eps ep ep_host ep_port ep_ip seen_v4=" " seen_v6=" " key # Ensure the chain exists, OUTPUT jumps to it, then flush stale entries. iptables -nL "$EP_CHAIN" >/dev/null 2>&1 || iptables -N "$EP_CHAIN" 2>/dev/null || true iptables -C OUTPUT -j "$EP_CHAIN" 2>/dev/null || iptables -I OUTPUT 1 -j "$EP_CHAIN" 2>/dev/null || true iptables -F "$EP_CHAIN" 2>/dev/null || true if [ "$IP6TABLES_OK" = "true" ]; then ip6tables -nL "$EP_CHAIN" >/dev/null 2>&1 || ip6tables -N "$EP_CHAIN" 2>/dev/null || true ip6tables -C OUTPUT -j "$EP_CHAIN" 2>/dev/null || ip6tables -I OUTPUT 1 -j "$EP_CHAIN" 2>/dev/null || true ip6tables -F "$EP_CHAIN" 2>/dev/null || true fi # Keep only host:port tokens; skip "(none)" and malformed entries. eps="$(wg show "$WIREGUARD_INTERFACE" endpoints 2>/dev/null | awk '{print $2}' | grep -F ':' | grep -v '(none)' || true)" for ep in $eps; do ep_port="${ep##*:}" ep_host="${ep%:*}" case "$ep_port" in ''|*[!0-9]*) continue ;; esac [ -z "$ep_host" ] && continue if printf '%s' "$ep_host" | grep -q ':'; then # Strip the surrounding [ ] brackets from an IPv6 endpoint for -d; # backslash-escape the bracket so the pattern is an unambiguous # literal, not a glob character class (mirrors sync_endpoint_chain). ep_ip="${ep_host#\[}"; ep_ip="${ep_ip%\]}" key="${ep_ip}/${ep_port}" case "$seen_v6" in *" $key "*) continue ;; esac seen_v6="${seen_v6}${key} " [ "$IP6TABLES_OK" = "true" ] && ip6tables -A "$EP_CHAIN" -d "$ep_ip" -p udp --dport "$ep_port" -j ACCEPT 2>/dev/null || true else ep_ip="$ep_host" key="${ep_ip}/${ep_port}" case "$seen_v4" in *" $key "*) continue ;; esac seen_v4="${seen_v4}${key} " iptables -A "$EP_CHAIN" -d "$ep_ip" -p udp --dport "$ep_port" -j ACCEPT 2>/dev/null || true fi done } FAIL_COUNT=0 # Give the first handshake time to complete before judging health. sleep 20 while true; do # Proactively re-open the current live endpoint IP+port every cycle. If the # provider rotates the endpoint IP while the tunnel is up, this adds the new # allow rule before the DROP so the next handshake to the new endpoint is # not blocked, minimising recovery delay (rather than waiting for a bounce). refresh_endpoint_rules HS="$(latest_handshake_epoch)" NOW="$(date +%s)" if [ -z "$HS" ] || [ "$HS" = "0" ]; then AGE=99999 else AGE=$((NOW - HS)) fi if [ "$AGE" -le "$STALE_AFTER" ]; then FAIL_COUNT=0 else # Stale handshake — but on an idle tunnel without PersistentKeepalive the # handshake ages out legitimately. Force a handshake with a probe and # re-evaluate AGE before counting this as a failure, so a healthy-but- # idle tunnel is not bounced every few minutes (needless churn + noisy # logs). A genuinely dead tunnel won't handshake, so AGE stays stale and # the failure still accrues -> real outages are still detected. hc_handshake_probe sleep 3 HS="$(latest_handshake_epoch)" NOW="$(date +%s)" if [ -z "$HS" ] || [ "$HS" = "0" ]; then AGE=99999 else AGE=$((NOW - HS)) fi if [ "$AGE" -le "$STALE_AFTER" ]; then FAIL_COUNT=0 else FAIL_COUNT=$((FAIL_COUNT + 1)) # Clamp so the counter can't grow unbounded across a long outage. [ "$FAIL_COUNT" -gt 3 ] && FAIL_COUNT=3 echo "$(date): WireGuard handshake stale after probe (age=${AGE}s, fail=${FAIL_COUNT})" fi fi if [ "$FAIL_COUNT" -ge 3 ]; then echo "$(date): restart trigger - bouncing $WIREGUARD_INTERFACE" wg-quick down "$WIREGUARD_INTERFACE" 2>/dev/null || true # Bring the tunnel back up via the sysctl shim (read-only /proc/sys). # The DROP policy + rules stay in place so we never leak during the bounce. if wg-quick up "$WIREGUARD_INTERFACE" 2>/dev/null; then # The peer endpoint may have rotated; re-open it so the kill-switch # does not strand the reconnect. Only reset the failure counter on a # successful bring-up. refresh_endpoint_rules FAIL_COUNT=0 else # Leave FAIL_COUNT at/above the threshold so the NEXT cycle retries # the bounce immediately instead of waiting for 3 more stale cycles. # Cap it so it can't overflow on a long outage. echo "$(date): wg-quick up failed; will retry next cycle (still fail-closed)" FAIL_COUNT=3 fi sleep 15 fi sleep 30 done HC chmod +x /app/wireguard_healthcheck.sh echo "[*] Starting Supervisor..." /usr/bin/supervisord -c /etc/supervisor/supervisord.conf # --------------------------------------------------------------------------- # Verify egress actually leaves via the tunnel before handing off to the app. # --------------------------------------------------------------------------- echo "[*] Waiting for first WireGuard handshake (up to 60s)..." HANDSHAKE_TIMEOUT=60 HANDSHAKE_START=$(date +%s) # WireGuard only performs a handshake when the kernel actually has a packet to # send over the tunnel (or every PersistentKeepalive interval). A config without # PersistentKeepalive and with no app traffic yet would never handshake, so this # passive poll could time out and abort a perfectly healthy tunnel. Emit a tiny # best-effort probe toward a public address routed INTO the tunnel (AllowedIPs= # 0.0.0.0/0 -> fwmark default; kill-switch already permits -o wg0), which gives # the kernel something to send and triggers the initial handshake. The probe # target need not reply; the outbound attempt alone initiates the handshake. wg_handshake_probe() { # Prefer ping (cheapest, no DNS); fall back to a curl to a bare IP so we do # not depend on DNS being up yet. Both are best-effort and fully silenced. ping -c 1 -W 1 -I "$WIREGUARD_INTERFACE" 1.1.1.1 >/dev/null 2>&1 \ || curl -s --max-time 3 -o /dev/null "https://1.1.1.1" >/dev/null 2>&1 \ || true } while true; do wg_handshake_probe HS="$(wg show "$WIREGUARD_INTERFACE" latest-handshakes 2>/dev/null | awk '{print $2}' | sort -nr | head -n1)" if [ -n "$HS" ] && [ "$HS" != "0" ]; then echo "[✓] WireGuard handshake established." break fi if [ $(($(date +%s) - HANDSHAKE_START)) -ge $HANDSHAKE_TIMEOUT ]; then echo "[✗] No WireGuard handshake after ${HANDSHAKE_TIMEOUT}s. Aborting (fail closed)." # Tidy up before aborting so a still-running supervised healthcheck can't # keep bouncing / wg-quick up a tunnel the operator has decided to # abandon. The container exits when entrypoint sees this non-zero exit # (kill-switch DROP stays in force throughout), so this is hygiene, not # leak-prevention. supervisorctl -c /etc/supervisor/supervisord.conf stop wireguard-healthcheck >/dev/null 2>&1 || true supervisorctl -c /etc/supervisor/supervisord.conf shutdown >/dev/null 2>&1 || true wg-quick down "$WIREGUARD_INTERFACE" >/dev/null 2>&1 || true exit 1 fi sleep 2 done echo "[*] Verifying external egress IP is the tunnel (not the host)..." EGRESS_IP="$(curl -s --max-time 15 https://api.ipify.org 2>/dev/null || true)" if [ -n "$EGRESS_IP" ]; then echo "[✓] External egress IP via tunnel: $EGRESS_IP" else echo "[!] Could not determine egress IP (endpoint may block ipify). Tunnel handshake is up; continuing." fi echo "[*] End of WireGuard script"