mirror of
https://github.com/jmcorgan/fips.git
synced 2026-08-10 16:43:12 +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
83 lines
4.0 KiB
XML
83 lines
4.0 KiB
XML
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 700 320" font-family="monospace" font-size="13">
|
|
<!-- Background -->
|
|
<rect width="700" height="320" fill="#0d1117" rx="8"/>
|
|
|
|
<!-- Title -->
|
|
<text x="350" y="28" fill="#e0e0e0" text-anchor="middle" font-size="15" font-weight="bold">Node Joining — B Connects to D</text>
|
|
|
|
<!-- Section titles -->
|
|
<text x="175" y="56" fill="#909090" text-anchor="middle" font-size="14">Before</text>
|
|
<text x="525" y="56" fill="#909090" text-anchor="middle" font-size="14">After</text>
|
|
|
|
<!-- Arrow between halves -->
|
|
<text x="350" y="180" fill="#909090" text-anchor="middle" font-size="22">→</text>
|
|
|
|
<!-- ======================== -->
|
|
<!-- BEFORE (left half) -->
|
|
<!-- ======================== -->
|
|
|
|
<!-- Root A at top center of left half -->
|
|
<!-- A: (175, 110) -->
|
|
<text x="175" y="78" fill="#d0a040" text-anchor="middle" font-size="10">★ root</text>
|
|
<circle cx="175" cy="110" r="22" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
|
|
<text x="175" y="115" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">A</text>
|
|
|
|
<!-- Children: C (105, 200), D (175, 200), E (245, 200) -->
|
|
<!-- Links from A to children -->
|
|
<line x1="175" y1="132" x2="105" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
<line x1="175" y1="132" x2="175" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
<line x1="175" y1="132" x2="245" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
|
|
<!-- C -->
|
|
<circle cx="105" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="105" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">C</text>
|
|
|
|
<!-- D -->
|
|
<circle cx="175" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="175" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">D</text>
|
|
|
|
<!-- E -->
|
|
<circle cx="245" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="245" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">E</text>
|
|
|
|
<!-- B isolated (dashed, off to the side) -->
|
|
<circle cx="60" cy="280" r="22" fill="#1a1a2e" stroke="#808890" stroke-width="2" stroke-dasharray="4,3"/>
|
|
<text x="60" y="285" fill="#808890" text-anchor="middle" font-weight="bold" font-size="14">B</text>
|
|
|
|
<!-- ======================== -->
|
|
<!-- AFTER (right half) -->
|
|
<!-- ======================== -->
|
|
|
|
<!-- Root A at top center of right half -->
|
|
<!-- A: (525, 110) -->
|
|
<text x="525" y="78" fill="#d0a040" text-anchor="middle" font-size="10">★ root</text>
|
|
<circle cx="525" cy="110" r="22" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
|
|
<text x="525" y="115" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">A</text>
|
|
|
|
<!-- Children: C (455, 200), D (525, 200), E (595, 200) -->
|
|
<!-- Links from A to children -->
|
|
<line x1="525" y1="132" x2="455" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
<line x1="525" y1="132" x2="525" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
<line x1="525" y1="132" x2="595" y2="178" stroke="#d0a040" stroke-width="2.5"/>
|
|
|
|
<!-- C -->
|
|
<circle cx="455" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="455" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">C</text>
|
|
|
|
<!-- D -->
|
|
<circle cx="525" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="525" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">D</text>
|
|
|
|
<!-- E -->
|
|
<circle cx="595" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="595" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">E</text>
|
|
|
|
<!-- B as child of D -->
|
|
<!-- Link from D to B -->
|
|
<line x1="525" y1="222" x2="525" y2="268" stroke="#d0a040" stroke-width="2.5"/>
|
|
|
|
<!-- B -->
|
|
<circle cx="525" cy="290" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
|
|
<text x="525" y="295" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">B</text>
|
|
</svg>
|