mirror of https://github.com/jmcorgan/fips.git synced 2026-07-30 19:46:15 +00:00

Files

T

Johnathan Corgan 7c2e11c5de Session 50: Design document reorganization and gossip protocol

- Create fips-gossip-protocol.md with wire formats for TreeAnnounce,
  FilterAnnounce, LookupRequest/LookupResponse
- Refactor fips-routing.md to reference gossip protocol for wire formats
- Update fips-session-protocol.md: remove reconciliation section,
  condense peer connection section
- Update spanning-tree-dynamics.md with gossip protocol reference
- Reorganize README.md with suggested reading order
- Remove obsolete fips-architecture-review.md

2026-02-01 17:42:17 +00:00

fips-architecture.md

Session 49: Wire protocol design with session indices

2026-02-01 16:28:16 +00:00

fips-design.md

Session 49: Wire protocol design with session indices

2026-02-01 16:28:16 +00:00

fips-gossip-protocol.md

Session 50: Design document reorganization and gossip protocol

2026-02-01 17:42:17 +00:00

fips-routing.md

Session 50: Design document reorganization and gossip protocol

2026-02-01 17:42:17 +00:00

fips-session-protocol.md

Session 50: Design document reorganization and gossip protocol

2026-02-01 17:42:17 +00:00

fips-state-machines.md

Separate protocol layers: link vs session message types

2026-02-01 03:19:54 +00:00

fips-transports.md

Restructure config to match sysctl-style paths

2026-01-29 19:49:37 +00:00

fips-tun-driver.md

Add TUN driver design document

2026-01-30 05:38:58 +00:00

fips-wire-protocol.md

Session 50: Design document cleanup and decision documentation

2026-02-01 17:22:44 +00:00

README.md

Session 50: Design document reorganization and gossip protocol

2026-02-01 17:42:17 +00:00

spanning-tree-dynamics.md

Session 50: Design document reorganization and gossip protocol

2026-02-01 17:42:17 +00:00

README.md

FIPS Design Documents

Protocol design specifications and analysis for the Federated Interoperable Peering System.

Suggested Reading Order

Start with the high-level architecture, then work through session flow, routing concepts, and finally the wire-level protocol details.

1. Architecture and Overview

Document	Description
fips-design.md	Core protocol: goals, identity, addressing, spanning tree

2. Protocol Flow (How Traffic Works)

Document	Description
fips-session-protocol.md	End-to-end session flow, Noise KK encryption, terminology

3. Routing (How Packets Find Their Way)

Document	Description
fips-routing.md	Routing concepts: bloom filters, discovery, greedy routing
spanning-tree-dynamics.md	Tree protocol behavior: convergence, partitions, recovery
fips-gossip-protocol.md	Wire formats: TreeAnnounce, FilterAnnounce, Lookup messages

4. Link Layer (How Peer Connections Work)

Document	Description
fips-wire-protocol.md	Transport layer: Noise IK, session indices, roaming, security
fips-transports.md	Transport-specific: UDP, Ethernet, Tor, radio characteristics

Implementation

Document	Description
fips-architecture.md	Software architecture: entities, state machines, configuration
fips-tun-driver.md	TUN interface driver: reader/writer threads, ICMPv6, packet flow
fips-state-machines.md	Phase-based state machine pattern: peer lifecycle, transitions

Document Cross-References

                    fips-design.md
                         │
                         ▼
                fips-session-protocol.md
                    │           │
          ┌─────────┘           └─────────┐
          ▼                               ▼
    fips-routing.md              fips-wire-protocol.md
          │                               │
          ▼                               │
spanning-tree-dynamics.md                 │
          │                               │
          └───────────┬───────────────────┘
                      ▼
            fips-gossip-protocol.md
                      │
                      ▼
              fips-transports.md