mirror of
https://github.com/jmcorgan/fips.git
synced 2026-10-05 19:18:25 +00:00
Johnathan Corgan
9e4b5d6a72
Carries thirteen commits up from maint: the source-comment sweep and its regression gate, and the v1 exposure remediation (key-material clearing, frame-length validation, and post-handshake identity confirmation). Ten paths conflicted. The resolutions: - Cargo.toml: kept both dependency additions, libm and zeroize. - src/control/queries.rs: took the corrected prose from maint but kept this branch's path to the relocated rx_loop module. Neither side was right alone. - src/control/read_handle.rs: took maint's corrected description of what the snapshot dispatch serves, and kept this branch's paragraph on the mutating profiling commands, which maint has never carried. - src/node/handlers/mod.rs: kept this branch's module list, widening handshake to pub(in crate::node) so the tests can name the waiver type. - src/node/dataplane/rx_loop.rs: union of the import blocks. - src/node/handlers/handshake.rs: kept the WireOutcome binding and dropped maint's possible_restart fix-up, which this branch folded away; placed the post-handshake identity confirmation above it, which keeps the confirmation ahead of the reverse-lookup repair as intended. - src/nostr/runtime.rs: took this branch's side. The function maint edits was relocated to traversal_machine.rs here and its copy already carries the same corrected text. - src/mmp/report.rs: deleted. This branch retired the module; maint's only change was removing a stale comment. - src/node/lifecycle.rs and src/peer/connection.rs: deleted, but their key-clearing work was relocated rather than dropped. The erasing guard now wraps both handshake entry points in src/peer/machine.rs and the outbound dial in src/node/lifecycle/mod.rs, since the files maint had changed no longer exist here. Without the relocation the guard type would have arrived with no callers at all. Eight further edits were forced by names that differ on this branch: the wire module path at seven sites, the connection lookup in the waiver classifier, and four test helpers the peer-machine work replaced.
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 |