Files
fips/docs/reference
Johnathan Corgan 5a36cbda76 Merge v0.5.0 into next
Carries the release and the four commits beneath it onto the development
line: the fipsctl probe report rework, the native datagram API end-of-file
fix and its client-author documentation, the release content, and the
version bump.

The version conflict resolves to next's 0.6.0-dev, as the forward merge
always does. README keeps next's side throughout: the badge, the two-layer
Noise XX description, and the status paragraph all describe this line, and
taking the release side would have replaced them with the older IK and XK
model that next no longer uses. The CLI reference takes the release side,
whose wording is version-agnostic where next's had hardcoded a version
string in an example.

The changelog needed repair the merge did not flag. Git aligned the
released heading with next's Unreleased heading, which filed 181 lines of
next-only work under a released date, left the block holding the released
content marked unreleased, and produced two headings for one version. It
also dropped the entry describing the lost IPv6 scope on inbound source
addresses, which appeared nowhere on this line afterwards.

All four are corrected, and each correction is checked by diffing against
the side it came from. The Unreleased block is byte-identical to its state
before the merge. The released block differs from the release line's by one
line, the deliberate rewording that drops the handshake pattern name
because this line uses a different one. The Breaking block is untouched.
2026-08-30 15:48:27 +00:00
..
2026-05-08 13:45:04 +00:00
2026-08-30 10:42:59 +00:00
2026-08-30 15:48:27 +00:00
2026-08-30 15:48:27 +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
native-api.md Native datagram API: the Rust surface, addressing and ports, errno table, ceilings, line protocol, command reference
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