mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
de2ccbf833
As part of testing #4750, @jamilbk ran into an interesting but unrelated bug. Currently, we never invalidate host candidates. However, because we rebind our sockets, we get new ports and thus our old host candidates are always invalid. Thus, if you have a setup where your gateway and client are on the same subnet they end up settling on a host-host connection. If the client then roams to a different network, we get a new srflx IP but because we don't invalidate the host candidate, we run into an ICE timeout and never switch over the connection. We actually have a unit test for this but it wasn't caught because of a bug in str0m (https://github.com/algesten/str0m/pull/504): Candidates with the same IP but different kind were incorrectly invalidated. In our test, we don't have a NAT and thus host == srflx candidate. Thus, in the roaming test, we invalidated the host candidate based on the new srflx candidate which made the connection migration work. With the patch included, the reconnect unit test actually fails to send the packet, confirming this theory. By invalidating all host candidates on `reconnect`, we fix this bug. --------- Co-authored-by: Jamil <jamilbk@users.noreply.github.com>
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