Skip to content

fix: handle Linux secret-service fallback for API keys #1905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tsubasakong wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: handle Linux secret-service fallback for API keys #1905

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
161 changes: 141 additions & 20 deletions src-tauri/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ use std::process::{Child, Command, Stdio};
use std::sync::Mutex;
use std::time::{SystemTime, UNIX_EPOCH};

#[cfg(target_os = "linux")]
use keyring::keyutils::KeyutilsCredential;
use keyring::Entry;
use reqwest::Url;
use serde::Serialize;
Expand Down Expand Up @@ -58,6 +60,67 @@ const SUPPORTED_SECRET_KEYS: [&str; 28] = [
"ICAO_API_KEY",
];

#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
fn is_missing_linux_secret_service_message(message: &str) -> bool {
let normalized = message.to_ascii_lowercase();
normalized.contains("dbus")
&& (normalized.contains("name is not activatable")
|| normalized.contains("serviceunknown")
|| normalized.contains("name has no owner")
|| (normalized.contains("org.freedesktop.secrets")
&& normalized.contains("not provided by any .service files")))
}

#[cfg(target_os = "linux")]
fn is_linux_secret_service_unavailable(err: &keyring::Error) -> bool {
let mut current: Option<&(dyn std::error::Error + 'static)> = Some(err);
while let Some(source) = current {
if is_missing_linux_secret_service_message(&source.to_string()) {
return true;
}
current = source.source();
}
false
}

#[cfg(target_os = "linux")]
fn linux_keyutils_vault_entry() -> Result<Entry, String> {
let credential = KeyutilsCredential::new_with_target(None, KEYRING_SERVICE, "secrets-vault")
.map_err(|e| format!("Failed to initialize Linux keyutils fallback: {e}"))?;
Ok(Entry::new_with_credential(Box::new(credential)))
}

fn sanitize_secret_vault(map: HashMap<String, String>) -> HashMap<String, String> {
map.into_iter()
.filter(|(k, v)| SUPPORTED_SECRET_KEYS.contains(&k.as_str()) && !v.trim().is_empty())
.map(|(k, v)| (k, v.trim().to_string()))
.collect()
}

#[cfg(target_os = "linux")]
fn load_linux_keyutils_vault() -> Option<HashMap<String, String>> {
let entry = linux_keyutils_vault_entry().ok()?;
let json = entry.get_password().ok()?;
serde_json::from_str::<HashMap<String, String>>(&json)
.ok()
.map(sanitize_secret_vault)
}

#[cfg(target_os = "linux")]
fn delete_linux_keyutils_vault() {
if let Ok(entry) = linux_keyutils_vault_entry() {
let _ = entry.delete_credential();
}
}

#[cfg_attr(not(target_os = "linux"), allow(dead_code))]
fn log_secret_storage_fallback(app: Option<&AppHandle>, message: &str) {
if let Some(app) = app {
append_desktop_log(app, "WARN", message);
}
eprintln!("[tauri] {message}");
}

struct LocalApiState {
child: Mutex<Option<Child>>,
token: Mutex<Option<String>>,
Expand Down Expand Up @@ -103,20 +166,20 @@ impl SecretsCache {
if let Ok(entry) = Entry::new(KEYRING_SERVICE, "secrets-vault") {
if let Ok(json) = entry.get_password() {
if let Ok(map) = serde_json::from_str::<HashMap<String, String>>(&json) {
let secrets: HashMap<String, String> = map
.into_iter()
.filter(|(k, v)| {
SUPPORTED_SECRET_KEYS.contains(&k.as_str()) && !v.trim().is_empty()
})
.map(|(k, v)| (k, v.trim().to_string()))
.collect();
return SecretsCache {
secrets: Mutex::new(secrets),
secrets: Mutex::new(sanitize_secret_vault(map)),
};
}
}
}

#[cfg(target_os = "linux")]
if let Some(secrets) = load_linux_keyutils_vault() {
return SecretsCache {
secrets: Mutex::new(secrets),
};
}

// Migration: read individual keys (old format), consolidate into vault.
// This triggers one keychain prompt per key — happens only once.
let mut secrets = HashMap::new();
Expand All @@ -134,13 +197,27 @@ impl SecretsCache {
// Write consolidated vault and clean up individual entries
if !secrets.is_empty() {
if let Ok(json) = serde_json::to_string(&secrets) {
if let Ok(vault_entry) = Entry::new(KEYRING_SERVICE, "secrets-vault") {
if vault_entry.set_password(&json).is_ok() {
for key in SUPPORTED_SECRET_KEYS.iter() {
if let Ok(entry) = Entry::new(KEYRING_SERVICE, key) {
let _ = entry.delete_credential();
let wrote_vault = if let Ok(vault_entry) = Entry::new(KEYRING_SERVICE, "secrets-vault") {
match vault_entry.set_password(&json) {
Ok(()) => true,
#[cfg(target_os = "linux")]
Err(err) if is_linux_secret_service_unavailable(&err) => {
if let Ok(fallback_entry) = linux_keyutils_vault_entry() {
fallback_entry.set_password(&json).is_ok()
} else {
false
}
}
Err(_) => false,
}
} else {
false
};
if wrote_vault {
for key in SUPPORTED_SECRET_KEYS.iter() {
if let Ok(entry) = Entry::new(KEYRING_SERVICE, key) {
let _ = entry.delete_credential();
}
}
}
}
Expand Down Expand Up @@ -214,15 +291,40 @@ struct DesktopRuntimeInfo {
local_api_port: Option<u16>,
}

fn save_vault(cache: &HashMap<String, String>) -> Result<(), String> {
fn save_vault(cache: &HashMap<String, String>, app: Option<&AppHandle>) -> Result<(), String> {
#[cfg(not(target_os = "linux"))]
let _ = app;

let json =
serde_json::to_string(cache).map_err(|e| format!("Failed to serialize vault: {e}"))?;
let entry = Entry::new(KEYRING_SERVICE, "secrets-vault")
.map_err(|e| format!("Keyring init failed: {e}"))?;
entry
.set_password(&json)
.map_err(|e| format!("Failed to write vault: {e}"))?;
Ok(())
match entry.set_password(&json) {
Ok(()) => {
#[cfg(target_os = "linux")]
delete_linux_keyutils_vault();
Ok(())
}
Err(err) => {
#[cfg(target_os = "linux")]
if is_linux_secret_service_unavailable(&err) {
// Keep saves working in Wayland/headless sessions that lack an
// activatable Secret Service backend. This falls back to the
// Linux kernel keyring, which is secure and works without DBus.
let fallback_entry = linux_keyutils_vault_entry()?;
fallback_entry
.set_password(&json)
.map_err(|fallback_err| format!("Failed to write vault: {fallback_err}"))?;
log_secret_storage_fallback(
app,
"Secret Service is unavailable on this Linux session; using the Linux kernel keyring fallback for API keys.",
);
return Ok(());
}

Err(format!("Failed to write vault: {err}"))
}
}
}

fn generate_local_token() -> String {
Expand Down Expand Up @@ -328,7 +430,8 @@ fn set_secret(
} else {
proposed.insert(key, trimmed);
}
save_vault(&proposed)?;
let app = webview.app_handle();
save_vault(&proposed, Some(&app))?;
*secrets = proposed;
Ok(())
}
Expand All @@ -345,7 +448,8 @@ fn delete_secret(webview: Webview, key: String, cache: tauri::State<'_, SecretsC
.map_err(|_| "Lock poisoned".to_string())?;
let mut proposed = secrets.clone();
proposed.remove(&key);
save_vault(&proposed)?;
let app = webview.app_handle();
save_vault(&proposed, Some(&app))?;
*secrets = proposed;
Ok(())
}
Expand Down Expand Up @@ -905,6 +1009,23 @@ mod sanitize_path_tests {
}
}

#[cfg(test)]
mod secret_storage_tests {
use super::is_missing_linux_secret_service_message;

#[test]
fn matches_missing_secret_service_backend_error() {
let message = "Platform secure storage failure: DBus error: The name is not activatable";
assert!(is_missing_linux_secret_service_message(message));
}

#[test]
fn ignores_other_storage_errors() {
let message = "Platform secure storage failure: permission denied";
assert!(!is_missing_linux_secret_service_message(message));
}
}

fn local_api_paths(app: &AppHandle) -> (PathBuf, PathBuf) {
let resource_dir = app
.path()
Expand Down
Loading