laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-10-05 19:18:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
fix/log-rotation
fips/docs/design/diagrams/dynamics-convergence.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

101 lines
5.3 KiB
XML
Raw Permalink Blame History

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 780 168" font-family="monospace" font-size="13">
<!-- Background -->
<rect width="780" height="168" fill="#0d1117" rx="8"/>
<!-- Title -->
<text x="390" y="22" text-anchor="middle" font-size="14" font-weight="bold" fill="#e0e0e0">Three-Node Convergence</text>
<!-- Panel separators -->
<line x1="193" y1="32" x2="193" y2="160" stroke="#303050" stroke-width="1"/>
<line x1="390" y1="32" x2="390" y2="160" stroke="#303050" stroke-width="1"/>
<line x1="587" y1="32" x2="587" y2="160" stroke="#303050" stroke-width="1"/>
<!-- ======================== -->
<!-- Panel 1: T0 — Isolated -->
<!-- ======================== -->
<text x="95" y="44" text-anchor="middle" font-size="10" fill="#909090">T0 &#x2014; Isolated</text>
<text x="45" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<text x="95" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<text x="145" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<circle cx="45" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="45" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">A</text>
<circle cx="95" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="95" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">B</text>
<circle cx="145" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="145" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">C</text>
<text x="95" y="150" text-anchor="middle" font-size="9" fill="#606060">node_addr: A &lt; B &lt; C</text>
<!-- ======================== -->
<!-- Panel 2: T1 — Links form -->
<!-- ======================== -->
<text x="292" y="44" text-anchor="middle" font-size="10" fill="#909090">T1 &#x2014; Links form</text>
<text x="242" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<text x="292" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<text x="342" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<!-- Peer link A—B (dashed gray) -->
<line x1="260" y1="105" x2="274" y2="105" stroke="#404860" stroke-width="1.5" stroke-dasharray="6,3"/>
<!-- Peer link B—C (dashed gray) -->
<line x1="310" y1="105" x2="324" y2="105" stroke="#404860" stroke-width="1.5" stroke-dasharray="6,3"/>
<circle cx="242" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="242" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">A</text>
<circle cx="292" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="292" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">B</text>
<circle cx="342" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="342" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">C</text>
<!-- ======================== -->
<!-- Panel 3: T2 — B re-parents -->
<!-- ======================== -->
<text x="490" y="44" text-anchor="middle" font-size="10" fill="#909090">T2 &#x2014; B re-parents</text>
<text x="440" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<text x="540" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<!-- Tree link A—B (gold solid) -->
<line x1="458" y1="105" x2="472" y2="105" stroke="#d0a040" stroke-width="2"/>
<!-- Peer link B—C (dashed gray) -->
<line x1="508" y1="105" x2="522" y2="105" stroke="#404860" stroke-width="1.5" stroke-dasharray="6,3"/>
<circle cx="440" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="440" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">A</text>
<circle cx="490" cy="105" r="18" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="490" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">B</text>
<circle cx="540" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="540" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">C</text>
<!-- ======================== -->
<!-- Panel 4: T3 — Converged -->
<!-- ======================== -->
<text x="685" y="44" text-anchor="middle" font-size="10" fill="#909090">T3 &#x2014; Converged</text>
<text x="635" y="72" text-anchor="middle" font-size="8" fill="#d0a040">&#x2605; root</text>
<!-- Tree link A—B (gold solid) -->
<line x1="653" y1="105" x2="667" y2="105" stroke="#d0a040" stroke-width="2"/>
<!-- Tree link B—C (gold solid) -->
<line x1="703" y1="105" x2="717" y2="105" stroke="#d0a040" stroke-width="2"/>
<circle cx="635" cy="105" r="18" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="635" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">A</text>
<circle cx="685" cy="105" r="18" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="685" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">B</text>
<circle cx="735" cy="105" r="18" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="735" y="109" text-anchor="middle" font-weight="bold" fill="#e0e0e0">C</text>
<text x="685" y="150" text-anchor="middle" font-size="9" fill="#909090">A &#x2190; B &#x2190; C</text>
</svg>
Reference in New Issue View Git Blame Copy Permalink