mirror of
https://github.com/jmcorgan/fips.git
synced 2026-10-05 11:08:25 +00:00
Johnathan Corgan
d69325a2a3
Brings up the four test-harness fixes, the two guard fixes on top of
them, the documentation corrections and the rebuilt changelog block.
Two conflicts, both in files each line had edited independently.
The readme conflicted on the badge pair. Resolved by taking maint's Rust
badge, which no longer asserts a version now that rust-toolchain.toml is
the only place that states one, and keeping this line's own v0.5.0-dev
status badge.
The changelog conflicted because both lines had rebuilt their unreleased
block and git tried to interleave the two. They are kept apart instead:
this line's work stays under Unreleased, and the maint work sits below it
under its own 0.4.2 heading, which is where it will live once that
release is tagged and saves splitting one interleaved block apart again
then. The heading carries no date; that is set at the tag. Both bodies
are carried through unmodified and everything from 0.4.1 down is
unchanged on both.
No Rust or Cargo file is touched by this merge, so the quartet run on
aa6661c still covers the code.
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 |