Files
Johnathan Corgan eaba693b18 packaging: bring systemd tarball to feature parity with .deb / AUR
The generic systemd install tarball is the catch-all install path
for systemd Linux distros that don't have a per-format package
(Fedora, RHEL/CentOS, openSUSE, Alpine, etc.). It had drifted
behind the .deb and AUR packages and was missing fips-gateway, the
mesh-interface firewall baseline, and the multi-backend DNS helper
in the shipped tarball. Bring it to parity:

- New `packaging/systemd/fips-gateway.service` (clone of the .deb
  unit; ExecStart pointed at `/usr/local/bin/fips-gateway`). Not
  enabled at install time; operator opt-in.
- New `packaging/systemd/fips-firewall.service` (clone of the .deb
  unit; nft path unchanged at `/usr/sbin/nft`). Not enabled at
  install time; operator opt-in.
- `build-tarball.sh` now bundles the `fips-gateway` binary, the two
  new units, the `fips.nft` baseline conffile, and the
  `fips-dns-setup` / `fips-dns-teardown` multi-backend helpers from
  `packaging/common/`.
- `install.sh` now installs `fips-gateway` to `/usr/local/bin/`,
  installs both new units to `/etc/systemd/system/` (without
  enabling them), preserves `/etc/fips/fips.nft` on upgrade like
  `fips.yaml`, and creates the `/etc/fips/fips.d/` operator drop-in
  directory. Post-install messaging mentions both opt-in services.
- `uninstall.sh` stops and disables the optional services in
  dependency order (firewall, gateway, dns, daemon), removes the
  new unit files, and removes the gateway binary. `--purge` already
  handles `/etc/fips/` removal which covers `fips.nft` and
  `fips.d/`.
- `README.install.md` documents all of the above: expanded
  "What Gets Installed" table, new sections covering the firewall
  baseline and the LAN gateway, refreshed DNS section reflecting
  the multi-backend setup helper (systemd dns-delegate /
  systemd-resolved drop-in / per-link resolvectl / dnsmasq /
  NetworkManager-dnsmasq), and updated Service Management.

Also fixes a latent packaging bug: `install.sh` previously
referenced `${SCRIPT_DIR}/../common/fips-dns-setup`, a path that
exists only in the source-repo layout and not in the extracted
tarball. The script now resolves the helper from the staging
directory first (the tarball case), falling back to the source-repo
relative path. Bug latent since the multi-backend DNS helpers
landed.

CHANGELOG `[Unreleased]` documents the parity bump under Changed
and the path-resolution fix under Fixed.

Closes the longest-standing parity gap for non-Debian / non-Arch
systemd Linux distros installing from the release-distribution
tarball.
2026-05-10 21:52:47 +00:00

212 lines
7.5 KiB
Bash
Executable File

