Skip to content

v0.3.0

Choose a tag to compare

@moonmouse11 moonmouse11 released this 26 Oct 23:42
· 4 commits to main since this release
e653bfe

Release 0.3.0: marketplace install, a much narrower root surface, and fixes for hanging connects. Full notes in CHANGELOG.md.

Important

Privileged code changed (CONTRIBUTING: plugins.omarchy.org needs a new maintainer review):
install.sh (and the sudoers rule it writes), uninstall.sh, and the new
scripts/omarchy-vpn-helper. The sub-intercept-* / happd-sniff* / happd-extract-config.py
scripts are removed. happ-killswitch is unchanged since v0.2.0.

Highlights

  • Marketplace install: omarchy plugin add downloads the plugin, and the panel's Finish setup / Update setup runs install.sh in a terminal. An install wizard asks for protocols and features before any password and installs only the packages they need.
  • Security:
    • The sudoers rule is cut down to three fixed entry points. Before, it let any user process get passwordless root (wg-quick *, cp/cat wildcards, kill).
    • The root helper refuses imports that could run commands as root. For WireGuard that means PostUp and its kin. For OpenVPN, a config is imported only if every directive is on an allowlist. WireGuard profile names longer than 15 characters are refused too.
    • IPv6 no longer leaks at boot or while switching servers.
    • The subscription header capture, which used a local CA, is removed.
  • Fixed:
    • Happ connects no longer hang on a stale subscription.
    • Quick clicks while switching no longer answer "Already switching".
    • A connect is refused while the Happ app holds the tunnel.
    • A failed setup step says "Setup failed" instead of "Done!".
    • Background subscription failures are logged.
  • README is rewritten for users, with badges. Real provider names and identifiers are removed from code and tests.

Upgrading

After omarchy plugin update omarchy-vpn, press Update setup in the panel (or run make install from a checkout). The sudoers rule, helpers and backend are copies and only change then.

Tested

  • make test-docker: 839 passed; ruff, mypy, shellcheck (--severity=warning) clean; SonarCloud quality gate passed with 0 open issues.
  • Fresh Omarchy 4.0.6 VM, on dev:
    • omarchy plugin validate and plugin add;
    • Finish setup through the wizard and sudo;
    • the panel, the window and SUPER+Shift+V;
    • plugin update, then Update setup;
    • uninstall.sh and plugin remove.
  • After setup, the sudoers rule allowed only the three entry points. After uninstall, nothing was left behind except ~/.config/vpn-manager.