mirror of
https://github.com/jmcorgan/fips.git
synced 2026-07-22 07:48:26 +00:00
d0a0824768
Same split as the maint-to-master merge: version identity stays with the receiving branch, project state flows up. Kept next's: Cargo.toml and Cargo.lock at 0.6.0-dev, the status badge, and the paragraph identifying next as the wire-format-breaking line that will not interoperate with v0.2.x, v0.3.x, or v0.4.x peers. Only the shipped-release pointer inside it moved from v0.4.0 to v0.4.1. The changelog conflict was additive rather than competing, and resolving it either way would have lost real content. Next's [Unreleased] Fixed section carries the XX rekey divergence and dual-initiation work; master brought the [0.4.1] section. Git could not tell these were adjacent rather than rival, so both were kept in order, with next's Breaking block and its own [Unreleased] entries untouched. Took from master: the bloom FPR default change and its duplicate-definition fix, the docs describing them, the v0.4.1 release notes, the v0.4.0 date correction, and the root RELEASE-NOTES.md mirror. Checked before merging that no incoming content names the Noise handshake pattern, since next is XX where master is IK. The two "Noise IK" strings on master both predate v0.4.0 and next already carries its own wording for them, so nothing needed rewording here. Quartet green: 1698 tests passed, clippy clean with -D warnings.
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 |