mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
d042addc5f
Upon receiving packets for a resource that we are not connected to, connlib emits a "connection intent" to the portal. In case there are gateways online for this resource, the portal sends us a "connection details" event. Currently, this is handled in a `create_or_reuse_connection` function. What the current name doesn't capture is that this message is essentially an update to connlib's "routing table", i.e. which gateway in which site to use for the given resource. If we move this concern to the fore-front of the design, whether or not we will make a new connection or reuse an existing one kind of becomes secondary. Re-framing the way we handle this messages makes it more natural to design it in an asynchronous way, i.e. set its return type to `()` and schedule events to be emitted. The translation of `Request::NewConnection` is more or less 1-to-1 with the introduction of `ClientEvent::RequestConnection`. The translation of `Request::ReuseConnection` turns into the also renamed `ClientEvent::RequestAccess`. This captures better what we need to do: When we have an existing connection, we need to request access for it, otherwise the gateway will drop all packets we send to this resource. The motivation for this refactoring is #6335. Buffering the initial packets while establishing a new connection opens up a race condition where we may send `RequestAccess` before the gateway has processed `RequestConnection`. In order to avoid this, we need to be able to locally buffer our `RequestAccess` messages and wait until the gateway has confirmed our connection.
Rust development guide
Firezone uses Rust for all data plane components. This directory contains the Linux and Windows clients, and low-level networking implementations related to STUN/TURN.
We target the last stable release of Rust using rust-toolchain.toml.
If you are using rustup, that is automatically handled for you.
Otherwise, ensure you have the latest stable version of Rust installed.
Reading Client logs
The Client logs are written as JSONL for machine-readability.
To make them more human-friendly, pipe them through jq like this:
cd path/to/logs # e.g. `$HOME/.cache/dev.firezone.client/data/logs` on Linux
cat *.log | jq -r '"\(.time) \(.severity) \(.message)"'
Resulting in, e.g.
2024-04-01T18:25:47.237661392Z INFO started log
2024-04-01T18:25:47.238193266Z INFO GIT_VERSION = 1.0.0-pre.11-35-gcc0d43531
2024-04-01T18:25:48.295243016Z INFO No token / actor_name on disk, starting in signed-out state
2024-04-01T18:25:48.295360641Z INFO null