mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 18:18:55 +00:00
fb5bda81e8
Bumps [derive_more](https://github.com/JelteF/derive_more) from 0.99.17 to 0.99.18. <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/JelteF/derive_more/blob/v0.99.18/CHANGELOG.md">derive_more's changelog</a>.</em></p> <blockquote> <h2>0.99.18 - 2024-06-15</h2> <ul> <li>Update syn to version 2.x</li> <li>Bump minimum supported rust version to 1.65</li> </ul> <h2>0.99.10 - 2020-09-11</h2> <h3>Improvements</h3> <ul> <li><code>From</code> supports additional types for conversion: <code>#[from(types(u8, u16))]</code>.</li> </ul> <h2>0.99.7 - 2020-05-16</h2> <h3>Fixes</h3> <ul> <li>Fix generic derives for <code>MulAssign</code></li> </ul> <h3>Improvements</h3> <ul> <li>When specifying specific features of the crate to only enable specific derives, the <code>extra-traits</code> feature of <code>syn</code> is not always enabled when those the specified features do not require it. This should speed up compile time of <code>syn</code> when this feature is not needed.</li> </ul> <h2>0.99.6 - 2020-05-13</h2> <h3>Improvements</h3> <ul> <li>Make sure output of derives is deterministic, for better support in rust-analyzer</li> </ul> <h2>0.99.5 - 2020-03-28</h2> <h3>New features</h3> <ul> <li>Support for deriving <code>Error</code>!!! (many thanks to <a href="https://github.com/ffuugoo"><code>@ffuugoo</code></a> and <a href="https://github.com/tyranron"><code>@tyranron</code></a>)</li> </ul> <h3>Fixes</h3> <ul> <li> <p>Fix generic bounds for <code>Deref</code> and <code>DerefMut</code> with <code>forward</code>, i.e. put <code>Deref</code> bound on whole type, so on <code>where Box<T>: Deref</code> instead of on <code>T: Deref</code>. (<a href="https://redirect.github.com/JelteF/derive_more/issues/114">#107</a>)</p> </li> <li> <p>The <code>tests</code> directory is now correctly included in the crate (requested by Debian package maintainers)</p> </li> </ul> <h2>0.99.4 - 2020-03-28</h2> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="678a4735bc"><code>678a473</code></a> chore: Release derive_more version 0.99.18</li> <li><a href="fcde5568cb"><code>fcde556</code></a> Include example published package</li> <li><a href="89cbd82959"><code>89cbd82</code></a> Remove track_caller feature detection because msrv was bumped</li> <li><a href="db36f6dade"><code>db36f6d</code></a> Fix question marks</li> <li><a href="f0c2530255"><code>f0c2530</code></a> fmt</li> <li><a href="461db95716"><code>461db95</code></a> Fix issue when compiling on 1.65</li> <li><a href="39ad36fd71"><code>39ad36f</code></a> Update changelog for v0.99.18</li> <li><a href="57b6e1746e"><code>57b6e17</code></a> Update to syn 2</li> <li><a href="ea4fa94003"><code>ea4fa94</code></a> Fix tests</li> <li><a href="ab82aef0bf"><code>ab82aef</code></a> Ignore error doctests as it still contains old backtrace logic</li> <li>Additional commits viewable in <a href="https://github.com/JelteF/derive_more/compare/v0.99.17...v0.99.18">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>
relay
This crate houses a minimalistic STUN & TURN server.
Features
We aim to support the following feature set:
- STUN binding requests
- TURN allocate requests
- TURN refresh requests
- TURN channel bind requests
- TURN channel data requests
Relaying of data through other means such as DATA frames is not supported.
Building
You can build the relay using: cargo build --release --bin firezone-relay
You should then find a binary in target/release/firezone-relay.
Running
The Firezone Relay supports Linux only. To run the Relay binary on your Linux host:
- Generate a new Relay token from the "Relays" section of the admin portal and save it in your secrets manager.
- Ensure the
FIREZONE_TOKEN=<relay_token>environment variable is set securely in your Relay's shell environment. The Relay expects this variable at startup. - Now, you can start the Firezone Relay with:
firezone-relay
To view more advanced configuration options pass the --help flag:
firezone-relay --help
Ports
By default, the relay listens on port 3478. This is the standard port for
STUN/TURN. Additionally, the relay needs to have access to the port range
49152 - 65535 for the allocations.
Portal Connection
When given a token, the relay will connect to the Firezone portal and wait for
an init message before commencing relay operations.
Design
The relay is designed in a sans-IO fashion, meaning the core components do not cause side effects but operate as pure, synchronous state machines. They take in data and emit commands: wake me at this point in time, send these bytes to this peer, etc.
This allows us to very easily unit-test all kinds of scenarios because all inputs are simple values.
The main server runs in a single task and spawns one additional task for each allocation. Incoming data that needs to be relayed is forwarded to the main task where it gets authenticated and relayed on success.