mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
1aa95ed17e
Our NAT table uses TCP & UDP ports for its entries. To correctly handle ICMP requests and responses, we use the ICMP identifier in those packets. All other ICMP messages are currently unsupported. The errors paths for accessing these fields, i.e. ports for UDP/TCP and identifier for ICMP currently conflate two different errors: - Unsupported IP payload: it is neither TCP, UDP or ICMP - Unsupported ICMP type: it is not an ICMP request or response This makes certain logs look worse than they are because we say "Unsupported IP protocol: Icmpv6". To avoid this, we create a dedicated error variant that calls out the unsupported ICMP type. Fixes: #5594.
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