mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-28 02:18:50 +00:00
578363a7fe
This PR introduces the `etherparse` dependency for parsing and generating IP packets. Using `etherparse`, we can implement the NAT46 & NAT64 implementations for the gateway more elegantly because it allows us to parse the IP and protocol headers into a static and much richer representation. The conversion to the IPv4/IPv6 equivalent is then just a question of transforming one data structure into another and writing it to the correct place in the buffer. We extract this functionality into dedicated `nat64` and `nat46` modules. Furthermore, we implement the various functions in `ip_packet::make` using `etherparse` too. Following that, we also overhaul the NAT translation tests that we have in `ip_packet::proptests`. Those now use the more low-level `consume_to_ipX` APIs which makes the tests more ergonomic to write. In the future, we should upstream `Ipv4HeaderSliceMut` and `Ipv6HeaderSliceMut` to `etherparse`. Moving all of this functionality to `etherparse` will make it easier to write tests that involve more IP packets as well as customise the behaviour of our NAT. Related: #5614. Related: #6371. Related: #6353.
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