Files
fips/docs/reference
Johnathan Corgan af66ffaea1 Merge branch 'maint'
Carries the seven security fixes up from the maintenance
line. Master has been refactored underneath most of the code they touch,
so this merge lands only the part that applies as written; the rest is
re-implemented against master's architecture in the commits that follow.

Landed complete by this merge:

- Bound the coordinate-cache warm path by the encrypted-header parser.
  The guard applies unchanged in src/node/dataplane/forwarding.rs, which
  is where master keeps the warm path. Its test is not here: master and
  the maintenance line added different tests to the same region of
  src/node/tests/forwarding.rs, and the union is made with the test that
  belongs to it.
- Filter and cap the punch targets taken from a peer's traversal signal.
- Reject traversal signals dated in the future.
- The character-boundary fix to the session-id log helper, which is what
  made the two traversal fixes safe to log.

Deferred to follow-on commits, because the mechanism they change does
not exist upstream in the shape the fix was written against:

- Bound a remote-supplied path MTU, and give the cache a way back.
  Master routes the keep-tighter rule through a sans-IO core with an
  apply site the maintenance line does not have, and keeps the lookup
  handlers in src/node/handlers/lookup.rs rather than a discovery module.
  The floor constant, the release helper and the TUN clamp side are here;
  the apply sites are not.
- Act on a routing signal only for a destination this node has bound.
- Never destroy an established session on an unauthenticated setup
  message. Master decides rekey in a clock-free core off a snapshot, so
  the fix's condition has no loop to sit in.
- Let flap dampening engage again after an episode lapses. Master
  extracted the mechanism into a component with an injected clock.

The counters, statistics and status-pane fields for the deferred fixes
merged cleanly and are in this commit, so they read zero until the fix
that feeds them lands. The halves that would not compile or would fail
without their fix were held back with it.

Green at this tree: fmt, build, clippy --all-targets -D warnings
and test --lib at 1784 passed.
2026-08-14 03:51:08 +00:00
..
2026-08-14 03:51:08 +00:00

Reference

Information-oriented technical descriptions for lookup on demand. Reference content describes what is: wire formats, configuration keys, command-line flags, control-socket commands, default values, file paths, exit codes. It is consulted, not read end-to-end.

Reference is austere by design: minimal narrative, no opinions, no guidance on when to use a feature. The "why" lives in design/; the "how do I accomplish X" lives in how-to/.

Available Reference

Document Scope
wire-formats.md All FMP and FSP message byte layouts, encapsulation walkthrough
configuration.md Full YAML configuration reference for the daemon and gateway
security.md nftables baseline, peer ACL, cryptographic primitives, rekey defaults, threat-resistance matrix
nostr-events.md Kind 37195 advert, Kind 21059 traversal signaling, Kind 10050 inbox relays
transports.md Per-transport statistics counter inventory
control-socket.md Line-delimited JSON control protocol for the daemon and gateway
cli-fips.md fips daemon CLI: options, exit codes, environment, files
cli-fipsctl.md fipsctl control-client: subcommands, options, exit codes
cli-fipstop.md fipstop live-status TUI: tabs, keybindings
cli-fips-gateway.md fips-gateway service CLI: options, exit codes, files