mirror of
https://github.com/jmcorgan/fips.git
synced 2026-10-05 19:18:25 +00:00
Johnathan Corgan
0fe4fc145f
Carries the experimental native datagram API up as its two commits: the API itself, where a client opens a flow to a peer's public key on a chosen port and reads datagrams off a descriptor the daemon hands it, and the macOS port that builds the listener over SOCK_DGRAM because Darwin has no SOCK_SEQPACKET for AF_UNIX. It is off by default and is not a stable interface. It changes no wire format on either line: every FSP data packet has carried a port pair inside its AEAD envelope since v0.2.0. No conflicts, and no adaptation. `git diff --numstat` for what this merge changes on next matches the master side file for file and count for count, so the merge took master's diff verbatim rather than resolving anything. The instrumentation step count needed no change this time: neither commit touches `src/instr/recorder.rs`, so the pinned figure the previous merge corrected to 28 still describes the tick.
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 |