github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(linux): compute device ID from /etc/machine-id (#10805)

Browse Source 
All of our Linux applications have a soft-dependency on systemd. That
is, in the default configuration, we expect systemd to be present on the
machine. The only exception here are the docker containers for Headless
Client and Gateway.

For the GUI client in particular, systemd is a hard-dependency in order
to control DNS on the system which we do via `systemd-resolved`. To
secure the communication between the GUI client and its tunnel process,
we automatically create a group called `firezone-client` to which the
user gets added. All members of the group are allowed to access the unix
socket which is used for IPC between the two processes. Membership in
this group is also a prerequisite for accessing any of the configuration
files.

On the first launch of the GUI client on a Linux system, this presents a
problem. For group membership changes to take the effect, the user needs
to reboot. We say that in the documentation but it is unclear whether
all users will read that thoroughly enough. To help the user, the GUI
client checks for membership of the current user in the group and alerts
the user via a dialog box if that isn't the case. This would all be fine
if it would actually work. Unfortunately, that check ends up being too
late in the process. If we aren't a member of the group, we cannot read
the device ID and bail early, thus never reaching the check and
terminating the process without any dialog box or user-visible error.

We could attempt to fix this by shuffling around some of the startup
init code. That is a sub-optimal solution however because it a) may get
broken again in the future and b) it means we have to delay
initialisation of telemetry until a much later point.

Given that this is only a problem on Linux, a better solution is to
simply not rely on the disk-based device ID at all. Instead, we can
integrate with systemd and deterministically derive a device ID from the
unique machine ID and a randomly chosen "app ID".

For backwards-compatibility reasons, the disk-based device ID is still
prioritised. For all new installs however, we will use the one based on
`/etc/machine-id`.
This commit is contained in:
Thomas Eizinger
2025-11-10 13:29:52 +11:00
committed by GitHub
parent 8651413a95
commit 166b0d1573
9 changed files with 132 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
rust/gui-client/src-tauri/src/bin/firezone-gui-client.rs
View File

@@ -85,7 +85,7 @@ fn try_main(
// Get the device ID before starting Tokio, so that all the worker threads will inherit the correct scope.
// Technically this means we can fail to get the device ID on a newly-installed system, since the Tunnel service may not have fully started up when the GUI process reaches this point, but in practice it's unlikely.
let id = firezone_bin_shared::device_id::get().context("Failed to get device ID")?;
let id = firezone_bin_shared::device_id::get_client().context("Failed to get device ID")?;
if cli.is_telemetry_allowed() {
rt.block_on(telemetry.start(

8
rust/gui-client/src-tauri/src/elevation.rs
View File

@@ -36,9 +36,11 @@ mod platform {
impl Error {
pub fn user_friendly_msg(&self) -> String {
match self {
Error::UserNotInFirezoneGroup => format!(
"You are not a member of the group `{FIREZONE_CLIENT_GROUP}`. Try `sudo usermod -aG {FIREZONE_CLIENT_GROUP} $USER` and then reboot"
),
Error::UserNotInFirezoneGroup => {
format!(
"You are not a member of the group `{FIREZONE_CLIENT_GROUP}`. If you have just installed Firezone for the first time, you need to reboot your computer for membership changes to take effect."
)
}
Error::Other(e) => format!("Failed to determine group ownership: {e:#}"),
}
}

13
rust/gui-client/src-tauri/src/service.rs
View File

@@ -113,12 +113,13 @@ async fn ipc_listen(
) -> Result<()> {
// Create the device ID and Tunnel service config dir if needed
// This also gives the GUI a safe place to put the log filter config
let device_id = device_id::get_or_create().context("Failed to read / create device ID")?;
let device_id =
device_id::get_or_create_client().context("Failed to read / create device ID")?;
// Fix up the group of the device ID file and directory so the GUI client can access it.
#[cfg(target_os = "linux")]
{
let path = device_id::path().context("Failed to access device ID path")?;
if device_id.source == device_id::Source::Disk {
let path = device_id::client_path().context("Failed to access device ID path")?;
let group_id = crate::firezone_client_group()
.context("Failed to get `firezone-client` group")?
.gid
@@ -630,7 +631,8 @@ impl<'a> Handler<'a> {
) -> Result<Session> {
let started_at = Instant::now();
let device_id = device_id::get_or_create().context("Failed to get-or-create device ID")?;
let device_id =
device_id::get_or_create_client().context("Failed to get-or-create device ID")?;
let url = LoginUrl::client(
Url::parse(api_url).context("Failed to parse URL")?,
@@ -744,7 +746,8 @@ pub fn run_smoke_test() -> Result<()> {
// Couldn't get the loop to work here yet, so SIGHUP is not implemented
rt.block_on(async {
let device_id = device_id::get_or_create().context("Failed to read / create device ID")?;
let device_id =
device_id::get_or_create_client().context("Failed to read / create device ID")?;
let mut server = ipc::Server::new(SocketId::Tunnel)?;
let _ = Handler::new(
device_id,