mirror of
https://github.com/jmcorgan/fips.git
synced 2026-10-30 07:37:36 +00:00
Johnathan Corgan
00e26765bd
Wire format diagrams: - Add 24 SVG diagrams covering every FMP and FSP wire format: common prefix, established frame headers, Noise IK handshake messages, handshake flow, TreeAnnounce, AncestryEntry, FilterAnnounce, LookupRequest/Response, SessionDatagram, Disconnect, SenderReport, ReceiverReport, FSP complete message, SessionSetup/Ack/Msg3, PathMtuNotification, CoordsRequired, PathBroken, and MtuExceeded - Replace ASCII art in fips-wire-formats.md with SVG references - Apply text edits to fips-mesh-layer.md, fips-mesh-operation.md, fips-transport-layer.md, and fips-ipv6-adapter.md Spanning tree dynamics: - Add 12 topology SVG diagrams: node join (overview + 3-panel steps), three-node convergence (4-panel), link addition with depth labels, link removal, partition formation, and 6 real-world example diagrams (office, mixed-link, two-site WAN topologies) - Rewrite all code blocks to narrative prose with diagram references - Add inline prior art attributions distinguishing Yggdrasil-derived concepts from FIPS-novel contributions - Add 3 new references (De Couto ETX, IEEE 802.1D, RFC 2328 OSPF) and Prior Art summary - Remove outdated sections: indirect partition note, integration test gaps, DHT-based lookup reference - Change "must elect a new root" to "must rediscover its new root" Spanning tree design review (fips-spanning-tree.md): - Rename "Root Election" to "Root Discovery" across docs - Add "What Is a Spanning Tree?" introductory section - Add parent selection intro explaining self-organization role - Fix tree distance example: 4 hops, not 2 - Clarify timestamp field as advisory only - Remove unimplemented ROOT_TIMEOUT and TREE_ENTRY_TTL from timing parameters and implementation status tables Bloom filter design review (fips-bloom-filters.md): - Add "What Is a Bloom Filter?" intro section - Rewrite Purpose section to frame filters as routing path identification - Correct FPR analysis (old values were 3-50x overstated) - Add Filter Occupancy Model based on network size and tree position - Fix filter expiration to describe actual MMP-based cleanup - Combine Scale Considerations with Size Classes after Wire Format - Fix stale FPR values in src/bloom/mod.rs comments Session layer review (fips-session-layer.md): - Add inline prior art attributions: Noise Protocol Framework, WireGuard, DTLS (RFC 6347), IKEv2 (RFC 7296), RFC 1191 PMTUD, Yggdrasil, NIP-44 - Replace warmup state machine ASCII art with SVG diagram - Convert CoordsWarmup wire format code block to prose - Add External References section with full citations Level 5 implementation doc cleanup: - Delete fips-software-architecture.md (redundant with protocol layer docs) - Delete fips-state-machines.md (Rust tutorial, not protocol design) - Add fipsctl command reference to README.md - Update cross-references in fips-intro.md, docs/design/README.md, fips-transport-layer.md, fips-configuration.md Fixes: - Correct fd::/8 to fd00::/8 in fips-session-layer.md, fips-identity-derivation.svg, and fips-node-architecture.svg - Fix config example MTU: 1197 → 1472 in fips-configuration.md File organization: - Move all SVG diagrams into docs/design/diagrams/ subdirectory - Update all diagram references to use new paths
39 lines
2.3 KiB
XML
39 lines
2.3 KiB
XML
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 500 320">
|
|
<rect width="500" height="320" fill="#0d1117" rx="8"/>
|
|
|
|
<!-- Title -->
|
|
<text x="250" y="30" text-anchor="middle" font-family="monospace" font-size="15" font-weight="bold" fill="#e0e0e0">Office Network — Physical Topology</text>
|
|
<text x="250" y="48" text-anchor="middle" font-family="monospace" font-size="11" fill="#909090">node_addr: A < C < B < E < D</text>
|
|
|
|
<!-- Node positions: A(100,110) B(340,110) D(100,250) C(340,250) E(460,250) -->
|
|
|
|
<!-- Mesh links (gray) -->
|
|
<line x1="100" y1="110" x2="340" y2="110" stroke="#404860" stroke-width="1.5"/><!-- A—B -->
|
|
<line x1="100" y1="110" x2="100" y2="250" stroke="#404860" stroke-width="1.5"/><!-- A—D -->
|
|
<line x1="100" y1="110" x2="340" y2="250" stroke="#404860" stroke-width="1.5"/><!-- A—C -->
|
|
<line x1="340" y1="110" x2="340" y2="250" stroke="#404860" stroke-width="1.5"/><!-- B—C -->
|
|
<line x1="340" y1="110" x2="100" y2="250" stroke="#404860" stroke-width="1.5"/><!-- B—D -->
|
|
<line x1="100" y1="250" x2="340" y2="250" stroke="#404860" stroke-width="1.5"/><!-- D—C -->
|
|
<line x1="340" y1="250" x2="460" y2="250" stroke="#404860" stroke-width="1.5"/><!-- C—E -->
|
|
|
|
<!-- Node A -->
|
|
<circle cx="100" cy="110" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="100" y="115" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">A</text>
|
|
|
|
<!-- Node B -->
|
|
<circle cx="340" cy="110" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="340" y="115" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">B</text>
|
|
|
|
<!-- Node D -->
|
|
<circle cx="100" cy="250" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="100" y="255" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">D</text>
|
|
|
|
<!-- Node C -->
|
|
<circle cx="340" cy="250" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="340" y="255" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">C</text>
|
|
|
|
<!-- Node E -->
|
|
<circle cx="460" cy="250" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="460" y="255" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">E</text>
|
|
</svg>
|
