laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-10-30 15:48:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
feat/multi-path-switchover
fips/docs/design/diagrams/dynamics-ex3-topology.svg
T
Johnathan Corgan 00e26765bd Design documentation illustration and review pass 
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
2026-02-24 17:32:37 +00:00

57 lines
3.1 KiB
XML
Raw Permalink Blame History

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 650 280">
<rect width="650" height="280" fill="#0d1117" rx="8"/>
<!-- Title -->
<text x="325" y="30" text-anchor="middle" font-family="monospace" font-size="15" font-weight="bold" fill="#e0e0e0">Two-Site Network — Physical Topology</text>
<text x="325" y="48" text-anchor="middle" font-family="monospace" font-size="11" fill="#909090">node_addr: A &lt; E &lt; B &lt; F &lt; C &lt; G</text>
<!-- Site 1 grouping -->
<rect x="42" y="68" width="200" height="185" rx="8" fill="none" stroke="#303050" stroke-width="1" stroke-dasharray="4,2"/>
<text x="142" y="86" text-anchor="middle" font-family="monospace" font-size="11" fill="#606880">Site 1</text>
<!-- Site 2 grouping -->
<rect x="408" y="68" width="200" height="185" rx="8" fill="none" stroke="#303050" stroke-width="1" stroke-dasharray="4,2"/>
<text x="508" y="86" text-anchor="middle" font-family="monospace" font-size="11" fill="#606880">Site 2</text>
<!-- Node positions:
Site 1: A(100,140) B(200,140) C(200,220)
Site 2: E(450,140) F(550,140) G(550,220)
-->
<!-- Local links — Site 1 -->
<line x1="100" y1="140" x2="200" y2="140" stroke="#404860" stroke-width="1.5"/><!-- A—B -->
<line x1="200" y1="140" x2="200" y2="220" stroke="#404860" stroke-width="1.5"/><!-- B—C -->
<!-- Local links — Site 2 -->
<line x1="450" y1="140" x2="550" y2="140" stroke="#404860" stroke-width="1.5"/><!-- E—F -->
<line x1="550" y1="140" x2="550" y2="220" stroke="#404860" stroke-width="1.5"/><!-- F—G -->
<!-- WAN link B—E (dashed) -->
<line x1="200" y1="140" x2="450" y2="140" stroke="#404860" stroke-width="1.5" stroke-dasharray="8,4"/>
<text x="325" y="132" text-anchor="middle" font-family="monospace" font-size="10" fill="#909090">WAN</text>
<!-- Node A -->
<circle cx="100" cy="140" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="100" y="145" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">A</text>
<!-- Node B -->
<circle cx="200" cy="140" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="200" y="145" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">B</text>
<!-- Node C -->
<circle cx="200" cy="220" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="200" y="225" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">C</text>
<!-- Node E -->
<circle cx="450" cy="140" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="450" y="145" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">E</text>
<!-- Node F -->
<circle cx="550" cy="140" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="550" y="145" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">F</text>
<!-- Node G -->
<circle cx="550" cy="220" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="550" y="225" text-anchor="middle" font-family="monospace" font-size="14" font-weight="bold" fill="#e0e0e0">G</text>
</svg>
Reference in New Issue View Git Blame Copy Permalink