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/ble-link-arbitration
fips/docs/design/diagrams/dynamics-link-addition.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

94 lines
4.8 KiB
XML
Raw Permalink Blame History

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 650 410" font-family="monospace" font-size="13">
<!-- Background -->
<rect width="650" height="410" fill="#0d1117" rx="8"/>
<!-- Title -->
<text x="325" y="30" fill="#e0e0e0" text-anchor="middle" font-size="15" font-weight="bold">Link Addition &#x2014; D Re-parents to A</text>
<!-- Section titles -->
<text x="165" y="58" fill="#909090" text-anchor="middle" font-size="14">Before</text>
<text x="485" y="58" fill="#909090" text-anchor="middle" font-size="14">After</text>
<!-- Arrow between halves -->
<text x="325" y="255" fill="#909090" text-anchor="middle" font-size="24">&#x2192;</text>
<!-- ======================== -->
<!-- BEFORE (left side) -->
<!-- ======================== -->
<!-- Root label at y=82, node A at cy=120 (top of circle at 98, 16px below label) -->
<!-- Vertical chain: A(120) - B(200) - C(280) - D(360) at x=165 -->
<text x="165" y="82" fill="#d0a040" text-anchor="middle" font-size="10">&#x2605; root</text>
<!-- Depth labels (left side) -->
<text x="205" y="124" fill="#606060" font-size="10" text-anchor="start">depth 0</text>
<text x="205" y="204" fill="#606060" font-size="10" text-anchor="start">depth 1</text>
<text x="205" y="284" fill="#606060" font-size="10" text-anchor="start">depth 2</text>
<text x="205" y="364" fill="#606060" font-size="10" text-anchor="start">depth 3</text>
<!-- Tree links (gold) -->
<line x1="165" y1="142" x2="165" y2="178" stroke="#d0a040" stroke-width="2.5"/>
<line x1="165" y1="222" x2="165" y2="258" stroke="#d0a040" stroke-width="2.5"/>
<line x1="165" y1="302" x2="165" y2="338" stroke="#d0a040" stroke-width="2.5"/>
<!-- Node A (root) -->
<circle cx="165" cy="120" r="22" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="165" y="125" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">A</text>
<!-- Node B -->
<circle cx="165" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="165" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">B</text>
<!-- Node C -->
<circle cx="165" cy="280" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="165" y="285" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">C</text>
<!-- Node D -->
<circle cx="165" cy="360" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="165" y="365" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">D</text>
<!-- ======================== -->
<!-- AFTER (right side) -->
<!-- ======================== -->
<!-- A at (485,120), B at (435,200), D at (535,200), C at (435,280) -->
<text x="485" y="82" fill="#d0a040" text-anchor="middle" font-size="10">&#x2605; root</text>
<!-- Depth labels (right side) -->
<text x="595" y="124" fill="#606060" font-size="10" text-anchor="start">depth 0</text>
<text x="595" y="204" fill="#606060" font-size="10" text-anchor="start">depth 1</text>
<text x="595" y="284" fill="#606060" font-size="10" text-anchor="start">depth 2</text>
<text x="595" y="364" fill="#606060" font-size="10" text-anchor="start">depth 3</text>
<!-- Ghost D at old position (depth 3) -->
<circle cx="485" cy="360" r="22" fill="none" stroke="#404040" stroke-width="1.5" stroke-dasharray="4,3"/>
<text x="485" y="365" fill="#404040" text-anchor="middle" font-weight="bold" font-size="14">D</text>
<!-- Tree links (gold) -->
<line x1="473" y1="138" x2="447" y2="182" stroke="#d0a040" stroke-width="2.5"/>
<line x1="497" y1="138" x2="523" y2="182" stroke="#d0a040" stroke-width="2.5"/>
<line x1="435" y1="222" x2="435" y2="258" stroke="#d0a040" stroke-width="2.5"/>
<!-- Dashed line from D new to ghost D old -->
<line x1="535" y1="222" x2="497" y2="342" stroke="#404040" stroke-width="1" stroke-dasharray="4,3"/>
<!-- Node A (root) -->
<circle cx="485" cy="120" r="22" fill="#1a1a2e" stroke="#d0a040" stroke-width="2.5"/>
<text x="485" y="125" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">A</text>
<!-- Node B -->
<circle cx="435" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="435" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">B</text>
<!-- Node D (re-parented to depth 1) -->
<circle cx="535" cy="200" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="535" y="205" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">D</text>
<!-- Node C -->
<circle cx="435" cy="280" r="22" fill="#1a1a2e" stroke="#e0e0e0" stroke-width="2"/>
<text x="435" y="285" fill="#e0e0e0" text-anchor="middle" font-weight="bold" font-size="14">C</text>
<!-- "new link" annotation on A→D -->
<text x="530" y="155" fill="#5a9f5a" text-anchor="start" font-size="9">new link</text>
</svg>
Reference in New Issue View Git Blame Copy Permalink