Aleksandr Bogomiakov
90ef5cefec
Offline devices reserved names and IPv4 addresses indefinitely, leaving stale members in the device history. Give every authenticated network participant the same right to retire another device's observed signed claim without an owner, quorum, permanent identity ban or secret change. Add a separately signed retirement containing the target's original signed claim as proof. Verify both signatures and network scopes, retain the strongest proved cutoff per target with deterministic ties, and suppress claim versions at or below it in membership, hostname ownership and IPv4 allocation. Keep the old signed records and range agreement, and retain markers after a newer claim returns so old replicas cannot resurrect obsolete reservations. A returning device signs a newer claim, allocates against current holders and resets its previous hostname priority rather than taking a reused name with an old time. Commit local retirement and the requester's author counter atomically before announcing it; receivers persist proofs before applying them. Bound history to 1024 targets by default, reject additional targets without evicting protection, and treat corrupt or over-limit mandatory storage as an explicit error. Repeat bounded marker batches with a per-session rotating cursor so queue pressure cannot indefinitely starve later markers. Exclude retired claims and cached hints from history-derived discovery without preventing a fresh authenticated device from returning. Expose Agent::forget_node through the shared local control API. CLI command tsng network forget-node accepts exact network names, full ids or unique id prefixes, and exact node hostnames, ids, prefixes or overlay IPv4 addresses. Ambiguous selections change nothing. Recheck the observed version and refuse self, online nodes, the selected exit node and absent or changed claims. Add Forget with an identity confirmation to offline tray device rows. Widen Show devices to 1440x640 with an 800x400 minimum to fit its contents. Control ALPN/version advances to tsunagi/ctrl/7 and local IPC to 21; upgrade all peers and restart the agent with matching CLI/tray clients. Data ALPN 5, network identity derivation, handshake encoding and existing record signing bytes remain unchanged. SQLite schema 9 adds retirement storage while retaining identity, secrets, settings and signed claims. Document behavior and limits. Validation on Linux through nix develop: - cargo fmt --all -- --check - cargo clippy --locked --workspace --all-targets -- -D warnings - cargo test --locked --workspace --all-targets: 519 passed, 2 existing ignored tests; inherited TSUNAGI_CONTROL_SOCKET and TSUNAGI_CONTROL_GROUP were unset - git diff --check and the built CLI forget-node help Tests use real iroh authentication and SQLite. Cover restart, stale-replica recovery, equal rights and network isolation, hostname reuse and return, twelve marker batches through a two-message queue, malformed signatures and proofs, invented future cutoffs, deterministic merge, capacity, migration and injected counter-write rollback, selectors and cleanup through two real CLI processes. Earlier iterations caught a private test API, a collapsible tray conditional and a crash-based CLI test waiting for QUIC's idle timeout; corrected before the final successful suite. Manual tray rendering, macOS/Windows, privileged TUNs and public-network traversal were not run. The requested RC tag is v0.1.0-rc.31; no push was requested.
11 KiB
tsunagi
A mesh VPN with no server.
Pick a network name, share a secret, and your machines are on one private network.
laptop$ tsng join -n home
joined `home`
secret tsn1u7c…
server$ tsng join -n home -s tsn1u7c…
server$ tsng id hostname server
laptop$ ssh server.home
No account, no coordination server, no admin console, no keys to approve. Anyone who knows the name and the secret is in. Nobody else can find the network, let alone enter it.
Why
Tailscale, Headscale and ZeroTier are great, but each needs a control server: theirs, or one you have to run and keep alive. tsunagi doesn't. Machines find each other through the public BitTorrent DHT, connect directly (hole punching, with relay fallback), and keep the network state among themselves.
| Tailscale | Headscale | ZeroTier | tsunagi | |
|---|---|---|---|---|
| Control server | hosted by vendor | you run it | hosted or self-run | none |
| Account / sign-in | yes | yes | yes | no |
| To join a network | sign in, get approved | pre-auth key | network ID, approval | name + secret |
| Direct connections | yes | yes | yes | yes |
| Exit nodes | yes | yes | via routes | yes |
Features
- Two things to know: a network name and a secret. A secret is generated for you when you make a network.
- Direct, encrypted links between members (WireGuard cryptography), with relay fallback behind strict NATs.
- Names for machines:
server.homejust works, even whileserveris switched off. A name belongs to whoever claimed it first; a later device with the same name keeps working by address and is told so. - Exit nodes: send all your internet traffic through any member that offers one.
- Multi-hop: members that can't reach each other directly are routed through a member that can, over whatever kind of link each hop has. A member reached that way is online, and shown as relayed; traffic moves to a direct link by itself the moment one comes up.
- LAN games: UDP broadcasts are relayed, so "LAN" lobbies show up across the mesh.
- Several networks at once on one device.
- Tray app for Windows, macOS and Linux; a command line for everything.
Install
Grab a build from the latest release.
| Platform | How |
|---|---|
| Windows | Run tsunagi-setup-<version>-x86_64.exe. Installs the service, the tray and tsng. |
| macOS | brew tap house-of-vanity/tap && brew install --cask tsunagi-guiCLI only: brew install tsunagi |
| Debian / Ubuntu | sudo apt install ./tsunagi-gui_<version>_amd64.deb (tsunagi_… for no tray) |
| Arch | sudo pacman -U tsunagi-gui-<version>-1-x86_64.pkg.tar.zst |
| NixOS | Flake and module below |
| Any other Linux | Unpack the tarball, then sudo ./install.sh && sudo systemctl enable --now tsunagi |
Linux packages run the agent as an unprivileged service user. Add yourself to
the tsunagi group (sudo usermod -aG tsunagi $USER, then log in again) to
use tsng and the tray without sudo.
Quick start
tsng join -n home # first machine: makes the network and prints a secret
tsng join -n home -s tsn1… # every other machine
tsng status # who is online, over which path
Every new network gets a stable pseudorandom /24 in 10.0.0.0/8, derived
from its network id. Its members agree on that range even when starting offline,
and each gets a name like <host>.home. Existing signed ranges are preserved.
If two configured networks have overlapping ranges, the agent runs only one.
tsng status, tsng network and the tray show which network blocks the
other. tsng network start <name-or-id> or the tray’s “Switch to this network”
button suspends the conflicting networks. They resume automatically when the
selected network stops; the selection survives restarting the agent. Explicitly
stopping a suspended network cancels its automatic resume.
Machines are called tsunagi-<id> until you rename them: tsng id hostname laptop.
Exit nodes
tsng network exit-node home on # on the machine that should be the exit
tsng exit-node # on another one: who offers an exit
tsng exit-node laptop # send everything through it
tsng exit-node off
The tray does the same with a checkbox. An exit node sees everything you send through it, so use only members you trust. Details and per-OS notes.
The default data transport order is wg,awg,wg-quic,tcp-tls. AWG negotiates a
fresh masking profile and outer keys for each pair connection attempt, including
reentry after fallback. Sustained data loss triggers switching independently of
the iroh control connection. Configuration and limits.
Change a network's protocol selection without editing its service or restarting:
tsng protocols # available protocols and settings
tsng protocols home # this device's choice for home
tsng protocols home awg,wg-quic # prefer AWG, retain QUIC as fallback
tsng protocols home none # control plane only
Exact network names, full ids and unique id prefixes work here. The choice is
local to this device, saved per network and applied immediately; an offline
change applies on the next start. In the tray, expand protocols on a network
tile to toggle protocols or change their preference order. Both endpoints need
a common protocol at the same wire version. tsng up --protocol supplies the
initial defaults for networks without a saved choice; it does not restrict
which built-in protocols can be enabled later.
Remove an obsolete offline device from a network's shared history:
tsng network forget-node home old-laptop
tsng network forget-node home 10.13.37.143
Networks accept exact names, full ids or unique id prefixes; nodes accept those id selectors, exact hostnames or overlay IPv4 addresses. Ambiguous selectors change nothing. Start the network first if it is stopped. In Show devices, click Forget beside an offline node and confirm its identity.
Every member has the same cleanup right. The signed cleanup frees the observed claim's name and IPv4 reservation, survives restarts and reaches offline replicas when they reconnect. It does not ban the device: a newer signed claim can return. Online nodes and the currently selected exit node cannot be forgotten. State and limits.
Platforms
| Platform | Build | CLI tsng |
Tray | Exit node: offer / use | Packages |
|---|---|---|---|---|---|
| Linux x86_64 | release | ✔ | ✔ | ✔ / ✔ | .deb, .pkg.tar.zst, tarball, Nix |
| Linux aarch64 | release | ✔ | –¹ | ✔ / ✔ | .deb, .pkg.tar.zst, tarball, Nix |
| Linux armv7 | release | ✔ | –¹ | ✔ / ✔ | .deb, .pkg.tar.zst, tarball |
| macOS, Apple silicon | release | ✔ | ✔ | ✔ / ✔² | Homebrew, tarball |
| macOS, Intel | from source | ✔³ | ✔³ | ✔ / ✔²³ | – |
| Windows x86_64 | release | ✔ | ✔ | ✔ / ✔² | installer, zip |
¹ Not in the release; builds from source (and through Nix). ² Newer and less battle-tested than on Linux. ³ Builds from source, not covered by CI.
The Linux CLI is a single static binary: it runs on any distribution.
NixOS
The repository is a flake with a package and a module.
# flake.nix
{
inputs.tsunagi.url = "github:house-of-vanity/tsunagi";
outputs = { nixpkgs, tsunagi, ... }: {
nixosConfigurations.myhost = nixpkgs.lib.nixosSystem {
modules = [
tsunagi.nixosModules.default
{
services.tsunagi = {
enable = true;
tray.enable = true; # optional, for desktops
users = [ "alice" ]; # may use tsng and the tray without sudo
};
}
];
};
};
}
Just trying it: nix run github:house-of-vanity/tsunagi#tsunagi-cli -- --help.
packages.<system>.tsunagi (with the tray) and tsunagi-cli are also exported,
along with overlays.default.
Build from source
Rust 1.91 or newer.
cargo build --release --bin tsng # the agent and CLI
cargo build --release --bin tsunagi-tray # the tray (Linux needs GTK 3 and libayatana-appindicator)
Windows needs Wintun next to tsng.exe.
Per-platform notes: Linux, Arch,
macOS, Windows.
How it works
- Your name and secret derive a network identity. Members publish signed contact records to the public Mainline DHT under it, and find each other there.
- Every connection proves knowledge of the secret before it's accepted. Traffic between members is end-to-end encrypted, relays included.
- Addresses and names are claimed with each device's own key and replicated between members. There is no one in charge, so nothing to be taken down.
The secret is the only key, so make it a good one (the generated ones are). The threat model says what this does and doesn't protect against.
Documentation
Architecture · Protocol · WireGuard data plane · Pairwise Amnezia transport · Routing · Exit nodes · Threat model · Contributing
Licence
WTFPL: do what the fuck you want to.