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

Files

T

Johnathan Corgan 5e7342c57c Standardize naming conventions across docs and source

Rename NodeId to NodeAddr and npub to pubkey throughout documentation
and source code for consistency with the established identity model.
Add FIPS API vs IPv6 adapter overview to session protocol document.
Add transport address terminology note to wire protocol document.

2026-02-06 04:03:32 +00:00

fips-architecture.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

fips-gossip-protocol.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

fips-intro.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

fips-routing.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

fips-session-protocol.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

fips-state-machines.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +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

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +00:00

README.md

Unify Noise IK for both link and session layers

2026-02-02 02:25:39 +00:00

spanning-tree-dynamics.md

Standardize naming conventions across docs and source

2026-02-06 04:03:32 +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. Introduction and Overview

Document	Description
fips-intro.md	Protocol introduction: goals, concepts, architecture

2. Protocol Flow (How Traffic Works)

Document	Description
fips-session-protocol.md	End-to-end session flow, Noise IK 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-intro.md
                           │
              ┌────────────┴────────────┐
              ▼                         ▼
    fips-session-protocol.md    fips-architecture.md
              │                         │
    ┌─────────┴─────────┐               ▼
    ▼                   ▼         fips-transports.md
fips-routing.md   fips-wire-protocol.md
    │       │
    ▼       ▼
spanning-tree-dynamics.md ←→ fips-gossip-protocol.md