Compare commits
26
Commits
No files matched your search
@@ -36,6 +36,7 @@ jobs:
|
||||
deb: true
|
||||
deb_arch: amd64
|
||||
pkg_arch: x86_64
|
||||
gnu_target: x86_64-unknown-linux-gnu
|
||||
- os: ubuntu-latest
|
||||
target: aarch64-unknown-linux-musl
|
||||
asset: tsunagi-linux-aarch64
|
||||
@@ -44,6 +45,16 @@ jobs:
|
||||
deb: true
|
||||
deb_arch: arm64
|
||||
pkg_arch: aarch64
|
||||
# 32-bit ARM with hardware float (ARMv7, `v7l`): single-board and edge
|
||||
# devices. Statically linked like the others.
|
||||
- os: ubuntu-latest
|
||||
target: armv7-unknown-linux-musleabihf
|
||||
asset: tsunagi-linux-armv7
|
||||
archive: tar.gz
|
||||
zig: true
|
||||
deb: true
|
||||
deb_arch: armhf
|
||||
pkg_arch: armv7h
|
||||
- os: macos-latest
|
||||
target: aarch64-apple-darwin
|
||||
asset: tsunagi-macos-aarch64
|
||||
@@ -97,9 +108,33 @@ jobs:
|
||||
# one lint to keep the musl build log clean. A real link error still
|
||||
# fails the build.
|
||||
export RUSTFLAGS="${RUSTFLAGS:-} -A linker_messages"
|
||||
cargo zigbuild --release --locked --target "${{ matrix.target }}" --bin tsunagi
|
||||
cargo zigbuild --release --locked --target "${{ matrix.target }}" --bin tsng
|
||||
else
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsunagi
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsng
|
||||
fi
|
||||
|
||||
# The tray GUI. On Linux it is built against glibc (an old baseline for
|
||||
# portability), not musl: a GUI must dlopen libGL/X11/Wayland at runtime,
|
||||
# which a static musl binary cannot. macOS and Windows build it natively.
|
||||
- name: Build the tray GUI
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [[ "${{ runner.os }}" == "Linux" ]]; then
|
||||
if [[ -n "${{ matrix.gnu_target }}" ]]; then
|
||||
# tray-icon links GTK and libappindicator through pkg-config, which
|
||||
# has no cross story under zig, so the Linux GUI is built natively
|
||||
# (x86_64 only) against the runner's glibc.
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y --no-install-recommends \
|
||||
libgtk-3-dev libayatana-appindicator3-dev libxdo-dev
|
||||
cargo build --release --locked \
|
||||
--target "${{ matrix.gnu_target }}" --bin tsunagi-tray
|
||||
else
|
||||
echo "no GUI build for ${{ matrix.target }}"
|
||||
fi
|
||||
else
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsunagi-tray
|
||||
fi
|
||||
|
||||
- name: Package
|
||||
@@ -111,10 +146,21 @@ jobs:
|
||||
stage="dist/pkg/${{ matrix.asset }}"
|
||||
mkdir -p "$stage"
|
||||
|
||||
bin="tsunagi"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && bin="tsunagi.exe"
|
||||
bin="tsng"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && bin="tsng.exe"
|
||||
cp "target/${{ matrix.target }}/release/${bin}" "$stage/"
|
||||
|
||||
# The tray GUI alongside it, where it was built (Linux: x86_64 only).
|
||||
tray="tsunagi-tray"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && tray="tsunagi-tray.exe"
|
||||
if [[ "${{ runner.os }}" == "Linux" ]]; then
|
||||
if [[ -n "${{ matrix.gnu_target }}" ]]; then
|
||||
cp "target/${{ matrix.gnu_target }}/release/${tray}" "$stage/"
|
||||
fi
|
||||
else
|
||||
cp "target/${{ matrix.target }}/release/${tray}" "$stage/"
|
||||
fi
|
||||
|
||||
# The top-level README, plus the per-OS install notes and integration
|
||||
# files, so the archive carries what the platform needs to set up.
|
||||
cp README.md "$stage/"
|
||||
@@ -150,7 +196,7 @@ jobs:
|
||||
set -euo pipefail
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
bash dist/deb/build-deb.sh \
|
||||
"target/${{ matrix.target }}/release/tsunagi" \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.deb_arch }}" \
|
||||
"$version" \
|
||||
"tsunagi_${version}_${{ matrix.deb_arch }}.deb"
|
||||
@@ -166,11 +212,30 @@ jobs:
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
pkgver="${version//-/_}"
|
||||
bash dist/arch/build-pkg.sh \
|
||||
"target/${{ matrix.target }}/release/tsunagi" \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.pkg_arch }}" \
|
||||
"$version" \
|
||||
"tsunagi-${pkgver}-1-${{ matrix.pkg_arch }}.pkg.tar.zst"
|
||||
|
||||
# The GUI variants: the same agent plus the tray binary and a desktop
|
||||
# launcher, named tsunagi-gui (conflicting with the headless packages).
|
||||
- name: Build the GUI packages
|
||||
if: matrix.gnu_target
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
pkgver="${version//-/_}"
|
||||
tray="target/${{ matrix.gnu_target }}/release/tsunagi-tray"
|
||||
bash dist/deb/build-deb.sh \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.deb_arch }}" "$version" \
|
||||
"tsunagi-gui_${version}_${{ matrix.deb_arch }}.deb" "$tray"
|
||||
bash dist/arch/build-pkg.sh \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.pkg_arch }}" "$version" \
|
||||
"tsunagi-gui-${pkgver}-1-${{ matrix.pkg_arch }}.pkg.tar.zst" "$tray"
|
||||
|
||||
# @v3 on purpose: Gitea does not support the v4 artifact backend. This is
|
||||
# what makes the archive (and the .deb, where built) show up under the run
|
||||
# and hands it to `publish`.
|
||||
|
||||
@@ -2,13 +2,14 @@ name: Release
|
||||
|
||||
# GitHub version of the release pipeline. The build half mirrors the Gitea one
|
||||
# in .gitea/workflows/release.yml (static musl Linux via cargo-zigbuild, native
|
||||
# macOS and Windows); only the publish half differs: GitHub needs the v4
|
||||
# artifact backend and fills the release with `gh`.
|
||||
# macOS and Windows); only the publish half differs: it uses the current
|
||||
# artifact actions (Node 24) and fills the release with `gh`.
|
||||
#
|
||||
# Every job is gated on `github.server_url == 'https://github.com'`, so this file
|
||||
# runs only on GitHub. Gitea runs its own copy in .gitea/workflows; should a
|
||||
# Gitea instance also read .github/workflows, the guard skips these jobs there
|
||||
# so they never fail on the @v4 artifact backend or `gh`.
|
||||
# runs only on GitHub. Gitea runs its own copy in .gitea/workflows (which pins
|
||||
# the older @v3 artifact actions it supports); should a Gitea instance also read
|
||||
# .github/workflows, the guard skips these jobs there so they never fail on the
|
||||
# artifact backend or `gh`.
|
||||
on:
|
||||
push:
|
||||
tags: ["v*"]
|
||||
@@ -37,6 +38,7 @@ jobs:
|
||||
deb: true
|
||||
deb_arch: amd64
|
||||
pkg_arch: x86_64
|
||||
gnu_target: x86_64-unknown-linux-gnu
|
||||
- os: ubuntu-latest
|
||||
target: aarch64-unknown-linux-musl
|
||||
asset: tsunagi-linux-aarch64
|
||||
@@ -45,6 +47,16 @@ jobs:
|
||||
deb: true
|
||||
deb_arch: arm64
|
||||
pkg_arch: aarch64
|
||||
# 32-bit ARM with hardware float (ARMv7, `v7l`): single-board and edge
|
||||
# devices. Statically linked like the others.
|
||||
- os: ubuntu-latest
|
||||
target: armv7-unknown-linux-musleabihf
|
||||
asset: tsunagi-linux-armv7
|
||||
archive: tar.gz
|
||||
zig: true
|
||||
deb: true
|
||||
deb_arch: armhf
|
||||
pkg_arch: armv7h
|
||||
- os: macos-latest
|
||||
target: aarch64-apple-darwin
|
||||
asset: tsunagi-macos-aarch64
|
||||
@@ -57,7 +69,7 @@ jobs:
|
||||
zig: false
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v5
|
||||
|
||||
- uses: dtolnay/rust-toolchain@stable
|
||||
with:
|
||||
@@ -98,9 +110,33 @@ jobs:
|
||||
# one lint to keep the musl build log clean. A real link error still
|
||||
# fails the build.
|
||||
export RUSTFLAGS="${RUSTFLAGS:-} -A linker_messages"
|
||||
cargo zigbuild --release --locked --target "${{ matrix.target }}" --bin tsunagi
|
||||
cargo zigbuild --release --locked --target "${{ matrix.target }}" --bin tsng
|
||||
else
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsunagi
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsng
|
||||
fi
|
||||
|
||||
# The tray GUI. On Linux it is built against glibc (an old baseline for
|
||||
# portability), not musl: a GUI must dlopen libGL/X11/Wayland at runtime,
|
||||
# which a static musl binary cannot. macOS and Windows build it natively.
|
||||
- name: Build the tray GUI
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if [[ "${{ runner.os }}" == "Linux" ]]; then
|
||||
if [[ -n "${{ matrix.gnu_target }}" ]]; then
|
||||
# tray-icon links GTK and libappindicator through pkg-config, which
|
||||
# has no cross story under zig, so the Linux GUI is built natively
|
||||
# (x86_64 only) against the runner's glibc.
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y --no-install-recommends \
|
||||
libgtk-3-dev libayatana-appindicator3-dev libxdo-dev
|
||||
cargo build --release --locked \
|
||||
--target "${{ matrix.gnu_target }}" --bin tsunagi-tray
|
||||
else
|
||||
echo "no GUI build for ${{ matrix.target }}"
|
||||
fi
|
||||
else
|
||||
cargo build --release --locked --target "${{ matrix.target }}" --bin tsunagi-tray
|
||||
fi
|
||||
|
||||
- name: Package
|
||||
@@ -112,10 +148,21 @@ jobs:
|
||||
stage="dist/pkg/${{ matrix.asset }}"
|
||||
mkdir -p "$stage"
|
||||
|
||||
bin="tsunagi"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && bin="tsunagi.exe"
|
||||
bin="tsng"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && bin="tsng.exe"
|
||||
cp "target/${{ matrix.target }}/release/${bin}" "$stage/"
|
||||
|
||||
# The tray GUI alongside it, where it was built (Linux: x86_64 only).
|
||||
tray="tsunagi-tray"
|
||||
[[ "${{ runner.os }}" == "Windows" ]] && tray="tsunagi-tray.exe"
|
||||
if [[ "${{ runner.os }}" == "Linux" ]]; then
|
||||
if [[ -n "${{ matrix.gnu_target }}" ]]; then
|
||||
cp "target/${{ matrix.gnu_target }}/release/${tray}" "$stage/"
|
||||
fi
|
||||
else
|
||||
cp "target/${{ matrix.target }}/release/${tray}" "$stage/"
|
||||
fi
|
||||
|
||||
# The top-level README, plus the per-OS install notes and integration
|
||||
# files, so the archive carries what the platform needs to set up.
|
||||
cp README.md "$stage/"
|
||||
@@ -151,7 +198,7 @@ jobs:
|
||||
set -euo pipefail
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
bash dist/deb/build-deb.sh \
|
||||
"target/${{ matrix.target }}/release/tsunagi" \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.deb_arch }}" \
|
||||
"$version" \
|
||||
"tsunagi_${version}_${{ matrix.deb_arch }}.deb"
|
||||
@@ -167,13 +214,32 @@ jobs:
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
pkgver="${version//-/_}"
|
||||
bash dist/arch/build-pkg.sh \
|
||||
"target/${{ matrix.target }}/release/tsunagi" \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.pkg_arch }}" \
|
||||
"$version" \
|
||||
"tsunagi-${pkgver}-1-${{ matrix.pkg_arch }}.pkg.tar.zst"
|
||||
|
||||
# The GUI variants: the same agent plus the tray binary and a desktop
|
||||
# launcher, named tsunagi-gui (conflicting with the headless packages).
|
||||
- name: Build the GUI packages
|
||||
if: matrix.gnu_target
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
version="${GITHUB_REF_NAME#v}"
|
||||
pkgver="${version//-/_}"
|
||||
tray="target/${{ matrix.gnu_target }}/release/tsunagi-tray"
|
||||
bash dist/deb/build-deb.sh \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.deb_arch }}" "$version" \
|
||||
"tsunagi-gui_${version}_${{ matrix.deb_arch }}.deb" "$tray"
|
||||
bash dist/arch/build-pkg.sh \
|
||||
"target/${{ matrix.target }}/release/tsng" \
|
||||
"${{ matrix.pkg_arch }}" "$version" \
|
||||
"tsunagi-gui-${pkgver}-1-${{ matrix.pkg_arch }}.pkg.tar.zst" "$tray"
|
||||
|
||||
- name: Upload the build outputs as run artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
uses: actions/upload-artifact@v7
|
||||
with:
|
||||
name: ${{ matrix.asset }}
|
||||
path: |
|
||||
@@ -191,7 +257,7 @@ jobs:
|
||||
contents: write
|
||||
steps:
|
||||
- name: Download every build artifact
|
||||
uses: actions/download-artifact@v4
|
||||
uses: actions/download-artifact@v8
|
||||
with:
|
||||
path: artifacts
|
||||
|
||||
@@ -206,7 +272,7 @@ jobs:
|
||||
run: |
|
||||
set -euo pipefail
|
||||
|
||||
# download-artifact@v4 nests each artifact under its own directory, so
|
||||
# download-artifact nests each artifact under its own directory, so
|
||||
# the archives are artifacts/<asset>/<file>.
|
||||
mapfile -t files < <(find artifacts -type f \( -name '*.tar.gz' -o -name '*.zip' -o -name '*.deb' -o -name '*.pkg.tar.zst' \))
|
||||
printf 'asset: %s\n' "${files[@]}"
|
||||
|
||||
@@ -30,7 +30,7 @@ scripts when improving the interactive workflow.
|
||||
Keep these separate. Crossing them is the main thing to review for.
|
||||
|
||||
- **Control plane vs data plane.** The separation is **logical, not physical**.
|
||||
The control protocol in `crates/tsunagi/src/proto/` knows nothing about
|
||||
The control protocol in `crates/tsunagi-core/src/proto/` knows nothing about
|
||||
packets, and a protocol crate knows nothing about the control protocol;
|
||||
either can be replaced on its own. Both may ride on iroh — refusing to
|
||||
would throw away iroh's NAT traversal and force the data plane to
|
||||
@@ -70,9 +70,9 @@ Keep these separate. Crossing them is the main thing to review for.
|
||||
ownership checks or add broadcast flooding to encrypted transit.
|
||||
- **Plugins never learn reachability.** An `IpPlugin` is handed a `PacketLink`
|
||||
per peer and moves datagrams over it. Addresses, hole punching and relays
|
||||
belong to `crates/tsunagi/src/dataplane/transport/`. A plugin announcement says *who*, never
|
||||
belong to `crates/tsunagi-core/src/dataplane/transport/`. A plugin announcement says *who*, never
|
||||
*where*.
|
||||
- **The core never parses a plugin payload.** See `crates/tsunagi/src/dataplane/mod.rs`. Only
|
||||
- **The core never parses a plugin payload.** See `crates/tsunagi-core/src/dataplane/mod.rs`. Only
|
||||
`crates/tsunagi-wg-quic/src/announcement.rs` interprets `wg-quic` payloads, and
|
||||
only after bounding every field. A data plane failure must never stop the
|
||||
control plane.
|
||||
@@ -81,7 +81,7 @@ Keep these separate. Crossing them is the main thing to review for.
|
||||
inbound packets are dropped unless their source is the address derived for
|
||||
the peer that sent them. Never trust an address a peer announces.
|
||||
- **Signed state is the only durable agreement.** A fact that must survive a
|
||||
participant being away goes in `crates/tsunagi/src/state/` as a record signed by its
|
||||
participant being away goes in `crates/tsunagi-core/src/state/` as a record signed by its
|
||||
author, never in a session. Merging is deterministic, an older version never
|
||||
rolls back a newer one, and absence from a snapshot is not deletion. Never
|
||||
add a vote or a quorum: a majority is not a trust root here, and it would
|
||||
@@ -115,7 +115,7 @@ Keep these separate. Crossing them is the main thing to review for.
|
||||
normal path *and* the important failures. See [docs/testing.md](docs/testing.md).
|
||||
Do not add tests for getters or to move a coverage number.
|
||||
2. **Never change `IDENTITY_SCHEME`, the derivation labels, or the transcript
|
||||
encoding** in `crates/tsunagi/src/identity/network.rs` and `crates/tsunagi/src/proto/handshake.rs` without
|
||||
encoding** in `crates/tsunagi-core/src/identity/network.rs` and `crates/tsunagi-core/src/proto/handshake.rs` without
|
||||
treating it as an incompatible protocol change. Bumping the crate version or
|
||||
the control protocol version must not change an existing `NetworkId`.
|
||||
3. **Secrets never leak.** Not into logs, not into `Debug`, not into status
|
||||
@@ -126,7 +126,7 @@ Keep these separate. Crossing them is the main thing to review for.
|
||||
the library; tests opt out explicitly at the top of each file.
|
||||
5. **Bounds before allocation.** Frame lengths are checked against
|
||||
`Limits::max_frame_len` before a buffer is allocated. Every string, list and
|
||||
queue has a limit in `crates/tsunagi/src/config.rs`.
|
||||
queue has a limit in `crates/tsunagi-core/src/config.rs`.
|
||||
6. **Failure is contained.** A bad signature, wrong secret, malformed packet or
|
||||
unknown version rejects one message or one session. It never stops another
|
||||
network and never stops the agent. There is no irreversible global error
|
||||
@@ -150,18 +150,18 @@ Keep these separate. Crossing them is the main thing to review for.
|
||||
|
||||
| path | responsibility |
|
||||
|---------------------|----------------|
|
||||
| `crates/tsunagi/src/identity/` | device identity; deterministic network space identity and derived keys |
|
||||
| `crates/tsunagi/src/storage/` | `state.sqlite`, `cache.sqlite`, directory ownership lock |
|
||||
| `crates/tsunagi/src/discovery.rs` | candidate sources; test and static backends |
|
||||
| `crates/tsunagi/src/proto/` | framing, message formats, membership handshake |
|
||||
| `crates/tsunagi/src/net.rs` | iroh endpoint adapter and observability snapshots |
|
||||
| `crates/tsunagi/src/agent/` | agent lifecycle, per-network runtimes, sessions, events, status |
|
||||
| `crates/tsunagi/src/state/` | signed records that outlive a session, their merge rules and address allocation |
|
||||
| `crates/tsunagi/src/overlay/` | the one interface an agent owns: provisioning, the TUN, routing, source checks, broadcast host rules |
|
||||
| `crates/tsunagi/src/dataplane/` | the protocol contract and the authenticated packet transport |
|
||||
| `crates/tsunagi/src/dns/` | the DNS view of a network: zone, server, resolver publication |
|
||||
| `crates/tsunagi-core/src/identity/` | device identity; deterministic network space identity and derived keys |
|
||||
| `crates/tsunagi-core/src/storage/` | `state.sqlite`, `cache.sqlite`, directory ownership lock |
|
||||
| `crates/tsunagi-core/src/discovery.rs` | candidate sources; test and static backends |
|
||||
| `crates/tsunagi-core/src/proto/` | framing, message formats, membership handshake |
|
||||
| `crates/tsunagi-core/src/net.rs` | iroh endpoint adapter and observability snapshots |
|
||||
| `crates/tsunagi-core/src/agent/` | agent lifecycle, per-network runtimes, sessions, events, status |
|
||||
| `crates/tsunagi-core/src/state/` | signed records that outlive a session, their merge rules and address allocation |
|
||||
| `crates/tsunagi-core/src/overlay/` | the one interface an agent owns: provisioning, the TUN, routing, source checks, broadcast host rules |
|
||||
| `crates/tsunagi-core/src/dataplane/` | the protocol contract and the authenticated packet transport |
|
||||
| `crates/tsunagi-core/src/dns/` | the DNS view of a network: zone, server, resolver publication |
|
||||
| `crates/tsunagi-wg-quic/` | the `wg-quic` protocol: its keys, its announcement, its tunnels |
|
||||
| `crates/tsunagi-cli/` | the command line agent; the only place that owns a runtime, a logger and signals |
|
||||
| `crates/tsunagi/` | the command line agent, built as `tsng`; the only place that owns a runtime, a logger and signals |
|
||||
| `tests/` | integration tests; `tests/common/` is the shared harness |
|
||||
|
||||
Add abstractions only at real substitution or testing boundaries. Do not add a
|
||||
|
||||
Generated
+2764
-113
File diff suppressed because it is too large.
Load diff
+2
-2
@@ -14,8 +14,8 @@ mainline = { path = "vendor/mainline" }
|
||||
[workspace.package]
|
||||
edition = "2024"
|
||||
rust-version = "1.91"
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://github.com/tsunagi-net/tsunagi"
|
||||
license = "WTFPL"
|
||||
repository = "https://github.com/house-of-vanity/tsunagi"
|
||||
|
||||
[workspace.lints.rust]
|
||||
missing_docs = "warn"
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||
Version 2, December 2004
|
||||
|
||||
Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim or modified
|
||||
copies of this license document, and changing it is allowed as long
|
||||
as the name is changed.
|
||||
|
||||
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. You just DO WHAT THE FUCK YOU WANT TO.
|
||||
@@ -36,7 +36,7 @@ A working library with **real iroh connections** and integration tests:
|
||||
overlay with deterministically derived addresses and optional IPv4, real
|
||||
tunnels carried over iroh, and address ownership enforced rather than
|
||||
believed;
|
||||
- a **command line agent**, `tsunagi`, with a local control socket.
|
||||
- a **command line agent**, `tsng`, with a local control socket.
|
||||
|
||||
### What it deliberately does **not** do
|
||||
|
||||
@@ -71,8 +71,8 @@ On the first machine:
|
||||
|
||||
```bash
|
||||
cargo build --release
|
||||
./target/release/tsunagi status # this device, the agent, and this host
|
||||
./target/release/tsunagi network # the networks this device belongs to
|
||||
./target/release/tsng status # this device, the agent, and this host
|
||||
./target/release/tsng network # the networks this device belongs to
|
||||
```
|
||||
|
||||
Two commands do the work, and they are separate on purpose: `up` runs the
|
||||
@@ -81,19 +81,19 @@ what it belongs to, at any time, while it runs.
|
||||
|
||||
```bash
|
||||
# Terminal one: the agent. It prints its endpoint id and then serves.
|
||||
./target/release/tsunagi up
|
||||
./target/release/tsng up
|
||||
|
||||
# Terminal two: make a network. With no --secret it invents one and prints
|
||||
# it, along with the line to send the other machine.
|
||||
./target/release/tsunagi join --network lab
|
||||
./target/release/tsng join --network lab
|
||||
```
|
||||
|
||||
On the second machine, start its agent and join the same network with the
|
||||
secret that was printed:
|
||||
|
||||
```bash
|
||||
./target/release/tsunagi up
|
||||
./target/release/tsunagi join --network lab --secret tsn1...
|
||||
./target/release/tsng up
|
||||
./target/release/tsng join --network lab --secret tsn1...
|
||||
```
|
||||
|
||||
**Name and secret are enough for the first meeting.** Mainline DHT discovery
|
||||
@@ -141,7 +141,7 @@ wg-quic: tsun0 on 10.13.37.69/24 mtu 1280, 1/1 tunnel(s) established
|
||||
From another shell on either machine:
|
||||
|
||||
```bash
|
||||
tsunagi status
|
||||
tsng status
|
||||
```
|
||||
|
||||
```text
|
||||
@@ -170,8 +170,8 @@ ping 100.65.243.53
|
||||
what they find, so `--ipv4-range` only matters for whoever starts the network:
|
||||
|
||||
```bash
|
||||
tsunagi up --ipv4-range 10.44.0.0/16
|
||||
tsunagi up --ipv4-range none # no data plane at all
|
||||
tsng up --ipv4-range 10.44.0.0/16
|
||||
tsng up --ipv4-range none # no data plane at all
|
||||
```
|
||||
|
||||
One agent has one interface, so two of its networks cannot both use that
|
||||
@@ -193,7 +193,7 @@ assigns it to the interface itself.
|
||||
|
||||
## Levels
|
||||
|
||||
The command line is split the way the design is. A bare `tsunagi up` needs
|
||||
The command line is split the way the design is. A bare `tsng up` needs
|
||||
only a network name and a secret; everything else sits under the level it
|
||||
belongs to, which `--help` shows as two sections:
|
||||
|
||||
@@ -204,7 +204,7 @@ belongs to, which `--help` shows as two sections:
|
||||
their own settings (`-o key=value`, or `-o protocol:key=value`).
|
||||
|
||||
```bash
|
||||
tsunagi protocols # what this build can carry packets with
|
||||
tsng protocols # what this build can carry packets with
|
||||
```
|
||||
|
||||
```text
|
||||
@@ -223,7 +223,7 @@ A pair of peers uses a protocol they both have **at the same wire version**.
|
||||
That is not the software version: two peers on different builds carry traffic
|
||||
for each other for as long as the bytes between them have not changed. A peer
|
||||
with nothing in common keeps its control plane — messages and signed state
|
||||
still flow — and simply has no data plane, which `tsunagi status` shows as a
|
||||
still flow — and simply has no data plane, which `tsng status` shows as a
|
||||
session with no agreed protocol.
|
||||
|
||||
## Names
|
||||
@@ -233,12 +233,12 @@ each named after the network, so members can be reached by name instead of
|
||||
by address:
|
||||
|
||||
```bash
|
||||
tsunagi up # DNS is already enabled
|
||||
tsng up # DNS is already enabled
|
||||
dig @127.0.0.1 -p 5354 music.lab
|
||||
```
|
||||
|
||||
An explicit choice is remembered across restarts. `--no-dns` or `tsunagi dns off`
|
||||
disables it; `--dns` or `tsunagi dns on` enables it again. Existing saved opt-outs
|
||||
An explicit choice is remembered across restarts. `--no-dns` or `tsng dns off`
|
||||
disables it; `--dns` or `tsng dns on` enables it again. Existing saved opt-outs
|
||||
remain respected. The `dns on` and `dns off` commands also take effect immediately
|
||||
on a running agent. `--dns` and `--no-dns` cannot be combined.
|
||||
|
||||
@@ -299,7 +299,7 @@ polkit.addRule(function(action, subject) {
|
||||
RULE
|
||||
```
|
||||
|
||||
**Without it the server still runs** — `tsunagi status` prints where it is
|
||||
**Without it the server still runs** — `tsng status` prints where it is
|
||||
listening and the exact `dig` line — so the automatic part is missing, not
|
||||
the feature. The refusal is said once rather than on every pass, and retried
|
||||
slowly, because nothing but a person will change it.
|
||||
@@ -318,7 +318,7 @@ remote peer could influence.
|
||||
That needs `CAP_NET_ADMIN`, granted once:
|
||||
|
||||
```bash
|
||||
sudo setcap cap_net_admin+p /usr/local/bin/tsunagi
|
||||
sudo setcap cap_net_admin+p /usr/local/bin/tsng
|
||||
```
|
||||
|
||||
`+p` rather than `+ep`: the capability is then *permitted* but not
|
||||
@@ -328,7 +328,7 @@ allocation changes. Everything else, including every byte from the network,
|
||||
is handled with it lowered. `+ep` works too; the agent lowers it on the way
|
||||
in.
|
||||
|
||||
`tsunagi status` says which of these applies on the host it runs on, along
|
||||
`tsng status` says which of these applies on the host it runs on, along
|
||||
with what the agent is doing. It grades each finding: **ok** for what works,
|
||||
**warn** for what the agent runs without and you can fix from the line it
|
||||
prints, **FAIL** for what it cannot work around. The words carry the grade as
|
||||
@@ -353,28 +353,28 @@ Every item takes the same shape, so there is nothing to remember: name it to
|
||||
see it, name it with a value to change it.
|
||||
|
||||
```
|
||||
tsunagi id everything about this device
|
||||
tsunagi id hostname the name it answers to
|
||||
tsunagi id hostname mango change it
|
||||
tsunagi id key the key it signs with
|
||||
tsunagi id key rotate replace that key
|
||||
tsng id everything about this device
|
||||
tsng id hostname the name it answers to
|
||||
tsng id hostname mango change it
|
||||
tsng id key the key it signs with
|
||||
tsng id key rotate replace that key
|
||||
|
||||
tsunagi network the networks this device belongs to
|
||||
tsunagi network join -n lab -s tsn1… join one; adds it to a running agent
|
||||
tsunagi network join -n lab resume one this device has, or make it on the spot
|
||||
tsunagi network stop lab stop serving it, keeping everything
|
||||
tsunagi network start lab serve it again, from where it left off
|
||||
tsunagi network leave lab give up the address and name, then forget it
|
||||
tsunagi network secret the secret of each joined network
|
||||
tsunagi network secret lab just that one, for copying
|
||||
tsunagi network secret generate a fresh secret for a network that does not exist yet
|
||||
tsng network the networks this device belongs to
|
||||
tsng network join -n lab -s tsn1… join one; adds it to a running agent
|
||||
tsng network join -n lab resume one this device has, or make it on the spot
|
||||
tsng network stop lab stop serving it, keeping everything
|
||||
tsng network start lab serve it again, from where it left off
|
||||
tsng network leave lab give up the address and name, then forget it
|
||||
tsng network secret the secret of each joined network
|
||||
tsng network secret lab just that one, for copying
|
||||
tsng network secret generate a fresh secret for a network that does not exist yet
|
||||
|
||||
tsunagi dns whether the local resolver is serving, and what
|
||||
tsunagi dns on start it, now and after every restart
|
||||
tsunagi dns off stop it, now and after every restart
|
||||
tsng dns whether the local resolver is serving, and what
|
||||
tsng dns on start it, now and after every restart
|
||||
tsng dns off stop it, now and after every restart
|
||||
```
|
||||
|
||||
**A network without a secret makes one.** `tsunagi join --network lab`
|
||||
**A network without a secret makes one.** `tsng join --network lab`
|
||||
resolves a bare name in the obvious way: if this device is already in
|
||||
exactly one network called `lab`, that one — so the name alone resumes what
|
||||
you have; if it is in none, a fresh random secret, printed in full with the
|
||||
@@ -386,11 +386,11 @@ joined `lab` (k2on43wadbi5x267vp6z3ogkm7nbjedfdoxyauxhtxhwqrprylba)
|
||||
|
||||
Run this on the other machine:
|
||||
|
||||
tsunagi join --network lab --secret tsn1u7c…
|
||||
tsng join --network lab --secret tsn1u7c…
|
||||
|
||||
Its agent has to be running. If it is not:
|
||||
|
||||
tsunagi up --peer 91e83a6e2b7a…
|
||||
tsng up --peer 91e83a6e2b7a…
|
||||
```
|
||||
|
||||
Two networks of one name is a thing that happens — a mistyped secret makes
|
||||
@@ -410,11 +410,11 @@ Asking for it is deliberate, because these reports get pasted into chats.
|
||||
|
||||
**`up` takes no network at all** if you would rather decide later: it
|
||||
brings up the agent and whatever it is already configured for, and waits.
|
||||
That is the shape of a daemon in one terminal and `tsunagi network join`
|
||||
That is the shape of a daemon in one terminal and `tsng network join`
|
||||
in another.
|
||||
|
||||
`network join` is also the answer to a question `up` cannot: a state
|
||||
directory belongs to one live agent, so a second `tsunagi up` cannot add a
|
||||
directory belongs to one live agent, so a second `tsng up` cannot add a
|
||||
network to the one already running. This adds it over the control socket and
|
||||
it starts at once. With no agent running it is written to the configuration
|
||||
and starts with the next `up`.
|
||||
@@ -477,11 +477,11 @@ The original IP packet, including its DF bit, is preserved. See
|
||||
|---|---|---|
|
||||
| `setcap cap_net_admin+p` | ordinary user, one capability | recommended: nothing to prepare, nothing left behind. Lost on every rebuild or copy of the binary. |
|
||||
| systemd service | `User=`, `AmbientCapabilities=CAP_NET_ADMIN` | the same, for an installed service |
|
||||
| `sudo tsunagi up` | root | everything works, nothing is isolated |
|
||||
| `sudo tsng up` | root | everything works, nothing is isolated |
|
||||
| macOS root LaunchDaemon | root | the native macOS deployment; see below |
|
||||
| `--no-tun` | ordinary user, no capabilities | tunnels run and handshake, traffic never reaches the OS |
|
||||
|
||||
On Windows, put `wintun.dll` beside the executable and start `tsunagi up`
|
||||
On Windows, put `wintun.dll` beside the executable and start `tsng up`
|
||||
from PowerShell or Command Prompt opened with **Run as administrator**.
|
||||
Run commands controlling that agent (`join`, `status`, `dns`, `network`)
|
||||
as the same Windows user with the same elevation. If Windows denies access
|
||||
@@ -498,7 +498,7 @@ grant like Linux, and a `utun` plus `/etc/resolver` are root-only. The kernel
|
||||
assigns the interface its `utunN` name, so the name derived from the network id
|
||||
is only a request and the real one is adopted once the interface is up.
|
||||
|
||||
Run it as root — `sudo tsunagi up` for a quick start, or install it as a root
|
||||
Run it as root — `sudo tsng up` for a quick start, or install it as a root
|
||||
**LaunchDaemon** for the native always-on deployment. As a daemon the agent runs
|
||||
unprivileged commands (`join`, `status`, `dns`, `network`) over its control
|
||||
socket like any other platform; the socket lives at `/var/run/tsunagi/agent.sock`
|
||||
@@ -613,10 +613,10 @@ paths. It supports `255.255.255.255` and the overlay subnet's broadcast address;
|
||||
received broadcasts never trigger another fanout.
|
||||
|
||||
```sh
|
||||
tsunagi join -n games --no-broadcast
|
||||
tsunagi join -n games --broadcast
|
||||
tsunagi network broadcast games off
|
||||
tsunagi network broadcast games on
|
||||
tsng join -n games --no-broadcast
|
||||
tsng join -n games --broadcast
|
||||
tsng network broadcast games off
|
||||
tsng network broadcast games on
|
||||
```
|
||||
|
||||
The choice persists across restarts and a plain `join`. It can be changed while
|
||||
@@ -681,8 +681,8 @@ directories by default; `--state-dir` and `--cache-dir` override them.
|
||||
One state directory belongs to one live agent, enforced with a real OS file
|
||||
lock rather than an existence check. That directory *is* the identity: one
|
||||
agent, one device key, one interface, and as many networks as you like on it
|
||||
— `tsunagi network join` adds them to the agent that is already running,
|
||||
which is why a second `tsunagi up` on the same directory is refused rather
|
||||
— `tsng network join` adds them to the agent that is already running,
|
||||
which is why a second `tsng up` on the same directory is refused rather
|
||||
than made to work. A second agent on the same host is a second identity, and
|
||||
needs everything of its own: its own state and cache directories, its own
|
||||
interface name and its own overlay range. The library owns no globals, so
|
||||
@@ -693,9 +693,9 @@ several of them run side by side in one process as readily as in one host.
|
||||
Membership outlives a session, so it also has to be possible to end it.
|
||||
|
||||
```bash
|
||||
tsunagi network # what this device belongs to
|
||||
tsunagi network leave lab # give up the address and the name, then forget it
|
||||
tsunagi wipe --yes # remove everything and be a stranger again
|
||||
tsng network # what this device belongs to
|
||||
tsng network leave lab # give up the address and the name, then forget it
|
||||
tsng wipe --yes # remove everything and be a stranger again
|
||||
```
|
||||
|
||||
**Stopping is not leaving.** `stop` closes this network's sessions, takes
|
||||
@@ -746,6 +746,7 @@ networks first if the addresses should be freed.
|
||||
- [docs/protocol.md](docs/protocol.md) — identity derivation, framing, handshake.
|
||||
- [docs/sync-model.md](docs/sync-model.md) — the planned signed-state model and
|
||||
what is deliberately not built yet.
|
||||
- [docs/exit-node.md](docs/exit-node.md) — exit nodes: sending all traffic through a member.
|
||||
- [docs/threat-model.md](docs/threat-model.md) — threat model and known limits.
|
||||
- [docs/testing.md](docs/testing.md) — what the suite covers and what it does not.
|
||||
- [AGENTS.md](AGENTS.md) — rules for anyone (human or agent) changing this repo.
|
||||
@@ -763,4 +764,4 @@ any of this.
|
||||
|
||||
## Licence
|
||||
|
||||
MIT OR Apache-2.0.
|
||||
[WTFPL](LICENSE): do what the fuck you want to.
|
||||
@@ -1,42 +0,0 @@
|
||||
[package]
|
||||
name = "tsunagi-cli"
|
||||
version = "0.1.0"
|
||||
description = "The tsunagi command line agent."
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
[[bin]]
|
||||
name = "tsunagi"
|
||||
path = "src/main.rs"
|
||||
# The binary and the library share a name, which `cargo doc` cannot map to
|
||||
# two directories. The command line is documented by `--help`, not rustdoc,
|
||||
# so the library keeps the name and this opts out.
|
||||
doc = false
|
||||
|
||||
[dependencies]
|
||||
tsunagi = { path = "../tsunagi", version = "0.1.0", features = ["tun-device", "dns-publish"] }
|
||||
tsunagi-wireguard = { path = "../tsunagi-wireguard", version = "0.1.0" }
|
||||
tsunagi-wg-quic = { path = "../tsunagi-wg-quic", version = "0.1.0" }
|
||||
tsunagi-tcp-tls = { path = "../tsunagi-tcp-tls", version = "0.1.0" }
|
||||
iroh.workspace = true
|
||||
tokio = { version = "1.53", features = ["rt", "rt-multi-thread", "sync", "time", "macros", "signal"] }
|
||||
tracing.workspace = true
|
||||
tracing-subscriber.workspace = true
|
||||
clap = { version = "4.5", features = ["derive", "env"] }
|
||||
# Already in the tree through clap. `anstream` strips the escapes when stdout
|
||||
# is not a terminal and turns on virtual terminal processing on Windows, so
|
||||
# colour is never written where it would show up as rubbish.
|
||||
anstream = "1.0"
|
||||
anstyle = "1.0"
|
||||
# Local interface addresses, for the diagnostics in `status`.
|
||||
netwatch = "0.19.3"
|
||||
|
||||
[dev-dependencies]
|
||||
tokio = { version = "1.53", features = ["rt", "rt-multi-thread", "sync", "time", "macros", "process"] }
|
||||
tempfile.workspace = true
|
||||
simple-dns = "0.12"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
@@ -1,56 +0,0 @@
|
||||
//! What the command line says about this device, against a running agent.
|
||||
//!
|
||||
//! These drive the real binary, which is why they live beside it rather
|
||||
//! than with the library's own tests: the library cannot depend on a binary
|
||||
//! built from a crate that depends on it.
|
||||
|
||||
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
|
||||
|
||||
use tempfile::TempDir;
|
||||
use tsunagi::Agent;
|
||||
use tsunagi::config::{AgentConfig, StoragePaths, TransportPolicy};
|
||||
|
||||
/// Asking who this device is must not need the directory lock.
|
||||
///
|
||||
/// The lock belongs to the one agent allowed to *write* the state. `id` only
|
||||
/// reads, so making it take the lock would mean the question could never be
|
||||
/// answered while an agent was running — which is exactly when you want to
|
||||
/// ask it.
|
||||
#[tokio::test]
|
||||
async fn identity_can_be_read_while_an_agent_holds_the_directory() {
|
||||
let dir = TempDir::new().unwrap();
|
||||
|
||||
// Hold the directory the way a running agent does.
|
||||
let agent = Agent::spawn(
|
||||
AgentConfig::new(StoragePaths::under(dir.path()))
|
||||
.with_transport(TransportPolicy::LocalOnly)
|
||||
.with_loopback_bind(),
|
||||
)
|
||||
.await
|
||||
.unwrap();
|
||||
let expected = agent.endpoint_id().to_string();
|
||||
|
||||
let output = tokio::process::Command::new(env!("CARGO_BIN_EXE_tsunagi"))
|
||||
.arg("id")
|
||||
// The same layout `StoragePaths::under` gives the agent above.
|
||||
.arg("--state-dir")
|
||||
.arg(dir.path().join("state"))
|
||||
.arg("--cache-dir")
|
||||
.arg(dir.path().join("cache"))
|
||||
.output()
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let stdout = String::from_utf8_lossy(&output.stdout);
|
||||
let stderr = String::from_utf8_lossy(&output.stderr);
|
||||
assert!(
|
||||
output.status.success(),
|
||||
"`id` failed while an agent was running:\n{stderr}"
|
||||
);
|
||||
assert!(
|
||||
stdout.contains(&expected),
|
||||
"expected {expected} in:\n{stdout}"
|
||||
);
|
||||
|
||||
agent.shutdown().await;
|
||||
}
|
||||
@@ -0,0 +1,113 @@
|
||||
[package]
|
||||
name = "tsunagi-core"
|
||||
version = "0.1.0"
|
||||
description = "Small private mesh networks: persistent agent identity, deterministic network spaces, an iroh control plane, signed state and a local DNS view."
|
||||
readme = "../../README.md"
|
||||
keywords = ["mesh", "p2p", "iroh", "networking"]
|
||||
categories = ["network-programming"]
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
[lib]
|
||||
name = "tsunagi"
|
||||
|
||||
[features]
|
||||
default = []
|
||||
# A real TUN device, so a plugin can carry actual IP traffic. On Linux it
|
||||
# needs CAP_NET_ADMIN; on Windows the process must run elevated and
|
||||
# `wintun.dll` must be reachable. Without either the in-memory device serves
|
||||
# tests. The platform-specific dependencies are declared per target, so
|
||||
# enabling this only pulls what the target it is built for actually uses.
|
||||
tun-device = [
|
||||
"dep:tun",
|
||||
"dep:rtnetlink",
|
||||
"dep:caps",
|
||||
"dep:futures-util",
|
||||
]
|
||||
# Telling the operating system where to send its DNS questions. systemd-resolved
|
||||
# on Linux, the Name Resolution Policy Table on Windows; the zone and the
|
||||
# server work without it either way.
|
||||
dns-publish = ["dep:zbus"]
|
||||
# The test harness in `testing`, for this crate's own tests and for a
|
||||
# protocol crate's. Not on by default: it is only of use to a test.
|
||||
testing = ["dep:tempfile", "dep:tracing-subscriber"]
|
||||
|
||||
[dependencies]
|
||||
arc-swap = "1.9"
|
||||
iroh.workspace = true
|
||||
# `net` for the local control interface: a Unix socket on Unix, a named pipe
|
||||
# on Windows. Both live behind the same `net` feature.
|
||||
tokio = { workspace = true, features = ["net"] }
|
||||
tokio-stream = "0.1"
|
||||
serde.workspace = true
|
||||
postcard.workspace = true
|
||||
bytes.workspace = true
|
||||
thiserror.workspace = true
|
||||
tracing.workspace = true
|
||||
hex.workspace = true
|
||||
data-encoding.workspace = true
|
||||
rusqlite = { version = "0.40", features = ["bundled"] }
|
||||
hkdf = "0.13"
|
||||
hmac = "0.13"
|
||||
sha2 = "0.11"
|
||||
subtle = "2.6"
|
||||
zeroize = { version = "1.9", features = ["derive"] }
|
||||
rand = "0.10"
|
||||
# Already in the tree through iroh. A packet codec, not a DNS server: the
|
||||
# zone logic is ours and a full server framework would be a large dependency
|
||||
# for answering A records from memory.
|
||||
simple-dns = "0.12"
|
||||
# The IANA top-level domain list, compiled in: one function, no
|
||||
# dependencies, no network. Used only to warn that a zone name shadows a
|
||||
# real public domain, never to refuse one.
|
||||
tld = "2.40"
|
||||
fs4 = { version = "1.1", features = ["sync"] }
|
||||
directories = "6.0"
|
||||
# The real system hostname, without a libc call of our own: this crate is
|
||||
# forbidden `unsafe` and will not make one.
|
||||
gethostname = "1.1"
|
||||
netwatch = "0.19.3"
|
||||
netdev = "0.46"
|
||||
mainline = "8.0"
|
||||
futures-lite = "2.6"
|
||||
tun = { version = "0.8", features = ["async"], optional = true }
|
||||
# Only for the `testing` harness, which a protocol crate's tests use too.
|
||||
tempfile = { version = "3.24", optional = true }
|
||||
tracing-subscriber = { version = "0.3", features = ["env-filter"], optional = true }
|
||||
|
||||
# Linux-only interface provisioning. `rtnetlink` configures the interface in
|
||||
# process, so no `ip` invocation is ever needed; `caps` keeps CAP_NET_ADMIN
|
||||
# out of the effective set except during the moments it is used.
|
||||
[target.'cfg(target_os = "linux")'.dependencies]
|
||||
rtnetlink = { version = "0.23", optional = true }
|
||||
# Pure Rust D-Bus, no libdbus to link against. `tokio` rather than the
|
||||
# default reactor, because the agent brings its own.
|
||||
zbus = { version = "5.19", default-features = false, features = ["tokio"], optional = true }
|
||||
caps = { version = "0.5", optional = true }
|
||||
futures-util = { version = "0.3", default-features = false, optional = true }
|
||||
|
||||
# Windows-only interface provisioning. The Wintun adapter itself is created
|
||||
# and driven through the `tun` dependency, whose safe wrapper is the only way
|
||||
# in — loading `wintun.dll` is an `unsafe` call this crate forbids. `netdev`
|
||||
# (already in the tree through `netwatch`) reads the interface table through a
|
||||
# safe wrapper, which is how the provisioner observes an adapter by name
|
||||
# before deciding what to change. Creating an adapter needs the process to be
|
||||
# elevated and `wintun.dll` to be reachable at run time.
|
||||
[target.'cfg(target_os = "windows")'.dependencies]
|
||||
windows-sys = { version = "0.61", features = [
|
||||
"Win32_Security",
|
||||
"Win32_Security_Authorization",
|
||||
"Win32_Foundation",
|
||||
] }
|
||||
|
||||
[dev-dependencies]
|
||||
# Its own tests use the harness it publishes.
|
||||
tsunagi-core = { path = ".", features = ["testing"] }
|
||||
tokio = { version = "1.53", features = ["rt", "rt-multi-thread", "sync", "time", "macros", "process", "test-util"] }
|
||||
tempfile.workspace = true
|
||||
tracing-subscriber.workspace = true
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
File renamed without changes.
@@ -388,6 +388,7 @@ impl Agent {
|
||||
async fn reserve_range(&self, network: NetworkId) -> RangePlan {
|
||||
let reserve = |wanted: Ipv4Range| {
|
||||
let reservation = crate::overlay::NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some(wanted),
|
||||
local: None,
|
||||
@@ -581,7 +582,7 @@ impl Agent {
|
||||
"`{name}` is already configured with a different secret, as {}. \
|
||||
Joining with this one adds a second network under the same name; \
|
||||
they share nothing. Check the secret, or use \
|
||||
`tsunagi network secret` \
|
||||
`tsng network secret` \
|
||||
to see which is which.",
|
||||
other.network_id
|
||||
);
|
||||
@@ -603,6 +604,72 @@ impl Agent {
|
||||
}
|
||||
}
|
||||
|
||||
/// Offers this agent as an exit node in a network, or stops, now and
|
||||
/// after restart. Off unless somebody turns it on.
|
||||
pub async fn set_exit_offer(&self, network_id: NetworkId, enabled: bool) -> Result<()> {
|
||||
self.inner
|
||||
.storage
|
||||
.set_exit_node(network_id, enabled)
|
||||
.await?;
|
||||
if self.is_active(network_id).await {
|
||||
let (reply, receive) = oneshot::channel();
|
||||
self.command(network_id, NetCommand::SetExitOffer { enabled, reply })
|
||||
.await?;
|
||||
receive.await.map_err(|_| Error::Stopped)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Sends this device's internet traffic through a member of a network,
|
||||
/// or back the ordinary way with `None`.
|
||||
///
|
||||
/// A device has one default route, so choosing in one network clears the
|
||||
/// choice in the others. The member has to be connected and offering
|
||||
/// to be an exit node. Remembered across restarts.
|
||||
pub async fn set_exit_via(&self, network_id: NetworkId, via: Option<EndpointId>) -> Result<()> {
|
||||
let active = self.is_active(network_id).await;
|
||||
if via.is_some() && !active {
|
||||
return Err(Error::NetworkNotActive(network_id));
|
||||
}
|
||||
if active {
|
||||
let (reply, receive) = oneshot::channel();
|
||||
self.command(network_id, NetCommand::SetExitVia { via, reply })
|
||||
.await?;
|
||||
receive
|
||||
.await
|
||||
.map_err(|_| Error::Stopped)?
|
||||
.map_err(|reason| Error::Rejected { reason })?;
|
||||
}
|
||||
self.inner
|
||||
.storage
|
||||
.set_exit_via(network_id, via.map(|peer| *peer.as_bytes()))
|
||||
.await?;
|
||||
if via.is_some() {
|
||||
// One default route: whatever the other networks were doing, they
|
||||
// are not any more.
|
||||
let others: Vec<NetworkId> = self
|
||||
.inner
|
||||
.networks
|
||||
.read()
|
||||
.await
|
||||
.keys()
|
||||
.copied()
|
||||
.filter(|other| *other != network_id)
|
||||
.collect();
|
||||
for other in others {
|
||||
let (reply, receive) = oneshot::channel();
|
||||
if self
|
||||
.command(other, NetCommand::SetExitVia { via: None, reply })
|
||||
.await
|
||||
.is_ok()
|
||||
{
|
||||
let _ = receive.await;
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Changes a network's local broadcast policy now and after restart.
|
||||
pub async fn set_broadcast(&self, network_id: NetworkId, enabled: bool) -> Result<()> {
|
||||
self.inner
|
||||
@@ -662,16 +729,23 @@ impl Agent {
|
||||
as Arc<dyn crate::discovery::NetworkDiscovery>,
|
||||
)
|
||||
};
|
||||
let broadcast = self
|
||||
let stored = self
|
||||
.inner
|
||||
.storage
|
||||
.list_networks()
|
||||
.await?
|
||||
.into_iter()
|
||||
.find(|stored| stored.network_id == network_id)
|
||||
.is_none_or(|stored| stored.broadcast);
|
||||
.find(|stored| stored.network_id == network_id);
|
||||
let broadcast = stored.as_ref().is_none_or(|stored| stored.broadcast);
|
||||
let exit_offer = stored.as_ref().is_some_and(|stored| stored.exit_node);
|
||||
let exit_via = stored
|
||||
.as_ref()
|
||||
.and_then(|stored| stored.exit_via)
|
||||
.and_then(|bytes| EndpointId::from_bytes(&bytes).ok());
|
||||
let handle = network::spawn(RuntimeParams {
|
||||
broadcast,
|
||||
exit_offer,
|
||||
exit_via,
|
||||
keys,
|
||||
adapter: self.inner.adapter.clone(),
|
||||
storage: self.inner.storage.clone(),
|
||||
@@ -733,6 +807,7 @@ impl Agent {
|
||||
}
|
||||
if let Some(interface) = self.inner.interface.get() {
|
||||
interface.sync_broadcast_rules().await;
|
||||
interface.sync_exit_rules().await;
|
||||
}
|
||||
self.inner.storage.set_auto_start(network_id, false).await?;
|
||||
Ok(())
|
||||
@@ -886,6 +961,12 @@ impl Agent {
|
||||
let keys = NetworkKeys::derive(&stored.name, &stored.secret);
|
||||
networks.push(NetworkStatus {
|
||||
broadcast: stored.broadcast,
|
||||
exit_offer: stored.exit_node,
|
||||
exit_via: stored
|
||||
.exit_via
|
||||
.and_then(|bytes| EndpointId::from_bytes(&bytes).ok()),
|
||||
exit_via_online: false,
|
||||
exit_rules: Default::default(),
|
||||
descriptor: keys.descriptor(),
|
||||
name: stored.name,
|
||||
network_id: stored.network_id,
|
||||
@@ -66,6 +66,16 @@ pub(crate) enum NetCommand {
|
||||
enabled: bool,
|
||||
reply: oneshot::Sender<()>,
|
||||
},
|
||||
/// Offer this agent as an exit node in this network, or stop.
|
||||
SetExitOffer {
|
||||
enabled: bool,
|
||||
reply: oneshot::Sender<()>,
|
||||
},
|
||||
/// Send this device's internet traffic through a member, or stop.
|
||||
SetExitVia {
|
||||
via: Option<EndpointId>,
|
||||
reply: oneshot::Sender<std::result::Result<(), String>>,
|
||||
},
|
||||
/// Resend this agent's announcement to every peer of this network.
|
||||
Reannounce,
|
||||
/// Answer to a different name from now on.
|
||||
@@ -106,6 +116,8 @@ impl std::fmt::Debug for NetCommand {
|
||||
NetCommand::Status { .. } => f.write_str("Status"),
|
||||
NetCommand::Recheck => f.write_str("Recheck"),
|
||||
NetCommand::SetBroadcast { enabled, .. } => write!(f, "SetBroadcast({enabled})"),
|
||||
NetCommand::SetExitOffer { enabled, .. } => write!(f, "SetExitOffer({enabled})"),
|
||||
NetCommand::SetExitVia { via, .. } => write!(f, "SetExitVia({})", via.is_some()),
|
||||
NetCommand::Reannounce => f.write_str("Reannounce"),
|
||||
NetCommand::SetHostname(_) => f.write_str("SetHostname"),
|
||||
NetCommand::Release { .. } => f.write_str("Release"),
|
||||
@@ -137,6 +149,10 @@ impl NetworkHandle {
|
||||
/// Everything a network runtime needs to run.
|
||||
pub(crate) struct RuntimeParams {
|
||||
pub(crate) broadcast: bool,
|
||||
/// This agent offers itself as an exit node here.
|
||||
pub(crate) exit_offer: bool,
|
||||
/// The member this device's internet traffic goes through.
|
||||
pub(crate) exit_via: Option<EndpointId>,
|
||||
pub(crate) keys: NetworkKeys,
|
||||
pub(crate) adapter: EndpointAdapter,
|
||||
pub(crate) storage: Storage,
|
||||
@@ -331,6 +347,14 @@ struct Runtime {
|
||||
pending_state: Vec<(EndpointId, Vec<SignedRecord>)>,
|
||||
/// The highest version this agent has ever published for this network.
|
||||
own_version: u64,
|
||||
/// Whether the exit node in use was reachable when last looked at, so
|
||||
/// that losing it is said once and getting it back is too.
|
||||
exit_via_was_online: bool,
|
||||
/// What the last announcement said about being an exit node.
|
||||
announced_exit: bool,
|
||||
/// The last hostname each peer announced, kept across restarts so a
|
||||
/// member that is away can still be called by name.
|
||||
known_hostnames: HashMap<EndpointId, String>,
|
||||
}
|
||||
|
||||
impl Runtime {
|
||||
@@ -382,6 +406,9 @@ impl Runtime {
|
||||
state: StateSet::new(),
|
||||
pending_state: Vec::new(),
|
||||
own_version: 0,
|
||||
exit_via_was_online: false,
|
||||
announced_exit: false,
|
||||
known_hostnames: HashMap::new(),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -501,6 +528,27 @@ impl Runtime {
|
||||
self.reannounce();
|
||||
let _ = reply.send(());
|
||||
}
|
||||
NetCommand::SetExitOffer { enabled, reply } => {
|
||||
self.params.exit_offer = enabled;
|
||||
self.apply_exit().await;
|
||||
self.reannounce();
|
||||
let _ = reply.send(());
|
||||
}
|
||||
NetCommand::SetExitVia { via, reply } => {
|
||||
let outcome = match via {
|
||||
Some(peer) if !self.exit_node_online(peer) => Err(
|
||||
"that member is not connected or does not offer to be an exit node"
|
||||
.to_string(),
|
||||
),
|
||||
_ => Ok(()),
|
||||
};
|
||||
if outcome.is_ok() {
|
||||
self.params.exit_via = via;
|
||||
self.exit_via_was_online = via.is_some();
|
||||
self.apply_exit().await;
|
||||
}
|
||||
let _ = reply.send(outcome);
|
||||
}
|
||||
NetCommand::Recheck => self.discovery_round().await,
|
||||
NetCommand::Reannounce => self.reannounce(),
|
||||
NetCommand::Release { reply } => {
|
||||
@@ -844,6 +892,17 @@ impl Runtime {
|
||||
.own_record_version(self.network_id, self.local_id)
|
||||
.await
|
||||
.unwrap_or(0);
|
||||
for (id, hostname) in self
|
||||
.params
|
||||
.storage
|
||||
.peer_hostnames(self.network_id)
|
||||
.await
|
||||
.unwrap_or_default()
|
||||
{
|
||||
if let Ok(id) = EndpointId::from_bytes(&id) {
|
||||
self.known_hostnames.insert(id, hostname);
|
||||
}
|
||||
}
|
||||
|
||||
self.ensure_own_claim().await;
|
||||
self.publish_allocations().await;
|
||||
@@ -1095,6 +1154,75 @@ impl Runtime {
|
||||
}
|
||||
}
|
||||
|
||||
fn exit_policy(&self) -> crate::overlay::ExitPolicy {
|
||||
crate::overlay::ExitPolicy {
|
||||
offer: self.params.exit_offer,
|
||||
via: self.params.exit_via,
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether this agent offers to be an exit node and can really be one.
|
||||
fn exit_ready(&self) -> bool {
|
||||
self.params.exit_offer
|
||||
&& self
|
||||
.params
|
||||
.interface
|
||||
.as_ref()
|
||||
.is_some_and(|interface| interface.exit_offer_ready(self.network_id))
|
||||
}
|
||||
|
||||
/// Whether a member is connected and says it is an exit node.
|
||||
fn exit_node_online(&self, peer: EndpointId) -> bool {
|
||||
self.sessions
|
||||
.get(&peer)
|
||||
.is_some_and(|session| session.exit_node)
|
||||
}
|
||||
|
||||
/// Puts the exit settings into the routing table and the host rules.
|
||||
///
|
||||
/// The routes and the rules stay as they are when the exit node in use
|
||||
/// goes away: dropping them would send the traffic out the old way, in
|
||||
/// the clear, without anyone having asked.
|
||||
async fn apply_exit(&mut self) {
|
||||
self.params
|
||||
.routes
|
||||
.set_exit(self.network_id, self.exit_policy());
|
||||
if let Some(interface) = self.params.interface.clone() {
|
||||
interface.sync_exit_rules().await;
|
||||
}
|
||||
// Said only once it is true: the rules may not have taken, or may
|
||||
// only now be possible.
|
||||
if self.exit_ready() != self.announced_exit {
|
||||
self.reannounce();
|
||||
}
|
||||
}
|
||||
|
||||
/// Says so, once, when the exit node in use is lost or comes back.
|
||||
fn watch_exit_via(&mut self) {
|
||||
let Some(via) = self.params.exit_via else {
|
||||
return;
|
||||
};
|
||||
let online = self.exit_node_online(via);
|
||||
if online == self.exit_via_was_online {
|
||||
return;
|
||||
}
|
||||
self.exit_via_was_online = online;
|
||||
if online {
|
||||
tracing::info!(
|
||||
network = %self.network_id,
|
||||
exit_node = %via.fmt_short(),
|
||||
"the exit node is back"
|
||||
);
|
||||
} else {
|
||||
tracing::warn!(
|
||||
network = %self.network_id,
|
||||
exit_node = %via.fmt_short(),
|
||||
"the exit node is gone or no longer offers to be one; internet traffic stays \
|
||||
routed through it and is dropped until it returns or `tsng exit-node off`"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
fn update_broadcast(&self) {
|
||||
self.params
|
||||
.routes
|
||||
@@ -1123,6 +1251,7 @@ impl Runtime {
|
||||
// a packet for ourselves does not go over a tunnel.
|
||||
let local = self.state.address_of(&self.local_id);
|
||||
let routes = crate::overlay::NetworkRoutes {
|
||||
exit: self.exit_policy(),
|
||||
broadcast: self.broadcast_policy(),
|
||||
range: Some(range),
|
||||
local,
|
||||
@@ -1219,6 +1348,7 @@ impl Runtime {
|
||||
// only once the address is really on the interface.
|
||||
if !is_missing {
|
||||
interface.sync_broadcast_rules().await;
|
||||
self.apply_exit().await;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1783,8 +1913,11 @@ impl Runtime {
|
||||
});
|
||||
}
|
||||
capabilities.truncate(self.params.limits.max_capabilities);
|
||||
let exit_node = self.exit_ready();
|
||||
self.announced_exit = exit_node;
|
||||
Announcement {
|
||||
broadcast: self.params.broadcast,
|
||||
exit_node,
|
||||
hostname: self.params.hostname.clone(),
|
||||
capabilities,
|
||||
}
|
||||
@@ -1863,6 +1996,7 @@ impl Runtime {
|
||||
self.metrics.disconnects += 1;
|
||||
self.drop_links_for(peer);
|
||||
self.update_broadcast();
|
||||
self.watch_exit_via();
|
||||
self.update_paths();
|
||||
self.announce_reach(false);
|
||||
for plugin in &self.params.plugins {
|
||||
@@ -1885,6 +2019,33 @@ impl Runtime {
|
||||
}
|
||||
}
|
||||
|
||||
/// Keeps the name a peer announced, on disk too when it changed.
|
||||
///
|
||||
/// Written off the loop: a name that is not stored this time is stored
|
||||
/// the next time the peer announces it.
|
||||
fn remember_hostname(&mut self, peer: EndpointId, hostname: &str) {
|
||||
if hostname.is_empty()
|
||||
|| self
|
||||
.known_hostnames
|
||||
.get(&peer)
|
||||
.is_some_and(|h| h == hostname)
|
||||
{
|
||||
return;
|
||||
}
|
||||
self.known_hostnames.insert(peer, hostname.to_string());
|
||||
let storage = self.params.storage.clone();
|
||||
let network_id = self.network_id;
|
||||
let hostname = hostname.to_string();
|
||||
tokio::spawn(async move {
|
||||
if let Err(err) = storage
|
||||
.remember_peer_hostname(network_id, *peer.as_bytes(), hostname)
|
||||
.await
|
||||
{
|
||||
tracing::debug!(%err, "could not remember a peer's hostname");
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
fn dispatch_message(&mut self, peer: EndpointId, message: ControlMessage) {
|
||||
match &message {
|
||||
ControlMessage::Announce(announcement) => {
|
||||
@@ -1892,9 +2053,12 @@ impl Runtime {
|
||||
if let Some(session) = self.sessions.get_mut(&peer) {
|
||||
session.hostname = Some(announcement.hostname.clone());
|
||||
session.broadcast = announcement.broadcast;
|
||||
session.exit_node = announcement.exit_node;
|
||||
session.capabilities = capabilities.clone();
|
||||
}
|
||||
self.remember_hostname(peer, &announcement.hostname);
|
||||
self.update_broadcast();
|
||||
self.watch_exit_via();
|
||||
self.dispatch_capabilities(peer, &capabilities);
|
||||
self.ensure_links();
|
||||
self.update_paths();
|
||||
@@ -1992,9 +2156,13 @@ impl Runtime {
|
||||
let snapshot = snapshot_connection(&session.conn);
|
||||
PeerStatus {
|
||||
broadcast: session.broadcast,
|
||||
exit_node: session.exit_node,
|
||||
endpoint_id: session.peer,
|
||||
role: session.role,
|
||||
hostname: session.hostname.clone(),
|
||||
hostname: session
|
||||
.hostname
|
||||
.clone()
|
||||
.or_else(|| self.known_hostnames.get(&session.peer).cloned()),
|
||||
protocols: session
|
||||
.capabilities
|
||||
.iter()
|
||||
@@ -2052,6 +2220,7 @@ impl Runtime {
|
||||
// both hold it would be untrue on one of them.
|
||||
overlay_address_v4: self.state.address_of(&endpoint_id),
|
||||
hostname: self.state.hostname_of(&endpoint_id).map(str::to_string),
|
||||
last_hostname: self.known_hostnames.get(&endpoint_id).cloned(),
|
||||
})
|
||||
})
|
||||
.collect();
|
||||
@@ -2060,6 +2229,18 @@ impl Runtime {
|
||||
|
||||
NetworkStatus {
|
||||
broadcast: self.params.broadcast,
|
||||
exit_offer: self.params.exit_offer,
|
||||
exit_via: self.params.exit_via,
|
||||
exit_via_online: self
|
||||
.params
|
||||
.exit_via
|
||||
.is_some_and(|via| self.exit_node_online(via)),
|
||||
exit_rules: self
|
||||
.params
|
||||
.interface
|
||||
.as_ref()
|
||||
.map(|interface| interface.exit_rules(self.network_id))
|
||||
.unwrap_or_default(),
|
||||
descriptor: self.params.keys.descriptor(),
|
||||
name: self.params.keys.name().clone(),
|
||||
network_id: self.network_id,
|
||||
@@ -74,6 +74,8 @@ pub(crate) struct Session {
|
||||
pub(crate) hostname: Option<String>,
|
||||
pub(crate) capabilities: Vec<PluginCapability>,
|
||||
pub(crate) broadcast: bool,
|
||||
/// The peer offers itself as an exit node in this network.
|
||||
pub(crate) exit_node: bool,
|
||||
pub(crate) messages_sent: u64,
|
||||
pub(crate) messages_received: u64,
|
||||
pub(crate) bytes_sent: u64,
|
||||
@@ -228,6 +230,7 @@ pub(crate) fn spawn(
|
||||
hostname: None,
|
||||
capabilities: Vec::new(),
|
||||
broadcast: false,
|
||||
exit_node: false,
|
||||
messages_sent: 0,
|
||||
messages_received: 0,
|
||||
bytes_sent: 0,
|
||||
File renamed without changes.
@@ -80,6 +80,11 @@ pub struct MemberStatus {
|
||||
/// Signed, so it is still known while the member is away — which is what
|
||||
/// lets an absent member be named rather than shown as a bare id.
|
||||
pub hostname: Option<String>,
|
||||
/// The last name this agent saw it announce, whether or not it is here.
|
||||
///
|
||||
/// Not signed, so it is a convenience for naming a member that is away
|
||||
/// and never a claim: the zone is served from `hostname`.
|
||||
pub last_hostname: Option<String>,
|
||||
}
|
||||
|
||||
/// Status of one authenticated session.
|
||||
@@ -87,6 +92,8 @@ pub struct MemberStatus {
|
||||
pub struct PeerStatus {
|
||||
/// This authenticated peer accepts network broadcasts.
|
||||
pub broadcast: bool,
|
||||
/// This authenticated peer offers itself as an exit node.
|
||||
pub exit_node: bool,
|
||||
/// Authenticated endpoint id.
|
||||
pub endpoint_id: EndpointId,
|
||||
/// Which side this agent played in the handshake.
|
||||
@@ -159,6 +166,14 @@ pub struct NetworkMetrics {
|
||||
pub struct NetworkStatus {
|
||||
/// Local broadcast participation in this network.
|
||||
pub broadcast: bool,
|
||||
/// This agent offers itself as an exit node in this network.
|
||||
pub exit_offer: bool,
|
||||
/// The member this device sends all its internet traffic through.
|
||||
pub exit_via: Option<EndpointId>,
|
||||
/// Whether that member is connected and still offering to be one.
|
||||
pub exit_via_online: bool,
|
||||
/// What the host rules for the exit settings are doing.
|
||||
pub exit_rules: crate::overlay::ExitRulesReport,
|
||||
/// Immutable deterministic description of the network space.
|
||||
pub descriptor: NetworkDescriptor,
|
||||
/// Network name, for convenience.
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -83,6 +83,8 @@ struct TunnelPeerState {
|
||||
link: SharedLink,
|
||||
tx_packets: AtomicU64,
|
||||
rx_packets: AtomicU64,
|
||||
tx_bytes: AtomicU64,
|
||||
rx_bytes: AtomicU64,
|
||||
dropped: AtomicU64,
|
||||
established_at: std::time::Instant,
|
||||
}
|
||||
@@ -100,6 +102,10 @@ pub struct TunnelPeerReport {
|
||||
pub tx_packets: u64,
|
||||
/// Packets successfully received and decrypted.
|
||||
pub rx_packets: u64,
|
||||
/// Plaintext bytes successfully encrypted and sent.
|
||||
pub tx_bytes: u64,
|
||||
/// Plaintext bytes successfully received and decrypted.
|
||||
pub rx_bytes: u64,
|
||||
/// Packets dropped due to encryption/decryption/send failures.
|
||||
pub dropped: u64,
|
||||
/// Uptime in seconds since the data link was established.
|
||||
@@ -145,6 +151,8 @@ impl<C: TunnelCodec> GenericTunnelPlugin<C> {
|
||||
path: state.link.path_description(),
|
||||
tx_packets: state.tx_packets.load(Ordering::Relaxed),
|
||||
rx_packets: state.rx_packets.load(Ordering::Relaxed),
|
||||
tx_bytes: state.tx_bytes.load(Ordering::Relaxed),
|
||||
rx_bytes: state.rx_bytes.load(Ordering::Relaxed),
|
||||
dropped: state.dropped.load(Ordering::Relaxed),
|
||||
uptime_secs: state.established_at.elapsed().as_secs(),
|
||||
})
|
||||
@@ -223,6 +231,9 @@ impl<C: TunnelCodec> IpPlugin for GenericTunnelPlugin<C> {
|
||||
Ok(ciphertext) => {
|
||||
if state.link.send(ciphertext).is_ok() {
|
||||
state.tx_packets.fetch_add(1, Ordering::Relaxed);
|
||||
state
|
||||
.tx_bytes
|
||||
.fetch_add(packet.len() as u64, Ordering::Relaxed);
|
||||
true
|
||||
} else {
|
||||
state.dropped.fetch_add(1, Ordering::Relaxed);
|
||||
@@ -242,6 +253,8 @@ impl<C: TunnelCodec> IpPlugin for GenericTunnelPlugin<C> {
|
||||
link: Arc::clone(&link),
|
||||
tx_packets: AtomicU64::new(0),
|
||||
rx_packets: AtomicU64::new(0),
|
||||
tx_bytes: AtomicU64::new(0),
|
||||
rx_bytes: AtomicU64::new(0),
|
||||
dropped: AtomicU64::new(0),
|
||||
established_at: std::time::Instant::now(),
|
||||
});
|
||||
@@ -268,6 +281,9 @@ impl<C: TunnelCodec> IpPlugin for GenericTunnelPlugin<C> {
|
||||
match codec.decrypt(network, peer, &payload) {
|
||||
Ok(packet) => {
|
||||
rx_state.rx_packets.fetch_add(1, Ordering::Relaxed);
|
||||
rx_state
|
||||
.rx_bytes
|
||||
.fetch_add(packet.len() as u64, Ordering::Relaxed);
|
||||
if let Some(ref sink) = sink {
|
||||
sink.deliver(network, peer, packet).await;
|
||||
}
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -120,6 +120,13 @@ pub enum Error {
|
||||
what: String,
|
||||
},
|
||||
|
||||
/// The request is understood and cannot be done as things stand.
|
||||
#[error("{reason}")]
|
||||
Rejected {
|
||||
/// Why, phrased so the message stands on its own.
|
||||
reason: String,
|
||||
},
|
||||
|
||||
/// Discovery backend failure. Never fatal for the agent.
|
||||
#[error("discovery error: {0}")]
|
||||
Discovery(String),
|
||||
File renamed without changes.
File renamed without changes.
@@ -44,6 +44,21 @@ use windows as transport;
|
||||
#[cfg(any(unix, windows))]
|
||||
pub use transport::ControlSocket;
|
||||
|
||||
/// Who may open the local control socket.
|
||||
///
|
||||
/// The default is owner-only. A system service shares its socket with a GUI or
|
||||
/// CLI running as another user by granting a group; the agent sets that on the
|
||||
/// socket when it binds it, so the access is correct from creation rather than
|
||||
/// patched afterwards.
|
||||
#[derive(Debug, Clone)]
|
||||
pub enum ControlSocketAccess {
|
||||
/// Owner only — mode `0600`. The per-user agent's default.
|
||||
Private,
|
||||
/// The owner and members of this group — the socket's group is set to this
|
||||
/// gid and the mode to `0660`. The caller resolves a group name to its gid.
|
||||
Group(u32),
|
||||
}
|
||||
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::Arc;
|
||||
use std::time::Duration;
|
||||
@@ -58,6 +73,31 @@ use crate::error::{Error, Result};
|
||||
/// Largest accepted local control message.
|
||||
pub const MAX_MESSAGE_LEN: usize = 1024 * 1024;
|
||||
|
||||
/// A string the control protocol must carry but that must never appear in a
|
||||
/// log: it serialises transparently (the text crosses the socket intact) but
|
||||
/// its `Debug` is redacted. Used for a network secret handed back to a local
|
||||
/// client that asked to copy it.
|
||||
#[derive(Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct RedactedText(String);
|
||||
|
||||
impl RedactedText {
|
||||
/// Wraps a string.
|
||||
pub fn new(text: impl Into<String>) -> Self {
|
||||
Self(text.into())
|
||||
}
|
||||
|
||||
/// Unwraps to the plain string.
|
||||
pub fn into_string(self) -> String {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for RedactedText {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.write_str("<redacted>")
|
||||
}
|
||||
}
|
||||
|
||||
/// Where the control socket for a state directory lives.
|
||||
///
|
||||
/// A Unix socket path is limited to around 100 bytes, which a state directory
|
||||
@@ -108,10 +148,17 @@ pub fn default_control_socket_path() -> PathBuf {
|
||||
}
|
||||
#[cfg(all(unix, not(target_os = "macos")))]
|
||||
{
|
||||
// Prefer a running system service's socket when it is present, so a
|
||||
// GUI or CLI reaches the packaged daemon with no configuration; fall
|
||||
// back to the per-user location otherwise.
|
||||
let system = PathBuf::from("/run/tsunagi/agent.sock");
|
||||
if system.exists() {
|
||||
return system;
|
||||
}
|
||||
if let Ok(paths) = crate::config::StoragePaths::user_default() {
|
||||
control_socket_path(&paths.state_dir)
|
||||
} else {
|
||||
PathBuf::from("/run/tsunagi/agent.sock")
|
||||
system
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -167,7 +214,7 @@ pub enum Request {
|
||||
///
|
||||
/// Asked of the running agent because that is the only way to add a
|
||||
/// network to an agent that is already up: the state directory belongs
|
||||
/// to one live agent, so a second `tsunagi up` cannot.
|
||||
/// to one live agent, so a second `tsng up` cannot.
|
||||
Join {
|
||||
/// The network name.
|
||||
name: String,
|
||||
@@ -180,6 +227,29 @@ pub enum Request {
|
||||
#[serde(default)]
|
||||
broadcast: Option<bool>,
|
||||
},
|
||||
/// Ask for a configured network's shared secret, in its `tsn1…` text form,
|
||||
/// so a local GUI or script can copy it to re-share. The reply travels only
|
||||
/// over the owner/group socket and the secret is never logged.
|
||||
Secret {
|
||||
/// Which network, by the id text `status` prints.
|
||||
network_id: String,
|
||||
},
|
||||
/// Offer this agent as an exit node in one network, or stop. Off unless
|
||||
/// asked.
|
||||
SetExitOffer {
|
||||
/// Public network identifier.
|
||||
network_id: String,
|
||||
/// Whether members may send their internet traffic through this agent.
|
||||
enabled: bool,
|
||||
},
|
||||
/// Send all this device's internet traffic through a member of one
|
||||
/// network, or back the ordinary way.
|
||||
SetExitNode {
|
||||
/// Public network identifier.
|
||||
network_id: String,
|
||||
/// The member's endpoint id, or `None` to stop using an exit node.
|
||||
peer: Option<String>,
|
||||
},
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for Request {
|
||||
@@ -200,6 +270,14 @@ impl std::fmt::Debug for Request {
|
||||
write!(f, "Dns {{ enable: {enable}, port: {port:?} }}")
|
||||
}
|
||||
Request::Join { name, .. } => write!(f, "Join {{ name: {name}, secret: <redacted> }}"),
|
||||
Request::Secret { network_id } => write!(f, "Secret {{ {network_id} }}"),
|
||||
Request::SetExitOffer {
|
||||
network_id,
|
||||
enabled,
|
||||
} => write!(f, "SetExitOffer {{ {network_id}, enabled: {enabled} }}"),
|
||||
Request::SetExitNode { network_id, peer } => {
|
||||
write!(f, "SetExitNode {{ {network_id}, peer: {peer:?} }}")
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -224,6 +302,12 @@ pub enum Response {
|
||||
///
|
||||
/// `None` means it is not serving at all.
|
||||
Dns(Option<DnsReport>),
|
||||
/// A network's shared secret, redacted in `Debug`.
|
||||
Secret(RedactedText),
|
||||
/// Whether this agent now offers itself as an exit node.
|
||||
ExitOffer(bool),
|
||||
/// The member this device now sends its internet traffic through.
|
||||
ExitNode(Option<String>),
|
||||
/// The request could not be served.
|
||||
Error(String),
|
||||
}
|
||||
@@ -295,6 +379,38 @@ pub struct StatusReport {
|
||||
pub networks: Vec<NetworkReport>,
|
||||
/// The local DNS service, when one was asked for.
|
||||
pub dns: Option<DnsReport>,
|
||||
/// The state directory the agent is actually using.
|
||||
///
|
||||
/// A client that was not told one would look in its own default, which is
|
||||
/// not the agent's when the agent runs as a service under another user.
|
||||
pub state_dir: String,
|
||||
/// The cache directory the agent is actually using.
|
||||
pub cache_dir: String,
|
||||
/// The executable the agent runs, which is what needs the capability.
|
||||
pub program: String,
|
||||
/// Whether the agent itself can manage the overlay interface.
|
||||
///
|
||||
/// It is the agent that creates the interface, so the client's own
|
||||
/// capabilities say nothing about it.
|
||||
pub privilege: PrivilegeReport,
|
||||
/// The version of the agent's software.
|
||||
pub version: String,
|
||||
/// The data plane protocols it has, each as `name vN` (wire version).
|
||||
pub protocols: Vec<String>,
|
||||
}
|
||||
|
||||
/// What the agent found when it checked whether it may manage an interface.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub enum PrivilegeReport {
|
||||
/// Not checked.
|
||||
#[default]
|
||||
Unknown,
|
||||
/// It can.
|
||||
Available,
|
||||
/// It cannot, with what was found.
|
||||
Missing(String),
|
||||
/// This platform has no provisioner yet.
|
||||
Unsupported,
|
||||
}
|
||||
|
||||
/// The local DNS service.
|
||||
@@ -368,6 +484,9 @@ pub struct NetworkReport {
|
||||
pub range_conflict: Option<String>,
|
||||
/// The overlay, when a protocol is running one.
|
||||
pub overlay: Option<OverlayReport>,
|
||||
/// Exit-node settings: whether this agent offers one, and whether it
|
||||
/// uses one.
|
||||
pub exit: ExitReport,
|
||||
}
|
||||
|
||||
/// One member of the network, from signed state.
|
||||
@@ -379,6 +498,8 @@ pub struct MemberReport {
|
||||
pub overlay_address_v4: Option<String>,
|
||||
/// Consecutive failed dial attempts, when this agent is trying to reach it.
|
||||
pub failed_dials: u32,
|
||||
/// The last hostname this agent saw it announce, kept while it is away.
|
||||
pub hostname: Option<String>,
|
||||
}
|
||||
|
||||
/// One control plane peer.
|
||||
@@ -393,6 +514,8 @@ pub struct PeerReport {
|
||||
pub transport: String,
|
||||
/// Round-trip time in milliseconds, when a path is selected.
|
||||
pub rtt_ms: Option<u64>,
|
||||
/// The peer offers itself as an exit node in this network.
|
||||
pub exit_node: bool,
|
||||
}
|
||||
|
||||
/// The WireGuard overlay of one network.
|
||||
@@ -425,6 +548,35 @@ pub struct OverlayReport {
|
||||
pub broadcast_rules: Option<HostRulesReport>,
|
||||
}
|
||||
|
||||
/// How one set of exit-node host rules went.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct RuleSetReport {
|
||||
/// Whether every step took.
|
||||
pub ok: bool,
|
||||
/// One line: what is in place, or what is missing and why.
|
||||
pub detail: String,
|
||||
}
|
||||
|
||||
/// One network's exit-node settings and what they are doing.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct ExitReport {
|
||||
/// This agent offers itself as an exit node in this network.
|
||||
pub offering: bool,
|
||||
/// Masquerading and forwarding rules for members' traffic, when offering.
|
||||
pub offer_rules: Option<RuleSetReport>,
|
||||
/// Whether the kernel forwards packets for the overlay interface.
|
||||
/// `Some(false)` means the rules are in place and nothing passes until it
|
||||
/// is turned on. `None` when unknown.
|
||||
pub forwarding: Option<bool>,
|
||||
/// The member this device sends its internet traffic through, as an
|
||||
/// endpoint id.
|
||||
pub via: Option<String>,
|
||||
/// Whether that member is connected and still offering to be one.
|
||||
pub via_online: bool,
|
||||
/// The routes that send this device's traffic through it.
|
||||
pub client_rules: Option<RuleSetReport>,
|
||||
}
|
||||
|
||||
/// What the agent installed on the host so LAN broadcast reaches the overlay.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
|
||||
pub struct HostRulesReport {
|
||||
@@ -457,6 +609,10 @@ pub struct OverlayPeerReport {
|
||||
pub tx_packets: u64,
|
||||
/// Packets decrypted from this peer.
|
||||
pub rx_packets: u64,
|
||||
/// Plaintext bytes encrypted and sent to this peer.
|
||||
pub tx_bytes: u64,
|
||||
/// Plaintext bytes decrypted from this peer.
|
||||
pub rx_bytes: u64,
|
||||
/// Data packets dropped: wrong source address, or too large for the path.
|
||||
pub dropped: u64,
|
||||
/// WireGuard protocol errors.
|
||||
@@ -560,6 +716,39 @@ pub trait ReportSource: Send + Sync + 'static {
|
||||
) -> BoxFuture<'_, std::result::Result<Option<DnsReport>, String>> {
|
||||
Box::pin(async move { Err("this agent cannot serve DNS".to_string()) })
|
||||
}
|
||||
|
||||
/// Returns a configured network's shared secret in its `tsn1…` text form.
|
||||
///
|
||||
/// Defaulted to a refusal, like the others. An implementor reads it from
|
||||
/// local state; it must never be logged.
|
||||
fn network_secret(
|
||||
&self,
|
||||
_network_id: String,
|
||||
) -> BoxFuture<'_, std::result::Result<String, String>> {
|
||||
Box::pin(async move { Err("this agent cannot read secrets".to_string()) })
|
||||
}
|
||||
|
||||
/// Offers this agent as an exit node in a network, or stops.
|
||||
///
|
||||
/// Defaulted to a refusal, like the others.
|
||||
fn set_exit_offer(
|
||||
&self,
|
||||
_network_id: String,
|
||||
_enabled: bool,
|
||||
) -> BoxFuture<'_, std::result::Result<bool, String>> {
|
||||
Box::pin(async move { Err("this agent cannot be an exit node".to_string()) })
|
||||
}
|
||||
|
||||
/// Sends this device's internet traffic through a member, or stops.
|
||||
///
|
||||
/// Defaulted to a refusal, like the others.
|
||||
fn set_exit_node(
|
||||
&self,
|
||||
_network_id: String,
|
||||
_peer: Option<String>,
|
||||
) -> BoxFuture<'_, std::result::Result<Option<String>, String>> {
|
||||
Box::pin(async move { Err("this agent cannot use an exit node".to_string()) })
|
||||
}
|
||||
}
|
||||
|
||||
impl<F> ReportSource for F
|
||||
@@ -575,7 +764,7 @@ where
|
||||
///
|
||||
/// A local answer comes from memory, so anything this slow means the agent is
|
||||
/// wedged rather than busy. Saying so beats waiting: unbounded, one wedged
|
||||
/// runtime leaves `tsunagi status` hanging with nothing on screen and no way
|
||||
/// runtime leaves `tsng status` hanging with nothing on screen and no way
|
||||
/// out but Ctrl-C.
|
||||
pub const EXCHANGE_TIMEOUT: Duration = Duration::from_secs(5);
|
||||
|
||||
@@ -590,7 +779,7 @@ pub const EXCHANGE_TIMEOUT: Duration = Duration::from_secs(5);
|
||||
///
|
||||
/// Bump it whenever [`Request`], [`Response`] or anything they contain
|
||||
/// changes shape.
|
||||
pub const CONTROL_PROTOCOL: u32 = u32::from_be_bytes([b'T', b'S', b'N', 15]);
|
||||
pub const CONTROL_PROTOCOL: u32 = u32::from_be_bytes([b'T', b'S', b'N', 17]);
|
||||
|
||||
/// Reads one request off an accepted stream, answers it, writes the response.
|
||||
///
|
||||
@@ -648,6 +837,23 @@ where
|
||||
Ok(report) => Response::Dns(report),
|
||||
Err(reason) => Response::Error(reason),
|
||||
},
|
||||
Request::Secret { network_id } => match source.network_secret(network_id).await {
|
||||
Ok(secret) => Response::Secret(RedactedText::new(secret)),
|
||||
Err(reason) => Response::Error(reason),
|
||||
},
|
||||
Request::SetExitOffer {
|
||||
network_id,
|
||||
enabled,
|
||||
} => match source.set_exit_offer(network_id, enabled).await {
|
||||
Ok(enabled) => Response::ExitOffer(enabled),
|
||||
Err(reason) => Response::Error(reason),
|
||||
},
|
||||
Request::SetExitNode { network_id, peer } => {
|
||||
match source.set_exit_node(network_id, peer).await {
|
||||
Ok(peer) => Response::ExitNode(peer),
|
||||
Err(reason) => Response::Error(reason),
|
||||
}
|
||||
}
|
||||
};
|
||||
write_message(&mut stream, &response).await
|
||||
}
|
||||
@@ -802,6 +1008,56 @@ pub async fn set_dns(
|
||||
}
|
||||
}
|
||||
|
||||
/// Offers the running agent as an exit node in one network, or stops.
|
||||
pub async fn set_exit_offer(
|
||||
path: impl AsRef<Path>,
|
||||
network_id: &str,
|
||||
enabled: bool,
|
||||
) -> Result<bool> {
|
||||
let request = Request::SetExitOffer {
|
||||
network_id: network_id.to_owned(),
|
||||
enabled,
|
||||
};
|
||||
match exchange(path.as_ref(), &request, EXCHANGE_TIMEOUT).await? {
|
||||
Response::ExitOffer(enabled) => Ok(enabled),
|
||||
Response::Error(message) => Err(Error::Storage(message)),
|
||||
other => Err(Error::Storage(format!("unexpected answer: {other:?}"))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sends the running agent's internet traffic through a member of one
|
||||
/// network, or back the ordinary way with `None`.
|
||||
pub async fn set_exit_node(
|
||||
path: impl AsRef<Path>,
|
||||
network_id: &str,
|
||||
peer: Option<&str>,
|
||||
) -> Result<Option<String>> {
|
||||
let request = Request::SetExitNode {
|
||||
network_id: network_id.to_owned(),
|
||||
peer: peer.map(str::to_owned),
|
||||
};
|
||||
match exchange(path.as_ref(), &request, EXCHANGE_TIMEOUT).await? {
|
||||
Response::ExitNode(peer) => Ok(peer),
|
||||
Response::Error(message) => Err(Error::Storage(message)),
|
||||
other => Err(Error::Storage(format!("unexpected answer: {other:?}"))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Asks a running agent for a configured network's shared secret, in its
|
||||
/// `tsn1…` text form, so a local client can copy it. The secret is never
|
||||
/// logged by this path.
|
||||
pub async fn network_secret(path: impl AsRef<Path>, network_id: &str) -> Result<String> {
|
||||
let path = path.as_ref();
|
||||
let request = Request::Secret {
|
||||
network_id: network_id.to_string(),
|
||||
};
|
||||
match exchange(path, &request, EXCHANGE_TIMEOUT).await? {
|
||||
Response::Secret(secret) => Ok(secret.into_string()),
|
||||
Response::Error(reason) => Err(Error::Storage(reason)),
|
||||
other => Err(Error::Storage(format!("unexpected answer: {other:?}"))),
|
||||
}
|
||||
}
|
||||
|
||||
pub(crate) async fn write_message<S, T>(stream: &mut S, value: &T) -> Result<()>
|
||||
where
|
||||
S: AsyncWrite + Unpin,
|
||||
@@ -22,8 +22,8 @@ use crate::error::{Error, Result};
|
||||
// The transport-agnostic surface, re-exported so this module is a complete
|
||||
// view of the local control interface on its own.
|
||||
pub use super::{
|
||||
CONTROL_PROTOCOL, EXCHANGE_TIMEOUT, ReportSource, is_serving, join_network, leave_network,
|
||||
request_status, set_active, set_dns, set_hostname,
|
||||
CONTROL_PROTOCOL, ControlSocketAccess, EXCHANGE_TIMEOUT, ReportSource, is_serving,
|
||||
join_network, leave_network, request_status, set_active, set_dns, set_hostname,
|
||||
};
|
||||
|
||||
/// Serves the local control interface on a Unix socket.
|
||||
@@ -39,11 +39,15 @@ impl ControlSocket {
|
||||
/// A socket file left behind by a crashed agent is replaced, but only
|
||||
/// after checking that nothing is listening on it, so two live agents
|
||||
/// never fight over one path.
|
||||
pub async fn bind(path: impl AsRef<Path>, source: Arc<dyn ReportSource>) -> Result<Self> {
|
||||
pub async fn bind(
|
||||
path: impl AsRef<Path>,
|
||||
source: Arc<dyn ReportSource>,
|
||||
access: ControlSocketAccess,
|
||||
) -> Result<Self> {
|
||||
let path = path.as_ref().to_path_buf();
|
||||
|
||||
if let Some(parent) = path.parent() {
|
||||
crate::storage::create_dir(parent)?;
|
||||
create_parent(parent, &access)?;
|
||||
}
|
||||
|
||||
if path.exists() {
|
||||
@@ -61,7 +65,7 @@ impl ControlSocket {
|
||||
path: path.clone(),
|
||||
source,
|
||||
})?;
|
||||
restrict(&path)?;
|
||||
apply_access(&path, &access)?;
|
||||
|
||||
let task = tokio::spawn(serve(listener, source));
|
||||
Ok(Self {
|
||||
@@ -94,9 +98,48 @@ impl Drop for ControlSocket {
|
||||
}
|
||||
}
|
||||
|
||||
fn restrict(path: &Path) -> Result<()> {
|
||||
/// Creates the socket's parent directory.
|
||||
///
|
||||
/// A group-shared socket must sit in a directory the group can traverse, so it
|
||||
/// is `0755`; a private socket keeps the owner-only state-directory default.
|
||||
fn create_parent(parent: &Path, access: &ControlSocketAccess) -> Result<()> {
|
||||
match access {
|
||||
ControlSocketAccess::Private => crate::storage::create_dir(parent),
|
||||
ControlSocketAccess::Group(_) => {
|
||||
std::fs::create_dir_all(parent).map_err(|source| Error::Io {
|
||||
path: parent.to_path_buf(),
|
||||
source,
|
||||
})?;
|
||||
set_mode(parent, 0o755)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Applies the access policy to the bound socket.
|
||||
///
|
||||
/// Private is owner-only `0600`. Group sets the socket's group to the gid and
|
||||
/// the mode to `0660`; if the group cannot be set — the agent is not a member,
|
||||
/// say — it falls back to owner-only rather than leaving the group wrong, so
|
||||
/// the socket is never more open than intended.
|
||||
fn apply_access(path: &Path, access: &ControlSocketAccess) -> Result<()> {
|
||||
match access {
|
||||
ControlSocketAccess::Private => set_mode(path, 0o600),
|
||||
ControlSocketAccess::Group(gid) => {
|
||||
if let Err(source) = std::os::unix::fs::chown(path, None, Some(*gid)) {
|
||||
tracing::warn!(
|
||||
path = %path.display(), gid, %source,
|
||||
"cannot set the control socket group; keeping it owner-only"
|
||||
);
|
||||
return set_mode(path, 0o600);
|
||||
}
|
||||
set_mode(path, 0o660)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn set_mode(path: &Path, mode: u32) -> Result<()> {
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o600)).map_err(|source| {
|
||||
std::fs::set_permissions(path, std::fs::Permissions::from_mode(mode)).map_err(|source| {
|
||||
Error::Io {
|
||||
path: path.to_path_buf(),
|
||||
source,
|
||||
@@ -170,7 +213,9 @@ mod tests {
|
||||
let source: Arc<dyn ReportSource> = Arc::new(|| -> BoxFuture<'static, StatusReport> {
|
||||
Box::pin(async { StatusReport::default() })
|
||||
});
|
||||
let control = ControlSocket::bind(&path, source).await.unwrap();
|
||||
let control = ControlSocket::bind(&path, source, ControlSocketAccess::Private)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
let answer = exchange(&path, &Request::Status, EXCHANGE_TIMEOUT)
|
||||
.await
|
||||
@@ -40,8 +40,8 @@ use tokio::task::JoinHandle;
|
||||
use crate::error::{Error, Result};
|
||||
|
||||
pub use super::{
|
||||
CONTROL_PROTOCOL, EXCHANGE_TIMEOUT, ReportSource, is_serving, join_network, leave_network,
|
||||
request_status, set_active, set_dns, set_hostname,
|
||||
CONTROL_PROTOCOL, ControlSocketAccess, EXCHANGE_TIMEOUT, ReportSource, is_serving,
|
||||
join_network, leave_network, request_status, set_active, set_dns, set_hostname,
|
||||
};
|
||||
|
||||
/// `ERROR_ACCESS_DENIED`: creating a first instance finds an existing pipe,
|
||||
@@ -149,7 +149,16 @@ impl ControlSocket {
|
||||
/// Claiming the first instance of the name is what detects a second agent:
|
||||
/// if the name already exists, the create is refused and that is reported
|
||||
/// as the state being locked, so two live agents never share one pipe.
|
||||
pub async fn bind(path: impl AsRef<Path>, source: Arc<dyn ReportSource>) -> Result<Self> {
|
||||
///
|
||||
/// `_access` is accepted for parity with the Unix socket; granting a group
|
||||
/// here means a pipe security descriptor and is a separate follow-up, so for
|
||||
/// now the pipe keeps its default (creator plus the built-in access the
|
||||
/// `PipeSecurityAttributes` set).
|
||||
pub async fn bind(
|
||||
path: impl AsRef<Path>,
|
||||
source: Arc<dyn ReportSource>,
|
||||
_access: ControlSocketAccess,
|
||||
) -> Result<Self> {
|
||||
let path = path.as_ref().to_path_buf();
|
||||
let name = pipe_name(&path);
|
||||
|
||||
@@ -201,7 +210,7 @@ impl Drop for ControlSocket {
|
||||
/// Accepts one client at a time, keeping a fresh instance ready for the next.
|
||||
///
|
||||
/// A named pipe server instance serves a single client, so a new instance is
|
||||
/// created as soon as one is taken — otherwise a second `tsunagi status` while
|
||||
/// created as soon as one is taken — otherwise a second `tsng status` while
|
||||
/// the first is mid-flight would find nothing listening.
|
||||
async fn serve(
|
||||
name: String,
|
||||
@@ -285,7 +294,7 @@ pub(crate) async fn connect(path: &Path) -> Result<NamedPipeClient> {
|
||||
format!(
|
||||
"the agent's control pipe exists, but Windows denied access. \
|
||||
Run this command as the same Windows user and with the same \
|
||||
elevation as `tsunagi up` (use an administrator terminal if \
|
||||
elevation as `tsng up` (use an administrator terminal if \
|
||||
the agent is elevated). Windows error: {err}"
|
||||
),
|
||||
),
|
||||
File renamed without changes.
File renamed without changes.
@@ -140,6 +140,7 @@ mod tests {
|
||||
fn limited_and_directed_broadcasts_never_cross_domains_or_target_disabled_peers() {
|
||||
let peer = iroh::SecretKey::from_bytes(&[8; 32]).public();
|
||||
let a = NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
range: Some("10.0.0.0/24".parse().unwrap()),
|
||||
local: Some("10.0.0.1".parse().unwrap()),
|
||||
peers: vec![("10.0.0.2".parse().unwrap(), peer)],
|
||||
@@ -149,6 +150,7 @@ mod tests {
|
||||
},
|
||||
};
|
||||
let b = NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
range: Some("10.1.0.0/24".parse().unwrap()),
|
||||
local: Some("10.1.0.1".parse().unwrap()),
|
||||
peers: vec![("10.1.0.2".parse().unwrap(), peer)],
|
||||
@@ -185,6 +187,7 @@ mod tests {
|
||||
assert!(!table.accepts(id("b"), peer, Ipv4Addr::BROADCAST));
|
||||
assert!(table.accepts(id("a"), peer, Ipv4Addr::BROADCAST));
|
||||
let disabled = NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: BroadcastPolicy {
|
||||
enabled: false,
|
||||
..a.broadcast.clone()
|
||||
File renamed without changes.
@@ -0,0 +1,32 @@
|
||||
//! Exit-node host rules: what makes this device an exit node for others, and
|
||||
//! what sends this device's own traffic through one.
|
||||
//!
|
||||
//! The packet side lives in [`super::router`]; this is the side the operating
|
||||
//! system sees. It is kept apart from the broadcast rules, which have a
|
||||
//! different lifetime and different tags.
|
||||
|
||||
/// How one set of host rules went.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
||||
pub struct RuleSetReport {
|
||||
/// Whether every step took.
|
||||
pub ok: bool,
|
||||
/// One line: what is in place, or what is missing and why.
|
||||
pub detail: String,
|
||||
}
|
||||
|
||||
/// What the host rules of one network's exit-node settings are doing.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
||||
pub struct ExitRulesReport {
|
||||
/// Masquerading and forwarding for members' traffic, when this agent
|
||||
/// offers itself as an exit node here. `None` means none are wanted.
|
||||
pub offer: Option<RuleSetReport>,
|
||||
/// Whether the kernel forwards packets for the overlay interface.
|
||||
///
|
||||
/// `Some(false)` means the rules are in place but nothing passes until
|
||||
/// forwarding is turned on, which the agent never does itself. `None`
|
||||
/// when it could not be read.
|
||||
pub forwarding: Option<bool>,
|
||||
/// The routes that send this device's traffic through its exit node.
|
||||
/// `None` means it uses none through this network.
|
||||
pub client: Option<RuleSetReport>,
|
||||
}
|
||||
@@ -0,0 +1,231 @@
|
||||
//! Host rules for exit nodes: what the operating system needs for this agent
|
||||
//! to carry other members' internet traffic, and for this device's own
|
||||
//! traffic to go through a member.
|
||||
//!
|
||||
//! Two independent halves, planned together because one interface carries
|
||||
//! both:
|
||||
//!
|
||||
//! * **Offering** — one set of rules per network that offers this agent as an
|
||||
//! exit node, chosen by that network's range: masquerade the range out of
|
||||
//! every other interface and let it through the forward chain. A network
|
||||
//! that does not offer has no rules, so its members' packets are dropped by
|
||||
//! the firewall as well as by the agent.
|
||||
//! * **Using** — policy routing that sends everything the host does not have
|
||||
//! a more specific route for into the overlay interface, while the agent's
|
||||
//! own sockets keep the ordinary route (see `linux_exit`).
|
||||
//!
|
||||
//! Nothing a peer announces becomes a host setting. Offering is the owner's
|
||||
//! switch; using is the user's choice of a member. Every object is tagged,
|
||||
//! reversible, and removed when it is no longer wanted, when the network
|
||||
//! leaves or stops, and when the agent stops.
|
||||
|
||||
use std::sync::{Arc, Mutex};
|
||||
|
||||
use crate::BoxFuture;
|
||||
use crate::state::Ipv4Range;
|
||||
|
||||
use super::RuleOutcome;
|
||||
|
||||
/// What the host should hold for one interface's exit settings.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
||||
pub struct ExitHostPlan {
|
||||
/// The overlay interface.
|
||||
pub interface: String,
|
||||
/// The ranges of every network that offers this agent as an exit node.
|
||||
pub offer: Vec<Ipv4Range>,
|
||||
/// Whether this device sends its internet traffic through a member.
|
||||
pub client: bool,
|
||||
}
|
||||
|
||||
impl ExitHostPlan {
|
||||
/// Whether there is nothing to hold.
|
||||
pub fn is_empty(&self) -> bool {
|
||||
self.offer.is_empty() && !self.client
|
||||
}
|
||||
}
|
||||
|
||||
/// What applying a plan achieved.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
||||
pub struct ExitHostReport {
|
||||
/// One outcome per offered range: its masquerade and forward rules.
|
||||
pub offer: Vec<(Ipv4Range, RuleOutcome)>,
|
||||
/// Whether the kernel forwards packets for the interface. `None` when it
|
||||
/// could not be read. The agent only reads this: turning forwarding on is
|
||||
/// the owner's decision.
|
||||
pub forwarding: Option<bool>,
|
||||
/// The routes and rules that send this device's traffic through the
|
||||
/// interface, when the plan asked for them.
|
||||
pub client: Option<RuleOutcome>,
|
||||
}
|
||||
|
||||
/// Installs and removes exit-node rules for an overlay interface.
|
||||
///
|
||||
/// Like the broadcast rules, no call fails as a whole: a step that cannot be
|
||||
/// done is in the report, because the caller's only useful response is to
|
||||
/// say so.
|
||||
pub trait ExitHostRules: Send + Sync + std::fmt::Debug + 'static {
|
||||
/// Makes the host match the plan, replacing what this agent put there
|
||||
/// for the interface before.
|
||||
fn apply<'a>(&'a self, plan: &'a ExitHostPlan) -> BoxFuture<'a, ExitHostReport>;
|
||||
|
||||
/// Removes everything this agent put there for the interface. Succeeds
|
||||
/// when nothing is there: it runs on the shutdown path, and once at
|
||||
/// startup to take away what a crashed run left.
|
||||
fn clear<'a>(&'a self, interface: &'a str) -> BoxFuture<'a, ()>;
|
||||
}
|
||||
|
||||
/// The tag every firewall object of one offered range carries.
|
||||
pub fn exit_tag(interface: &str, range: &Ipv4Range) -> String {
|
||||
format!("{}{range}", exit_tag_prefix(interface))
|
||||
}
|
||||
|
||||
/// The start of every tag for an interface; what cleanup selects by.
|
||||
pub fn exit_tag_prefix(interface: &str) -> String {
|
||||
format!("tsunagi-exit:{interface}:")
|
||||
}
|
||||
|
||||
/// The one-line detail for a set of offer outcomes.
|
||||
pub fn offer_detail(outcome: &RuleOutcome, range: &Ipv4Range) -> String {
|
||||
match outcome {
|
||||
RuleOutcome::Applied => format!("masquerade + forward for {range} in place"),
|
||||
RuleOutcome::Failed(reason) => reason.clone(),
|
||||
}
|
||||
}
|
||||
|
||||
/// An in-memory host for exit rules, for tests: nothing is touched.
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct MockExitRules {
|
||||
state: Arc<Mutex<Option<ExitHostPlan>>>,
|
||||
calls: Arc<Mutex<Vec<String>>>,
|
||||
forwarding: Arc<Mutex<Option<bool>>>,
|
||||
failure: Arc<Mutex<Option<String>>>,
|
||||
}
|
||||
|
||||
impl MockExitRules {
|
||||
/// An empty host with forwarding turned on.
|
||||
pub fn new() -> Self {
|
||||
let rules = Self::default();
|
||||
*lock(&rules.forwarding) = Some(true);
|
||||
rules
|
||||
}
|
||||
|
||||
/// What the host reports for kernel forwarding from now on.
|
||||
pub fn set_forwarding(&self, forwarding: Option<bool>) {
|
||||
*lock(&self.forwarding) = forwarding;
|
||||
}
|
||||
|
||||
/// Makes every step fail with this reason from now on.
|
||||
pub fn fail_with(&self, reason: Option<String>) {
|
||||
*lock(&self.failure) = reason;
|
||||
}
|
||||
|
||||
/// What is installed now.
|
||||
pub fn installed(&self) -> Option<ExitHostPlan> {
|
||||
lock(&self.state).clone()
|
||||
}
|
||||
|
||||
/// Every `apply:<interface>` / `clear:<interface>` call, in order.
|
||||
pub fn calls(&self) -> Vec<String> {
|
||||
lock(&self.calls).clone()
|
||||
}
|
||||
}
|
||||
|
||||
fn lock<T>(mutex: &Mutex<T>) -> std::sync::MutexGuard<'_, T> {
|
||||
match mutex.lock() {
|
||||
Ok(guard) => guard,
|
||||
Err(poisoned) => poisoned.into_inner(),
|
||||
}
|
||||
}
|
||||
|
||||
impl ExitHostRules for MockExitRules {
|
||||
fn apply<'a>(&'a self, plan: &'a ExitHostPlan) -> BoxFuture<'a, ExitHostReport> {
|
||||
Box::pin(async move {
|
||||
lock(&self.calls).push(format!("apply:{}", plan.interface));
|
||||
let outcome = match lock(&self.failure).clone() {
|
||||
Some(reason) => RuleOutcome::Failed(reason),
|
||||
None => {
|
||||
*lock(&self.state) = Some(plan.clone());
|
||||
RuleOutcome::Applied
|
||||
}
|
||||
};
|
||||
ExitHostReport {
|
||||
offer: plan
|
||||
.offer
|
||||
.iter()
|
||||
.map(|range| (*range, outcome.clone()))
|
||||
.collect(),
|
||||
forwarding: *lock(&self.forwarding),
|
||||
client: plan.client.then_some(outcome),
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn clear<'a>(&'a self, interface: &'a str) -> BoxFuture<'a, ()> {
|
||||
Box::pin(async move {
|
||||
lock(&self.calls).push(format!("clear:{interface}"));
|
||||
*lock(&self.state) = None;
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
|
||||
|
||||
use super::*;
|
||||
|
||||
fn range() -> Ipv4Range {
|
||||
"10.13.37.0/24".parse().unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_name_the_interface_and_the_range() {
|
||||
assert_eq!(
|
||||
exit_tag("tsun0", &range()),
|
||||
"tsunagi-exit:tsun0:10.13.37.0/24"
|
||||
);
|
||||
assert!(exit_tag("tsun0", &range()).starts_with(&exit_tag_prefix("tsun0")));
|
||||
// Another interface's tag never matches this one's prefix.
|
||||
assert!(!exit_tag("tsun01", &range()).starts_with(&exit_tag_prefix("tsun0")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_empty_plan_is_nothing_to_hold() {
|
||||
let mut plan = ExitHostPlan::default();
|
||||
assert!(plan.is_empty());
|
||||
plan.client = true;
|
||||
assert!(!plan.is_empty());
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_mock_applies_reports_and_clears() {
|
||||
let rules = MockExitRules::new();
|
||||
let plan = ExitHostPlan {
|
||||
interface: "tsun0".into(),
|
||||
offer: vec![range()],
|
||||
client: true,
|
||||
};
|
||||
let report = rules.apply(&plan).await;
|
||||
assert_eq!(report.offer[0].1, RuleOutcome::Applied);
|
||||
assert_eq!(report.forwarding, Some(true));
|
||||
assert_eq!(report.client, Some(RuleOutcome::Applied));
|
||||
assert_eq!(rules.installed(), Some(plan));
|
||||
|
||||
rules.set_forwarding(Some(false));
|
||||
rules.fail_with(Some("denied".into()));
|
||||
let report = rules
|
||||
.apply(&ExitHostPlan {
|
||||
interface: "tsun0".into(),
|
||||
offer: vec![range()],
|
||||
client: false,
|
||||
})
|
||||
.await;
|
||||
assert_eq!(report.forwarding, Some(false));
|
||||
assert!(matches!(report.offer[0].1, RuleOutcome::Failed(_)));
|
||||
assert_eq!(report.client, None);
|
||||
|
||||
rules.clear("tsun0").await;
|
||||
assert_eq!(rules.installed(), None);
|
||||
assert_eq!(rules.calls(), ["apply:tsun0", "apply:tsun0", "clear:tsun0"]);
|
||||
}
|
||||
}
|
||||
+11
-7
@@ -50,7 +50,7 @@ fn pick_iptables(exists: impl Fn(&str) -> bool) -> Option<&'static str> {
|
||||
|
||||
/// What running `iptables` produced.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
enum Ran {
|
||||
pub(super) enum Ran {
|
||||
/// There is no `iptables` to run.
|
||||
Missing,
|
||||
/// It ran, and exited like this.
|
||||
@@ -63,7 +63,7 @@ enum Ran {
|
||||
|
||||
/// Runs `iptables` with these arguments. A function value so the flow below
|
||||
/// can be tested without touching the host.
|
||||
type Run<'a> = &'a dyn Fn(&[String]) -> Ran;
|
||||
pub(super) type Run<'a> = &'a dyn Fn(&[String]) -> Ran;
|
||||
|
||||
/// The match and target of the rule, without the chain or position.
|
||||
fn rule_spec(plan: &BroadcastRulesPlan) -> Vec<String> {
|
||||
@@ -88,7 +88,7 @@ fn rule_spec(plan: &BroadcastRulesPlan) -> Vec<String> {
|
||||
|
||||
/// Waits briefly for the xtables lock instead of failing when another tool
|
||||
/// holds it.
|
||||
fn locked(args: impl IntoIterator<Item = String>) -> Vec<String> {
|
||||
pub(super) fn locked(args: impl IntoIterator<Item = String>) -> Vec<String> {
|
||||
["-w", "5"]
|
||||
.into_iter()
|
||||
.map(str::to_string)
|
||||
@@ -118,7 +118,7 @@ fn list_args() -> Vec<String> {
|
||||
|
||||
/// Splits one `iptables -S` line into words, honouring double quotes, which
|
||||
/// `iptables` puts around comments that need them.
|
||||
fn split_rule_line(line: &str) -> Vec<String> {
|
||||
pub(super) fn split_rule_line(line: &str) -> Vec<String> {
|
||||
let mut words = Vec::new();
|
||||
let mut current = String::new();
|
||||
let mut quoted = false;
|
||||
@@ -175,7 +175,7 @@ fn tagged_deletions(listing: &str, tag: &str) -> Vec<Vec<String>> {
|
||||
}
|
||||
|
||||
/// A failure message with the likely fix for the likely cause.
|
||||
fn failure(stderr: &str) -> String {
|
||||
pub(super) fn failure(stderr: &str) -> String {
|
||||
let text = stderr.trim();
|
||||
let lower = text.to_ascii_lowercase();
|
||||
if lower.contains("permission denied") || lower.contains("must be root") {
|
||||
@@ -261,7 +261,7 @@ fn clear_firewall(run: Run<'_>, interface: &str) {
|
||||
}
|
||||
|
||||
/// Runs the real `iptables`.
|
||||
fn run_iptables(args: &[String]) -> Ran {
|
||||
pub(super) fn run_iptables(args: &[String]) -> Ran {
|
||||
let Some(program) = pick_iptables(|path| std::path::Path::new(path).is_file()) else {
|
||||
return Ran::Missing;
|
||||
};
|
||||
@@ -283,7 +283,7 @@ fn run_iptables(args: &[String]) -> Ran {
|
||||
/// The Linux implementation: netlink for the route, `iptables` for the rule.
|
||||
#[derive(Debug)]
|
||||
pub struct LinuxHostRules {
|
||||
route: RouteHandle,
|
||||
pub(super) route: RouteHandle,
|
||||
}
|
||||
|
||||
impl LinuxHostRules {
|
||||
@@ -306,6 +306,10 @@ impl BroadcastHostRules for LinuxHostRules {
|
||||
"netlink+iptables"
|
||||
}
|
||||
|
||||
fn exit_rules(&self) -> Option<&dyn super::ExitHostRules> {
|
||||
Some(self)
|
||||
}
|
||||
|
||||
fn apply<'a>(&'a self, plan: &'a BroadcastRulesPlan) -> BoxFuture<'a, BroadcastRulesReport> {
|
||||
Box::pin(async move {
|
||||
let route = self.set_route(plan.interface.clone(), plan.source).await;
|
||||
@@ -0,0 +1,728 @@
|
||||
//! Exit-node host rules on Linux: `iptables` for the offering side, policy
|
||||
//! routing over netlink for the using side.
|
||||
//!
|
||||
//! # Offering
|
||||
//!
|
||||
//! For every network that offers this agent as an exit node, three rules,
|
||||
//! selected by that network's range and carrying the tag
|
||||
//! `tsunagi-exit:<if>:<range>`:
|
||||
//!
|
||||
//! ```text
|
||||
//! -t nat POSTROUTING -s <range> ! -o <if> -j MASQUERADE
|
||||
//! -t filter FORWARD -i <if> -s <range> ! -o <if> -j ACCEPT
|
||||
//! -t filter FORWARD -o <if> -d <range> -m conntrack --ctstate RELATED,ESTABLISHED -j ACCEPT
|
||||
//! ```
|
||||
//!
|
||||
//! `! -o <if>` is the egress without naming it: whatever interface the
|
||||
//! default route uses, now or after it changes. Kernel forwarding is only
|
||||
//! *read*. Turning it on changes how the whole host behaves, which is the
|
||||
//! owner's decision, so when it is off the rules are installed anyway and the
|
||||
//! report says so.
|
||||
//!
|
||||
//! # Using
|
||||
//!
|
||||
//! Policy routing, with no `/1` routes and nothing in the main table:
|
||||
//!
|
||||
//! ```text
|
||||
//! table 0x7473: default dev <if>
|
||||
//! 5280: from all uidrange <euid>-<euid> lookup main
|
||||
//! 5290: from all lookup main suppress_prefixlength 0
|
||||
//! 5300: from all lookup 0x7473
|
||||
//! ```
|
||||
//!
|
||||
//! The first keeps the agent's *own* sockets off the tunnel: its QUIC, relay,
|
||||
//! DHT and DNS traffic would otherwise be routed into the interface it is
|
||||
//! carrying, a loop. The second lets every specific route — the LAN, another
|
||||
//! VPN, a tunnel to somewhere else — keep working, because only the default
|
||||
//! route is suppressed. The priorities sit after Tailscale's 5270.
|
||||
//!
|
||||
//! The first rule exempts a *user id*, so it is only right when the agent has
|
||||
//! one of its own, as the packaged service does. An agent started from a login
|
||||
//! session would take that user's own applications out of the tunnel with it,
|
||||
//! and the exit node would silently do nothing for them. That is refused, not
|
||||
//! guessed at: see [`client_refusal`].
|
||||
|
||||
use crate::BoxFuture;
|
||||
use crate::state::Ipv4Range;
|
||||
|
||||
use super::RuleOutcome;
|
||||
use super::exit::{ExitHostPlan, ExitHostReport, ExitHostRules, exit_tag, exit_tag_prefix};
|
||||
use super::linux::{LinuxHostRules, Ran, Run, failure, locked, run_iptables, split_rule_line};
|
||||
|
||||
/// The chains the offering rules live in: `(table, chain)`.
|
||||
const CHAINS: [(&str, &str); 2] = [("nat", "POSTROUTING"), ("filter", "FORWARD")];
|
||||
|
||||
/// One firewall rule: where it goes, and its match and target.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
struct Rule {
|
||||
table: &'static str,
|
||||
chain: &'static str,
|
||||
spec: Vec<String>,
|
||||
}
|
||||
|
||||
fn owned(words: &[&str]) -> Vec<String> {
|
||||
words.iter().map(|word| word.to_string()).collect()
|
||||
}
|
||||
|
||||
/// The three rules of one offered range.
|
||||
fn offer_rules(interface: &str, range: &Ipv4Range) -> Vec<Rule> {
|
||||
let range_text = range.to_string();
|
||||
let tag = exit_tag(interface, range);
|
||||
let comment = ["-m", "comment", "--comment", tag.as_str()];
|
||||
let spec = |head: &[&str], tail: &[&str]| -> Vec<String> {
|
||||
owned(head)
|
||||
.into_iter()
|
||||
.chain(owned(&comment))
|
||||
.chain(owned(tail))
|
||||
.collect()
|
||||
};
|
||||
vec![
|
||||
Rule {
|
||||
table: "nat",
|
||||
chain: "POSTROUTING",
|
||||
spec: spec(
|
||||
&["-s", &range_text, "!", "-o", interface],
|
||||
&["-j", "MASQUERADE"],
|
||||
),
|
||||
},
|
||||
Rule {
|
||||
table: "filter",
|
||||
chain: "FORWARD",
|
||||
spec: spec(
|
||||
&["-i", interface, "-s", &range_text, "!", "-o", interface],
|
||||
&["-j", "ACCEPT"],
|
||||
),
|
||||
},
|
||||
Rule {
|
||||
table: "filter",
|
||||
chain: "FORWARD",
|
||||
spec: spec(
|
||||
&[
|
||||
"-o",
|
||||
interface,
|
||||
"-d",
|
||||
&range_text,
|
||||
"-m",
|
||||
"conntrack",
|
||||
"--ctstate",
|
||||
"RELATED,ESTABLISHED",
|
||||
],
|
||||
&["-j", "ACCEPT"],
|
||||
),
|
||||
},
|
||||
]
|
||||
}
|
||||
|
||||
fn check_args(rule: &Rule) -> Vec<String> {
|
||||
locked(
|
||||
owned(&["-t", rule.table, "-C", rule.chain])
|
||||
.into_iter()
|
||||
.chain(rule.spec.iter().cloned()),
|
||||
)
|
||||
}
|
||||
|
||||
fn insert_args(rule: &Rule) -> Vec<String> {
|
||||
locked(
|
||||
owned(&["-t", rule.table, "-I", rule.chain, "1"])
|
||||
.into_iter()
|
||||
.chain(rule.spec.iter().cloned()),
|
||||
)
|
||||
}
|
||||
|
||||
fn list_args(table: &str, chain: &str) -> Vec<String> {
|
||||
locked(owned(&["-t", table, "-S", chain]))
|
||||
}
|
||||
|
||||
/// A rule found in a listing whose comment starts with our prefix.
|
||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||
struct Found {
|
||||
/// The whole tag.
|
||||
tag: String,
|
||||
/// The words after `-A <chain>`, which is what `-D` needs.
|
||||
rest: Vec<String>,
|
||||
}
|
||||
|
||||
/// Every rule in an `iptables -S <chain>` listing carrying a tag that starts
|
||||
/// with `prefix`. Anything else in the chain is left alone.
|
||||
fn tagged_rules(listing: &str, chain: &str, prefix: &str) -> Vec<Found> {
|
||||
listing
|
||||
.lines()
|
||||
.filter_map(|line| {
|
||||
let words = split_rule_line(line);
|
||||
let [append, found_chain, rest @ ..] = words.as_slice() else {
|
||||
return None;
|
||||
};
|
||||
if append != "-A" || found_chain != chain {
|
||||
return None;
|
||||
}
|
||||
let tag = rest
|
||||
.windows(2)
|
||||
.find(|pair| pair[0] == "--comment" && pair[1].starts_with(prefix))
|
||||
.map(|pair| pair[1].clone())?;
|
||||
Some(Found {
|
||||
tag,
|
||||
rest: rest.to_vec(),
|
||||
})
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
fn delete_args(table: &str, chain: &str, found: &Found) -> Vec<String> {
|
||||
locked(
|
||||
owned(&["-t", table, "-D", chain])
|
||||
.into_iter()
|
||||
.chain(found.rest.iter().cloned()),
|
||||
)
|
||||
}
|
||||
|
||||
fn missing_iptables(range: &Ipv4Range, interface: &str) -> String {
|
||||
format!(
|
||||
"iptables not found; install it (the iptables-nft package is enough), or masquerade \
|
||||
{range} out of every interface but `{interface}` and forward it yourself"
|
||||
)
|
||||
}
|
||||
|
||||
/// Reads one chain, or says why not.
|
||||
fn read_chain(run: Run<'_>, table: &str, chain: &str) -> Result<String, Failure> {
|
||||
match run(&list_args(table, chain)) {
|
||||
Ran::Missing => Err(Failure::Missing),
|
||||
Ran::Exited {
|
||||
success: true,
|
||||
stdout,
|
||||
..
|
||||
} => Ok(stdout),
|
||||
Ran::Exited { stderr, .. } => Err(Failure::Failed(failure(&stderr))),
|
||||
}
|
||||
}
|
||||
|
||||
enum Failure {
|
||||
Missing,
|
||||
Failed(String),
|
||||
}
|
||||
|
||||
/// Deletes found rules; the first failure ends it.
|
||||
fn delete_all(
|
||||
run: Run<'_>,
|
||||
table: &str,
|
||||
chain: &str,
|
||||
found: &[Found],
|
||||
keep: impl Fn(&Found) -> bool,
|
||||
) -> Result<(), String> {
|
||||
for rule in found.iter().filter(|rule| !keep(rule)) {
|
||||
if let Ran::Exited {
|
||||
success: false,
|
||||
stderr,
|
||||
..
|
||||
} = run(&delete_args(table, chain, rule))
|
||||
{
|
||||
return Err(failure(&stderr));
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Makes the firewall hold exactly the offering rules of these ranges for the
|
||||
/// interface, and no others of ours.
|
||||
fn apply_offer(
|
||||
run: Run<'_>,
|
||||
interface: &str,
|
||||
ranges: &[Ipv4Range],
|
||||
) -> Vec<(Ipv4Range, RuleOutcome)> {
|
||||
let fail_all = |reason: String| -> Vec<(Ipv4Range, RuleOutcome)> {
|
||||
ranges
|
||||
.iter()
|
||||
.map(|range| (*range, RuleOutcome::Failed(reason.clone())))
|
||||
.collect()
|
||||
};
|
||||
let prefix = exit_tag_prefix(interface);
|
||||
let wanted: Vec<String> = ranges.iter().map(|r| exit_tag(interface, r)).collect();
|
||||
|
||||
// What is there now, per chain.
|
||||
let mut present: Vec<(&str, &str, Vec<Found>)> = Vec::new();
|
||||
for (table, chain) in CHAINS {
|
||||
match read_chain(run, table, chain) {
|
||||
Ok(listing) => present.push((table, chain, tagged_rules(&listing, chain, &prefix))),
|
||||
Err(Failure::Missing) => {
|
||||
return match ranges.first() {
|
||||
Some(range) => fail_all(missing_iptables(range, interface)),
|
||||
None => Vec::new(),
|
||||
};
|
||||
}
|
||||
Err(Failure::Failed(reason)) => return fail_all(reason),
|
||||
}
|
||||
}
|
||||
|
||||
// Rules for a range no longer offered, or left by an earlier run.
|
||||
for (table, chain, found) in &present {
|
||||
if let Err(reason) = delete_all(run, table, chain, found, |rule| wanted.contains(&rule.tag))
|
||||
{
|
||||
return fail_all(reason);
|
||||
}
|
||||
}
|
||||
|
||||
ranges
|
||||
.iter()
|
||||
.map(|range| {
|
||||
let rules = offer_rules(interface, range);
|
||||
let tag = exit_tag(interface, range);
|
||||
let in_place = rules
|
||||
.iter()
|
||||
.all(|rule| matches!(run(&check_args(rule)), Ran::Exited { success: true, .. }))
|
||||
&& present.iter().all(|(_, chain, found)| {
|
||||
let have = found.iter().filter(|rule| rule.tag == tag).count();
|
||||
have == rules.iter().filter(|rule| rule.chain == *chain).count()
|
||||
});
|
||||
if in_place {
|
||||
return (*range, RuleOutcome::Applied);
|
||||
}
|
||||
// Start this range from a clean slate: a half-installed set, or
|
||||
// one that differs from the plan, is replaced as a whole.
|
||||
for (table, chain, found) in &present {
|
||||
if let Err(reason) = delete_all(run, table, chain, found, |rule| rule.tag != tag) {
|
||||
return (*range, RuleOutcome::Failed(reason));
|
||||
}
|
||||
}
|
||||
for rule in &rules {
|
||||
match run(&insert_args(rule)) {
|
||||
Ran::Missing => {
|
||||
return (
|
||||
*range,
|
||||
RuleOutcome::Failed(missing_iptables(range, interface)),
|
||||
);
|
||||
}
|
||||
Ran::Exited { success: true, .. } => {}
|
||||
Ran::Exited { stderr, .. } => {
|
||||
return (*range, RuleOutcome::Failed(failure(&stderr)));
|
||||
}
|
||||
}
|
||||
}
|
||||
(*range, RuleOutcome::Applied)
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
/// Removes every offering rule of ours for the interface. Best effort.
|
||||
fn clear_offer(run: Run<'_>, interface: &str) {
|
||||
let prefix = exit_tag_prefix(interface);
|
||||
for (table, chain) in CHAINS {
|
||||
let Ok(listing) = read_chain(run, table, chain) else {
|
||||
continue;
|
||||
};
|
||||
let found = tagged_rules(&listing, chain, &prefix);
|
||||
if let Err(reason) = delete_all(run, table, chain, &found, |_| false) {
|
||||
tracing::warn!(
|
||||
interface,
|
||||
"cannot remove an exit node firewall rule: {reason}"
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// The kernel's forwarding switch for packets arriving on the interface,
|
||||
/// read from the text of the sysctl files. Never written.
|
||||
fn forwarding_state(read: impl Fn(&str) -> Option<String>, interface: &str) -> Option<bool> {
|
||||
let flag = |text: String| match text.trim() {
|
||||
"1" => Some(true),
|
||||
"0" => Some(false),
|
||||
_ => None,
|
||||
};
|
||||
// The name is derived here, but it ends up in a path.
|
||||
if !interface.is_empty() && !interface.contains(['/', '\0']) && interface != ".." {
|
||||
let per_interface = format!("/proc/sys/net/ipv4/conf/{interface}/forwarding");
|
||||
if let Some(state) = read(&per_interface).and_then(flag) {
|
||||
return Some(state);
|
||||
}
|
||||
}
|
||||
read("/proc/sys/net/ipv4/ip_forward").and_then(flag)
|
||||
}
|
||||
|
||||
fn read_sysctl(path: &str) -> Option<String> {
|
||||
std::fs::read_to_string(path).ok()
|
||||
}
|
||||
|
||||
/// The effective user id from the text of `/proc/self/status`.
|
||||
fn parse_euid(status: &str) -> Option<u32> {
|
||||
status
|
||||
.lines()
|
||||
.find_map(|line| line.strip_prefix("Uid:"))
|
||||
.and_then(|rest| rest.split_whitespace().nth(1))
|
||||
.and_then(|effective| effective.parse().ok())
|
||||
}
|
||||
|
||||
/// Why the using side must not be installed for this process, if it must not.
|
||||
///
|
||||
/// The bypass rule exempts this process's *user id* from the tunnel. That is
|
||||
/// right for a service with an id of its own and wrong for a process started
|
||||
/// from somebody's login session, which shares its id with every application
|
||||
/// that person runs. A login session is recognised by `XDG_RUNTIME_DIR`,
|
||||
/// which `systemd --user` and the login managers set and a system service
|
||||
/// does not. Crude on purpose: refusing a service that was started oddly is
|
||||
/// a message, and exempting a user's applications is a silent failure.
|
||||
fn client_refusal(xdg_runtime_dir: Option<&str>) -> Option<String> {
|
||||
xdg_runtime_dir.filter(|dir| !dir.is_empty()).map(|_| {
|
||||
"the exit node needs the agent to run as a system service with a user of its own: \
|
||||
this agent was started from a login session, so routing everything through the \
|
||||
overlay would take that user's own applications out of the tunnel with it"
|
||||
.to_string()
|
||||
})
|
||||
}
|
||||
|
||||
impl LinuxHostRules {
|
||||
async fn blocking<T: Send + 'static>(
|
||||
work: impl FnOnce() -> T + Send + 'static,
|
||||
) -> Result<T, String> {
|
||||
tokio::task::spawn_blocking(work)
|
||||
.await
|
||||
.map_err(|err| format!("the task failed: {err}"))
|
||||
}
|
||||
|
||||
async fn apply_client(&self, interface: &str) -> RuleOutcome {
|
||||
let xdg = std::env::var("XDG_RUNTIME_DIR").ok();
|
||||
if let Some(reason) = client_refusal(xdg.as_deref()) {
|
||||
// Whatever an earlier run left must not stay in force.
|
||||
self.clear_client().await;
|
||||
return RuleOutcome::Failed(reason);
|
||||
}
|
||||
let Some(euid) = std::fs::read_to_string("/proc/self/status")
|
||||
.ok()
|
||||
.and_then(|status| parse_euid(&status))
|
||||
else {
|
||||
return RuleOutcome::Failed("cannot tell which user this agent runs as".to_string());
|
||||
};
|
||||
let route = self.route.clone();
|
||||
let interface = interface.to_string();
|
||||
match Self::blocking(move || route.set_exit_client(&interface, euid)).await {
|
||||
Ok(Ok(())) => RuleOutcome::Applied,
|
||||
Ok(Err(err)) => RuleOutcome::Failed(err.to_string()),
|
||||
Err(reason) => RuleOutcome::Failed(reason),
|
||||
}
|
||||
}
|
||||
|
||||
async fn clear_client(&self) {
|
||||
let route = self.route.clone();
|
||||
if let Ok(Err(err)) = Self::blocking(move || route.clear_exit_client()).await {
|
||||
tracing::warn!(%err, "cannot remove the exit node routing rules");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl ExitHostRules for LinuxHostRules {
|
||||
fn apply<'a>(&'a self, plan: &'a ExitHostPlan) -> BoxFuture<'a, ExitHostReport> {
|
||||
Box::pin(async move {
|
||||
let interface = plan.interface.clone();
|
||||
let ranges = plan.offer.clone();
|
||||
let offer = {
|
||||
let (job_interface, job_ranges) = (interface.clone(), ranges.clone());
|
||||
Self::blocking(move || apply_offer(&run_iptables, &job_interface, &job_ranges))
|
||||
.await
|
||||
.unwrap_or_else(|reason| {
|
||||
ranges
|
||||
.iter()
|
||||
.map(|range| (*range, RuleOutcome::Failed(reason.clone())))
|
||||
.collect()
|
||||
})
|
||||
};
|
||||
let forwarding = if ranges.is_empty() {
|
||||
None
|
||||
} else {
|
||||
forwarding_state(read_sysctl, &interface)
|
||||
};
|
||||
let client = if plan.client {
|
||||
Some(self.apply_client(&interface).await)
|
||||
} else {
|
||||
self.clear_client().await;
|
||||
None
|
||||
};
|
||||
ExitHostReport {
|
||||
offer,
|
||||
forwarding,
|
||||
client,
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn clear<'a>(&'a self, interface: &'a str) -> BoxFuture<'a, ()> {
|
||||
Box::pin(async move {
|
||||
let name = interface.to_string();
|
||||
let _ = Self::blocking(move || clear_offer(&run_iptables, &name)).await;
|
||||
self.clear_client().await;
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
|
||||
|
||||
use std::cell::RefCell;
|
||||
|
||||
use super::*;
|
||||
|
||||
fn range() -> Ipv4Range {
|
||||
"10.13.37.0/24".parse().unwrap()
|
||||
}
|
||||
|
||||
fn words(args: &[String]) -> String {
|
||||
args.join(" ")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_rules_masquerade_the_range_out_of_every_other_interface_and_forward_it() {
|
||||
let rules = offer_rules("tsun0", &range());
|
||||
assert_eq!(rules.len(), 3);
|
||||
assert_eq!(
|
||||
words(&rules[0].spec),
|
||||
"-s 10.13.37.0/24 ! -o tsun0 -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j MASQUERADE"
|
||||
);
|
||||
assert_eq!((rules[0].table, rules[0].chain), ("nat", "POSTROUTING"));
|
||||
assert_eq!(
|
||||
words(&rules[1].spec),
|
||||
"-i tsun0 -s 10.13.37.0/24 ! -o tsun0 -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j ACCEPT"
|
||||
);
|
||||
assert_eq!((rules[1].table, rules[1].chain), ("filter", "FORWARD"));
|
||||
assert_eq!(
|
||||
words(&rules[2].spec),
|
||||
"-o tsun0 -d 10.13.37.0/24 -m conntrack --ctstate RELATED,ESTABLISHED -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j ACCEPT"
|
||||
);
|
||||
// Nothing may widen to every source or to the other direction.
|
||||
for rule in &rules {
|
||||
assert!(!words(&rule.spec).contains("0.0.0.0/0"));
|
||||
}
|
||||
assert!(words(&insert_args(&rules[1])).starts_with("-w 5 -t filter -I FORWARD 1 -i tsun0"));
|
||||
assert!(words(&check_args(&rules[0])).starts_with("-w 5 -t nat -C POSTROUTING -s"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_rules_with_our_tag_for_this_interface_are_selected() {
|
||||
let listing = "\
|
||||
-P FORWARD DROP
|
||||
-A FORWARD -i tsun0 -s 10.13.37.0/24 ! -o tsun0 -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j ACCEPT
|
||||
-A FORWARD -i tsun1 -m comment --comment tsunagi-exit:tsun1:10.99.0.0/24 -j ACCEPT
|
||||
-A FORWARD -i tsun01 -m comment --comment tsunagi-exit:tsun01:10.5.0.0/24 -j ACCEPT
|
||||
-A FORWARD -m comment --comment \"allow tsunagi-exit:tsun0:x\" -j ACCEPT
|
||||
-A FORWARD -m comment --comment tsunagi:tsun0 -j ACCEPT
|
||||
-A INPUT -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j ACCEPT
|
||||
-A FORWARD -j ACCEPT
|
||||
";
|
||||
let found = tagged_rules(listing, "FORWARD", &exit_tag_prefix("tsun0"));
|
||||
assert_eq!(found.len(), 1, "{found:?}");
|
||||
assert_eq!(found[0].tag, "tsunagi-exit:tsun0:10.13.37.0/24");
|
||||
assert_eq!(
|
||||
words(&delete_args("filter", "FORWARD", &found[0])),
|
||||
"-w 5 -t filter -D FORWARD -i tsun0 -s 10.13.37.0/24 ! -o tsun0 -m comment --comment tsunagi-exit:tsun0:10.13.37.0/24 -j ACCEPT"
|
||||
);
|
||||
assert!(tagged_rules("", "FORWARD", "tsunagi-exit:tsun0:").is_empty());
|
||||
}
|
||||
|
||||
/// A scripted `iptables` that remembers which rules it was given.
|
||||
struct Fake {
|
||||
calls: RefCell<Vec<String>>,
|
||||
/// Rules present, as `-S` lines per `(table, chain)`.
|
||||
listing: RefCell<Vec<(String, String)>>,
|
||||
missing: bool,
|
||||
check_ok: bool,
|
||||
}
|
||||
|
||||
impl Fake {
|
||||
fn new(check_ok: bool) -> Self {
|
||||
Self {
|
||||
calls: RefCell::new(Vec::new()),
|
||||
listing: RefCell::new(Vec::new()),
|
||||
missing: false,
|
||||
check_ok,
|
||||
}
|
||||
}
|
||||
|
||||
fn with_rule(self, table: &str, line: &str) -> Self {
|
||||
self.listing
|
||||
.borrow_mut()
|
||||
.push((table.to_string(), line.to_string()));
|
||||
self
|
||||
}
|
||||
|
||||
fn run(&self, args: &[String]) -> Ran {
|
||||
if self.missing {
|
||||
return Ran::Missing;
|
||||
}
|
||||
let line = args.join(" ");
|
||||
self.calls.borrow_mut().push(line.clone());
|
||||
let table = args
|
||||
.iter()
|
||||
.position(|word| word == "-t")
|
||||
.map(|at| args[at + 1].clone())
|
||||
.unwrap_or_default();
|
||||
let ok = |stdout: String| Ran::Exited {
|
||||
success: true,
|
||||
stdout,
|
||||
stderr: String::new(),
|
||||
};
|
||||
if line.contains(" -S ") {
|
||||
let listing: Vec<String> = self
|
||||
.listing
|
||||
.borrow()
|
||||
.iter()
|
||||
.filter(|(t, _)| *t == table)
|
||||
.map(|(_, l)| l.clone())
|
||||
.collect();
|
||||
return ok(listing.join("\n"));
|
||||
}
|
||||
if line.contains(" -C ") {
|
||||
return Ran::Exited {
|
||||
success: self.check_ok,
|
||||
stdout: String::new(),
|
||||
stderr: String::new(),
|
||||
};
|
||||
}
|
||||
ok(String::new())
|
||||
}
|
||||
|
||||
fn verbs(&self, verb: &str) -> Vec<String> {
|
||||
self.calls
|
||||
.borrow()
|
||||
.iter()
|
||||
.filter(|call| call.contains(&format!(" {verb} ")))
|
||||
.cloned()
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_fresh_host_gets_the_three_rules() {
|
||||
let fake = Fake::new(false);
|
||||
let outcome = apply_offer(&|args| fake.run(args), "tsun0", &[range()]);
|
||||
assert_eq!(outcome, vec![(range(), RuleOutcome::Applied)]);
|
||||
let inserted = fake.verbs("-I");
|
||||
assert_eq!(inserted.len(), 3, "{inserted:?}");
|
||||
assert!(inserted[0].contains("-t nat -I POSTROUTING 1"));
|
||||
assert!(fake.verbs("-D").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn rules_already_in_place_are_left_alone() {
|
||||
let tag = exit_tag("tsun0", &range());
|
||||
let fake = Fake::new(true)
|
||||
.with_rule(
|
||||
"nat",
|
||||
&format!("-A POSTROUTING -s 10.13.37.0/24 ! -o tsun0 -m comment --comment {tag} -j MASQUERADE"),
|
||||
)
|
||||
.with_rule("filter", &format!("-A FORWARD -i tsun0 -m comment --comment {tag} -j ACCEPT"))
|
||||
.with_rule("filter", &format!("-A FORWARD -o tsun0 -m comment --comment {tag} -j ACCEPT"));
|
||||
let outcome = apply_offer(&|args| fake.run(args), "tsun0", &[range()]);
|
||||
assert_eq!(outcome, vec![(range(), RuleOutcome::Applied)]);
|
||||
assert!(fake.verbs("-I").is_empty());
|
||||
assert!(fake.verbs("-D").is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_stale_range_is_removed_and_a_half_installed_set_is_replaced() {
|
||||
let old: Ipv4Range = "10.99.0.0/24".parse().unwrap();
|
||||
let old_tag = exit_tag("tsun0", &old);
|
||||
let tag = exit_tag("tsun0", &range());
|
||||
let fake = Fake::new(true)
|
||||
.with_rule(
|
||||
"nat",
|
||||
&format!(
|
||||
"-A POSTROUTING -s 10.99.0.0/24 -m comment --comment {old_tag} -j MASQUERADE"
|
||||
),
|
||||
)
|
||||
// Only one of the three for the current range.
|
||||
.with_rule(
|
||||
"filter",
|
||||
&format!("-A FORWARD -i tsun0 -m comment --comment {tag} -j ACCEPT"),
|
||||
)
|
||||
// Somebody else's rule, which must survive.
|
||||
.with_rule("filter", "-A FORWARD -i eth0 -j ACCEPT");
|
||||
let outcome = apply_offer(&|args| fake.run(args), "tsun0", &[range()]);
|
||||
assert_eq!(outcome, vec![(range(), RuleOutcome::Applied)]);
|
||||
let deleted = fake.verbs("-D");
|
||||
assert!(
|
||||
deleted.iter().any(|call| call.contains(&old_tag)),
|
||||
"{deleted:?}"
|
||||
);
|
||||
assert!(
|
||||
deleted.iter().any(|call| call.contains(&tag)),
|
||||
"{deleted:?}"
|
||||
);
|
||||
assert!(
|
||||
deleted.iter().all(|call| !call.contains("eth0")),
|
||||
"{deleted:?}"
|
||||
);
|
||||
assert_eq!(fake.verbs("-I").len(), 3);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn clearing_removes_only_our_rules_for_the_interface() {
|
||||
let tag = exit_tag("tsun0", &range());
|
||||
let other = exit_tag("tsun1", &range());
|
||||
let fake = Fake::new(true)
|
||||
.with_rule(
|
||||
"nat",
|
||||
&format!("-A POSTROUTING -m comment --comment {tag} -j MASQUERADE"),
|
||||
)
|
||||
.with_rule(
|
||||
"nat",
|
||||
&format!("-A POSTROUTING -m comment --comment {other} -j MASQUERADE"),
|
||||
)
|
||||
.with_rule("filter", "-A FORWARD -j ACCEPT");
|
||||
clear_offer(&|args| fake.run(args), "tsun0");
|
||||
let deleted = fake.verbs("-D");
|
||||
assert_eq!(deleted.len(), 1, "{deleted:?}");
|
||||
assert!(deleted[0].contains(&tag));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_missing_iptables_is_a_failure_that_says_what_to_do() {
|
||||
let mut fake = Fake::new(false);
|
||||
fake.missing = true;
|
||||
let outcome = apply_offer(&|args| fake.run(args), "tsun0", &[range()]);
|
||||
let RuleOutcome::Failed(reason) = &outcome[0].1 else {
|
||||
panic!("{outcome:?}");
|
||||
};
|
||||
assert!(reason.contains("iptables not found"), "{reason}");
|
||||
assert!(reason.contains("10.13.37.0/24"), "{reason}");
|
||||
// Nothing wanted and nothing to run is not a failure of anything.
|
||||
assert!(apply_offer(&|args| fake.run(args), "tsun0", &[]).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn forwarding_is_read_per_interface_then_globally_and_never_written() {
|
||||
let files = |per: Option<&'static str>, global: Option<&'static str>| {
|
||||
move |path: &str| match path {
|
||||
"/proc/sys/net/ipv4/conf/tsun0/forwarding" => per.map(str::to_string),
|
||||
"/proc/sys/net/ipv4/ip_forward" => global.map(str::to_string),
|
||||
_ => None,
|
||||
}
|
||||
};
|
||||
assert_eq!(
|
||||
forwarding_state(files(Some("1\n"), Some("0\n")), "tsun0"),
|
||||
Some(true)
|
||||
);
|
||||
assert_eq!(
|
||||
forwarding_state(files(Some("0\n"), Some("1\n")), "tsun0"),
|
||||
Some(false)
|
||||
);
|
||||
assert_eq!(
|
||||
forwarding_state(files(None, Some("1\n")), "tsun0"),
|
||||
Some(true)
|
||||
);
|
||||
assert_eq!(forwarding_state(files(None, None), "tsun0"), None);
|
||||
assert_eq!(forwarding_state(files(Some("junk"), None), "tsun0"), None);
|
||||
// A name that would leave the directory is not looked up.
|
||||
assert_eq!(forwarding_state(files(Some("1"), None), "../../x"), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_effective_uid_is_the_second_field() {
|
||||
let status = "Name:\ttsunagi\nUid:\t1001\t1002\t1001\t1001\nGid:\t5\t5\t5\t5\n";
|
||||
assert_eq!(parse_euid(status), Some(1002));
|
||||
assert_eq!(parse_euid("Name:\tx\n"), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_login_session_is_refused_and_a_service_is_not() {
|
||||
let reason = client_refusal(Some("/run/user/1000")).unwrap();
|
||||
assert!(reason.contains("system service"), "{reason}");
|
||||
assert!(client_refusal(None).is_none());
|
||||
assert!(client_refusal(Some("")).is_none());
|
||||
}
|
||||
}
|
||||
File renamed without changes.
+31
-1
@@ -45,9 +45,17 @@ use std::sync::{Arc, Mutex};
|
||||
use crate::BoxFuture;
|
||||
use crate::state::Ipv4Range;
|
||||
|
||||
mod exit;
|
||||
pub use exit::{
|
||||
ExitHostPlan, ExitHostReport, ExitHostRules, MockExitRules, exit_tag, exit_tag_prefix,
|
||||
offer_detail,
|
||||
};
|
||||
|
||||
#[cfg(all(feature = "tun-device", target_os = "linux"))]
|
||||
mod linux;
|
||||
#[cfg(all(feature = "tun-device", target_os = "linux"))]
|
||||
mod linux_exit;
|
||||
#[cfg(all(feature = "tun-device", target_os = "linux"))]
|
||||
pub use linux::LinuxHostRules;
|
||||
|
||||
// Compiled everywhere so the scripts it builds are tested everywhere; only
|
||||
@@ -159,6 +167,15 @@ pub trait BroadcastHostRules: Send + Sync + std::fmt::Debug + 'static {
|
||||
/// Removes what this agent put there for the interface. Succeeds when
|
||||
/// nothing is there: it runs on the shutdown path.
|
||||
fn clear<'a>(&'a self, interface: &'a str) -> BoxFuture<'a, ()>;
|
||||
|
||||
/// The exit-node rules that go with these, when the platform has them.
|
||||
///
|
||||
/// One object per host, because both halves need the same privileged
|
||||
/// helpers; the default is that this platform has none, which is said
|
||||
/// where it matters rather than pretended.
|
||||
fn exit_rules(&self) -> Option<&dyn ExitHostRules> {
|
||||
None
|
||||
}
|
||||
}
|
||||
|
||||
/// The platform has no implementation, which is said rather than pretended.
|
||||
@@ -195,6 +212,7 @@ pub type MockRulesState = std::collections::BTreeMap<String, BroadcastRulesPlan>
|
||||
/// An in-memory host, for tests: nothing is touched.
|
||||
#[derive(Debug, Clone, Default)]
|
||||
pub struct MockHostRules {
|
||||
exit: MockExitRules,
|
||||
state: Arc<Mutex<MockRulesState>>,
|
||||
calls: Arc<Mutex<Vec<String>>>,
|
||||
firewall_failure: Arc<Mutex<Option<String>>>,
|
||||
@@ -203,7 +221,15 @@ pub struct MockHostRules {
|
||||
impl MockHostRules {
|
||||
/// An empty host.
|
||||
pub fn new() -> Self {
|
||||
Self::default()
|
||||
Self {
|
||||
exit: MockExitRules::new(),
|
||||
..Self::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// The exit-node half of this host, for inspecting and steering tests.
|
||||
pub fn exit(&self) -> &MockExitRules {
|
||||
&self.exit
|
||||
}
|
||||
|
||||
/// Makes the firewall step fail with this reason from now on.
|
||||
@@ -234,6 +260,10 @@ impl BroadcastHostRules for MockHostRules {
|
||||
"mock"
|
||||
}
|
||||
|
||||
fn exit_rules(&self) -> Option<&dyn ExitHostRules> {
|
||||
Some(&self.exit)
|
||||
}
|
||||
|
||||
fn apply<'a>(&'a self, plan: &'a BroadcastRulesPlan) -> BoxFuture<'a, BroadcastRulesReport> {
|
||||
Box::pin(async move {
|
||||
lock(&self.calls).push(format!("apply:{}", plan.interface));
|
||||
+1
-1
@@ -90,7 +90,7 @@ fn classify(what: &str, text: &str) -> String {
|
||||
|| lower.contains("run as administrator")
|
||||
|| lower.contains("permissiondenied")
|
||||
{
|
||||
format!("{what}: Windows refused; run tsunagi from an elevated (administrator) process")
|
||||
format!("{what}: Windows refused; run tsng from an elevated (administrator) process")
|
||||
} else if lower.contains("is not recognized") || lower.contains("commandnotfound") {
|
||||
format!("{what}: the NetTCPIP/NetSecurity PowerShell modules are not available: {text}")
|
||||
} else if text.is_empty() {
|
||||
+495
-2
@@ -29,7 +29,11 @@ use tokio::task::JoinHandle;
|
||||
|
||||
use crate::identity::NetworkId;
|
||||
|
||||
use super::hostrules::{BroadcastHostRules, BroadcastRulesPlan, BroadcastRulesReport};
|
||||
use super::exit::{ExitRulesReport, RuleSetReport};
|
||||
use super::hostrules::{
|
||||
BroadcastHostRules, BroadcastRulesPlan, BroadcastRulesReport, ExitHostPlan, ExitHostReport,
|
||||
RuleOutcome, offer_detail,
|
||||
};
|
||||
use super::packet::IpHeader;
|
||||
use super::router::{Route, RoutingTable};
|
||||
use super::tun::{TunDevice, TunFactory, TunRequest};
|
||||
@@ -158,6 +162,31 @@ pub struct Interface {
|
||||
host_rules: Option<Arc<dyn BroadcastHostRules>>,
|
||||
/// What those rules last reported, `None` while none are installed.
|
||||
rules_report: std::sync::Mutex<Option<BroadcastRulesReport>>,
|
||||
/// What the exit-node rules were last asked for, and what came of it.
|
||||
exit_state: std::sync::Mutex<ExitState>,
|
||||
}
|
||||
|
||||
/// The exit-node host rules as this interface last left them.
|
||||
#[derive(Debug, Default)]
|
||||
struct ExitState {
|
||||
/// Whether what an earlier run left behind has been taken away. Done once,
|
||||
/// at the first sync, whether or not anything is wanted now: a firewall
|
||||
/// rule that forwards a range must not outlive the switch that offered it.
|
||||
cleaned: bool,
|
||||
/// What was last applied, `None` while nothing is.
|
||||
plan: Option<ExitHostPlan>,
|
||||
/// What came of it.
|
||||
report: Option<ExitHostReport>,
|
||||
}
|
||||
|
||||
impl ExitState {
|
||||
/// Whether every step of the last apply took.
|
||||
fn is_ok(&self) -> bool {
|
||||
self.report.as_ref().is_some_and(|report| {
|
||||
report.offer.iter().all(|(_, outcome)| outcome.is_applied())
|
||||
&& report.client.as_ref().is_none_or(RuleOutcome::is_applied)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl Interface {
|
||||
@@ -245,6 +274,7 @@ impl Interface {
|
||||
sync_lock: Arc::new(tokio::sync::Mutex::new(())),
|
||||
host_rules,
|
||||
rules_report: std::sync::Mutex::new(None),
|
||||
exit_state: std::sync::Mutex::new(ExitState::default()),
|
||||
})
|
||||
}
|
||||
|
||||
@@ -298,6 +328,193 @@ impl Interface {
|
||||
}
|
||||
}
|
||||
|
||||
/// Brings the host's exit-node rules in line with the routing table.
|
||||
///
|
||||
/// Idempotent, and cheap when nothing changed. It never fails: the
|
||||
/// outcome is kept for [`Self::exit_rules`]. The first call also takes
|
||||
/// away whatever an earlier run left, even when nothing is wanted now.
|
||||
pub async fn sync_exit_rules(&self) {
|
||||
let Some(exit) = self
|
||||
.host_rules
|
||||
.as_ref()
|
||||
.and_then(|rules| rules.exit_rules())
|
||||
else {
|
||||
return;
|
||||
};
|
||||
let _guard = self.sync_lock.lock().await;
|
||||
let mut ranges: Vec<_> = self
|
||||
.routes
|
||||
.exit_offers()
|
||||
.into_iter()
|
||||
.map(|(_, range)| range)
|
||||
.collect();
|
||||
ranges.sort_by_key(|range| (range.base, range.prefix_len));
|
||||
ranges.dedup();
|
||||
let wanted = ExitHostPlan {
|
||||
interface: self.name.clone(),
|
||||
offer: ranges,
|
||||
client: self.routes.exit_via().is_some(),
|
||||
};
|
||||
|
||||
let first = !std::mem::replace(&mut self.exit_state().cleaned, true);
|
||||
if first {
|
||||
exit.clear(&self.name).await;
|
||||
}
|
||||
let (planned, ok) = {
|
||||
let state = self.exit_state();
|
||||
(state.plan.clone(), state.is_ok())
|
||||
};
|
||||
if wanted.is_empty() {
|
||||
if planned.is_some() {
|
||||
exit.clear(&self.name).await;
|
||||
let mut state = self.exit_state();
|
||||
state.plan = None;
|
||||
state.report = None;
|
||||
tracing::info!(interface = %self.name, "exit node host rules removed");
|
||||
}
|
||||
return;
|
||||
}
|
||||
if planned.as_ref() == Some(&wanted) && ok {
|
||||
return;
|
||||
}
|
||||
let report = exit.apply(&wanted).await;
|
||||
for (range, outcome) in &report.offer {
|
||||
match outcome {
|
||||
RuleOutcome::Applied => tracing::info!(
|
||||
interface = %self.name,
|
||||
%range,
|
||||
"exit node firewall rules applied"
|
||||
),
|
||||
RuleOutcome::Failed(reason) => tracing::warn!(
|
||||
interface = %self.name,
|
||||
%range,
|
||||
"exit node firewall rules are incomplete: {reason}"
|
||||
),
|
||||
}
|
||||
}
|
||||
if report.offer.iter().any(|(_, outcome)| outcome.is_applied())
|
||||
&& report.forwarding == Some(false)
|
||||
{
|
||||
tracing::warn!(
|
||||
interface = %self.name,
|
||||
"kernel forwarding is off for this interface, so nothing is forwarded for the \
|
||||
exit node yet: `sysctl -w net.ipv4.conf.{0}.forwarding=1` (or \
|
||||
`net.ipv4.ip_forward=1`), and set it in sysctl.d to keep it",
|
||||
self.name
|
||||
);
|
||||
}
|
||||
match &report.client {
|
||||
Some(RuleOutcome::Applied) => tracing::info!(
|
||||
interface = %self.name,
|
||||
"this device's traffic is routed through its exit node"
|
||||
),
|
||||
Some(RuleOutcome::Failed(reason)) => tracing::warn!(
|
||||
interface = %self.name,
|
||||
"cannot route this device's traffic through the exit node: {reason}"
|
||||
),
|
||||
None => {}
|
||||
}
|
||||
let mut state = self.exit_state();
|
||||
state.plan = Some(wanted);
|
||||
state.report = Some(report);
|
||||
}
|
||||
|
||||
fn exit_state(&self) -> std::sync::MutexGuard<'_, ExitState> {
|
||||
match self.exit_state.lock() {
|
||||
Ok(guard) => guard,
|
||||
Err(poisoned) => poisoned.into_inner(),
|
||||
}
|
||||
}
|
||||
|
||||
/// What the exit-node rules of a network are doing now.
|
||||
///
|
||||
/// `offer` is `Some` while the network offers this agent as an exit node,
|
||||
/// `client` while this device sends its traffic through a member of it.
|
||||
pub fn exit_rules(&self, network: NetworkId) -> ExitRulesReport {
|
||||
let Some((policy, range)) = self.routes.exit_settings(network) else {
|
||||
return ExitRulesReport::default();
|
||||
};
|
||||
let unavailable = match self
|
||||
.host_rules
|
||||
.as_ref()
|
||||
.map(|rules| rules.exit_rules().is_some())
|
||||
{
|
||||
None => Some(
|
||||
"this overlay interface is not on the host (no TUN device), so there is \
|
||||
nothing to forward to",
|
||||
),
|
||||
Some(false) => Some("exit nodes are only supported on Linux yet"),
|
||||
Some(true) => None,
|
||||
};
|
||||
let failed = |detail: &str| RuleSetReport {
|
||||
ok: false,
|
||||
detail: detail.to_string(),
|
||||
};
|
||||
let state = self.exit_state();
|
||||
let mut out = ExitRulesReport::default();
|
||||
if policy.offer {
|
||||
out.offer = Some(match (unavailable, range) {
|
||||
(Some(why), _) => failed(why),
|
||||
(None, None) => failed("waiting for the network to agree an address range"),
|
||||
(None, Some(range)) => {
|
||||
match state
|
||||
.report
|
||||
.as_ref()
|
||||
.and_then(|report| report.offer.iter().find(|(r, _)| *r == range))
|
||||
{
|
||||
Some((_, outcome)) => RuleSetReport {
|
||||
ok: outcome.is_applied(),
|
||||
detail: offer_detail(outcome, &range),
|
||||
},
|
||||
None => failed("not applied yet"),
|
||||
}
|
||||
}
|
||||
});
|
||||
if unavailable.is_none() {
|
||||
out.forwarding = state.report.as_ref().and_then(|report| report.forwarding);
|
||||
}
|
||||
}
|
||||
if policy.via.is_some()
|
||||
&& self
|
||||
.routes
|
||||
.exit_via()
|
||||
.is_some_and(|(selected, _)| selected == network)
|
||||
{
|
||||
out.client = Some(match unavailable {
|
||||
Some(why) => failed(why),
|
||||
None => match state
|
||||
.report
|
||||
.as_ref()
|
||||
.and_then(|report| report.client.as_ref())
|
||||
{
|
||||
Some(RuleOutcome::Applied) => RuleSetReport {
|
||||
ok: true,
|
||||
detail: "this device's traffic is routed through the exit node".to_string(),
|
||||
},
|
||||
Some(RuleOutcome::Failed(reason)) => failed(reason),
|
||||
None => failed("not applied yet"),
|
||||
},
|
||||
});
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Whether this agent can really act as an exit node in a network: the
|
||||
/// rules members' traffic needs are in place. Kernel forwarding is not
|
||||
/// part of it, because the agent never turns that on itself.
|
||||
pub fn exit_offer_ready(&self, network: NetworkId) -> bool {
|
||||
let Some((policy, Some(range))) = self.routes.exit_settings(network) else {
|
||||
return false;
|
||||
};
|
||||
policy.offer
|
||||
&& self.exit_state().report.as_ref().is_some_and(|report| {
|
||||
report
|
||||
.offer
|
||||
.iter()
|
||||
.any(|(r, outcome)| *r == range && outcome.is_applied())
|
||||
})
|
||||
}
|
||||
|
||||
/// What the broadcast host rules achieved, `None` when none are installed
|
||||
/// or this interface has no host to configure.
|
||||
pub fn broadcast_rules(&self) -> Option<BroadcastRulesReport> {
|
||||
@@ -379,6 +596,16 @@ impl Interface {
|
||||
if let Some(rules) = &self.host_rules {
|
||||
rules.clear(&self.name).await;
|
||||
self.store_rules_report(None);
|
||||
let touched = {
|
||||
let state = self.exit_state();
|
||||
state.cleaned || state.plan.is_some()
|
||||
};
|
||||
if let (true, Some(exit)) = (touched, rules.exit_rules()) {
|
||||
exit.clear(&self.name).await;
|
||||
let mut state = self.exit_state();
|
||||
state.plan = None;
|
||||
state.report = None;
|
||||
}
|
||||
}
|
||||
// The packet loop holds the device open, and it ends only when the
|
||||
// device reports end of stream — which a real interface never does
|
||||
@@ -435,6 +662,11 @@ impl Interface {
|
||||
IpAddr::V4(destination) if self.routes.is_local_destination(network, destination) => {
|
||||
false
|
||||
}
|
||||
// This agent is an exit node of this network: a member's packet
|
||||
// for the internet goes to the host, which masquerades it.
|
||||
IpAddr::V4(destination) if self.routes.accepts_exit_traffic(network, destination) => {
|
||||
false
|
||||
}
|
||||
_ => {
|
||||
self.tally.wrong_destination.fetch_add(1, Ordering::Relaxed);
|
||||
return Err(Rejected::WrongDestination);
|
||||
@@ -525,7 +757,7 @@ mod tests {
|
||||
use crate::overlay::broadcast::BroadcastPolicy;
|
||||
use crate::overlay::hostrules::{MockHostRules, RuleOutcome};
|
||||
use crate::overlay::provision::{ManagedTunFactory, MockProvisioner};
|
||||
use crate::overlay::router::NetworkRoutes;
|
||||
use crate::overlay::router::{ExitPolicy, NetworkRoutes};
|
||||
use crate::overlay::tun::{MemoryTun, MemoryTunFactory};
|
||||
|
||||
fn network(name: &str) -> NetworkId {
|
||||
@@ -667,6 +899,7 @@ mod tests {
|
||||
.set_network(
|
||||
id,
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.13.37.0/24".parse().unwrap()),
|
||||
local: Some(addr(1)),
|
||||
@@ -833,6 +1066,7 @@ mod tests {
|
||||
.set_network(
|
||||
id,
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.13.37.0/24".parse().unwrap()),
|
||||
local: Some(addr(9)),
|
||||
@@ -856,6 +1090,7 @@ mod tests {
|
||||
.set_network(
|
||||
id,
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: BroadcastPolicy {
|
||||
enabled: broadcast_enabled,
|
||||
..Default::default()
|
||||
@@ -910,6 +1145,7 @@ mod tests {
|
||||
.set_network(
|
||||
id,
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: BroadcastPolicy::default(),
|
||||
range: Some("10.13.37.0/24".parse().unwrap()),
|
||||
local: Some(addr(9)),
|
||||
@@ -978,4 +1214,261 @@ mod tests {
|
||||
assert!(interface.broadcast_rules().is_none());
|
||||
interface.remove().await;
|
||||
}
|
||||
|
||||
const INTERNET: Ipv4Addr = Ipv4Addr::new(93, 184, 216, 34);
|
||||
|
||||
fn offering() -> ExitPolicy {
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: None,
|
||||
}
|
||||
}
|
||||
|
||||
fn using(exit: EndpointId) -> ExitPolicy {
|
||||
ExitPolicy {
|
||||
offer: false,
|
||||
via: Some(exit),
|
||||
}
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn internet_traffic_goes_to_the_exit_node_and_only_once_one_is_chosen() {
|
||||
let (interface, device, routes, carrier, id) = interface(false).await;
|
||||
device.push_from_os(ipv4(addr(1), INTERNET, b"before"));
|
||||
wait_for(&interface, |counters| counters.unroutable).await;
|
||||
assert!(carrier.carried().is_empty(), "no exit node, no route");
|
||||
|
||||
routes.set_exit(id, using(peer(2)));
|
||||
device.push_from_os(ipv4(addr(1), INTERNET, b"after"));
|
||||
wait_for(&interface, |counters| counters.sent).await;
|
||||
let carried = carrier.carried();
|
||||
assert_eq!(carried.len(), 1);
|
||||
assert_eq!(carried[0].0.peer, peer(2));
|
||||
assert_eq!(&carried[0].1[20..], b"after");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_exit_node_may_answer_with_any_source_and_nobody_else_may() {
|
||||
let (interface, device, routes, _carrier, id) = interface(false).await;
|
||||
routes.set_exit(id, using(peer(2)));
|
||||
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(INTERNET, addr(1), b"reply"))
|
||||
.await
|
||||
.unwrap();
|
||||
let written = tokio::time::timeout(std::time::Duration::from_secs(5), device.pop_to_os())
|
||||
.await
|
||||
.expect("the reply reaches the interface")
|
||||
.unwrap();
|
||||
assert_eq!(&written[20..], b"reply");
|
||||
|
||||
// Another member cannot use the internet's addresses.
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(3), ipv4(INTERNET, addr(1), b"spoof"))
|
||||
.await,
|
||||
Err(Rejected::WrongSource)
|
||||
);
|
||||
// Nor can the exit node speak for a member.
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(addr(3), addr(1), b"spoof"))
|
||||
.await,
|
||||
Err(Rejected::WrongSource)
|
||||
);
|
||||
// And what it sends still has to be for this agent.
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(INTERNET, addr(200), b"elsewhere"))
|
||||
.await,
|
||||
Err(Rejected::WrongDestination)
|
||||
);
|
||||
assert_eq!(interface.counters().received, 1);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_exit_node_hands_a_members_internet_packet_to_the_host_only_while_offering() {
|
||||
let (interface, device, routes, _carrier, id) = interface(false).await;
|
||||
|
||||
// Not offering: dropped exactly as before.
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(addr(2), INTERNET, b"request"))
|
||||
.await,
|
||||
Err(Rejected::WrongDestination)
|
||||
);
|
||||
assert_eq!(interface.counters().received, 0);
|
||||
|
||||
routes.set_exit(id, offering());
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(addr(2), INTERNET, b"request"))
|
||||
.await
|
||||
.unwrap();
|
||||
let written = tokio::time::timeout(std::time::Duration::from_secs(5), device.pop_to_os())
|
||||
.await
|
||||
.expect("the request reaches the interface")
|
||||
.unwrap();
|
||||
assert_eq!(&written[20..], b"request");
|
||||
|
||||
// The source must still be the sender's own address.
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(addr(3), INTERNET, b"spoof"))
|
||||
.await,
|
||||
Err(Rejected::WrongSource)
|
||||
);
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(INTERNET, INTERNET, b"spoof"))
|
||||
.await,
|
||||
Err(Rejected::WrongSource)
|
||||
);
|
||||
// Offering does not make this a door to the overlay or to this host.
|
||||
for destination in [addr(3), addr(200), Ipv4Addr::LOCALHOST] {
|
||||
assert_eq!(
|
||||
interface
|
||||
.deliver(id, peer(2), ipv4(addr(2), destination, b"no"))
|
||||
.await,
|
||||
Err(Rejected::WrongDestination),
|
||||
"{destination}"
|
||||
);
|
||||
}
|
||||
assert_eq!(interface.counters().received, 1);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn the_exit_rules_follow_the_routing_table_and_leave_with_the_interface() {
|
||||
let rules = MockHostRules::new();
|
||||
let (interface, routes, id) = managed_interface(&rules, false).await;
|
||||
let range: crate::state::Ipv4Range = "10.13.37.0/24".parse().unwrap();
|
||||
|
||||
// Nothing wanted: nothing installed, but what a crashed run left is
|
||||
// taken away once.
|
||||
interface.sync_exit_rules().await;
|
||||
interface.sync_exit_rules().await;
|
||||
assert_eq!(rules.exit().calls(), ["clear:tsunrules"]);
|
||||
assert!(rules.exit().installed().is_none());
|
||||
assert!(!interface.exit_offer_ready(id));
|
||||
assert_eq!(interface.exit_rules(id), ExitRulesReport::default());
|
||||
|
||||
// Offering: the range is masqueraded, and the agent can say so.
|
||||
routes.set_exit(id, offering());
|
||||
assert!(!interface.exit_offer_ready(id), "not applied yet");
|
||||
let waiting = interface.exit_rules(id).offer.unwrap();
|
||||
assert!(!waiting.ok);
|
||||
assert!(waiting.detail.contains("not applied yet"), "{waiting:?}");
|
||||
interface.sync_exit_rules().await;
|
||||
assert_eq!(rules.exit().installed().unwrap().offer, vec![range]);
|
||||
assert!(interface.exit_offer_ready(id));
|
||||
let report = interface.exit_rules(id);
|
||||
assert!(report.offer.as_ref().unwrap().ok);
|
||||
assert_eq!(report.forwarding, Some(true));
|
||||
assert!(report.client.is_none());
|
||||
|
||||
// Unchanged: not applied again.
|
||||
interface.sync_exit_rules().await;
|
||||
assert_eq!(
|
||||
rules
|
||||
.exit()
|
||||
.calls()
|
||||
.iter()
|
||||
.filter(|call| call.starts_with("apply"))
|
||||
.count(),
|
||||
1
|
||||
);
|
||||
|
||||
// Forwarding off in the kernel: still installed, still ready, and said.
|
||||
rules.exit().set_forwarding(Some(false));
|
||||
routes.set_exit(
|
||||
id,
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: Some(peer(2)),
|
||||
},
|
||||
);
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(rules.exit().installed().unwrap().client);
|
||||
assert!(interface.exit_offer_ready(id));
|
||||
let report = interface.exit_rules(id);
|
||||
assert_eq!(report.forwarding, Some(false));
|
||||
assert!(report.offer.unwrap().ok);
|
||||
assert!(report.client.unwrap().ok);
|
||||
|
||||
// Turned off: removed, and no longer announced as ready.
|
||||
routes.set_exit(id, ExitPolicy::default());
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(rules.exit().installed().is_none());
|
||||
assert!(!interface.exit_offer_ready(id));
|
||||
assert_eq!(interface.exit_rules(id), ExitRulesReport::default());
|
||||
|
||||
routes.set_exit(id, offering());
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(rules.exit().installed().is_some());
|
||||
interface.remove().await;
|
||||
assert!(
|
||||
rules.exit().installed().is_none(),
|
||||
"gone with the interface"
|
||||
);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_failed_exit_step_is_reported_and_the_agent_does_not_claim_to_be_an_exit_node() {
|
||||
let rules = MockHostRules::new();
|
||||
rules.exit().fail_with(Some("iptables needs root".into()));
|
||||
let (interface, routes, id) = managed_interface(&rules, false).await;
|
||||
routes.set_exit(id, offering());
|
||||
interface.sync_exit_rules().await;
|
||||
|
||||
assert!(!interface.exit_offer_ready(id));
|
||||
let offer = interface.exit_rules(id).offer.unwrap();
|
||||
assert!(!offer.ok);
|
||||
assert!(offer.detail.contains("iptables needs root"), "{offer:?}");
|
||||
|
||||
// It is tried again, not given up on, the next time it is asked.
|
||||
rules.exit().fail_with(None);
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(interface.exit_offer_ready(id));
|
||||
interface.remove().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn an_interface_without_a_host_cannot_be_an_exit_node_and_says_why() {
|
||||
let (interface, _device, routes, _carrier, id) = interface(false).await;
|
||||
routes.set_exit(
|
||||
id,
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: Some(peer(2)),
|
||||
},
|
||||
);
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(!interface.exit_offer_ready(id));
|
||||
let report = interface.exit_rules(id);
|
||||
let offer = report.offer.unwrap();
|
||||
assert!(!offer.ok);
|
||||
assert!(offer.detail.contains("not on the host"), "{offer:?}");
|
||||
assert!(!report.client.unwrap().ok);
|
||||
interface.remove().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn a_network_waiting_for_its_range_has_nothing_to_masquerade_yet() {
|
||||
let rules = MockHostRules::new();
|
||||
let (interface, routes, _id) = managed_interface(&rules, false).await;
|
||||
let waiting = network("waiting");
|
||||
routes
|
||||
.set_network(
|
||||
waiting,
|
||||
NetworkRoutes {
|
||||
exit: offering(),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.unwrap();
|
||||
interface.sync_exit_rules().await;
|
||||
assert!(rules.exit().installed().is_none());
|
||||
let offer = interface.exit_rules(waiting).offer.unwrap();
|
||||
assert!(offer.detail.contains("address range"), "{offer:?}");
|
||||
interface.remove().await;
|
||||
}
|
||||
}
|
||||
@@ -40,6 +40,7 @@ pub enum OverlayError {
|
||||
|
||||
pub mod broadcast;
|
||||
pub mod config;
|
||||
pub mod exit;
|
||||
pub mod hostrules;
|
||||
pub mod interface;
|
||||
pub mod packet;
|
||||
@@ -48,9 +49,10 @@ pub mod router;
|
||||
pub mod tun;
|
||||
|
||||
pub use config::{Cidr, DEFAULT_INTERFACE_PREFIX, MAX_INTERFACE_NAME_LEN, interface_name};
|
||||
pub use exit::{ExitRulesReport, RuleSetReport};
|
||||
pub use hostrules::{
|
||||
BroadcastHostRules, BroadcastRulesPlan, BroadcastRulesReport, MockHostRules, RuleOutcome,
|
||||
UnsupportedHostRules,
|
||||
BroadcastHostRules, BroadcastRulesPlan, BroadcastRulesReport, ExitHostPlan, ExitHostReport,
|
||||
ExitHostRules, MockExitRules, MockHostRules, RuleOutcome, UnsupportedHostRules,
|
||||
};
|
||||
pub use interface::{Counters, Interface, PacketCarrier, Rejected};
|
||||
pub use packet::IpHeader;
|
||||
@@ -59,7 +61,7 @@ pub use provision::{
|
||||
MockHost, MockProvisioner, Privilege, Provisioned, UnsupportedProvisioner, plan_changes,
|
||||
probe_net_admin,
|
||||
};
|
||||
pub use router::{NetworkRoutes, Route, RouteError, RoutingTable};
|
||||
pub use router::{ExitPolicy, NetworkRoutes, Route, RouteError, RoutingTable};
|
||||
pub use tun::{MemoryTun, MemoryTunFactory, TunDevice, TunFactory, TunRequest, address_is_local};
|
||||
|
||||
#[cfg(all(feature = "tun-device", target_os = "linux"))]
|
||||
File renamed without changes.
File renamed without changes.
+405
-2
@@ -48,7 +48,8 @@ use futures_util::TryStreamExt;
|
||||
use rtnetlink::packet_route::address::{AddressAttribute, AddressMessage};
|
||||
use rtnetlink::packet_route::link::{InfoKind, LinkAttribute, LinkFlags, LinkInfo, LinkMessage};
|
||||
use rtnetlink::packet_route::route::RouteScope;
|
||||
use rtnetlink::{LinkMessageBuilder, LinkUnspec, RouteMessageBuilder};
|
||||
use rtnetlink::packet_route::rule::{RuleAction, RuleAttribute, RuleMessage, RuleUidRange};
|
||||
use rtnetlink::{IpVersion, LinkMessageBuilder, LinkUnspec, RouteMessageBuilder};
|
||||
|
||||
use crate::BoxFuture;
|
||||
use crate::overlay::OverlayError;
|
||||
@@ -72,6 +73,11 @@ enum Command {
|
||||
SetBroadcastRoute(String, Ipv4Addr, Reply<()>),
|
||||
/// Remove that route from this interface.
|
||||
DelBroadcastRoute(String, Reply<()>),
|
||||
/// Send the host's default traffic through this interface, except what
|
||||
/// this user id sends.
|
||||
SetExitClient(String, u32, Reply<()>),
|
||||
/// Take those routing rules away again.
|
||||
ClearExitClient(Reply<()>),
|
||||
/// Stop the thread.
|
||||
Stop,
|
||||
}
|
||||
@@ -203,6 +209,20 @@ impl RouteHandle {
|
||||
Command::DelBroadcastRoute(interface, reply)
|
||||
})
|
||||
}
|
||||
|
||||
/// Sends the host's default traffic through `interface`, except what the
|
||||
/// user id `uid` sends. Replaces what an earlier call set up.
|
||||
pub(crate) fn set_exit_client(&self, interface: &str, uid: u32) -> Result<(), OverlayError> {
|
||||
let interface = interface.to_string();
|
||||
call_thread(&self.commands, |reply| {
|
||||
Command::SetExitClient(interface, uid, reply)
|
||||
})
|
||||
}
|
||||
|
||||
/// Removes those rules. Succeeds when none are there.
|
||||
pub(crate) fn clear_exit_client(&self) -> Result<(), OverlayError> {
|
||||
call_thread(&self.commands, Command::ClearExitClient)
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for NetlinkProvisioner {
|
||||
@@ -324,7 +344,11 @@ fn netlink_thread(requests: mpsc::Receiver<Command>) {
|
||||
Command::Delete(_, reply)
|
||||
| Command::Configure(_, reply)
|
||||
| Command::SetBroadcastRoute(_, _, reply)
|
||||
| Command::DelBroadcastRoute(_, reply) => {
|
||||
| Command::DelBroadcastRoute(_, reply)
|
||||
| Command::SetExitClient(_, _, reply) => {
|
||||
let _ = reply.send(Err(OverlayError::Unavailable(message)));
|
||||
}
|
||||
Command::ClearExitClient(reply) => {
|
||||
let _ = reply.send(Err(OverlayError::Unavailable(message)));
|
||||
}
|
||||
Command::Stop => return,
|
||||
@@ -373,6 +397,22 @@ fn netlink_thread(requests: mpsc::Receiver<Command>) {
|
||||
});
|
||||
let _ = reply.send(result);
|
||||
}
|
||||
Command::SetExitClient(name, uid, reply) => {
|
||||
let result = NetAdmin::acquire().and_then(|guard| {
|
||||
let result = runtime.block_on(set_exit_client(&name, uid));
|
||||
drop(guard);
|
||||
result
|
||||
});
|
||||
let _ = reply.send(result);
|
||||
}
|
||||
Command::ClearExitClient(reply) => {
|
||||
let result = NetAdmin::acquire().and_then(|guard| {
|
||||
let result = runtime.block_on(clear_exit_client());
|
||||
drop(guard);
|
||||
result
|
||||
});
|
||||
let _ = reply.send(result);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -596,6 +636,308 @@ async fn del_broadcast_route(name: &str) -> Result<(), OverlayError> {
|
||||
.await
|
||||
}
|
||||
|
||||
/// The routing table that holds the exit node's default route: `tsun` in
|
||||
/// ASCII-ish hex, and nothing else uses it.
|
||||
const EXIT_TABLE: u32 = 0x7473;
|
||||
/// The main table.
|
||||
const MAIN_TABLE: u32 = 254;
|
||||
/// Where the exit rules sit, after Tailscale's 5270.
|
||||
const EXIT_BYPASS_PRIORITY: u32 = 5280;
|
||||
const EXIT_SPECIFIC_PRIORITY: u32 = 5290;
|
||||
const EXIT_DEFAULT_PRIORITY: u32 = 5300;
|
||||
|
||||
/// The table a rule looks up.
|
||||
fn rule_table(rule: &RuleMessage) -> u32 {
|
||||
rule.attributes
|
||||
.iter()
|
||||
.find_map(|attribute| match attribute {
|
||||
RuleAttribute::Table(table) => Some(*table),
|
||||
_ => None,
|
||||
})
|
||||
.unwrap_or(u32::from(rule.header.table))
|
||||
}
|
||||
|
||||
fn rule_priority(rule: &RuleMessage) -> Option<u32> {
|
||||
rule.attributes
|
||||
.iter()
|
||||
.find_map(|attribute| match attribute {
|
||||
RuleAttribute::Priority(priority) => Some(*priority),
|
||||
_ => None,
|
||||
})
|
||||
}
|
||||
|
||||
/// Whether a rule is one of the three this agent adds for an exit node.
|
||||
///
|
||||
/// Recognised by shape as well as priority: those numbers are not reserved,
|
||||
/// and a rule somebody else put at one of them must not be removed.
|
||||
fn is_exit_rule(rule: &RuleMessage) -> bool {
|
||||
let table = rule_table(rule);
|
||||
match rule_priority(rule) {
|
||||
Some(EXIT_BYPASS_PRIORITY) => {
|
||||
table == MAIN_TABLE
|
||||
&& rule
|
||||
.attributes
|
||||
.iter()
|
||||
.any(|attribute| matches!(attribute, RuleAttribute::UidRange(_)))
|
||||
}
|
||||
Some(EXIT_SPECIFIC_PRIORITY) => {
|
||||
table == MAIN_TABLE
|
||||
&& rule
|
||||
.attributes
|
||||
.iter()
|
||||
.any(|attribute| matches!(attribute, RuleAttribute::SuppressPrefixLen(0)))
|
||||
}
|
||||
Some(EXIT_DEFAULT_PRIORITY) => table == EXIT_TABLE,
|
||||
_ => false,
|
||||
}
|
||||
}
|
||||
|
||||
fn exit_default_route(index: Option<u32>) -> rtnetlink::packet_route::route::RouteMessage {
|
||||
let mut builder = RouteMessageBuilder::<Ipv4Addr>::new()
|
||||
.destination_prefix(Ipv4Addr::UNSPECIFIED, 0)
|
||||
.table_id(EXIT_TABLE);
|
||||
if let Some(index) = index {
|
||||
builder = builder.output_interface(index).scope(RouteScope::Link);
|
||||
}
|
||||
builder.build()
|
||||
}
|
||||
|
||||
/// The exit table's IPv6 default: nothing is reachable through it.
|
||||
///
|
||||
/// There is no IPv6 through an exit node, and what the ordinary route would do
|
||||
/// is send it out in the clear. This turns it into an immediate refusal, which
|
||||
/// is what makes applications fall back to IPv4.
|
||||
fn exit_blocking_route_v6() -> rtnetlink::packet_route::route::RouteMessage {
|
||||
RouteMessageBuilder::<std::net::Ipv6Addr>::new()
|
||||
.destination_prefix(std::net::Ipv6Addr::UNSPECIFIED, 0)
|
||||
.table_id(EXIT_TABLE)
|
||||
.kind(rtnetlink::packet_route::route::RouteType::Unreachable)
|
||||
.build()
|
||||
}
|
||||
|
||||
/// A host with no IPv6 at all has nothing to block, and says so this way.
|
||||
fn family_unsupported(err: &impl std::fmt::Display) -> bool {
|
||||
let text = err.to_string();
|
||||
text.contains("not supported") || text.contains("Address family")
|
||||
}
|
||||
|
||||
/// Removes the exit node's routing rules and its tables. Nothing there is
|
||||
/// success: it also runs once at startup, for what a crashed run left.
|
||||
async fn clear_exit_client() -> Result<(), OverlayError> {
|
||||
with_netlink(|handle| async move { remove_exit_client(&handle).await }).await
|
||||
}
|
||||
|
||||
/// Deletes this agent's exit rules of one address family.
|
||||
async fn remove_exit_rules(
|
||||
handle: &rtnetlink::Handle,
|
||||
version: IpVersion,
|
||||
) -> Result<(), OverlayError> {
|
||||
let mut rules = handle.rule().get(version).execute();
|
||||
let mut ours = Vec::new();
|
||||
while let Some(rule) = rules
|
||||
.try_next()
|
||||
.await
|
||||
.map_err(|err| OverlayError::Unavailable(format!("cannot read the routing rules: {err}")))?
|
||||
{
|
||||
if is_exit_rule(&rule) {
|
||||
ours.push(rule);
|
||||
}
|
||||
}
|
||||
for rule in ours {
|
||||
match handle.rule().del(rule).execute().await {
|
||||
Ok(()) => {}
|
||||
// Gone already.
|
||||
Err(err) if err.to_string().contains("No such") => {}
|
||||
Err(err) => {
|
||||
return Err(OverlayError::Unavailable(format!(
|
||||
"cannot remove an exit node routing rule: {err}"
|
||||
)));
|
||||
}
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
async fn remove_exit_client(handle: &rtnetlink::Handle) -> Result<(), OverlayError> {
|
||||
remove_exit_rules(handle, IpVersion::V4).await?;
|
||||
match handle.route().del(exit_default_route(None)).execute().await {
|
||||
Ok(()) => {}
|
||||
// "No such process": no such route, which is the goal.
|
||||
Err(err) if err.to_string().contains("No such") => {}
|
||||
Err(err) => {
|
||||
return Err(OverlayError::Unavailable(format!(
|
||||
"cannot remove the exit node default route: {err}"
|
||||
)));
|
||||
}
|
||||
}
|
||||
|
||||
match remove_exit_rules(handle, IpVersion::V6).await {
|
||||
Ok(()) => {}
|
||||
Err(OverlayError::Unavailable(reason)) if family_unsupported(&reason) => return Ok(()),
|
||||
Err(err) => return Err(err),
|
||||
}
|
||||
match handle.route().del(exit_blocking_route_v6()).execute().await {
|
||||
Ok(()) => Ok(()),
|
||||
Err(err) if err.to_string().contains("No such") || family_unsupported(&err) => Ok(()),
|
||||
Err(err) => Err(OverlayError::Unavailable(format!(
|
||||
"cannot remove the exit node IPv6 block: {err}"
|
||||
))),
|
||||
}
|
||||
}
|
||||
|
||||
/// Sets up the using side of an exit node.
|
||||
///
|
||||
/// ```text
|
||||
/// ip route replace default dev <if> table 0x7473
|
||||
/// ip rule add priority 5280 uidrange <uid>-<uid> lookup main
|
||||
/// ip rule add priority 5290 lookup main suppress_prefixlength 0
|
||||
/// ip rule add priority 5300 lookup 0x7473
|
||||
/// ```
|
||||
///
|
||||
/// and the same for IPv6 with `ip -6 route replace unreachable default table
|
||||
/// 0x7473`, so that IPv6 is refused instead of leaving the ordinary way.
|
||||
///
|
||||
/// What an earlier call left is removed first, so repeating it is safe, and
|
||||
/// the rules go in last, so a failure part way never leaves a rule that
|
||||
/// sends traffic to a table with no route in it.
|
||||
async fn set_exit_client(name: &str, uid: u32) -> Result<(), OverlayError> {
|
||||
with_netlink(|handle| async move {
|
||||
let index = link_index(&handle, name).await.ok_or_else(|| {
|
||||
OverlayError::Unavailable(format!(
|
||||
"interface `{name}` disappeared before the exit node routes could be added"
|
||||
))
|
||||
})?;
|
||||
remove_exit_client(&handle).await?;
|
||||
let fail = |what: &str, err: rtnetlink::Error| {
|
||||
OverlayError::Unavailable(format!("cannot add the exit node {what}: {err}"))
|
||||
};
|
||||
handle
|
||||
.route()
|
||||
.add(exit_default_route(Some(index)))
|
||||
.replace()
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("default route", err))?;
|
||||
|
||||
let mut bypass = handle
|
||||
.rule()
|
||||
.add()
|
||||
.v4()
|
||||
.table_id(MAIN_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_BYPASS_PRIORITY);
|
||||
bypass
|
||||
.message_mut()
|
||||
.attributes
|
||||
.push(RuleAttribute::UidRange(RuleUidRange {
|
||||
start: uid,
|
||||
end: uid,
|
||||
}));
|
||||
bypass
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the agent's own traffic", err))?;
|
||||
|
||||
let mut specific = handle
|
||||
.rule()
|
||||
.add()
|
||||
.v4()
|
||||
.table_id(MAIN_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_SPECIFIC_PRIORITY);
|
||||
specific
|
||||
.message_mut()
|
||||
.attributes
|
||||
.push(RuleAttribute::SuppressPrefixLen(0));
|
||||
specific
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the specific routes", err))?;
|
||||
|
||||
handle
|
||||
.rule()
|
||||
.add()
|
||||
.v4()
|
||||
.table_id(EXIT_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_DEFAULT_PRIORITY)
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the default route", err))?;
|
||||
|
||||
set_exit_block_v6(&handle, uid).await
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
/// The IPv6 half: an unreachable default for everything but the agent's own
|
||||
/// connections and the specific routes, which keep working.
|
||||
async fn set_exit_block_v6(handle: &rtnetlink::Handle, uid: u32) -> Result<(), OverlayError> {
|
||||
let fail = |what: &str, err: rtnetlink::Error| {
|
||||
OverlayError::Unavailable(format!("cannot add the exit node IPv6 {what}: {err}"))
|
||||
};
|
||||
if let Err(err) = handle
|
||||
.route()
|
||||
.add(exit_blocking_route_v6())
|
||||
.replace()
|
||||
.execute()
|
||||
.await
|
||||
{
|
||||
// Without IPv6 there is nothing to leak.
|
||||
return if family_unsupported(&err) {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(fail("block", err))
|
||||
};
|
||||
}
|
||||
|
||||
let mut bypass = handle
|
||||
.rule()
|
||||
.add()
|
||||
.v6()
|
||||
.table_id(MAIN_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_BYPASS_PRIORITY);
|
||||
bypass
|
||||
.message_mut()
|
||||
.attributes
|
||||
.push(RuleAttribute::UidRange(RuleUidRange {
|
||||
start: uid,
|
||||
end: uid,
|
||||
}));
|
||||
bypass
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the agent's own traffic", err))?;
|
||||
|
||||
let mut specific = handle
|
||||
.rule()
|
||||
.add()
|
||||
.v6()
|
||||
.table_id(MAIN_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_SPECIFIC_PRIORITY);
|
||||
specific
|
||||
.message_mut()
|
||||
.attributes
|
||||
.push(RuleAttribute::SuppressPrefixLen(0));
|
||||
specific
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the specific routes", err))?;
|
||||
|
||||
handle
|
||||
.rule()
|
||||
.add()
|
||||
.v6()
|
||||
.table_id(EXIT_TABLE)
|
||||
.action(RuleAction::ToTable)
|
||||
.priority(EXIT_DEFAULT_PRIORITY)
|
||||
.execute()
|
||||
.await
|
||||
.map_err(|err| fail("rule for the default route", err))
|
||||
}
|
||||
|
||||
async fn configure_link(configure: &Configure) -> Result<(), OverlayError> {
|
||||
let name = configure.name.as_str();
|
||||
with_netlink(|handle| async move {
|
||||
@@ -737,6 +1079,67 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
fn rule(priority: u32, table: u32, extra: Vec<RuleAttribute>) -> RuleMessage {
|
||||
let mut message = RuleMessage::default();
|
||||
message.attributes.push(RuleAttribute::Priority(priority));
|
||||
if table > 255 {
|
||||
message.attributes.push(RuleAttribute::Table(table));
|
||||
} else {
|
||||
message.header.table = table as u8;
|
||||
}
|
||||
message.attributes.extend(extra);
|
||||
message
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn only_the_three_exit_rules_are_recognised_as_ours() {
|
||||
let uid = RuleAttribute::UidRange(RuleUidRange { start: 5, end: 5 });
|
||||
assert!(is_exit_rule(&rule(5280, 254, vec![uid.clone()])));
|
||||
assert!(is_exit_rule(&rule(
|
||||
5290,
|
||||
254,
|
||||
vec![RuleAttribute::SuppressPrefixLen(0)]
|
||||
)));
|
||||
assert!(is_exit_rule(&rule(5300, EXIT_TABLE, vec![])));
|
||||
|
||||
// Same priorities, somebody else's rules.
|
||||
assert!(!is_exit_rule(&rule(5280, 254, vec![])));
|
||||
assert!(!is_exit_rule(&rule(5290, 254, vec![])));
|
||||
assert!(!is_exit_rule(&rule(5300, 52, vec![])));
|
||||
assert!(!is_exit_rule(&rule(5270, 52, vec![])));
|
||||
assert!(!is_exit_rule(&rule(5280, 100, vec![uid])));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_ipv6_default_of_the_exit_table_refuses_instead_of_routing() {
|
||||
let route = exit_blocking_route_v6();
|
||||
assert_eq!(route.header.destination_prefix_length, 0);
|
||||
let debug = format!("{route:?}");
|
||||
assert!(debug.contains("Unreachable"), "{debug}");
|
||||
assert!(debug.contains(&format!("Table({EXIT_TABLE})")), "{debug}");
|
||||
assert!(!debug.contains("Oif"), "{debug}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_host_without_ipv6_is_not_a_failure() {
|
||||
assert!(family_unsupported(
|
||||
&"Address family not supported by protocol"
|
||||
));
|
||||
assert!(family_unsupported(&"Operation not supported"));
|
||||
assert!(!family_unsupported(&"Operation not permitted"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_default_route_of_the_exit_table_names_the_table_and_the_interface() {
|
||||
let route = exit_default_route(Some(7));
|
||||
assert_eq!(route.header.destination_prefix_length, 0);
|
||||
let debug = format!("{route:?}");
|
||||
assert!(debug.contains(&format!("Table({EXIT_TABLE})")), "{debug}");
|
||||
assert!(debug.contains("Oif(7)"), "{debug}");
|
||||
// Deleting names no interface, so it matches whatever it was added on.
|
||||
assert!(!format!("{:?}", exit_default_route(None)).contains("Oif"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_interface_that_is_not_a_tun_is_reported_foreign() {
|
||||
let message = LinkMessage::default();
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
+4
-6
@@ -15,7 +15,7 @@
|
||||
//! Grant it with:
|
||||
//!
|
||||
//! ```text
|
||||
//! sudo setcap cap_net_admin,cap_net_bind_service+p /usr/local/bin/tsunagi
|
||||
//! sudo setcap cap_net_admin,cap_net_bind_service+p /usr/local/bin/tsng
|
||||
//! ```
|
||||
//!
|
||||
//! `+p` rather than `+ep`: with `+p` the capability is permitted but not
|
||||
@@ -171,7 +171,7 @@ mod linux_impl {
|
||||
caps::raise(None, CapSet::Effective, Capability::CAP_NET_ADMIN).map_err(|err| {
|
||||
OverlayError::Unavailable(format!(
|
||||
"cannot raise CAP_NET_ADMIN: {err}. {}",
|
||||
Privilege::how_to_grant("tsunagi")
|
||||
Privilege::how_to_grant("tsng")
|
||||
))
|
||||
})?;
|
||||
Ok(Self { raised: true })
|
||||
@@ -204,10 +204,8 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn the_grant_instructions_name_the_program() {
|
||||
let text = Privilege::how_to_grant("/usr/local/bin/tsunagi");
|
||||
assert!(
|
||||
text.contains("setcap cap_net_admin,cap_net_bind_service+p /usr/local/bin/tsunagi")
|
||||
);
|
||||
let text = Privilege::how_to_grant("/usr/local/bin/tsng");
|
||||
assert!(text.contains("setcap cap_net_admin,cap_net_bind_service+p /usr/local/bin/tsng"));
|
||||
assert!(text.contains("--no-tun"), "the fallback is offered too");
|
||||
}
|
||||
|
||||
File renamed without changes.
File renamed without changes.
@@ -40,9 +40,21 @@ pub struct Route {
|
||||
pub peer: EndpointId,
|
||||
}
|
||||
|
||||
/// A network's exit-node settings, as far as packets are concerned.
|
||||
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
|
||||
pub struct ExitPolicy {
|
||||
/// This agent offers itself as an exit node here: packets from members
|
||||
/// for addresses outside every overlay range are handed to the host.
|
||||
pub offer: bool,
|
||||
/// The member all other traffic is sent to, if this device uses one.
|
||||
pub via: Option<EndpointId>,
|
||||
}
|
||||
|
||||
/// What one network contributes to the table.
|
||||
#[derive(Debug, Clone, Default, PartialEq, Eq)]
|
||||
pub struct NetworkRoutes {
|
||||
/// Exit-node settings of this network.
|
||||
pub exit: ExitPolicy,
|
||||
/// Local broadcast policy and authenticated willing recipients.
|
||||
pub broadcast: BroadcastPolicy,
|
||||
/// The range this network allocates from, once it has agreed one.
|
||||
@@ -153,6 +165,16 @@ impl RoutingTable {
|
||||
}
|
||||
}
|
||||
|
||||
/// Replaces only a network's exit-node settings, without changing addresses.
|
||||
///
|
||||
/// A network that has no entry yet (its range is not agreed) takes them
|
||||
/// from [`NetworkRoutes::exit`] when it is added.
|
||||
pub fn set_exit(&self, network: NetworkId, policy: ExitPolicy) {
|
||||
if let Some(routes) = self.write().get_mut(&network) {
|
||||
routes.exit = policy;
|
||||
}
|
||||
}
|
||||
|
||||
/// Recognizes limited and configured subnet broadcasts before unicast lookup.
|
||||
pub fn is_broadcast(&self, destination: Ipv4Addr) -> bool {
|
||||
self.broadcast.load().is_destination(destination)
|
||||
@@ -181,6 +203,10 @@ impl RoutingTable {
|
||||
///
|
||||
/// This agent's own address returns `None`: a packet for ourselves does
|
||||
/// not go over a tunnel, and answering with a peer would send it to one.
|
||||
///
|
||||
/// An address nobody holds, outside every overlay range and an ordinary
|
||||
/// unicast destination, goes to this device's exit node when it has one:
|
||||
/// that is what sending *all* traffic through a member means.
|
||||
pub fn route(&self, destination: Ipv4Addr) -> Option<Route> {
|
||||
let networks = self.read();
|
||||
for (network, routes) in networks.iter() {
|
||||
@@ -198,17 +224,80 @@ impl RoutingTable {
|
||||
});
|
||||
}
|
||||
}
|
||||
None
|
||||
// Inside an overlay range, an unowned address is nobody's, not the
|
||||
// internet's.
|
||||
if !is_internet_destination(destination) || in_any_range(&networks, destination) {
|
||||
return None;
|
||||
}
|
||||
exit_via(&networks).map(|(network, peer)| Route { network, peer })
|
||||
}
|
||||
|
||||
/// Whether a peer may send from a source address.
|
||||
///
|
||||
/// A peer speaks only for the address the network agreed it holds. The
|
||||
/// one exception is this device's exit node: what comes back from the
|
||||
/// internet carries the internet's addresses, so from *that* peer any
|
||||
/// source outside the overlay ranges is accepted.
|
||||
pub fn may_send_from(&self, network: NetworkId, peer: EndpointId, source: Ipv4Addr) -> bool {
|
||||
self.read().get(&network).is_some_and(|routes| {
|
||||
routes
|
||||
.peers
|
||||
.iter()
|
||||
.any(|(address, holder)| *address == source && *holder == peer)
|
||||
})
|
||||
let networks = self.read();
|
||||
let Some(routes) = networks.get(&network) else {
|
||||
return false;
|
||||
};
|
||||
if routes
|
||||
.peers
|
||||
.iter()
|
||||
.any(|(address, holder)| *address == source && *holder == peer)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
routes.exit.via == Some(peer)
|
||||
&& is_internet_destination(source)
|
||||
&& !in_any_range(&networks, source)
|
||||
}
|
||||
|
||||
/// Whether this agent, as an exit node of `network`, takes a member's
|
||||
/// packet for `destination` to the host.
|
||||
///
|
||||
/// Only an ordinary unicast address outside every overlay range, so a
|
||||
/// packet for another member, for this agent or for the local network
|
||||
/// segment never leaves by this door. The sender's own source address is
|
||||
/// checked separately, by [`Self::may_send_from`].
|
||||
pub fn accepts_exit_traffic(&self, network: NetworkId, destination: Ipv4Addr) -> bool {
|
||||
let networks = self.read();
|
||||
networks
|
||||
.get(&network)
|
||||
.is_some_and(|routes| routes.exit.offer)
|
||||
&& is_internet_destination(destination)
|
||||
&& !in_any_range(&networks, destination)
|
||||
}
|
||||
|
||||
/// The network and member this device sends its internet traffic through.
|
||||
///
|
||||
/// One default route, so one answer; if several networks claim one (they
|
||||
/// should not) the lowest network id decides, so two runs agree.
|
||||
pub fn exit_via(&self) -> Option<(NetworkId, EndpointId)> {
|
||||
exit_via(&self.read())
|
||||
}
|
||||
|
||||
/// Networks that offer this agent as an exit node, with the range each
|
||||
/// agreed. A network that has not agreed one yet has nothing to
|
||||
/// masquerade and is left out.
|
||||
pub fn exit_offers(&self) -> Vec<(NetworkId, Ipv4Range)> {
|
||||
let mut offers: Vec<(NetworkId, Ipv4Range)> = self
|
||||
.read()
|
||||
.iter()
|
||||
.filter(|(_, routes)| routes.exit.offer)
|
||||
.filter_map(|(network, routes)| Some((*network, routes.range?)))
|
||||
.collect();
|
||||
offers.sort_by_key(|(network, _)| *network);
|
||||
offers
|
||||
}
|
||||
|
||||
/// One network's exit-node settings and its range, if it is in the table.
|
||||
pub fn exit_settings(&self, network: NetworkId) -> Option<(ExitPolicy, Option<Ipv4Range>)> {
|
||||
self.read()
|
||||
.get(&network)
|
||||
.map(|routes| (routes.exit, routes.range))
|
||||
}
|
||||
|
||||
/// Whether an ordinary packet terminates on this host in this network.
|
||||
@@ -275,6 +364,31 @@ impl RoutingTable {
|
||||
}
|
||||
}
|
||||
|
||||
/// Whether an address is an ordinary unicast one: not this host, not a
|
||||
/// multicast or broadcast group, not link-local, not unspecified.
|
||||
fn is_internet_destination(address: Ipv4Addr) -> bool {
|
||||
!(address.is_unspecified()
|
||||
|| address.is_loopback()
|
||||
|| address.is_multicast()
|
||||
|| address.is_broadcast()
|
||||
|| address.is_link_local())
|
||||
}
|
||||
|
||||
/// Whether an address lies in any network's range.
|
||||
fn in_any_range(networks: &HashMap<NetworkId, NetworkRoutes>, address: Ipv4Addr) -> bool {
|
||||
networks
|
||||
.values()
|
||||
.any(|routes| routes.range.is_some_and(|range| range.contains(address)))
|
||||
}
|
||||
|
||||
/// The exit node in use, if any, from the lowest network that names one.
|
||||
fn exit_via(networks: &HashMap<NetworkId, NetworkRoutes>) -> Option<(NetworkId, EndpointId)> {
|
||||
networks
|
||||
.iter()
|
||||
.filter_map(|(network, routes)| Some((*network, routes.exit.via?)))
|
||||
.min_by_key(|(network, _)| *network)
|
||||
}
|
||||
|
||||
/// Whether two ranges share any address.
|
||||
fn ranges_overlap(one: Ipv4Range, other: Ipv4Range) -> bool {
|
||||
// A range contains the other's base, or the other way round. With
|
||||
@@ -308,6 +422,7 @@ mod tests {
|
||||
|
||||
fn routes() -> NetworkRoutes {
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.13.37.0/24".parse().unwrap()),
|
||||
local: Some(addr(1)),
|
||||
@@ -391,6 +506,7 @@ mod tests {
|
||||
.set_network(
|
||||
second,
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.99.0.0/16".parse().unwrap()),
|
||||
local: Some(Ipv4Addr::new(10, 99, 0, 1)),
|
||||
@@ -420,6 +536,7 @@ mod tests {
|
||||
if a < b { (a, b) } else { (b, a) }
|
||||
};
|
||||
let mk = |enabled: bool, base: [u8; 4], local: Option<Ipv4Addr>| NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: BroadcastPolicy {
|
||||
enabled,
|
||||
..Default::default()
|
||||
@@ -495,6 +612,7 @@ mod tests {
|
||||
.set_network(
|
||||
network("wide"),
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.0.0.0/8".parse().unwrap()),
|
||||
..Default::default()
|
||||
@@ -507,6 +625,7 @@ mod tests {
|
||||
.set_network(
|
||||
network("narrow"),
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.13.37.0/24".parse().unwrap()),
|
||||
..Default::default()
|
||||
@@ -549,6 +668,7 @@ mod tests {
|
||||
.set_network(
|
||||
network("two"),
|
||||
NetworkRoutes {
|
||||
exit: Default::default(),
|
||||
broadcast: Default::default(),
|
||||
range: Some("10.99.0.0/16".parse().unwrap()),
|
||||
local: Some(Ipv4Addr::new(10, 99, 0, 1)),
|
||||
@@ -573,4 +693,233 @@ mod tests {
|
||||
assert_eq!(table.route(addr(2)), None);
|
||||
assert_eq!(table.len(), 1, "the network is known, it just has nothing");
|
||||
}
|
||||
|
||||
fn with_exit(offer: bool, via: Option<EndpointId>) -> NetworkRoutes {
|
||||
NetworkRoutes {
|
||||
exit: ExitPolicy { offer, via },
|
||||
..routes()
|
||||
}
|
||||
}
|
||||
|
||||
const INTERNET: Ipv4Addr = Ipv4Addr::new(93, 184, 216, 34);
|
||||
|
||||
#[test]
|
||||
fn without_an_exit_node_the_internet_has_nowhere_to_go() {
|
||||
let table = RoutingTable::new();
|
||||
table.set_network(network("plain"), routes()).unwrap();
|
||||
assert_eq!(table.route(INTERNET), None);
|
||||
assert_eq!(table.exit_via(), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn with_an_exit_node_every_ordinary_destination_goes_to_it() {
|
||||
let table = RoutingTable::new();
|
||||
let id = network("client");
|
||||
table
|
||||
.set_network(id, with_exit(false, Some(peer(2))))
|
||||
.unwrap();
|
||||
let exit = Route {
|
||||
network: id,
|
||||
peer: peer(2),
|
||||
};
|
||||
assert_eq!(table.route(INTERNET), Some(exit));
|
||||
assert_eq!(table.route(Ipv4Addr::new(192, 168, 1, 10)), Some(exit));
|
||||
assert_eq!(table.exit_via(), Some((id, peer(2))));
|
||||
// A member's own address still goes to that member.
|
||||
assert_eq!(
|
||||
table.route(addr(3)),
|
||||
Some(Route {
|
||||
network: id,
|
||||
peer: peer(3)
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_exit_node_is_never_the_answer_for_what_is_not_the_internet() {
|
||||
let table = RoutingTable::new();
|
||||
table
|
||||
.set_network(network("client"), with_exit(false, Some(peer(2))))
|
||||
.unwrap();
|
||||
// Ourselves, a free address inside the overlay range, and everything
|
||||
// that is not an ordinary unicast destination.
|
||||
for destination in [
|
||||
addr(1),
|
||||
addr(200),
|
||||
Ipv4Addr::new(127, 0, 0, 1),
|
||||
Ipv4Addr::new(224, 0, 0, 251),
|
||||
Ipv4Addr::new(239, 255, 255, 250),
|
||||
Ipv4Addr::BROADCAST,
|
||||
Ipv4Addr::UNSPECIFIED,
|
||||
Ipv4Addr::new(169, 254, 1, 1),
|
||||
] {
|
||||
assert_eq!(table.route(destination), None, "{destination}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn another_networks_range_is_not_the_internet_either() {
|
||||
let table = RoutingTable::new();
|
||||
table
|
||||
.set_network(network("client"), with_exit(false, Some(peer(2))))
|
||||
.unwrap();
|
||||
table
|
||||
.set_network(
|
||||
network("other"),
|
||||
NetworkRoutes {
|
||||
range: Some("10.99.0.0/16".parse().unwrap()),
|
||||
local: Some(Ipv4Addr::new(10, 99, 0, 1)),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(table.route(Ipv4Addr::new(10, 99, 7, 7)), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn two_exit_choices_resolve_to_the_lowest_network_id() {
|
||||
let table = RoutingTable::new();
|
||||
let (a, b) = (network("one"), network("two"));
|
||||
table
|
||||
.set_network(a, with_exit(false, Some(peer(2))))
|
||||
.unwrap();
|
||||
table
|
||||
.set_network(
|
||||
b,
|
||||
NetworkRoutes {
|
||||
exit: ExitPolicy {
|
||||
offer: false,
|
||||
via: Some(peer(9)),
|
||||
},
|
||||
range: Some("10.99.0.0/16".parse().unwrap()),
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.unwrap();
|
||||
let (chosen, _) = table.exit_via().unwrap();
|
||||
assert_eq!(chosen, a.min(b));
|
||||
assert_eq!(table.route(INTERNET).unwrap().network, a.min(b));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_exit_peer_may_send_from_any_internet_address_but_nobody_else_may() {
|
||||
let table = RoutingTable::new();
|
||||
let id = network("client");
|
||||
table
|
||||
.set_network(id, with_exit(false, Some(peer(2))))
|
||||
.unwrap();
|
||||
|
||||
// What comes back from the internet carries the internet's addresses.
|
||||
assert!(table.may_send_from(id, peer(2), INTERNET));
|
||||
// Another member still speaks only for its own address.
|
||||
assert!(!table.may_send_from(id, peer(3), INTERNET));
|
||||
assert!(table.may_send_from(id, peer(3), addr(3)));
|
||||
// The exit peer cannot pass itself off as somebody else in the
|
||||
// overlay, nor as this agent, nor as something that is not a source.
|
||||
assert!(!table.may_send_from(id, peer(2), addr(3)));
|
||||
assert!(!table.may_send_from(id, peer(2), addr(1)));
|
||||
assert!(!table.may_send_from(id, peer(2), addr(200)));
|
||||
for source in [
|
||||
Ipv4Addr::LOCALHOST,
|
||||
Ipv4Addr::UNSPECIFIED,
|
||||
Ipv4Addr::new(224, 0, 0, 1),
|
||||
Ipv4Addr::BROADCAST,
|
||||
] {
|
||||
assert!(!table.may_send_from(id, peer(2), source), "{source}");
|
||||
}
|
||||
// Without choosing an exit node nobody gets the exception.
|
||||
let plain = RoutingTable::new();
|
||||
plain.set_network(id, routes()).unwrap();
|
||||
assert!(!plain.may_send_from(id, peer(2), INTERNET));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn an_exit_node_takes_a_members_internet_packets_only_while_it_offers() {
|
||||
let table = RoutingTable::new();
|
||||
let id = network("server");
|
||||
table.set_network(id, with_exit(false, None)).unwrap();
|
||||
assert!(!table.accepts_exit_traffic(id, INTERNET));
|
||||
|
||||
table.set_exit(
|
||||
id,
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: None,
|
||||
},
|
||||
);
|
||||
assert!(table.accepts_exit_traffic(id, INTERNET));
|
||||
assert!(table.accepts_exit_traffic(id, Ipv4Addr::new(192, 168, 1, 10)));
|
||||
// Never for another member, for this agent, a free overlay address,
|
||||
// or anything that is not an ordinary unicast destination.
|
||||
for destination in [
|
||||
addr(1),
|
||||
addr(2),
|
||||
addr(200),
|
||||
Ipv4Addr::LOCALHOST,
|
||||
Ipv4Addr::new(224, 0, 0, 251),
|
||||
Ipv4Addr::BROADCAST,
|
||||
Ipv4Addr::UNSPECIFIED,
|
||||
] {
|
||||
assert!(
|
||||
!table.accepts_exit_traffic(id, destination),
|
||||
"{destination}"
|
||||
);
|
||||
}
|
||||
// An unknown network offers nothing.
|
||||
assert!(!table.accepts_exit_traffic(network("elsewhere"), INTERNET));
|
||||
|
||||
table.set_exit(id, ExitPolicy::default());
|
||||
assert!(!table.accepts_exit_traffic(id, INTERNET));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn offers_are_listed_by_network_with_the_range_each_agreed() {
|
||||
let table = RoutingTable::new();
|
||||
let (a, b) = (network("a"), network("b"));
|
||||
table.set_network(a, with_exit(true, None)).unwrap();
|
||||
table
|
||||
.set_network(
|
||||
b,
|
||||
NetworkRoutes {
|
||||
exit: ExitPolicy {
|
||||
offer: true,
|
||||
via: None,
|
||||
},
|
||||
// No range agreed yet: nothing to masquerade.
|
||||
..Default::default()
|
||||
},
|
||||
)
|
||||
.unwrap();
|
||||
assert_eq!(
|
||||
table.exit_offers(),
|
||||
vec![(a, "10.13.37.0/24".parse().unwrap())]
|
||||
);
|
||||
assert_eq!(
|
||||
table.exit_settings(a),
|
||||
Some((
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: None
|
||||
},
|
||||
Some("10.13.37.0/24".parse().unwrap())
|
||||
))
|
||||
);
|
||||
assert_eq!(table.exit_settings(network("none")), None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn setting_exit_for_a_network_with_no_entry_is_remembered_by_the_caller() {
|
||||
// The runtime keeps the policy and passes it with the network when
|
||||
// its range is agreed; a setter for a network the table does not know
|
||||
// yet changes nothing.
|
||||
let table = RoutingTable::new();
|
||||
table.set_exit(
|
||||
network("later"),
|
||||
ExitPolicy {
|
||||
offer: true,
|
||||
via: None,
|
||||
},
|
||||
);
|
||||
assert!(table.is_empty());
|
||||
}
|
||||
}
|
||||
@@ -483,15 +483,15 @@ mod system {
|
||||
if denied {
|
||||
let hint = if cfg!(target_os = "windows") {
|
||||
"Open PowerShell or Command Prompt with 'Run as administrator' and \
|
||||
start `tsunagi up` there."
|
||||
start `tsng up` there."
|
||||
} else if cfg!(target_os = "linux") {
|
||||
"Start `tsunagi up` as root or grant CAP_NET_ADMIN with \
|
||||
"Start `tsng up` as root or grant CAP_NET_ADMIN with \
|
||||
`sudo setcap cap_net_admin,cap_net_bind_service+p /path/to/tsunagi`."
|
||||
} else if cfg!(target_os = "macos") {
|
||||
"Creating a utun interface needs root on macOS; start `tsunagi up` \
|
||||
"Creating a utun interface needs root on macOS; start `tsng up` \
|
||||
with `sudo`, or install it as a root LaunchDaemon."
|
||||
} else {
|
||||
"Start `tsunagi up` with the privileges required to create a TUN interface."
|
||||
"Start `tsng up` with the privileges required to create a TUN interface."
|
||||
};
|
||||
return OverlayError::Unavailable(format!(
|
||||
"permission denied while creating the TUN interface `{name}`. \
|
||||
@@ -539,7 +539,7 @@ mod system {
|
||||
let message = open_error("tsun0", error).to_string();
|
||||
assert!(message.contains("permission denied"), "{message}");
|
||||
assert!(message.contains("tsun0"), "{message}");
|
||||
assert!(message.contains("tsunagi up"), "{message}");
|
||||
assert!(message.contains("tsng up"), "{message}");
|
||||
#[cfg(target_os = "windows")]
|
||||
assert!(message.contains("Run as administrator"), "{message}");
|
||||
#[cfg(target_os = "linux")]
|
||||
File renamed without changes.
File renamed without changes.
@@ -20,7 +20,7 @@ use crate::error::ProtocolError;
|
||||
/// The version in the ALPN is the wire-compatibility version of the control
|
||||
/// protocol. It is independent of the network identity scheme version, so
|
||||
/// bumping it must not change any existing [`crate::NetworkId`].
|
||||
pub const ALPN: &[u8] = b"tsunagi/ctrl/3";
|
||||
pub const ALPN: &[u8] = b"tsunagi/ctrl/4";
|
||||
|
||||
/// ALPN of the tsunagi data plane.
|
||||
///
|
||||
@@ -41,7 +41,7 @@ pub const MAX_DATA_PROTOCOL_LEN: usize = 32;
|
||||
pub const MAX_SIGNATURE_LEN: usize = 64;
|
||||
|
||||
/// Control protocol version carried inside the handshake.
|
||||
pub const PROTOCOL_VERSION: u16 = 3;
|
||||
pub const PROTOCOL_VERSION: u16 = 4;
|
||||
|
||||
/// First message of the handshake, sent by the initiator.
|
||||
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
||||
@@ -75,6 +75,11 @@ pub struct AuthProof {
|
||||
pub struct Announcement {
|
||||
/// Local opt-in to receive LAN broadcasts in this network.
|
||||
pub broadcast: bool,
|
||||
/// This agent offers itself as an exit node in this network: members may
|
||||
/// send all their internet traffic through it. Off unless its owner
|
||||
/// turned it on, and only said once the rules that make it work are in
|
||||
/// place.
|
||||
pub exit_node: bool,
|
||||
/// Human-readable hostname. A mutable binding, not an identity.
|
||||
pub hostname: String,
|
||||
/// Announced IP plugin capabilities. Opaque to the core.
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -254,6 +254,18 @@ impl Storage {
|
||||
.await
|
||||
}
|
||||
|
||||
/// Persists whether this agent offers itself as an exit node in a network.
|
||||
pub async fn set_exit_node(&self, network_id: NetworkId, enabled: bool) -> Result<()> {
|
||||
self.with_state(move |state| state.set_exit_node(network_id, enabled))
|
||||
.await
|
||||
}
|
||||
|
||||
/// Persists the member this device sends its internet traffic through.
|
||||
pub async fn set_exit_via(&self, network_id: NetworkId, via: Option<[u8; 32]>) -> Result<()> {
|
||||
self.with_state(move |state| state.set_exit_via(network_id, via.as_ref()))
|
||||
.await
|
||||
}
|
||||
|
||||
/// Updates the auto-start flag of a network.
|
||||
pub async fn set_auto_start(&self, network_id: NetworkId, auto_start: bool) -> Result<()> {
|
||||
self.with_state(move |state| state.set_auto_start(network_id, auto_start))
|
||||
@@ -264,7 +276,8 @@ impl Storage {
|
||||
pub async fn remove_network(&self, network_id: NetworkId) -> Result<()> {
|
||||
self.with_state(move |state| {
|
||||
state.remove_network(network_id)?;
|
||||
state.forget_signed_records(network_id)
|
||||
state.forget_signed_records(network_id)?;
|
||||
state.forget_peer_hostnames(network_id)
|
||||
})
|
||||
.await?;
|
||||
self.with_cache((), move |cache| cache.forget_network(network_id))
|
||||
@@ -283,6 +296,26 @@ impl Storage {
|
||||
.await
|
||||
}
|
||||
|
||||
/// Remembers the hostname a member announced, so it can still be named
|
||||
/// once it is away.
|
||||
pub async fn remember_peer_hostname(
|
||||
&self,
|
||||
network_id: NetworkId,
|
||||
endpoint_id: [u8; 32],
|
||||
hostname: String,
|
||||
) -> Result<()> {
|
||||
self.with_state(move |state| {
|
||||
state.remember_peer_hostname(network_id, &endpoint_id, &hostname)
|
||||
})
|
||||
.await
|
||||
}
|
||||
|
||||
/// The hostnames members of a network last announced.
|
||||
pub async fn peer_hostnames(&self, network_id: NetworkId) -> Result<Vec<([u8; 32], String)>> {
|
||||
self.with_state(move |state| state.peer_hostnames(network_id))
|
||||
.await
|
||||
}
|
||||
|
||||
/// Records an address hint. Failures are non-fatal.
|
||||
pub async fn record_hint(
|
||||
&self,
|
||||
@@ -21,7 +21,7 @@ use crate::identity::{DeviceIdentity, NetworkId, NetworkName, NetworkSecret};
|
||||
use crate::state::{RecordBody, SignedRecord};
|
||||
|
||||
/// Schema version written by this build.
|
||||
pub const SCHEMA_VERSION: i64 = 4;
|
||||
pub const SCHEMA_VERSION: i64 = 6;
|
||||
|
||||
/// Key of the stored hostname setting.
|
||||
const SETTING_HOSTNAME: &str = "hostname";
|
||||
@@ -42,6 +42,10 @@ pub struct StoredNetwork {
|
||||
pub auto_start: bool,
|
||||
/// Local broadcast participation, enabled unless explicitly disabled.
|
||||
pub broadcast: bool,
|
||||
/// This agent offers itself as an exit node here. Off unless turned on.
|
||||
pub exit_node: bool,
|
||||
/// The member this device sends all its internet traffic through, if any.
|
||||
pub exit_via: Option<[u8; 32]>,
|
||||
}
|
||||
|
||||
/// The mandatory state store.
|
||||
@@ -191,13 +195,45 @@ impl StateStore {
|
||||
PRAGMA user_version = 4;
|
||||
COMMIT;").map_err(|err| self.corrupt(format!("cannot migrate schema to 4: {err}")))?;
|
||||
}
|
||||
if found < 5 {
|
||||
self.conn
|
||||
.execute_batch(
|
||||
"BEGIN;
|
||||
CREATE TABLE IF NOT EXISTS peer_hostnames (
|
||||
network_id BLOB NOT NULL,
|
||||
endpoint_id BLOB NOT NULL,
|
||||
hostname TEXT NOT NULL,
|
||||
PRIMARY KEY (network_id, endpoint_id)
|
||||
);
|
||||
PRAGMA user_version = 5;
|
||||
COMMIT;",
|
||||
)
|
||||
.map_err(|err| self.corrupt(format!("cannot migrate schema to 5: {err}")))?;
|
||||
}
|
||||
if found < 6 {
|
||||
self.conn
|
||||
.execute_batch(
|
||||
"BEGIN;
|
||||
ALTER TABLE networks ADD COLUMN exit_node INTEGER NOT NULL DEFAULT 0 CHECK (exit_node IN (0,1));
|
||||
ALTER TABLE networks ADD COLUMN exit_via BLOB;
|
||||
PRAGMA user_version = 6;
|
||||
COMMIT;",
|
||||
)
|
||||
.map_err(|err| self.corrupt(format!("cannot migrate schema to 6: {err}")))?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Confirms the expected tables exist, so that a truncated or foreign
|
||||
/// database is reported rather than used.
|
||||
fn verify_shape(&self) -> Result<()> {
|
||||
for table in ["device_identity", "networks", "settings", "signed_records"] {
|
||||
for table in [
|
||||
"device_identity",
|
||||
"networks",
|
||||
"settings",
|
||||
"signed_records",
|
||||
"peer_hostnames",
|
||||
] {
|
||||
let present: Option<String> = self
|
||||
.conn
|
||||
.query_row(
|
||||
@@ -430,11 +466,56 @@ impl StateStore {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Saves whether this agent offers itself as an exit node in a network.
|
||||
pub fn set_exit_node(&self, network_id: NetworkId, enabled: bool) -> Result<()> {
|
||||
let changed = self
|
||||
.conn
|
||||
.execute(
|
||||
"UPDATE networks SET exit_node = ?2 WHERE network_id = ?1",
|
||||
params![network_id.as_bytes().as_slice(), enabled as i64],
|
||||
)
|
||||
.map_err(|err| Error::Storage(format!("cannot update exit node offer: {err}")))?;
|
||||
if changed == 0 {
|
||||
return Err(Error::NetworkUnknown(network_id));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Saves which member this device sends its internet traffic through.
|
||||
///
|
||||
/// One device has one default route, so choosing an exit node in one
|
||||
/// network clears the choice in every other.
|
||||
pub fn set_exit_via(&self, network_id: NetworkId, via: Option<&[u8; 32]>) -> Result<()> {
|
||||
let tx = self
|
||||
.conn
|
||||
.unchecked_transaction()
|
||||
.map_err(|err| Error::Storage(format!("cannot update exit node: {err}")))?;
|
||||
let changed = tx
|
||||
.execute(
|
||||
"UPDATE networks SET exit_via = ?2 WHERE network_id = ?1",
|
||||
params![network_id.as_bytes().as_slice(), via.map(|v| v.as_slice())],
|
||||
)
|
||||
.map_err(|err| Error::Storage(format!("cannot update exit node: {err}")))?;
|
||||
if changed == 0 {
|
||||
return Err(Error::NetworkUnknown(network_id));
|
||||
}
|
||||
if via.is_some() {
|
||||
tx.execute(
|
||||
"UPDATE networks SET exit_via = NULL WHERE network_id != ?1",
|
||||
params![network_id.as_bytes().as_slice()],
|
||||
)
|
||||
.map_err(|err| Error::Storage(format!("cannot update exit node: {err}")))?;
|
||||
}
|
||||
tx.commit()
|
||||
.map_err(|err| Error::Storage(format!("cannot update exit node: {err}")))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Lists every configured network.
|
||||
pub fn list_networks(&self) -> Result<Vec<StoredNetwork>> {
|
||||
let mut stmt = self
|
||||
.conn
|
||||
.prepare("SELECT network_id, name, secret, auto_start, broadcast FROM networks ORDER BY name")
|
||||
.prepare("SELECT network_id, name, secret, auto_start, broadcast, exit_node, exit_via FROM networks ORDER BY name")
|
||||
.map_err(|err| Error::Storage(format!("cannot list networks: {err}")))?;
|
||||
let rows = stmt
|
||||
.query_map([], |row| {
|
||||
@@ -442,13 +523,21 @@ impl StateStore {
|
||||
let name: String = row.get(1)?;
|
||||
let secret: Vec<u8> = row.get(2)?;
|
||||
let auto_start: i64 = row.get(3)?;
|
||||
Ok((id, name, secret, auto_start != 0, row.get::<_, bool>(4)?))
|
||||
Ok((
|
||||
id,
|
||||
name,
|
||||
secret,
|
||||
auto_start != 0,
|
||||
row.get::<_, bool>(4)?,
|
||||
row.get::<_, bool>(5)?,
|
||||
row.get::<_, Option<Vec<u8>>>(6)?,
|
||||
))
|
||||
})
|
||||
.map_err(|err| Error::Storage(format!("cannot list networks: {err}")))?;
|
||||
|
||||
let mut out = Vec::new();
|
||||
for row in rows {
|
||||
let (id, name, secret, auto_start, broadcast) =
|
||||
let (id, name, secret, auto_start, broadcast, exit_node, exit_via) =
|
||||
row.map_err(|err| Error::Storage(format!("cannot read network row: {err}")))?;
|
||||
let id: [u8; 32] = id
|
||||
.as_slice()
|
||||
@@ -460,6 +549,8 @@ impl StateStore {
|
||||
secret: NetworkSecret::from_bytes(secret)?,
|
||||
auto_start,
|
||||
broadcast,
|
||||
exit_node,
|
||||
exit_via: exit_via.and_then(|bytes| <[u8; 32]>::try_from(bytes.as_slice()).ok()),
|
||||
});
|
||||
}
|
||||
Ok(out)
|
||||
@@ -635,6 +726,61 @@ impl StateStore {
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Remembers the hostname a member last announced.
|
||||
pub fn remember_peer_hostname(
|
||||
&self,
|
||||
network_id: NetworkId,
|
||||
endpoint_id: &[u8; 32],
|
||||
hostname: &str,
|
||||
) -> Result<()> {
|
||||
self.conn
|
||||
.execute(
|
||||
"INSERT INTO peer_hostnames (network_id, endpoint_id, hostname)
|
||||
VALUES (?1, ?2, ?3)
|
||||
ON CONFLICT(network_id, endpoint_id) DO UPDATE SET hostname = excluded.hostname",
|
||||
params![
|
||||
network_id.as_bytes().as_slice(),
|
||||
endpoint_id.as_slice(),
|
||||
hostname
|
||||
],
|
||||
)
|
||||
.map_err(|err| Error::Storage(format!("cannot remember a hostname: {err}")))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The last hostname every member of a network announced.
|
||||
pub fn peer_hostnames(&self, network_id: NetworkId) -> Result<Vec<([u8; 32], String)>> {
|
||||
let mut stmt = self
|
||||
.conn
|
||||
.prepare("SELECT endpoint_id, hostname FROM peer_hostnames WHERE network_id = ?1")
|
||||
.map_err(|err| Error::Storage(format!("cannot read hostnames: {err}")))?;
|
||||
let rows = stmt
|
||||
.query_map(params![network_id.as_bytes().as_slice()], |row| {
|
||||
Ok((row.get::<_, Vec<u8>>(0)?, row.get::<_, String>(1)?))
|
||||
})
|
||||
.map_err(|err| Error::Storage(format!("cannot read hostnames: {err}")))?;
|
||||
let mut out = Vec::new();
|
||||
for row in rows {
|
||||
let (id, hostname) =
|
||||
row.map_err(|err| Error::Storage(format!("cannot read hostnames: {err}")))?;
|
||||
if let Ok(id) = <[u8; 32]>::try_from(id.as_slice()) {
|
||||
out.push((id, hostname));
|
||||
}
|
||||
}
|
||||
Ok(out)
|
||||
}
|
||||
|
||||
/// Forgets every remembered hostname of a network.
|
||||
pub fn forget_peer_hostnames(&self, network_id: NetworkId) -> Result<()> {
|
||||
self.conn
|
||||
.execute(
|
||||
"DELETE FROM peer_hostnames WHERE network_id = ?1",
|
||||
params![network_id.as_bytes().as_slice()],
|
||||
)
|
||||
.map_err(|err| Error::Storage(format!("cannot forget hostnames: {err}")))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Reads an arbitrary setting.
|
||||
pub fn get_setting(&self, key: &str) -> Result<Option<String>> {
|
||||
self.conn
|
||||
@@ -698,6 +844,60 @@ mod broadcast_storage_tests {
|
||||
use super::*;
|
||||
use crate::identity::NetworkKeys;
|
||||
|
||||
#[test]
|
||||
fn exit_node_choices_are_off_by_default_and_one_choice_clears_the_others() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let store = StateStore::open(dir.path().join("state.sqlite")).unwrap();
|
||||
let secret = NetworkSecret::from_bytes([5; 32]).unwrap();
|
||||
let make = |name: &str| {
|
||||
let name = NetworkName::new(name).unwrap();
|
||||
let id = NetworkKeys::derive(&name, &secret).network_id();
|
||||
store.upsert_network(id, &name, &secret, true).unwrap();
|
||||
id
|
||||
};
|
||||
let (a, b) = (make("exit-a"), make("exit-b"));
|
||||
let listed = || store.list_networks().unwrap();
|
||||
assert!(
|
||||
listed()
|
||||
.iter()
|
||||
.all(|n| !n.exit_node && n.exit_via.is_none())
|
||||
);
|
||||
|
||||
store.set_exit_node(a, true).unwrap();
|
||||
store.set_exit_via(a, Some(&[7; 32])).unwrap();
|
||||
store.set_exit_via(b, Some(&[8; 32])).unwrap();
|
||||
let by_id = |id: NetworkId| listed().into_iter().find(|n| n.network_id == id).unwrap();
|
||||
assert!(by_id(a).exit_node, "offering is per network and kept");
|
||||
assert_eq!(by_id(a).exit_via, None, "one default route: a was cleared");
|
||||
assert_eq!(by_id(b).exit_via, Some([8; 32]));
|
||||
|
||||
store.set_exit_via(b, None).unwrap();
|
||||
assert_eq!(by_id(b).exit_via, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_remembered_hostname_survives_a_restart_and_follows_the_latest_name() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let path = dir.path().join("state.sqlite");
|
||||
let name = NetworkName::new("hostnames").unwrap();
|
||||
let secret = NetworkSecret::from_bytes([9; 32]).unwrap();
|
||||
let id = NetworkKeys::derive(&name, &secret).network_id();
|
||||
let peer = [3u8; 32];
|
||||
|
||||
let store = StateStore::open(&path).unwrap();
|
||||
store.remember_peer_hostname(id, &peer, "laptop").unwrap();
|
||||
store.remember_peer_hostname(id, &peer, "laptop-2").unwrap();
|
||||
drop(store);
|
||||
|
||||
let store = StateStore::open(&path).unwrap();
|
||||
assert_eq!(
|
||||
store.peer_hostnames(id).unwrap(),
|
||||
vec![(peer, "laptop-2".to_string())]
|
||||
);
|
||||
store.forget_peer_hostnames(id).unwrap();
|
||||
assert!(store.peer_hostnames(id).unwrap().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn v3_migration_preserves_identity_and_networks_and_defaults_broadcast_on() {
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
@@ -714,7 +914,12 @@ mod broadcast_storage_tests {
|
||||
store.set_hostname("old-host").unwrap();
|
||||
store
|
||||
.conn
|
||||
.execute_batch("ALTER TABLE networks DROP COLUMN broadcast; PRAGMA user_version=3;")
|
||||
.execute_batch(
|
||||
"ALTER TABLE networks DROP COLUMN broadcast; \
|
||||
ALTER TABLE networks DROP COLUMN exit_node; \
|
||||
ALTER TABLE networks DROP COLUMN exit_via; \
|
||||
PRAGMA user_version=3;",
|
||||
)
|
||||
.unwrap();
|
||||
drop(store);
|
||||
let store = StateStore::open(&path).unwrap();
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -0,0 +1,173 @@
|
||||
//! Scenario 1: deterministic network identity.
|
||||
//!
|
||||
//! The same name and secret must yield the same network space on different
|
||||
//! devices, and nothing else — hostname, device key, restart — may change it.
|
||||
|
||||
#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]
|
||||
|
||||
use tsunagi::Agent;
|
||||
use tsunagi::discovery::SharedMemoryDiscovery;
|
||||
use tsunagi::identity::{NetworkKeys, NetworkName, NetworkSecret};
|
||||
use tsunagi::testing::{TestAgent, config_with, network};
|
||||
|
||||
#[test]
|
||||
fn derivation_is_a_pure_function_of_name_and_secret() {
|
||||
let name = NetworkName::new("home").unwrap();
|
||||
let other = NetworkName::new("Home").unwrap();
|
||||
let secret = NetworkSecret::generate();
|
||||
let other_secret = NetworkSecret::generate();
|
||||
|
||||
let a = NetworkKeys::derive(&name, &secret);
|
||||
let b = NetworkKeys::derive(&name, &secret);
|
||||
assert_eq!(a.network_id(), b.network_id());
|
||||
assert_eq!(a.discovery_key(), b.discovery_key());
|
||||
assert_eq!(a.descriptor(), b.descriptor());
|
||||
|
||||
// A different name is a different space. Names are used verbatim, so case
|
||||
// matters.
|
||||
assert_ne!(
|
||||
a.network_id(),
|
||||
NetworkKeys::derive(&other, &secret).network_id()
|
||||
);
|
||||
// A different secret is a different space.
|
||||
assert_ne!(
|
||||
a.network_id(),
|
||||
NetworkKeys::derive(&name, &other_secret).network_id()
|
||||
);
|
||||
// Separated key material: the discovery key is not the network id.
|
||||
assert_ne!(a.network_id().as_bytes(), a.discovery_key().as_bytes());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn descriptor_carries_no_creator_time_or_secret() {
|
||||
let name = NetworkName::new("shared").unwrap();
|
||||
let secret = NetworkSecret::generate();
|
||||
let first = NetworkKeys::derive(&name, &secret).descriptor();
|
||||
let second = NetworkKeys::derive(&name, &secret).descriptor();
|
||||
|
||||
// Two independently built descriptors are byte identical: no random
|
||||
// creator id, no creation timestamp, no owner signature.
|
||||
assert_eq!(first.to_canonical_bytes(), second.to_canonical_bytes());
|
||||
|
||||
let encoded = first.to_canonical_bytes();
|
||||
let secret_bytes = secret.encode();
|
||||
assert!(
|
||||
!encoded
|
||||
.windows(secret_bytes.len())
|
||||
.any(|window| window == secret_bytes.as_bytes()),
|
||||
"the secret must never appear in the public descriptor"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn names_are_validated_not_silently_normalised() {
|
||||
assert!(NetworkName::new("").is_err());
|
||||
assert!(NetworkName::new(" home").is_err(), "must not be trimmed");
|
||||
assert!(NetworkName::new("home ").is_err(), "must not be trimmed");
|
||||
assert!(NetworkName::new("ho\nme").is_err());
|
||||
assert!(NetworkName::new("a".repeat(65)).is_err());
|
||||
assert_eq!(NetworkName::new("home").unwrap().as_str(), "home");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn secrets_are_not_truncated_or_normalised() {
|
||||
let secret = NetworkSecret::generate();
|
||||
let text = secret.encode();
|
||||
let round_tripped = NetworkSecret::decode(&text).unwrap();
|
||||
assert_eq!(secret, round_tripped);
|
||||
|
||||
// Short secrets are rejected rather than stretched.
|
||||
assert!(NetworkSecret::from_bytes(vec![7u8; 15]).is_err());
|
||||
assert!(NetworkSecret::from_bytes(vec![7u8; 16]).is_ok());
|
||||
|
||||
// Debug output must not leak the secret.
|
||||
let rendered = format!("{secret:?}");
|
||||
assert_eq!(rendered, "NetworkSecret(<redacted>)");
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn different_devices_and_hostnames_agree_on_the_network_id() {
|
||||
let discovery = SharedMemoryDiscovery::new();
|
||||
let (name, secret) = network("agreement");
|
||||
|
||||
let a = TestAgent::spawn_with(|cfg| cfg.with_hostname("alpha"), &discovery)
|
||||
.await
|
||||
.unwrap();
|
||||
let b = TestAgent::spawn_with(|cfg| cfg.with_hostname("beta"), &discovery)
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
assert_ne!(
|
||||
a.agent.endpoint_id(),
|
||||
b.agent.endpoint_id(),
|
||||
"different devices must have different endpoint ids"
|
||||
);
|
||||
assert_eq!(a.agent.hostname(), "alpha");
|
||||
assert_eq!(b.agent.hostname(), "beta");
|
||||
|
||||
let id_a = a.agent.join_network(&name, &secret).await.unwrap();
|
||||
let id_b = b.agent.join_network(&name, &secret).await.unwrap();
|
||||
assert_eq!(id_a, id_b);
|
||||
|
||||
a.agent.shutdown().await;
|
||||
b.agent.shutdown().await;
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn restart_keeps_the_device_and_network_identity() {
|
||||
let discovery = SharedMemoryDiscovery::new();
|
||||
let (name, secret) = network("stable");
|
||||
|
||||
let first = TestAgent::spawn(&discovery).await.unwrap();
|
||||
let device_id = first.agent.endpoint_id();
|
||||
let network_id = first.agent.join_network(&name, &secret).await.unwrap();
|
||||
let dir = first.stop().await;
|
||||
|
||||
let reopened = Agent::spawn(config_with(dir.path(), &discovery))
|
||||
.await
|
||||
.unwrap();
|
||||
assert_eq!(
|
||||
reopened.endpoint_id(),
|
||||
device_id,
|
||||
"restarting must not mint a new peer"
|
||||
);
|
||||
let networks = reopened.list_networks().await.unwrap();
|
||||
assert_eq!(networks.len(), 1);
|
||||
assert_eq!(networks[0].network_id, network_id);
|
||||
assert!(networks[0].active, "auto-start networks come back up");
|
||||
|
||||
reopened.shutdown().await;
|
||||
drop(reopened);
|
||||
drop(dir);
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn changing_the_secret_keeps_the_device_identity() {
|
||||
let discovery = SharedMemoryDiscovery::new();
|
||||
let dir = tempfile::TempDir::new().unwrap();
|
||||
let agent = Agent::spawn(config_with(dir.path(), &discovery))
|
||||
.await
|
||||
.unwrap();
|
||||
let device_id = agent.endpoint_id();
|
||||
|
||||
let name = NetworkName::new("rotating").unwrap();
|
||||
let old = agent
|
||||
.join_network(&name, &NetworkSecret::generate())
|
||||
.await
|
||||
.unwrap();
|
||||
let new = agent
|
||||
.join_network(&name, &NetworkSecret::generate())
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
assert_ne!(old, new, "a new secret is a new network space");
|
||||
assert_eq!(
|
||||
agent.endpoint_id(),
|
||||
device_id,
|
||||
"rotating the network secret must not change the persistent iroh id"
|
||||
);
|
||||
|
||||
agent.shutdown().await;
|
||||
drop(agent);
|
||||
drop(dir);
|
||||
}
|
||||
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
@@ -8,7 +8,7 @@ license.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
[dependencies]
|
||||
tsunagi = { path = "../tsunagi", version = "0.1.0" }
|
||||
tsunagi-core = { path = "../tsunagi-core", version = "0.1.0" }
|
||||
iroh.workspace = true
|
||||
tokio = { workspace = true, features = ["net", "io-util", "time", "sync", "macros"] }
|
||||
rustls = "0.23"
|
||||
@@ -33,7 +33,7 @@ netdev = "0.46"
|
||||
caps = "0.5"
|
||||
|
||||
[dev-dependencies]
|
||||
tsunagi = { path = "../tsunagi", features = ["testing"] }
|
||||
tsunagi-core = { path = "../tsunagi-core", features = ["testing"] }
|
||||
tempfile.workspace = true
|
||||
tracing-subscriber.workspace = true
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
[package]
|
||||
name = "tsunagi-tray"
|
||||
version = "0.1.0"
|
||||
description = "Tray application to manage a running tsunagi agent."
|
||||
edition.workspace = true
|
||||
rust-version.workspace = true
|
||||
license.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
[[bin]]
|
||||
name = "tsunagi-tray"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
# The agent control client and the report types: the GUI is a thin client over
|
||||
# the same local control interface the CLI uses, so it reuses these directly
|
||||
# and never re-implements the protocol.
|
||||
tsunagi-core = { path = "../tsunagi-core", version = "0.1.0" }
|
||||
# Native, lightweight GUI — no web engine. eframe re-exports egui.
|
||||
eframe = { version = "0.31", default-features = false, features = ["default_fonts", "glow", "wayland", "x11"] }
|
||||
# Cross-platform tray icon + menu (Windows tray, macOS menu bar, Linux SNI).
|
||||
tray-icon = "0.21"
|
||||
# Background worker that talks to the agent off the UI thread.
|
||||
tokio = { version = "1.53", features = ["rt", "rt-multi-thread", "sync", "time", "macros"] }
|
||||
tracing.workspace = true
|
||||
tracing-subscriber.workspace = true
|
||||
egui-phosphor = "0.9"
|
||||
|
||||
# Linux only: tray-icon (already GTK-based there) needs the app to initialise
|
||||
# GTK and run its main loop.
|
||||
[target.'cfg(target_os = "linux")'.dependencies]
|
||||
gtk = "0.18"
|
||||
|
||||
# Windows and macOS: the tray process has no GUI toolkit, only an event loop to
|
||||
# serve the icon (and, on macOS, the Accessory activation policy that keeps it
|
||||
# out of the Dock). Pinned to eframe's winit so the types unify.
|
||||
[target.'cfg(any(windows, target_os = "macos"))'.dependencies]
|
||||
winit = "0.30"
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
@@ -0,0 +1,175 @@
|
||||
//! The About window: what this software is, and what it is talking to.
|
||||
//!
|
||||
//! Compact on purpose — one table for the client, one for the agent. The agent
|
||||
//! half is whatever the agent says about itself, so a client and an agent that
|
||||
//! are not the same build show up as such.
|
||||
|
||||
use eframe::egui;
|
||||
|
||||
use tsunagi::ipc::{PrivilegeReport, StatusReport};
|
||||
|
||||
use crate::agent::Snapshot;
|
||||
use crate::format;
|
||||
|
||||
const REPOSITORY: &str = env!("CARGO_PKG_REPOSITORY");
|
||||
const AUTHOR: &str = "AB <tsunagi@hexor.cy>";
|
||||
const VERSION: &str = env!("CARGO_PKG_VERSION");
|
||||
|
||||
/// Draws the window body into its viewport.
|
||||
pub(crate) fn show(ctx: &egui::Context, socket: &std::path::Path, snapshot: &Snapshot) {
|
||||
egui::CentralPanel::default().show(ctx, |ui| {
|
||||
// Long paths and a taller agent table must scroll rather than be cut.
|
||||
egui::ScrollArea::both()
|
||||
.auto_shrink([false, false])
|
||||
.show(ui, |ui| body(ui, socket, snapshot));
|
||||
});
|
||||
}
|
||||
|
||||
fn body(ui: &mut egui::Ui, socket: &std::path::Path, snapshot: &Snapshot) {
|
||||
{
|
||||
ui.horizontal(|ui| {
|
||||
ui.heading("tsunagi");
|
||||
ui.label(egui::RichText::new(VERSION).small().weak());
|
||||
});
|
||||
ui.label("Peer-to-peer mesh network with no server.");
|
||||
ui.add_space(6.0);
|
||||
|
||||
section(ui, "client");
|
||||
grid(ui, "about client", |ui| {
|
||||
row(ui, "repository", |ui| {
|
||||
ui.hyperlink(REPOSITORY);
|
||||
});
|
||||
row(ui, "author", |ui| {
|
||||
format::copy_field(ui, AUTHOR, AUTHOR);
|
||||
});
|
||||
row(ui, "license", |ui| {
|
||||
ui.label(env!("CARGO_PKG_LICENSE"));
|
||||
});
|
||||
row(ui, "build", |ui| {
|
||||
ui.label(format!(
|
||||
"{} {} · {}",
|
||||
std::env::consts::OS,
|
||||
std::env::consts::ARCH,
|
||||
if cfg!(debug_assertions) {
|
||||
"debug"
|
||||
} else {
|
||||
"release"
|
||||
}
|
||||
));
|
||||
});
|
||||
});
|
||||
|
||||
ui.add_space(8.0);
|
||||
section(ui, "agent");
|
||||
let socket = socket.display().to_string();
|
||||
match &snapshot.status {
|
||||
None => {
|
||||
grid(ui, "about agent", |ui| {
|
||||
row(ui, "socket", |ui| format::copy_field(ui, &socket, &socket));
|
||||
row(ui, "state", |ui| {
|
||||
ui.label("connecting…");
|
||||
});
|
||||
});
|
||||
}
|
||||
Some(Err(error)) => {
|
||||
grid(ui, "about agent", |ui| {
|
||||
row(ui, "socket", |ui| format::copy_field(ui, &socket, &socket));
|
||||
row(ui, "state", |ui| {
|
||||
ui.colored_label(egui::Color32::from_rgb(0xd8, 0x4a, 0x3a), "unreachable");
|
||||
});
|
||||
row(ui, "reason", |ui| {
|
||||
ui.add(egui::Label::new(error).wrap());
|
||||
});
|
||||
});
|
||||
}
|
||||
Some(Ok(report)) => agent_table(ui, &socket, report),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn agent_table(ui: &mut egui::Ui, socket: &str, report: &StatusReport) {
|
||||
grid(ui, "about agent", |ui| {
|
||||
row(ui, "socket", |ui| format::copy_field(ui, socket, socket));
|
||||
row(ui, "state", |ui| {
|
||||
ui.colored_label(egui::Color32::from_rgb(0x3c, 0xb0, 0x4a), "connected");
|
||||
});
|
||||
row(ui, "version", |ui| {
|
||||
if report.version.is_empty() {
|
||||
ui.weak("unknown");
|
||||
} else if report.version == VERSION {
|
||||
ui.label(&report.version);
|
||||
} else {
|
||||
ui.colored_label(
|
||||
egui::Color32::from_rgb(0xd8, 0x9a, 0x2a),
|
||||
format!("{} (client is {VERSION})", report.version),
|
||||
);
|
||||
}
|
||||
});
|
||||
if !report.protocols.is_empty() {
|
||||
row(ui, "protocols", |ui| {
|
||||
ui.label(report.protocols.join(" · "));
|
||||
});
|
||||
}
|
||||
row(ui, "endpoint id", |ui| {
|
||||
format::copy_field(ui, &format::short(&report.endpoint_id), &report.endpoint_id);
|
||||
});
|
||||
row(ui, "hostname", |ui| {
|
||||
ui.label(&report.hostname);
|
||||
});
|
||||
if !report.program.is_empty() {
|
||||
row(ui, "binary", |ui| {
|
||||
format::copy_field(ui, &report.program, &report.program);
|
||||
});
|
||||
}
|
||||
if !report.state_dir.is_empty() {
|
||||
row(ui, "state dir", |ui| {
|
||||
format::copy_field(ui, &report.state_dir, &report.state_dir);
|
||||
});
|
||||
row(ui, "cache dir", |ui| {
|
||||
format::copy_field(ui, &report.cache_dir, &report.cache_dir);
|
||||
});
|
||||
}
|
||||
row(ui, "interface", |ui| match &report.privilege {
|
||||
PrivilegeReport::Unknown => {
|
||||
ui.weak("unknown");
|
||||
}
|
||||
PrivilegeReport::Available => {
|
||||
ui.label("can be managed (CAP_NET_ADMIN)");
|
||||
}
|
||||
PrivilegeReport::Missing(_) => {
|
||||
ui.colored_label(egui::Color32::from_rgb(0xd8, 0x9a, 0x2a), "no privileges");
|
||||
}
|
||||
PrivilegeReport::Unsupported => {
|
||||
ui.label("not supported on this platform");
|
||||
}
|
||||
});
|
||||
row(ui, "cache", |ui| {
|
||||
ui.label(if report.cache_healthy {
|
||||
"usable"
|
||||
} else {
|
||||
"unavailable"
|
||||
});
|
||||
});
|
||||
row(ui, "listening", |ui| {
|
||||
ui.label(report.bound_sockets.join(", "));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
fn section(ui: &mut egui::Ui, title: &str) {
|
||||
ui.label(egui::RichText::new(title).strong());
|
||||
}
|
||||
|
||||
fn grid(ui: &mut egui::Ui, id: &str, add: impl FnOnce(&mut egui::Ui)) {
|
||||
egui::Grid::new(id)
|
||||
.num_columns(2)
|
||||
.spacing([12.0, 3.0])
|
||||
.show(ui, add);
|
||||
}
|
||||
|
||||
/// One label/value line of a table.
|
||||
fn row(ui: &mut egui::Ui, label: &str, value: impl FnOnce(&mut egui::Ui)) {
|
||||
ui.weak(label);
|
||||
value(ui);
|
||||
ui.end_row();
|
||||
}
|
||||
@@ -0,0 +1,256 @@
|
||||
//! The client side: a background worker that talks to the agent over the local
|
||||
//! control socket, off the UI thread.
|
||||
//!
|
||||
//! The UI never blocks on IO. A worker on a tokio runtime polls the agent for
|
||||
//! status on an interval and runs the commands the UI sends (join, leave,
|
||||
//! activate, broadcast), writing the latest snapshot into shared state and
|
||||
//! asking egui to repaint. The whole thing is a thin layer over
|
||||
//! [`tsunagi::ipc`]; no protocol is re-implemented here.
|
||||
|
||||
use std::path::PathBuf;
|
||||
use std::sync::{Arc, Mutex};
|
||||
use std::time::{Duration, Instant};
|
||||
|
||||
use eframe::egui;
|
||||
use tokio::sync::mpsc;
|
||||
|
||||
use tsunagi::ipc::{self, StatusReport};
|
||||
|
||||
/// How often the worker refreshes status while idle.
|
||||
const POLL_INTERVAL: Duration = Duration::from_secs(2);
|
||||
|
||||
/// A request from the UI to the agent.
|
||||
pub(crate) enum Command {
|
||||
/// Stop serving a network, or start serving it again.
|
||||
SetActive { network_id: String, active: bool },
|
||||
/// Turn local broadcast participation on or off for a network.
|
||||
SetBroadcast { network_id: String, enabled: bool },
|
||||
/// Offer this device as an exit node in a network, or stop.
|
||||
SetExitOffer { network_id: String, enabled: bool },
|
||||
/// Send all this device's internet traffic through a member of a
|
||||
/// network, or (`None`) back the ordinary way.
|
||||
SetExitNode {
|
||||
network_id: String,
|
||||
peer: Option<String>,
|
||||
},
|
||||
/// Join a network, or start one already configured.
|
||||
Join { name: String, secret: String },
|
||||
/// Leave a network entirely.
|
||||
Leave { network_id: String },
|
||||
/// Change the hostname this device announces.
|
||||
SetHostname(String),
|
||||
/// Fetch a network's shared secret and place it on the clipboard.
|
||||
CopySecret { network_id: String },
|
||||
}
|
||||
|
||||
/// The latest the worker knows, read by the UI each frame.
|
||||
#[derive(Clone, Default)]
|
||||
pub(crate) struct Snapshot {
|
||||
/// The last status, or the reason it could not be read (agent down, no
|
||||
/// permission on the socket, …).
|
||||
pub status: Option<Result<StatusReport, String>>,
|
||||
/// The outcome of the most recent command, for a transient banner.
|
||||
pub last_action: Option<Result<String, String>>,
|
||||
/// Whether a command is currently being executed.
|
||||
pub busy: bool,
|
||||
/// Bumped each time `status` is refreshed, so the UI can tell new data from
|
||||
/// a repaint of the same data and sample traffic rates only on change.
|
||||
pub generation: u64,
|
||||
/// When this status was read, for computing rates between refreshes.
|
||||
pub at: Option<Instant>,
|
||||
/// The socket the last request went to.
|
||||
pub socket: PathBuf,
|
||||
}
|
||||
|
||||
/// Handle the UI holds: send commands, read the latest snapshot.
|
||||
pub(crate) struct AgentClient {
|
||||
tx: mpsc::UnboundedSender<Command>,
|
||||
shared: Arc<Mutex<Snapshot>>,
|
||||
/// A secret fetched for the clipboard, taken by the UI thread which owns
|
||||
/// the clipboard; kept out of [`Snapshot`] so it is copied once, not every
|
||||
/// frame, and never travels in the cloned snapshot.
|
||||
pending_copy: Arc<Mutex<Option<String>>>,
|
||||
}
|
||||
|
||||
impl AgentClient {
|
||||
/// Starts the worker on `runtime`, reporting to `ctx` (for repaints).
|
||||
pub(crate) fn spawn(runtime: &tokio::runtime::Handle, ctx: egui::Context) -> Self {
|
||||
let (tx, rx) = mpsc::unbounded_channel();
|
||||
let shared = Arc::new(Mutex::new(Snapshot {
|
||||
socket: resolve_socket(),
|
||||
..Snapshot::default()
|
||||
}));
|
||||
let pending_copy = Arc::new(Mutex::new(None));
|
||||
runtime.spawn(worker(
|
||||
rx,
|
||||
Arc::clone(&shared),
|
||||
Arc::clone(&pending_copy),
|
||||
ctx,
|
||||
));
|
||||
Self {
|
||||
tx,
|
||||
shared,
|
||||
pending_copy,
|
||||
}
|
||||
}
|
||||
|
||||
/// Takes any secret the worker fetched for the clipboard.
|
||||
pub(crate) fn take_pending_copy(&self) -> Option<String> {
|
||||
lock(&self.pending_copy).take()
|
||||
}
|
||||
|
||||
/// The control socket this client talks to, as last resolved.
|
||||
pub(crate) fn socket(&self) -> PathBuf {
|
||||
lock(&self.shared).socket.clone()
|
||||
}
|
||||
|
||||
/// Sends a command; a dropped worker simply means nothing happens.
|
||||
pub(crate) fn send(&self, command: Command) {
|
||||
let _ = self.tx.send(command);
|
||||
}
|
||||
|
||||
/// A copy of the latest snapshot.
|
||||
pub(crate) fn snapshot(&self) -> Snapshot {
|
||||
lock(&self.shared).clone()
|
||||
}
|
||||
}
|
||||
|
||||
fn lock<T>(mutex: &Mutex<T>) -> std::sync::MutexGuard<'_, T> {
|
||||
match mutex.lock() {
|
||||
Ok(guard) => guard,
|
||||
Err(poisoned) => poisoned.into_inner(),
|
||||
}
|
||||
}
|
||||
|
||||
/// The worker loop: refresh on an interval and whenever a command runs.
|
||||
async fn worker(
|
||||
mut rx: mpsc::UnboundedReceiver<Command>,
|
||||
shared: Arc<Mutex<Snapshot>>,
|
||||
pending_copy: Arc<Mutex<Option<String>>>,
|
||||
ctx: egui::Context,
|
||||
) {
|
||||
refresh(&shared, &ctx).await;
|
||||
let mut tick = tokio::time::interval(POLL_INTERVAL);
|
||||
tick.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);
|
||||
|
||||
loop {
|
||||
tokio::select! {
|
||||
_ = tick.tick() => {
|
||||
refresh(&shared, &ctx).await;
|
||||
}
|
||||
command = rx.recv() => {
|
||||
let Some(command) = command else { return };
|
||||
run(&resolve_socket(), command, &shared, &pending_copy, &ctx).await;
|
||||
refresh(&shared, &ctx).await;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Reads status and stores it, mapping any failure to a human string.
|
||||
///
|
||||
/// The socket is looked for again each time: a window opened before the agent
|
||||
/// was started would otherwise keep asking the per-user path for ever, while
|
||||
/// the service came up at the system one.
|
||||
async fn refresh(shared: &Arc<Mutex<Snapshot>>, ctx: &egui::Context) {
|
||||
let socket = resolve_socket();
|
||||
let status = ipc::request_status(&socket)
|
||||
.await
|
||||
.map_err(|err| err.to_string());
|
||||
{
|
||||
let mut guard = lock(shared);
|
||||
guard.status = Some(status);
|
||||
guard.generation = guard.generation.wrapping_add(1);
|
||||
guard.at = Some(Instant::now());
|
||||
guard.socket = socket;
|
||||
}
|
||||
ctx.request_repaint();
|
||||
}
|
||||
|
||||
/// Runs one command and records its outcome.
|
||||
async fn run(
|
||||
socket: &std::path::Path,
|
||||
command: Command,
|
||||
shared: &Arc<Mutex<Snapshot>>,
|
||||
pending_copy: &Arc<Mutex<Option<String>>>,
|
||||
ctx: &egui::Context,
|
||||
) {
|
||||
lock(shared).busy = true;
|
||||
ctx.request_repaint();
|
||||
|
||||
let outcome: Result<String, String> = match command {
|
||||
Command::SetActive { network_id, active } => ipc::set_active(socket, &network_id, active)
|
||||
.await
|
||||
.map(|report| {
|
||||
let state = if report.active { "started" } else { "stopped" };
|
||||
format!("{} {}", state, report.name)
|
||||
})
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::SetBroadcast {
|
||||
network_id,
|
||||
enabled,
|
||||
} => ipc::set_broadcast(socket, &network_id, enabled)
|
||||
.await
|
||||
.map(|on| format!("broadcast {}", if on { "on" } else { "off" }))
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::SetExitOffer {
|
||||
network_id,
|
||||
enabled,
|
||||
} => ipc::set_exit_offer(socket, &network_id, enabled)
|
||||
.await
|
||||
.map(|on| format!("exit node {}", if on { "on" } else { "off" }))
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::SetExitNode { network_id, peer } => {
|
||||
ipc::set_exit_node(socket, &network_id, peer.as_deref())
|
||||
.await
|
||||
.map(|peer| match peer {
|
||||
Some(_) => "now using the exit node".to_string(),
|
||||
None => "stopped using an exit node".to_string(),
|
||||
})
|
||||
.map_err(|err| err.to_string())
|
||||
}
|
||||
Command::Join { name, secret } => ipc::join_network(socket, &name, &secret)
|
||||
.await
|
||||
.map(|report| format!("joined {}", report.name))
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::Leave { network_id } => ipc::leave_network(socket, &network_id)
|
||||
.await
|
||||
.map(|report| format!("left {}", report.name))
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::SetHostname(name) => ipc::set_hostname(socket, &name)
|
||||
.await
|
||||
.map(|accepted| format!("hostname: {accepted}"))
|
||||
.map_err(|err| err.to_string()),
|
||||
Command::CopySecret { network_id } => {
|
||||
match ipc::network_secret(socket, &network_id).await {
|
||||
// The secret goes only to the clipboard slot, never into the
|
||||
// banner text or any log line.
|
||||
Ok(secret) => {
|
||||
*lock(pending_copy) = Some(secret);
|
||||
Ok("secret copied to clipboard".to_string())
|
||||
}
|
||||
Err(err) => Err(err.to_string()),
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
{
|
||||
let mut guard = lock(shared);
|
||||
guard.busy = false;
|
||||
guard.last_action = if matches!(&outcome, Ok(message) if message.is_empty()) {
|
||||
None
|
||||
} else {
|
||||
Some(outcome)
|
||||
};
|
||||
}
|
||||
ctx.request_repaint();
|
||||
}
|
||||
|
||||
/// Where the GUI looks for the agent: `TSUNAGI_CONTROL_SOCKET` if set, else the
|
||||
/// platform default (the system service's path).
|
||||
pub(crate) fn resolve_socket() -> PathBuf {
|
||||
if let Some(path) = std::env::var_os("TSUNAGI_CONTROL_SOCKET") {
|
||||
return PathBuf::from(path);
|
||||
}
|
||||
ipc::default_control_socket_path()
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
//! The eframe application behind the window: the main view, the per-network
|
||||
//! devices windows, and the agent worker.
|
||||
//!
|
||||
//! It runs in its own process, started by the tray when the user chooses Open
|
||||
//! and gone when the window is closed. The tray, which has to outlive the
|
||||
//! window, lives in the other process; see [`crate::tray`].
|
||||
|
||||
use std::time::Duration;
|
||||
|
||||
use eframe::egui;
|
||||
|
||||
use crate::about;
|
||||
use crate::agent::AgentClient;
|
||||
use crate::devices;
|
||||
use crate::stats::Traffic;
|
||||
use crate::ui::{self, UiState};
|
||||
|
||||
/// The window's state.
|
||||
pub(crate) struct App {
|
||||
agent: AgentClient,
|
||||
state: UiState,
|
||||
/// Traffic rates derived from successive snapshots.
|
||||
traffic: Traffic,
|
||||
/// The snapshot generation last folded into `traffic`.
|
||||
sampled: u64,
|
||||
}
|
||||
|
||||
impl App {
|
||||
/// Builds the app: resolves the socket and starts the worker.
|
||||
pub(crate) fn new(
|
||||
cc: &eframe::CreationContext<'_>,
|
||||
runtime: tokio::runtime::Handle,
|
||||
) -> Result<Self, String> {
|
||||
let ctx = cc.egui_ctx.clone();
|
||||
// Add the Phosphor icon glyphs to the font set so the icon buttons
|
||||
// render instead of showing as tofu.
|
||||
let mut fonts = egui::FontDefinitions::default();
|
||||
egui_phosphor::add_to_fonts(&mut fonts, egui_phosphor::Variant::Regular);
|
||||
ctx.set_fonts(fonts);
|
||||
|
||||
let agent = AgentClient::spawn(&runtime, ctx);
|
||||
Ok(Self {
|
||||
agent,
|
||||
state: UiState::default(),
|
||||
traffic: Traffic::default(),
|
||||
sampled: 0,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl eframe::App for App {
|
||||
fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
|
||||
let snapshot = self.agent.snapshot();
|
||||
if snapshot.generation != self.sampled
|
||||
&& let (Some(Ok(report)), Some(at)) = (&snapshot.status, snapshot.at)
|
||||
{
|
||||
self.traffic.observe(report, at);
|
||||
self.sampled = snapshot.generation;
|
||||
}
|
||||
|
||||
ui::draw(ctx, &self.agent, &mut self.state, &snapshot, &self.traffic);
|
||||
self.show_devices_windows(ctx, &snapshot);
|
||||
self.show_about_window(ctx, &snapshot);
|
||||
|
||||
// A secret the worker fetched for the clipboard: copy it here, on the
|
||||
// UI thread that owns the clipboard, exactly once.
|
||||
if let Some(secret) = self.agent.take_pending_copy() {
|
||||
ctx.copy_text(secret);
|
||||
}
|
||||
|
||||
// Keep ticking so fresh status is picked up.
|
||||
ctx.request_repaint_after(Duration::from_millis(500));
|
||||
}
|
||||
}
|
||||
|
||||
impl App {
|
||||
/// Renders the About window while it is open.
|
||||
fn show_about_window(&mut self, ctx: &egui::Context, snapshot: &crate::agent::Snapshot) {
|
||||
if !self.state.about_open {
|
||||
return;
|
||||
}
|
||||
let builder = egui::ViewportBuilder::default()
|
||||
.with_title("About tsunagi")
|
||||
.with_inner_size([560.0, 520.0])
|
||||
.with_min_inner_size([380.0, 280.0]);
|
||||
let socket = self.agent.socket();
|
||||
let keep = ctx.show_viewport_immediate(
|
||||
egui::ViewportId::from_hash_of("about"),
|
||||
builder,
|
||||
|vctx, _class| {
|
||||
about::show(vctx, &socket, snapshot);
|
||||
!vctx.input(|i| i.viewport().close_requested())
|
||||
},
|
||||
);
|
||||
if !keep {
|
||||
self.state.about_open = false;
|
||||
}
|
||||
}
|
||||
|
||||
/// Renders one separate window per open network-devices view.
|
||||
fn show_devices_windows(&mut self, ctx: &egui::Context, snapshot: &crate::agent::Snapshot) {
|
||||
let Some(Ok(report)) = &snapshot.status else {
|
||||
return;
|
||||
};
|
||||
let open: Vec<String> = self.state.open_devices.iter().cloned().collect();
|
||||
for id in open {
|
||||
let Some(network) = report.networks.iter().find(|n| n.network_id == id) else {
|
||||
// The network is gone (left/forgotten); close its window.
|
||||
self.state.open_devices.remove(&id);
|
||||
continue;
|
||||
};
|
||||
let viewport_id = egui::ViewportId::from_hash_of(("devices", &id));
|
||||
let builder = egui::ViewportBuilder::default()
|
||||
.with_title(devices::title(network))
|
||||
.with_inner_size([940.0, 540.0])
|
||||
.with_min_inner_size([480.0, 320.0]);
|
||||
let agent = &self.agent;
|
||||
let traffic = &self.traffic;
|
||||
// The window shares the single unit setting, so its toggle and the
|
||||
// main window's stay in step.
|
||||
let unit = &mut self.state.unit;
|
||||
let confirm = &mut self.state.exit_confirm;
|
||||
let keep = ctx.show_viewport_immediate(viewport_id, builder, |vctx, _class| {
|
||||
devices::show(
|
||||
vctx,
|
||||
agent,
|
||||
unit,
|
||||
confirm,
|
||||
network,
|
||||
&report.endpoint_id,
|
||||
traffic,
|
||||
);
|
||||
!vctx.input(|i| i.viewport().close_requested())
|
||||
});
|
||||
if !keep {
|
||||
self.state.open_devices.remove(&id);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 137 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user