Skip to content

burrow v1.1.0

Choose a tag to compare

@github-actions github-actions released this 18 Nov 07:40
· 12 commits to main since this release

A one-command installer, plus a hardening pass from a full security audit of the
code base. Upgrade by re-running the installer, or with git pull && ./burrow up, or by
re-running burrow deploy. Your secret is kept either way.

Added

  • install.sh: install on a server with one command, configured through
    environment variables:
    curl -fsSL https://raw.githubusercontent.com/deadboyccc/Burrow/main/install.sh | sudo BURROW_DOMAIN=notes.example.com bash
    (or BURROW_COVER_DOMAIN=… for simple mode). It installs prerequisites, fetches the
    pinned release, prepares the host, creates the secret, starts the proxy, runs the
    smoke test and prints the links and QR code. Re-running it upgrades in place and keeps
    the secret. BURROW_DRY_RUN=1 previews every step.
  • Documented stealth mode without a domain: use your IP as a free wildcard-DNS name such as
    203-0-113-7.sslip.io, and point links at the IP with LINK_HOST. You still get a real
    certificate. Also documented the rules for custom decoy pages: CSS in files, because of
    the strict Content-Security-Policy, and a 404.html.

Security

  • install-host.sh could lock you out of SSH: sudo drops SSH_CONNECTION, so a
    non-default SSH port was firewalled off. SSH now stays open on --ssh-port and on
    every port sshd listens on. If none can be determined, the firewall is left off.
  • burrow smoke --link treats the server as hostile. Every probe has one overall time
    budget (a server could stall it forever with drips or empty TLS records).
    Server-supplied text is stripped of terminal escape sequences before printing.
  • Dotfiles in site.local/ (.git, .DS_Store, …) are no longer published or
    uploaded, and Caddy hides dotfiles too.
  • deploy validates and quotes every value it sends to the server's root shell, and
    requires non-interactive sudo up front.
  • config show hides SOCKS credentials, link errors no longer echo the secret, and
    Secret objects keep the key out of repr().
  • Unattended upgrades now include Docker's packages (runc and containerd fixes).

Fixed

  • Failures were reported as success. The command dispatcher switched off set -e for
    every command. For example, deploy printed "Deployed." after the server failed to
    start. Errors now stop the command with a non-zero exit, and deploy stops at the
    first failed step.
  • The running decoy kept serving a deleted copy of the site after a re-render (e.g. from
    doctor, or a new year in the footer). The site is now synced in place, and doctor
    no longer re-renders under a running stack.
  • config set DOMAIN … (or the mode) got stuck in a loop. The secret is now
    regenerated. config set validates all pairs before writing, and refuses to create a
    .env.
  • up refuses to adopt the containers of another burrow installation on the same host.
  • install-host.sh no longer aborts at the sysctl step on container VPSes (skipping the
    firewall). It refreshes package lists before installing, writes daemon.json before
    Docker starts (so live-restore applies), and validates --dir.
  • The watchdog no longer restarts mtg when the probe tool itself failed, and is quiet on
    servers without a .env.
  • status exits non-zero when the proxy is unhealthy. HTTP→HTTPS redirects keep a
    non-443 proxy port, and the IPv6 overlay follows BIND_ADDR.
  • Validation covers every key in every mode. It also rejects CONCURRENCY with
    leading zeros and malformed IPv6 addresses.
  • Probe verdicts are correct for resets after partial answers, partial TLS flights, HTTP
    servers that keep the connection open, and non-ASCII status codes. Out-of-range
    --port/--dc values are rejected, and the replay check reports "inconclusive"
    instead of a false alarm.
  • A friendly error on bash < 4.4 (macOS's default bash). Host sysctl tuning no longer
    lowers fs.file-max.

Changed

  • Digby, the mascot, redrawn as a detailed dawn badge.