mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
ec93cfb834
Bumps [keyring](https://github.com/hwchen/keyring-rs) from 3.6.2 to 3.6.3. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/hwchen/keyring-rs/releases">keyring's releases</a>.</em></p> <blockquote> <h2>v3.6.3: Likely final release of v3</h2> <p>This release integrates a few important bug fixes (thanks <a href="https://github.com/vermiculus"><code>@vermiculus</code></a>, <a href="https://github.com/unkcpz"><code>@unkcpz</code></a>) that have come in since the release of v3.6.2, and is the last release expected for the v3 series. The release of v4 is expected in about a month, and it will bring significant changes:</p> <ul> <li>the cross-platform API will become its own crate: keyring-core.</li> <li>each credential store will become its own store.</li> <li>this crate will become an example of how to write a keyring-based application.</li> </ul> <p>PLEASE NOTE: with this release, the main branch has changed significantly. What was on the main branch has moved to be a v4 branch, and the main branch was reverted to v3.6.2 and then had bug fix commits added on. If you have an existing fork of this repository, you should immediately sync your repo by choosing the "discard commits" option, which will take your repo back to v3.6.2 and then pull the newer commits. Then, if you have development work on one of your other branches, you should rebase that work onto the updated main.</p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="315cbdf6c6"><code>315cbdf</code></a> Credits for v3.6.3 release.</li> <li><a href="edee747db0"><code>edee747</code></a> Merge pull request <a href="https://redirect.github.com/hwchen/keyring-rs/issues/260">#260</a> from open-source-cooperative/dependabot/cargo/windows...</li> <li><a href="a3470f1260"><code>a3470f1</code></a> Update windows-sys requirement from 0.59 to 0.60</li> <li><a href="f38b5e9afa"><code>f38b5e9</code></a> Cherry pick all contributions since 3.6.2.</li> <li><a href="b9af61dc5a"><code>b9af61d</code></a> Zero out credential passwords before dealloc.</li> <li><a href="19ec928f2b"><code>19ec928</code></a> Don't clone returned passwords.</li> <li><a href="46eebf5688"><code>46eebf5</code></a> windows: use static value for 'comment' attribute</li> <li><a href="7b408eddc7"><code>7b408ed</code></a> Revert variable renaming</li> <li><a href="88a3d6c01d"><code>88a3d6c</code></a> Cosmetic fix: remove blank lines</li> <li><a href="afcc3148ca"><code>afcc314</code></a> Implement default byte -> password conversion methods.</li> <li>Additional commits viewable in <a href="https://github.com/hwchen/keyring-rs/compare/v3.6.2...v3.6.3">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@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
Benchmarking on Linux
The recommended way for benchmarking any of the Rust components is Linux' perf utility.
For example, to attach to a running application, do:
- Ensure the binary you are profiling is compiled with the
releaseprofile. sudo perf record -g --freq 10000 --pid $(pgrep <your-binary>).- Run the speed test or whatever load-inducing task you want to measure.
sudo perf script > profile.perf- Open profiler.firefox.com and load
profile.perf
Instead of attaching to a process with --pid, you can also specify the path to executable directly.
That is useful if you want to capture perf data for a test or a micro-benchmark.