mirror of
https://github.com/jmcorgan/fips.git
synced 2026-10-06 03:28:24 +00:00
fr34akyandJohnathan Corgan
47f8f01e2f
Two checks, both about the detector being able to do its job at all rather than taste in numbers. A zero `poll_interval_secs` was silently clamped to one second, so a typo produced a node polling twenty times more often than configured and saying nothing about it. It is now refused, and only while detection is enabled, since a disabled detector imposes no constraint on its own knobs. A `debounce_ms` whose worst case — the full `MAX_DEBOUNCE_ROUNDS` of settling — meets or exceeds `link_dead_timeout_secs` is refused too, because the liveness reaper would tear the peering down before the change was ever reported: the machinery would run and could not help. The constant is shared with the detector rather than restated, so the two cannot drift. Both multiplications saturate. The operands are operator-supplied `u64`s, and an overflow would wrap to a small number and silently accept the very configuration this refuses. Documented in the reference, because neither refusal was predictable from it. The debounce one couples two keys in different blocks, so an operator shortening `link_dead_timeout_secs` for fast failover can make an untouched `debounce_ms` illegal and meet a hard startup refusal citing a netmon key they never set. The multiplier its own error message uses is now on the page. A test asserts the shipped defaults still validate, which is the failure mode a cross-field check invites. Another asserts the refusal message carries no run of literal spaces: it is the whole diagnostic for the only refusal reachable by editing `debounce_ms`, substring assertions cannot see how it reads, and rustfmt does not touch string literals — a continuation join had already left twenty-two of them mid-sentence.
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 |