mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-28 02:18:50 +00:00
99aa973db4
Currently, `snownet` allocates a 65KB buffer per connection as a scratch-space for encrypting packets. 65KB is the theoretical limit of a UDP packet. In practice, the largest UDP packets we send are 1336 bytes due to the MTU of 1280 set on our TUN interface and various overheads for WG, TURN channels and NAT46. Thus, it is unnecessary to allocate such a large buffer per connection. For gateways with many connections, reducing these buffers results in a smaller memory footprint. Additionally, any UDP packets larger than this buffer could be an indicator of a DoS attack and we can thus drop them without processing. A legitimate client / gateway will never send a packet larger than that.
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