3 Commits

Include renames

Author	SHA1	Message	Date
Johnathan Corgan	70002baf20	Settle the native-api counter reads instead of racing the reader task ... The suite asserted a happens-before the native API does not offer. A client's write on a flow descriptor lands in the kernel buffer of an AF_UNIX socketpair and runs no daemon code; the counters advance only inside the per-flow reader task, after that task's own recv().await. `stats` is answered on a different task and loads the same atomics, and the daemon is a single-threaded runtime, so a stats reply can be produced while the datagrams are still queued and the reader task has not been polled. The reply is then a well-formed status ok with a live flow_id and local_port and both counters at zero, which is the shape that redded maint at c5aeef39 and next at 1c822ae9. The crate's own tests already concede this. Connection::settle is a bounded yield loop whose doc comment says it yields "rather than asserting into a race a test would lose intermittently", and the in-crate assertions run behind it. The shell harness had no equivalent, though it half knew: one counter read is followed by a sleep whose comment calls it "the task hop", which is why that step passed while its neighbours did not. An RPC step may now carry "settle", which re-asks the command until its expectations hold or a five-second deadline passes. A bounded re-ask is a barrier where a fixed sleep is a guess, and a datagram that never arrives still reds rather than hanging. Nothing here serializes anything. Reproduced and measured rather than reasoned about. Against a daemon throttled to 0.02 CPU with twenty concurrent clients, the unsettled read failed 9 of 60 runs, every failure carrying the zero-counter signature, while the settling read failed 0 of 60 interleaved under the same load. An expectation that can never hold still reds, at the five-second bound. The full suite passes 28 of 28. The close scenario's one-second sleep is replaced by settling the release check, since the same task hop delays the daemon noticing end of file. Two verdict lines are corrected while here. Both were canned else-branch strings that fire on any non-zero client exit, so each named a cause the run never observed: one reported traffic crossing between flows when the evidence was a zero counter, the other reported a flow not being released when the failing assertion was a datagram count. The two-flow scenario's second read is deliberately left alone, with a note saying why: settling re-asks until an expectation holds, and "b counted 0" holds on the first ask whether or not b's reader has run, so that assertion stays a false green until it makes a positive claim.	2026-09-07 18:27:28 +00:00
Johnathan Corgan	a5a05e5024	fix(testing): put the native-api harness's mounted directories in the worktree ... The native-api suite failed on the internal builder while passing on GitHub, at the same commit and with the same test script. Two of its three failing assertions read as defects in the daemon and are not. A bind-mount source is resolved by the Docker daemon in the host's mount namespace, never in the caller's. The CI worker unit sets systemd's PrivateTmp=, so its /tmp is its own, and a path from `mktemp -d` exists only inside the unit. The daemon finds nothing there and creates an empty directory at the same path on the host instead. Everything downstream follows from that: a socket the container binds lands in a directory this script cannot see, so the check reports "socket never appeared" while the daemon under test logs the bind eighteen lines below it; and a file mount such as fips.yaml arrives as a directory, so the node exits with "Is a directory (os error 21)" and the check reports that the two nodes did not start. Reproduced directly, since a private /tmp needs privileges this host does not grant unprivileged: `docker run -v /tmp/absent/fips.yaml:/etc/fips/fips.yaml` against a path that does not exist leaves root-owned directories on the host and makes the container read the config as a directory, which is the CI log's error verbatim. Twelve such directories from the failing runs were still in /tmp, root-owned and timestamped to the native-api stage, when this was traced. Give the harness a per-run temporary root inside the worktree and route every bind-mount source through it. The worktree is the same path in both namespaces, which is the property that matters and the one /tmp does not have. /target is already ignored, and the pid in the path keeps the two trunk runs on the builder out of each other's way. Seven directories move: the single-node socket directory, the gated and API-off directories, and the two socket and two config directories of the two-node check. The build context and the log files stay on `mktemp`, because the daemon resolves neither, and the comment on the helper says which is which so the distinction does not have to be rediscovered. This is why the suite is the only one affected: it is the only one under testing/ that bind-mounts a `mktemp` path at all. Every other script there uses mktemp for host-side scratch only. Worth naming rather than leaving to be found: the third assertion, "No socket appears when the API is not enabled", passed throughout. It asserts an absence, and a mount that goes to the wrong place produces an absence too, so in that environment it could not have failed. It passes here for the right reason now. Verified by running the suite on this host: 28 passed, 0 failed, and the exit trap left no directory behind. That run had an ordinary shared /tmp, so it shows the change breaks nothing; the builder's private /tmp is what the next gate run exercises. No changelog entry: nothing here changes what the release ships.	2026-08-21 09:29:00 +00:00
Johnathan Corgan	3a789370b9	Add an experimental native datagram API addressed by public key ... A client process opens a flow to a peer's public key on a chosen port and sends and receives datagrams on a file descriptor the daemon hands it. No IPv6 emulation, no TUN device, no DNS: a datagram travels from key to key. The feature is off by default and is not a stable interface. The wire needs no change and gets none. Every FSP data packet has carried a port pair inside its AEAD envelope since v0.2.0, and port 256 is simply the IPv6 shim. What was missing was a way for a program to ask for a port of its own and be handed the traffic. Addressing is the part worth reading twice, because the obvious design is wrong. The x-only public key is the address. An npub is that key written in bech32, so converting between them is a local encoding rather than a lookup or a name service. The 16-byte node address that travels on the wire is the first half of a SHA-256 of the key: it is a truncated hash, it does not invert, and it appears nowhere a client can see. An earlier iteration of this work reported a peer by that hash and could supply a key only sometimes, which is what treating a wire identifier as an identity produces. An accepted flow therefore always knows its peer. The key is captured where the peer is authenticated rather than looked up when a report is rendered: every inbound datagram passes one call site inside a handler that refuses anything whose session is not established, and the responder has already rejected the session unless the claimed address derives from the key it proved. Reaching for the identity cache instead gives a best-effort answer from a structure that evicts. A listener is a descriptor. The daemon writes one message per arrival to it, carrying the new flow's descriptor and the peer's address, so poll, select and epoll work on a listener and accepting is a recvmsg. That is what lets the API be used from a program that already has an event loop, which a command-and-reply listener could not support: an arrival could not be waited on beside anything else. There is no accept command and no reject command. Refusing a flow is closing the descriptor you were handed. The Rust surface mirrors std::net. FipsStream::connect, FipsListener::bind, incoming, accept, io::Result and an errno mapping rather than a bespoke error type. An address is given as an npub, as a key, or as a pair, through one parameter, the way ToSocketAddrs takes several spellings of one thing. Each type holds its descriptor and copies of what setup told it and nothing else, so a stream that outlives its setup connection is not representable. set_nonblocking, AsFd and the four deadline methods carry the names and signatures std::net uses for the same jobs. They were asked for by a user integrating the API with tokio: AsyncFd requires a non-blocking descriptor, and anything receiving from a peer needs a bounded wait. AsFd is the better of the two descriptor accessors, because the borrow cannot outlive the value that owns the descriptor, so a reactor cannot hold a registration for a descriptor that has since been closed and its number reused by the next open. The non-blocking flag is read, modified and written back rather than assigned, since the flag word carries more than that one bit and a caller may have set O_ASYNC. A zero timeout is refused with EINVAL, because the kernel reads a zero timeval as "wait for ever", which inverts what a caller passing zero means; std::net refuses it for the same reason. The two directions are separate options and stay that way. FipsListener gets no timeout methods, matching TcpListener: bounding an accept is set_nonblocking plus the caller's own poll, which the reactor how-to builds. A flow taken from accept is blocking whatever the listener was set to, because the two are separate sockets and the daemon hands over a fresh one. One rule has no counterpart in Berkeley sockets and a client author must know it: the v1 wire carries no half-close, so nothing peer-driven ever closes a flow. A server written to read until the flow ends waits for a signal that cannot arrive, holding a thread and a flow per peer until its process exits. A program decides its own termination, and the example serves one datagram per flow. The tests reach a live daemon rather than a stand-in. Every public item had a unit test against a hand-written stand-in with canned replies, and the five entry points a program actually calls first, connect, connect_from, connect_at, bind and the SOCKET constant, had no coverage of any kind, because the tests that appear to cover them build a Wire over a socket pair and hand it to the private open and hold, so nothing ever resolved a socket path or mapped its errors. examples/native-surface.rs walks all thirty-eight items against a running daemon and reports the number of assertions it made. The count is read from the recorder rather than written as a literal, and the harness asserts the exit status, the completion marker and the count together, so deleting an assertion fails the check rather than quietly shrinking it. Watchdogs turn a hang into a named failure, which several of the walked behaviours would otherwise produce. The shared Docker image is built once for every integration leg, so the new binary is staged at all ten places the existing one is, the interop builder included, which gets a stub because those images exercise the wire between daemon versions and older refs do not carry the example. The platform gating was tested rather than reasoned about: flipping all eleven gates so the native API is excluded leaves the crate compiling clean across the workspace, every target and the profiling feature. The shipped docs tree gains what only the LaTeX manual under design/ had, which is not published with the daemon. A reference entry covers the whole surface: addressing and the port tiers, the Berkeley mapping, every method on FipsAddr, FipsStream, FipsListener and Incoming, the errno table, the ceilings, the four places data disappears with nothing reported, the line protocol and the command reference. The errno table gives names rather than numbers, since the client maps each name onto the libc constant for the platform it was built for and the supported platforms disagree on the numbers. A tutorial side trip stands up two throwaway nodes on one machine, peered over loopback UDP with no TUN and no DNS, then writes a listening program and a connecting program against them; it needs neither the public mesh nor root, because the native path is the one that does not go through the IPv6 adapter. The obligations a client in another language carries are a how-to of their own, since they are a task rather than a description: reading the setup connection with recvmsg, associating a descriptor with the last complete line, telling an empty datagram from a close, and six others. Serving many peers from one poll loop is another, with the whole program, because the straightforward listener spawns a thread per flow and that is wrong at the node's ceiling of 256. The drop causes are a table mapping each of the seven texts DropReason::as_str produces to the counter it increments, with drop_oversize called out as the ninth counter that is not in the table. What a daemon restart costs is a section of its own: every flow and listener ends, descriptors do not survive, there is no resumption, and datagrams sent but not yet forwarded are lost through a window nothing bounds. A stack comparison diagram places the interface against the stack a reader already knows: the same application over HTTP, TLS, TCP, IP and Ethernet on one side, and over its own format, FSP, FMP and a FIPS transport on the other, aligned so each row is one concern. The two columns are not alternatives and are not drawn as such. An unmodified IPv6 program's packets reach fips0, and the adapter hands each one to FSP as a payload, so the left stack runs inside the right one; the left column ends at a fork, eth0 for the ordinary internet and fips0 for the mesh, and an arrow leaves fips0 and runs back up into FSP's input. The row where TCP would be is empty on purpose and names Reliable Object Delivery, which is where that capability is expected to land. ROD is a v2 capability, the box is dashed because none of it exists yet, and the design entry says the part a reader needs most: nothing on the surface anticipates it, so a program written today should assume it does not exist. Both endpoints carry a scheme and a worked port, https://<npub>.fips:443 and fips://<npub>:443, with a footnote saying the two ports are not the same kind of thing, a TCP port inside the tunnel on the left and an FSP port on the right. The fips:// form is a coinage: nothing in the tree parses it, nothing registers the scheme, and the API takes a key and a port as separate arguments rather than a URL. The diagram also says where the right column stops, since FIPS over UDP still rides IP and Ethernet beneath. It appears in fips-concepts.md and fips-ipv6-adapter.md, which were making its argument in prose without a picture, and deliberately not in fips-architecture.md, which already carries the OSI mapping and makes the same point about the transport row. The gateway's control socket moves onto the same bind policy this API uses, which is the one change here that touches deployed behaviour: fips-gateway now tightens /run/fips to 0750. That is unreachable under the packaged deployment, where fips.service has already created the directory at that mode, and reachable for a source build or a container that starts the gateway alone. One changelog entry under Added, describing the released state: what a client opens and reads, the addressing and why the node address is not it, the listener being a descriptor, the std::net shape of the Rust surface, and the one rule Berkeley sockets have no counterpart for. It says in as many words that the wire is unchanged.	2026-08-21 05:48:23 +00:00