Files
fips/docs/design
Johnathan Corgan af66ffaea1 Merge branch 'maint'
Carries the seven security fixes up from the maintenance
line. Master has been refactored underneath most of the code they touch,
so this merge lands only the part that applies as written; the rest is
re-implemented against master's architecture in the commits that follow.

Landed complete by this merge:

- Bound the coordinate-cache warm path by the encrypted-header parser.
  The guard applies unchanged in src/node/dataplane/forwarding.rs, which
  is where master keeps the warm path. Its test is not here: master and
  the maintenance line added different tests to the same region of
  src/node/tests/forwarding.rs, and the union is made with the test that
  belongs to it.
- Filter and cap the punch targets taken from a peer's traversal signal.
- Reject traversal signals dated in the future.
- The character-boundary fix to the session-id log helper, which is what
  made the two traversal fixes safe to log.

Deferred to follow-on commits, because the mechanism they change does
not exist upstream in the shape the fix was written against:

- Bound a remote-supplied path MTU, and give the cache a way back.
  Master routes the keep-tighter rule through a sans-IO core with an
  apply site the maintenance line does not have, and keeps the lookup
  handlers in src/node/handlers/lookup.rs rather than a discovery module.
  The floor constant, the release helper and the TUN clamp side are here;
  the apply sites are not.
- Act on a routing signal only for a destination this node has bound.
- Never destroy an established session on an unauthenticated setup
  message. Master decides rekey in a clock-free core off a snapshot, so
  the fix's condition has no loop to sit in.
- Let flap dampening engage again after an episode lapses. Master
  extracted the mechanism into a component with an injected clock.

The counters, statistics and status-pane fields for the deferred fixes
merged cleanly and are in this commit, so they read zero until the fix
that feeds them lands. The halves that would not compile or would fail
without their fix were held back with it.

Green at this tree: fmt, build, clippy --all-targets -D warnings
and test --lib at 1784 passed.
2026-08-14 03:51:08 +00:00
..
2026-06-07 23:30:35 +00:00

FIPS Design

Architectural and protocol-level explanations for FIPS — the why and the how behind the wire and the system. For wire formats and configuration keys, see reference/. For task recipes, see how-to/. For end-to-end lessons, see tutorials/.

Reading Order

Start with fips-concepts.md for the novice-friendly framing of what FIPS is and why, then move to fips-architecture.md for the protocol stack, identity model, and two-layer encryption walkthrough. From there, follow the protocol stack from bottom to top. After the stack, fips-mesh-operation.md explains how the pieces work together at runtime. Cross-cutting and supporting documents cover specific subsystems in detail.

Foundations

Document Description
fips-concepts.md What FIPS is, why it exists, mental model
fips-architecture.md Protocol stack, identity, two-layer encryption
fips-prior-work.md Designs and protocols FIPS builds on

Protocol Stack

Document Description
fips-transport-layer.md Transport layer: datagram delivery over arbitrary media
fips-mesh-layer.md FIPS Mesh Protocol (FMP): peer authentication, link encryption, forwarding
fips-session-layer.md FIPS Session Protocol (FSP): end-to-end encryption, sessions
fips-ipv6-adapter.md IPv6 adaptation: TUN interface, DNS, MTU enforcement

Cross-Cutting

Document Description
fips-mmp.md Metrics Measurement Protocol (link + session)
fips-mtu.md Path MTU model, encapsulation overhead, PMTUD
fips-security.md fips0 interface threat model and default-deny baseline

Mesh Behavior

Document Description
fips-mesh-operation.md How the mesh operates: routing, discovery, error recovery
fips-nostr-discovery.md Optional Nostr-mediated peer discovery and UDP NAT hole-punch
port-advertisement-and-nat-traversal.md Nostr-signaled port advertisement and UDP NAT-traversal protocol; generic, with FIPS as an example implementation

Deeper Dives

Document Description
fips-spanning-tree.md Spanning tree algorithms: root discovery, parent selection, coordinates
fips-bloom-filters.md Bloom filter properties: FPR analysis, size classes, split-horizon
spanning-tree-dynamics.md Spanning tree walkthroughs: convergence scenarios, worked examples

Adjacent Components

Document Description
fips-gateway.md fips-gateway service: outbound (LAN-to-mesh) DNS-proxy + virtual-IP NAT and inbound (mesh-to-LAN) port-forwarding, sharing one nftables table