Restructures /docs/ by reader purpose (tutorials, how-to, reference, design), adds the new-user-progression and operator-recipe content the prior layout lacked, runs an accuracy pass against current source across the pre-existing design docs, and rewrites the gateway feature-set documentation end-to-end around its actual operational profile (a niche feature designed for systems already serving DHCP/DNS to a LAN, with two independent halves — outbound LAN→mesh, inbound mesh→LAN — sharing one nftables table, one binary, and one control socket). Top-level README and getting-started rewritten around two equally-weighted deployment modes (overlay on existing IP networks; ground-up over non-IP transports). ## Additions - 11 new tutorials in docs/tutorials/: an 8-step new-user progression from single-daemon test-mesh peering through to a ground-up two-device mesh, an IPv6-adapter side-trip walkthrough, an Advanced Tutorials index, and a hand-held OpenWrt walk-through for fips-gateway deployment that exercises both halves of the feature. - 12 new how-tos in docs/how-to/: firewall activation, Nostr discovery (resolve / advertise / open across five scenarios), Tor onion (directory + control_port modes), UDP buffer tuning, unprivileged-user setup, persistent identity, host aliases, Bluetooth LE peering, MTU diagnostics, manual Linux-host gateway deployment (covers both halves), gateway troubleshooting (organised by half), and a section index. - 9 new reference docs in docs/reference/: configuration, wire formats, control-socket protocol, four CLI references (fips, fipsctl, fipstop, fips-gateway), security posture matrix, and Nostr events catalog. Configuration and wire-formats are renamed-and-extended from prior design/ versions; the other seven are net-new. - 6 new design docs: fips-concepts, fips-architecture, and fips-prior-work split out of the deleted fips-intro.md; consolidated fips-mmp and fips-mtu aggregations; and a new generic port-advertisement-and-nat-traversal doc (Nostr-signaled port advertisement plus UDP NAT-traversal protocol, FIPS as an example implementation, suitable for eventual NIP submission). - Top-level docs/getting-started.md walking through the binary-installer-only Install story. - packaging/common/hosts pre-populated with the eight public test-mesh nodes so shortnames resolve out of the box on every fresh install. ## Changes - 23 wire-format diagrams relocated to reference/diagrams/ alongside the wire-formats move. - 4 design diagrams corrected against source code (fips-protocol-stack, fips-identity-derivation, fips-coordinate-discovery, fips-routing-decision). - 10 pre-existing design docs reconciled with current source. Numeric corrections: stale link-MMP report bounds (now [1s, 5s] with 200 ms cold-start floor); UDP default MTU (now 1280, IPv6 minimum); node_addr formula (SHA-256(pubkey)[..16]); Noise patterns (IK at link, XK at session); peer-ACL semantics (strict allowlist requires ALL in peers.deny); daemon DNS upstream ([::1]:5354); on-the-wire bloom-filter size (1,071 bytes); obsolete Cargo-feature references (PR #79 dropped them) removed. - Transport framing tightened across the docs: TCP is for UDP-filtered networks (not NAT traversal); Tor is a deployment mode (not failover); WebSocket dropped (not a shipped FIPS transport); WiFi promoted to Implemented via Ethernet in infrastructure mode; classic-Bluetooth row removed (BLE is the only Bluetooth-mode transport). - docs/design/fips-gateway.md rewritten end-to-end to lead with the niche-feature framing and the two-halves structure. Title moved from "FIPS Outbound LAN Gateway" to "FIPS Gateway"; architecture section describes the common machinery (the fips-gateway service, the nftables table, the control socket) before splitting into separate "Outbound Half" and "Inbound Half" sections of equal weight; security considerations split per-half; no Future Work section (speculative directions live in the project tracker, not in protocol design docs). Inbound port forwarding is a first-class half rather than a buried "Implemented Extensions" subsection. - Gateway terminology unified across all gateway docs as a separate Linux service running alongside the fips daemon (its own systemd unit / OpenWrt init script). Container- pattern terms (sidecar) are reserved for the Docker/Kubernetes sidecar deployment examples — the testing/sidecar/ tree, examples/k8s-sidecar/, examples/sidecar-nostr-relay/, examples/wireguard-sidecar-macos/, and the related CHANGELOG / top-level README entries — where the term carries its standard container meaning. - Net-new design body content: rekey section in fips-mesh-layer (Noise IK msg1/msg2 over the established link, K-bit cutover, drain window, smaller-NodeAddr-wins tie-breaker on dual-init); Mesh Size Estimation and Antipoison FPR Cap sections in fips-bloom-filters; Mesh-Interface Query Filter subsection in fips-ipv6-adapter; failure-suppression knobs and clock- skew tolerance in fips-nostr-discovery; loop-rejection and mid-chain ancestor swap added to spanning-tree propagation / stability rules; Priority Chain in fips-mesh-operation renumbered to match the routing-decision diagram. - Top-level README: dropped the stale nostr-discovery cargo-feature parenthetical. docs/README.md and the four section READMEs (tutorials, how-to, reference, design) refreshed for the new structure; index rows reflect both halves of the gateway feature and the new fips-gateway CLI reference. - Cargo.toml [package.metadata.deb] assets path updated for the fips-security.md move; .gitignore /reference/ rule anchored to repo root so docs/reference/ is trackable. - packaging/openwrt-ipk/files/etc/fips/fips.yaml configuration-doc URL updated to the new docs/reference/configuration.md location. ## Deletions - docs/design/fips-intro.md (split into the three new intro design docs). - docs/design/document-relationships.svg (orphan, no longer referenced). - docs/proposals/ tree removed; the only proposal it contained (the Nostr UDP hole-punch protocol) was rewritten as the new generic design/port-advertisement-and-nat-traversal.md.
FIPS: Free Internetworking Peering System
A distributed, decentralized network routing protocol for mesh nodes connecting over arbitrary transports.
FIPS is under active development. The protocol and APIs are not yet stable. See Status & Roadmap below.
Overview
FIPS is a self-organizing mesh network that operates natively over a variety of physical and logical media — local area networks, Bluetooth, serial links, radio, or the existing internet as an overlay. Nodes generate their own identities, discover each other, and route traffic without any central authority or global topology knowledge.
FIPS uses Nostr keypairs (secp256k1/schnorr) as native node identities, allowing users to generate their own persistent or ephemeral node addresses. Nodes address each other by npub, and the same cryptographic identity serves as both the routing address and the basis for end-to-end encrypted sessions across the mesh.
FIPS allows existing TCP/IP based network software to use the FIPS mesh network by generating a local IP address from the node npub and tunnelling IP packets to other endpoints transparently knowing only their npub. Native FIPS-aware applications do not need this IP tunneling or emulation capability.
All traffic over the FIPS mesh is encrypted and authenticated both hop-to-hop between peers and independently end-to-end between FIPS endpoints.
Features
- Self-organizing mesh routing — spanning tree coordinates with bloom filter guided discovery, no global routing tables
- Multi-transport — UDP, TCP, Ethernet, Tor, and Bluetooth (BLE L2CAP) today; designed for serial and radio
- Noise encryption — hop-by-hop link encryption (IK) plus independent end-to-end session encryption (XK), with periodic rekey for forward secrecy
- Nostr-native identity — secp256k1 keypairs as node addresses, no registration or central authority
- IPv6 adaptation — TUN interface maps npubs to fd00::/8 addresses
for unmodified IP applications; built-in
.fipsDNS resolver with optional static hostname mapping (/etc/fips/hosts) - Outbound LAN gateway — optional
fips-gatewaydaemon lets unmodified LAN hosts reach.fipsdestinations via a DNS-allocated virtual IP pool and kernel nftables NAT - Metrics Measurement Protocol — per-link RTT, loss, jitter, and goodput measurement with mesh size estimation
- ECN congestion signaling — hop-by-hop CE flag relay with RFC 3168 IPv6 marking, transport kernel drop detection
- Operator visibility —
fipsctlCLI andfipstopTUI dashboard for runtime inspection and runtime peer management - Zero configuration — sensible defaults; a node can start with no config file, though peer addresses are needed to join a network
Building
git clone https://github.com/jmcorgan/fips.git
cd fips
cargo build --release
Requires Rust 1.85+ (edition 2024). Linux, macOS, and Windows are supported (see transport matrix below).
Transport support by platform
| Transport | Linux | macOS | Windows | OpenWrt |
|---|---|---|---|---|
| UDP | ✅ | ✅ | ✅ | ✅ |
| TCP | ✅ | ✅ | ✅ | ✅ |
| Ethernet | ✅ | ✅ | ❌ | ✅ |
| Tor | ✅ | ✅ | ✅ | ✅ |
| BLE | ✅ | ❌ | ❌ | ❌ |
On Linux, the BLE transport requires BlueZ and libdbus. On
Debian/Ubuntu: sudo apt install bluez libdbus-1-dev. Then build with
BLE enabled: cargo build --release --features ble.
On OpenWrt, BLE is disabled because libdbus is not available on the target. All other transports work and ship in the default ipk.
Installation
After building, choose one of the following methods to install.
Debian / Ubuntu (.deb)
Requires cargo-deb:
cargo install cargo-deb
cargo deb
sudo dpkg -i target/debian/fips_*.deb
This installs the daemon, CLI tools, systemd units, and a default
configuration. Edit /etc/fips/fips.yaml before starting:
sudo nano /etc/fips/fips.yaml
sudo systemctl start fips
The service is enabled at boot automatically. To use fipsctl and
fipstop without sudo, add your user to the fips group:
sudo usermod -aG fips $USER # log out and back in to take effect
Remove with sudo dpkg -r fips (preserves config) or
sudo dpkg -P fips (removes everything including identity keys).
Generic Linux (systemd tarball)
./packaging/systemd/build-tarball.sh
tar xzf deploy/fips-*-linux-*.tar.gz
cd fips-*-linux-*/
sudo ./install.sh
See packaging/systemd/README.install.md for the full installation and configuration guide.
macOS (.pkg)
./packaging/macos/build-pkg.sh
sudo installer -pkg deploy/fips-*-macos-*.pkg -target /
This installs binaries to /usr/local/bin/, config to
/usr/local/etc/fips/, sets up .fips DNS resolution via
/etc/resolver/fips, and registers a launchd daemon. Edit
/usr/local/etc/fips/fips.yaml before starting:
sudo nano /usr/local/etc/fips/fips.yaml
sudo launchctl load -w /Library/LaunchDaemons/com.fips.daemon.plist
Remove with sudo packaging/macos/uninstall.sh (preserves config).
To restart the node after making configuration changes:
sudo launchctl unload -w /Library/LaunchDaemons/com.fips.daemon.plist
sudo launchctl load -w /Library/LaunchDaemons/com.fips.daemon.plist
Check logs for troubleshooting:
sudo tail -f /usr/local/var/log/fips/fips.log
Note: On macOS, the TUN device is named
utun<N>(kernel-assigned) rather thanfips0.
Windows
Build without BLE (requires Linux-only libdbus):
cargo build --release --no-default-features --features tui
The wintun driver is required for TUN support.
Download wintun.dll and place it in the same directory as fips.exe.
Running the daemon requires Administrator privileges for TUN creation.
Foreground mode:
.\fips.exe -c fips.yaml
Windows Service:
# Install (requires Administrator)
.\fips.exe --install-service
# Manage via standard service tools
sc start fips
sc stop fips
# Uninstall
.\fips.exe --uninstall-service
Place fips.yaml in the current directory or %APPDATA%\fips\, or set
the FIPS_CONFIG environment variable.
The control socket uses TCP on localhost:21210 instead of a Unix domain
socket. fipsctl and fipstop connect to this port automatically.
Configuration
The default configuration file is installed at /etc/fips/fips.yaml:
# FIPS Node Configuration
node:
identity:
# By default, a new ephemeral keypair is generated on each start.
# Uncomment persistent to keep the same identity across restarts;
# on first start a keypair is saved to fips.key/fips.pub next to
# this config file (mode 0600/0644).
# persistent: true
#
# Or set an explicit key (overrides persistent):
# nsec: "nsec1..."
tun:
enabled: true
name: fips0
mtu: 1280
dns:
enabled: true
bind_addr: "127.0.0.1"
port: 5354
transports:
udp:
bind_addr: "0.0.0.0:2121"
tcp:
# Accepts inbound connections. No static outbound peers.
bind_addr: "0.0.0.0:8443"
# Ethernet transport — uncomment and set your interface name.
# ethernet:
# interface: "eth0"
# discovery: true
# announce: true
# auto_connect: true
# accept_connections: true
peers:
# Static peers for bootstrapping (UDP or TCP):
- npub: "npub1qmc3cvfz0yu2hx96nq3gp55zdan2qclealn7xshgr448d3nh6lks7zel98"
alias: "fips-test-node"
addresses:
- transport: udp
addr: "217.77.8.91:2121"
connect_policy: auto_connect
See docs/design/fips-configuration.md for the full reference.
Usage
DNS Resolution
FIPS includes a DNS resolver (enabled by default, port 5354) that maps
.fips names to fd00::/8 IPv6 addresses.
Linux: The .deb package auto-detects and configures whichever
resolver is present (systemd dns-delegate, systemd-resolved, dnsmasq,
or NetworkManager with dnsmasq); no manual setup is needed. For
manual or tarball installs, point your resolver at 127.0.0.1:5354
for the fips domain — e.g., with systemd-resolved:
sudo resolvectl dns fips0 127.0.0.1:5354
sudo resolvectl domain fips0 ~fips
macOS: DNS is configured automatically by the .pkg installer via
/etc/resolver/fips. No manual setup is needed.
Then reach any FIPS node by npub with standard IPv6 tools:
ping6 npub1bbb....fips
ssh -6 npub1bbb....fips
macOS note: Use
ping6instead ofping. macOS ships separateping(IPv4-only) andping6(IPv6) binaries;pingwill not resolve AAAA records. Similarly, usecurl -6,ssh -6, etc. when connecting by.fipshostname.
Monitoring
Use fipsctl to query a running node:
fipsctl show status # Node status overview
fipsctl show peers # Authenticated peers and security state
fipsctl show links # Active links
fipsctl show tree # Spanning tree state
fipsctl show sessions # End-to-end sessions and rekey health
fipsctl show bloom # Bloom filter state
fipsctl show mmp # MMP metrics summary
fipsctl show cache # Coordinate cache entries and routes
fipsctl show connections # Pending handshake connections
fipsctl show transports # Transport instances
fipsctl show routing # Routing, discovery, and retry state
fipsctl show identity-cache # Known node identities (npubs)
fipstop provides an interactive TUI dashboard with live-updating
views of node status, peers, links, sessions, tree state, transports,
and routing:
fipstop # connect to local daemon
fipstop -r 1 # 1-second refresh interval
Service Management
sudo systemctl start fips
sudo systemctl stop fips
sudo systemctl restart fips
sudo journalctl -u fips -f
Testing
See testing/ for Docker-based integration test harnesses including static topology tests and stochastic chaos simulation.
Examples
- examples/sidecar-nostr-relay/ — Run a strfry Nostr relay reachable exclusively over the FIPS mesh. The relay container shares the FIPS sidecar's network namespace and is isolated from the host network.
- examples/k8s-sidecar/ — Run FIPS as a
Kubernetes Pod sidecar. The sidecar creates
fips0in the Pod's shared network namespace so every other container in the Pod gets mesh access without modification. - examples/wireguard-sidecar-macos/ —
Reach the FIPS mesh from a macOS host through a local Docker
container over a WireGuard tunnel. Only traffic destined for
fd00::/8transits the sidecar; regular internet traffic continues to use the host network.
Documentation
Protocol design documentation is in docs/design/, organized as a layered protocol specification. Start with fips-intro.md for the full protocol overview.
If you want to contribute, start with:
Project Structure
src/ Rust source (library + fips/fipsctl/fipstop/fips-gateway binaries)
packaging/ Debian, macOS .pkg, Windows ZIP, OpenWrt ipk, AUR, systemd tarball
examples/ Deployment examples (Nostr relay, K8s sidecar, macOS WireGuard)
docs/design/ Protocol design specifications
testing/ Docker-based integration test harnesses
Status & Roadmap
FIPS is at v0.2.0. The core protocol works end-to-end over UDP, TCP, Ethernet, Tor, and Bluetooth (BLE) with a small live mesh of deployed nodes.
What works today
- Spanning tree construction with greedy coordinate routing
- Bloom filter guided discovery (no flooding, single-path with retry)
- Noise IK (link layer) and Noise XK (session layer) encryption
- Periodic Noise rekey with hitless cutover for forward secrecy (FMP + FSP)
- Persistent node identity with key file management
- IPv6 TUN adapter with built-in
.fipsDNS resolver and multi-backend auto-configuration (systemd dns-delegate, systemd-resolved, dnsmasq, NetworkManager) - Static hostname mapping (
/etc/fips/hosts) with auto-reload - Per-link metrics (RTT, loss, jitter, goodput) and mesh size estimation
- ECN congestion signaling (hop-by-hop CE relay, IPv6 CE marking, kernel drop detection)
- UDP, TCP, Ethernet, Tor, and BLE transports (BLE via L2CAP CoC with per-link MTU negotiation)
- Outbound LAN gateway for unmodified hosts via DNS-allocated virtual IPs and nftables NAT
- Runtime inspection and peer management via
fipsctlandfipstop - Reproducible builds with toolchain pinning and SOURCE_DATE_EPOCH
- Linux (Debian, systemd tarball, OpenWrt, AUR), macOS (
.pkg), and Windows (ZIP, service) packaging - Docker-based integration and chaos testing
- Nostr-mediated overlay endpoint discovery and UDP hole punching for NAT traversal — peers publish endpoint adverts on public Nostr relays, exchange candidates via NIP-59 gift-wrapped offers/answers, and establish direct paths through NATs using STUN-assisted punching
Near-term priorities
- Native API for FIPS-aware applications (npub:port addressing)
- Security audit of cryptographic protocols
Longer-term
- Mobile platform support
- Bandwidth-aware routing and QoS
- Protocol stability and versioned wire format
- Published crate
License
MIT — see LICENSE.
