mirror of https://github.com/jmcorgan/fips.git synced 2026-07-22 07:48:26 +00:00

Files

Johnathan Corgan 7260ad2878 Improve README and enable DNS resolver by default

Rework top-level README: add badges, status/roadmap section, config
search path docs, minimal two-node example with transports, DNS setup
instructions with systemd-resolved and resolv.conf examples, and
connectivity test walkthrough.

Replace ASCII document-relationship diagram with SVG in design docs.

Change DNS resolver default from disabled to enabled (port 5354).
Update config merge to allow higher-priority configs to disable it.

2026-02-24 18:58:32 +00:00

2.0 KiB

Raw Blame History

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

2.0 KiB Raw Blame History