Files
tidewall/tools/godot.sh
T
claudeandClaude Opus 5.5 9b5064d7a8 H5: Security review, and fixes for connection-slot exhaustion
docs/SECURITY_REVIEW.md lists the scope, nine findings and what was done.

- High, fixed: a peer that connects and stops answering kept its ENet slot
  for up to 15 s after being turned away, so one address could fill every
  slot. Flood refusals now disconnect at once (reason in the disconnect
  data, which NetClient now honours for REASON_BUSY), peers told to leave
  get 1 s to acknowledge, and when slots run short the longest-waiting
  silent guest makes room.
- Medium, mitigated: ENet holds half-open slots for spoofed CONNECTs that
  the script never sees. The host now has 512 slots (NetServer.peer_slots).
- Medium, fixed: SourceLimiter, handshakes per source and the list
  server's per-address cap count an IPv6 /64 as one source.
- Low, fixed: CommandLog refuses a header with non-numeric fields instead
  of raising errors.
- tools/godot.sh unsets DISPLAY and WAYLAND_DISPLAY so the engine's error
  alerts can never reach the host desktop.
- A test fixture's 10.0.0.9 is now the documentation address 192.0.2.9.

Tests: 4 new handshake tests with real non-acknowledging ENet peers,
test_source_limiter (3), a CommandLog type test. make check, make fuzz,
make client-check, make discovery-check and make soak-selfcheck pass.

Closes #58

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-14 02:36:36 -05:00

67 lines
2.3 KiB
Bash
Executable File

#!/usr/bin/env bash
# Runs the repo-local Godot engine pinned in tools/engine.version.
#
# tools/godot.sh [godot args...] run the engine, headless unless told otherwise
# tools/godot.sh --verify check the engine's version and SHA-512, then exit
#
# Windows must never open on the host desktop, so --headless is added by default.
# The offscreen container harness sets TIDEWALL_GODOT_DISPLAY=1, inside its container
# only, to allow rendering to its private X server.
#
# User data, editor settings and caches are kept in .godot-home/ inside the repo.
set -euo pipefail
repo="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
binary="$repo/tools/godot/Godot_v4.7.2-stable_linux.x86_64"
if [[ ! -x "$binary" ]]; then
cat >&2 <<MSG
tools/godot.sh: the Godot engine is missing.
Expected an executable at: $binary
tools/godot/ is git-ignored. Download Godot 4.7.2 (Linux x86_64 editor and export
templates) from the official release, check them against tools/engine.upstream.sha512,
and extract them there.
MSG
exit 127
fi
verify() {
local expected actual
expected="$(cat "$repo/tools/engine.version")"
actual="$("$binary" --headless --version | tail -n 1)"
if [[ "$actual" != "$expected" ]]; then
echo "tools/godot.sh: engine version is '$actual', expected '$expected'." >&2
return 1
fi
# Only the binary: hashing the 1.2 GB templates on every check is wasteful.
# R2 verifies the templates before packaging.
(cd "$repo" && grep 'linux\.x86_64$' tools/engine.sha512 | sha512sum --check --quiet) || {
echo "tools/godot.sh: engine binary does not match tools/engine.sha512." >&2
return 1
}
echo "Engine OK: $actual"
}
if [[ "${1:-}" == "--verify" ]]; then
verify
exit $?
fi
# Keep the engine's data out of the user's home directory.
export XDG_DATA_HOME="$repo/.godot-home/data"
export XDG_CONFIG_HOME="$repo/.godot-home/config"
export XDG_CACHE_HOME="$repo/.godot-home/cache"
mkdir -p "$XDG_DATA_HOME" "$XDG_CONFIG_HOME" "$XDG_CACHE_HOME"
touch "$repo/tools/godot/.gdignore"
args=("--path" "$repo")
if [[ "${TIDEWALL_GODOT_DISPLAY:-0}" != "1" ]]; then
args+=("--headless")
# Even headless, the engine shows its error alerts (a script that can't run, say)
# through zenity or kdialog on whatever display the environment names. Name none.
unset DISPLAY WAYLAND_DISPLAY
fi
exec "$binary" "${args[@]}" "$@"