mirror of https://github.com/jmcorgan/fips.git synced 2026-10-05 11:08:25 +00:00

Files

T

Johnathan Corgan 3ec75e8385 docs(netmon): state the probe's measured syscall cost

The per-peer probe's cost was given as five syscalls read off the code
rather than measured, and the backstop timer's as a few syscalls per
period. Counted with strace on Linux, a probe that gets an answer makes
five (socket, bind, connect, getsockname, close) and one with no route
makes four. A build with debug assertions adds an fcntl before each close,
from the standard library's open-descriptor check, which is why a test
binary counts six.

At the 128-peer default a sample is 640 syscalls, and a reported change
under the default debounce costs two to nine samples, 1280 to 5760
syscalls. State those figures where the cost is described, and describe
the backstop as costing one sample per period.

2026-09-14 16:09:10 +00:00

diagrams

docs: four-section /docs/ restructure with new-user content, accuracy pass, and gateway feature-set rewrite

2026-05-08 03:02:12 +00:00

cli-fips-gateway.md

docs: four-section /docs/ restructure with new-user content, accuracy pass, and gateway feature-set rewrite

2026-05-08 03:02:12 +00:00

cli-fips.md

Prepare the v0.5.0 release content

2026-08-30 10:42:59 +00:00

cli-fipsctl.md

feat(transport): bind and rebind network interfaces dynamically

2026-09-10 19:18:09 +00:00

cli-fipstop.md

feat(fipstop): surface interface presence in the transports view

2026-09-10 19:18:09 +00:00

configuration.md

docs(netmon): state the probe's measured syscall cost

2026-09-14 16:09:10 +00:00

control-socket.md

feat(transport): bind and rebind network interfaces dynamically

2026-09-10 19:18:09 +00:00

native-api.md

docs(native): correct the end-of-file guidance given to client authors

2026-08-30 08:27:16 +00:00

nostr-events.md

Prepare the v0.5.0 release content

2026-08-30 10:42:59 +00:00

README.md

Add an experimental native datagram API addressed by public key

2026-08-21 05:48:23 +00:00

security.md

Prepare the v0.5.0 release content

2026-08-30 10:42:59 +00:00

transports.md

Prepare the v0.5.0 release content

2026-08-30 10:42:59 +00:00

wire-formats.md

docs: four-section /docs/ restructure with new-user content, accuracy pass, and gateway feature-set rewrite

2026-05-08 03:02:12 +00:00

README.md

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