#!/usr/bin/env bash
# FIPS Install Script
#
# Installs the FIPS mesh network daemon as a systemd service.
#
# Usage: sudo ./install.sh
#
# Files installed:
# /usr/local/bin/fips Daemon binary
# /usr/local/bin/fipsctl CLI query tool
# /usr/local/bin/fipstop TUI monitor
# /usr/local/bin/fips-gateway Outbound LAN gateway binary (opt-in)
# /etc/fips/fips.yaml Configuration (preserved if exists)
# /etc/fips/hosts Host-to-npub mappings (preserved if exists)
# /etc/fips/fips.nft Mesh-interface nftables baseline (preserved if exists)
# /etc/fips/fips.d/ Operator drop-in directory for nft rules
# /etc/systemd/system/fips.service Daemon unit (enabled)
# /etc/systemd/system/fips-dns.service DNS routing for .fips domain (enabled)
# /etc/systemd/system/fips-gateway.service Gateway unit (NOT enabled; opt-in)
# /etc/systemd/system/fips-firewall.service Firewall baseline unit (NOT enabled; opt-in)
set -euo pipefail
INSTALL_PREFIX="/usr/local"
CONFIG_DIR="/etc/fips"
CONFIG_FILE="${CONFIG_DIR}/fips.yaml"
SYSTEMD_DIR="/etc/systemd/system"
FIPS_GROUP="fips"
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
# --- Preflight checks ---
if [ "$(id -u)" -ne 0 ]; then
echo "Error: This script must be run as root (use sudo)." >&2
exit 1
fi
if [ ! -f "${SCRIPT_DIR}/fips" ]; then
echo "Error: fips binary not found in ${SCRIPT_DIR}" >&2
exit 1
fi
if ! command -v systemctl &>/dev/null; then
echo "Error: systemctl not found. This script requires systemd." >&2
exit 1
fi
if [ ! -e /dev/net/tun ]; then
echo "Warning: /dev/net/tun not found. TUN support may not work." >&2
echo " Load the module with: modprobe tun" >&2
fi
# --- Create fips group for control socket access ---
if ! getent group "${FIPS_GROUP}" &>/dev/null; then
groupadd --system "${FIPS_GROUP}"
echo "Created system group '${FIPS_GROUP}'."
fi
# --- Install binaries ---
echo "Installing binaries to ${INSTALL_PREFIX}/bin/"
install -m 0755 "${SCRIPT_DIR}/fips" "${INSTALL_PREFIX}/bin/fips"
install -m 0755 "${SCRIPT_DIR}/fipsctl" "${INSTALL_PREFIX}/bin/fipsctl"
if [ -f "${SCRIPT_DIR}/fipstop" ]; then
install -m 0755 "${SCRIPT_DIR}/fipstop" "${INSTALL_PREFIX}/bin/fipstop"
fi
if [ -f "${SCRIPT_DIR}/fips-gateway" ]; then
install -m 0755 "${SCRIPT_DIR}/fips-gateway" "${INSTALL_PREFIX}/bin/fips-gateway"
fi
# --- Install configuration ---
mkdir -p "${CONFIG_DIR}"
if [ -f "${CONFIG_FILE}" ]; then
echo "Configuration exists at ${CONFIG_FILE}, not overwriting."
install -m 0644 "${SCRIPT_DIR}/fips.yaml" "${CONFIG_DIR}/fips.yaml.template"
echo " New template installed as ${CONFIG_DIR}/fips.yaml.template"
else
install -m 0600 "${SCRIPT_DIR}/fips.yaml" "${CONFIG_FILE}"
echo "Configuration installed to ${CONFIG_FILE}"
fi
HOSTS_FILE="${CONFIG_DIR}/hosts"
if [ -f "${HOSTS_FILE}" ]; then
echo "Hosts file exists at ${HOSTS_FILE}, not overwriting."
else
install -m 0644 "${SCRIPT_DIR}/hosts" "${HOSTS_FILE}"
echo "Hosts file installed to ${HOSTS_FILE}"
fi
# Mesh-interface nftables baseline. Preserved on upgrade like fips.yaml
# so operator edits aren't clobbered.
NFT_FILE="${CONFIG_DIR}/fips.nft"
if [ -f "${NFT_FILE}" ]; then
echo "Firewall baseline exists at ${NFT_FILE}, not overwriting."
install -m 0644 "${SCRIPT_DIR}/fips.nft" "${CONFIG_DIR}/fips.nft.template"
echo " New template installed as ${CONFIG_DIR}/fips.nft.template"
elif [ -f "${SCRIPT_DIR}/fips.nft" ]; then
install -m 0644 "${SCRIPT_DIR}/fips.nft" "${NFT_FILE}"
echo "Firewall baseline installed to ${NFT_FILE}"
fi
# Drop-in directory for operator nftables rules included by
# /etc/fips/fips.nft. Empty by default; the include glob matches
# nothing cleanly out of the box.
if [ ! -d "${CONFIG_DIR}/fips.d" ]; then
install -d -m 0755 "${CONFIG_DIR}/fips.d"
echo "Drop-in directory created at ${CONFIG_DIR}/fips.d/"
fi
# --- Install systemd units ---
was_active=false
if systemctl is-active --quiet fips.service 2>/dev/null; then
was_active=true
echo "Stopping running fips service..."
systemctl stop fips.service
fi
dns_was_active=false
if systemctl is-active --quiet fips-dns.service 2>/dev/null; then
dns_was_active=true
echo "Stopping running fips-dns service..."
systemctl stop fips-dns.service
fi
install -m 0644 "${SCRIPT_DIR}/fips.service" "${SYSTEMD_DIR}/fips.service"
install -m 0644 "${SCRIPT_DIR}/fips-dns.service" "${SYSTEMD_DIR}/fips-dns.service"
if [ -f "${SCRIPT_DIR}/fips-gateway.service" ]; then
install -m 0644 "${SCRIPT_DIR}/fips-gateway.service" "${SYSTEMD_DIR}/fips-gateway.service"
fi
if [ -f "${SCRIPT_DIR}/fips-firewall.service" ]; then
install -m 0644 "${SCRIPT_DIR}/fips-firewall.service" "${SYSTEMD_DIR}/fips-firewall.service"
fi
# DNS helpers ship flat in the tarball alongside install.sh; from a
# source checkout they live under packaging/common/. Resolve from
# either layout.
install -d -m 0755 /usr/lib/fips
if [ -f "${SCRIPT_DIR}/fips-dns-setup" ]; then
install -m 0755 "${SCRIPT_DIR}/fips-dns-setup" /usr/lib/fips/fips-dns-setup
install -m 0755 "${SCRIPT_DIR}/fips-dns-teardown" /usr/lib/fips/fips-dns-teardown
else
install -m 0755 "${SCRIPT_DIR}/../common/fips-dns-setup" /usr/lib/fips/fips-dns-setup
install -m 0755 "${SCRIPT_DIR}/../common/fips-dns-teardown" /usr/lib/fips/fips-dns-teardown
fi
systemctl daemon-reload
echo "systemd units and DNS scripts installed."
# --- Configure runtime directory group ownership ---
# systemd creates /run/fips/ with RuntimeDirectory, but we need the
# group set to 'fips' so group members can access the control socket.
# Create a tmpfiles.d entry for this.
cat > /etc/tmpfiles.d/fips.conf <<'TMPFILES'
d /run/fips 0750 root fips -
TMPFILES
echo "tmpfiles.d entry created for /run/fips/ ownership."
# --- Enable service ---
systemctl enable fips.service
systemctl enable fips-dns.service
echo "Services enabled (will start on boot)."
# Restart if they were running before
if $was_active; then
echo "Restarting fips service..."
systemctl start fips.service
fi
if $dns_was_active; then
echo "Restarting fips-dns service..."
systemctl start fips-dns.service
fi
echo ""
echo "=== Installation complete ==="
echo ""
echo "Before starting the service, edit ${CONFIG_FILE}:"
echo ""
echo " 1. Set a persistent identity (if publishing npub for static peers)"
echo " Uncomment 'persistent: true' in the identity section."
echo " A keypair will be generated and saved on first start."
echo ""
echo " 2. Configure Ethernet transport interface (if using)"
echo " Uncomment the ethernet section and set the interface name."
echo ""
echo " 3. Add static peers (if bootstrapping over UDP/TCP)"
echo ""
echo "Start the service:"
echo " sudo systemctl start fips"
echo ""
echo "Optional services (NOT enabled by default):"
echo ""
echo " Mesh-interface firewall baseline (default-deny on fips0):"
echo " sudo systemctl enable --now fips-firewall.service"
echo " Operator drop-ins under /etc/fips/fips.d/*.nft"
echo ""
echo " Outbound LAN gateway (bridge unmodified LAN hosts to .fips):"
echo " sudo systemctl enable --now fips-gateway.service"
echo " Configure under the gateway: section of ${CONFIG_FILE}"
echo ""
echo "Monitor:"
echo " sudo journalctl -u fips -f"
echo " fipsctl show status"
echo " fipstop"
echo ""
echo "To use fipsctl/fipstop without sudo, add your user to the fips group:"
echo " sudo usermod -aG fips \$USER"
echo " (log out and back in for group membership to take effect)"