laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-07-22 07:48:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a16370e78d5dd3e4355b24609689260e15980ce4
fips/docs/design
History
Johnathan Corgan a16370e78d Update changelog, version, and design docs for v0.2.0 
Bump version to 0.2.0 and finalize changelog with discovery rework,
Tor transport, connect/disconnect commands, reproducible builds, and
12 bug fixes.

Update design documentation for discovery protocol rework:
- fips-wire-formats.md: remove visited bloom filter from LookupRequest,
  update size calculations
- fips-mesh-operation.md: replace flooding description with bloom-guided
  tree routing, add retry/backoff/rate-limiting subsections
- fips-configuration.md: add 5 new discovery config parameters, update
  control socket description for connect/disconnect commands
2026-03-22 20:26:09 +00:00
..
diagrams
Design documentation illustration and review pass
2026-02-24 17:32:37 +00:00
document-relationships.svg
Improve README and enable DNS resolver by default
2026-02-24 18:58:32 +00:00
fips-bloom-filters.md
Design documentation illustration and review pass
2026-02-24 17:32:37 +00:00
fips-configuration.md
Update changelog, version, and design docs for v0.2.0
2026-03-22 20:26:09 +00:00
fips-intro.md
Implement Tor transport with operator visibility
2026-03-15 16:19:54 +00:00
fips-ipv6-adapter.md
Implement FSP port multiplexing and IPv6 header compression
2026-03-11 12:53:32 +00:00
fips-mesh-layer.md
Add DNS hostname support in peer addresses for UDP and TCP transports
2026-03-15 00:49:54 +00:00
fips-mesh-operation.md
Update changelog, version, and design docs for v0.2.0
2026-03-22 20:26:09 +00:00
fips-session-layer.md
Implement FSP port multiplexing and IPv6 header compression
2026-03-11 12:53:32 +00:00
fips-spanning-tree.md
Design documentation illustration and review pass
2026-02-24 17:32:37 +00:00
fips-transport-layer.md
Implement Tor transport with operator visibility
2026-03-15 16:19:54 +00:00
fips-wire-formats.md
Update changelog, version, and design docs for v0.2.0
2026-03-22 20:26:09 +00:00
README.md
Improve README and enable DNS resolver by default
2026-02-24 18:58:32 +00:00
spanning-tree-dynamics.md
Design documentation illustration and review pass
2026-02-24 17:32:37 +00:00

README.md

FIPS Design Documents

Protocol design specifications for the Federated Interoperable Peering System — a self-organizing encrypted mesh network built on Nostr identities.

Reading Order

Start with the introduction, then follow the protocol stack from bottom to top. After the stack, the mesh operation document explains how all the pieces work together. Supporting references provide deeper dives into specific topics.

Protocol Stack

Document Description
fips-intro.md Protocol introduction: goals, architecture, layer model
fips-transport-layer.md Transport layer: datagram delivery over arbitrary media
fips-mesh-layer.md FIPS Mesh Protocol (FMP): peer authentication, link encryption, forwarding
fips-session-layer.md FIPS Session Protocol (FSP): end-to-end encryption, sessions
fips-ipv6-adapter.md IPv6 adaptation: TUN interface, DNS, MTU enforcement

Mesh Behavior

Document Description
fips-mesh-operation.md How the mesh operates: routing, discovery, error recovery
fips-wire-formats.md Wire format reference for all message types

Supporting References

Document Description
fips-spanning-tree.md Spanning tree algorithms: root discovery, parent selection, coordinates
fips-bloom-filters.md Bloom filter math: FPR analysis, size classes, split-horizon

Implementation

Document Description
fips-configuration.md YAML configuration reference

Supplemental

Document Description
spanning-tree-dynamics.md Spanning tree walkthroughs: convergence scenarios, worked examples

Document Relationships

Document relationships