Lines
86.86 %
Functions
100 %
Branches
//! GNOME Keyring file format low level API.
// TODO:
// - Order user calls
// - Keep proxis around
// - Make more things async
#[cfg(feature = "async-std")]
use std::io;
use std::{
path::{Path, PathBuf},
sync::LazyLock,
};
use async_fs as fs;
use async_fs::unix::{DirBuilderExt, OpenOptionsExt};
use futures_lite::AsyncWriteExt;
use rand::Rng;
use serde::{Deserialize, Serialize};
#[cfg(feature = "tokio")]
use tokio::{fs, io, io::AsyncWriteExt};
use zbus::zvariant::{Endian, Type, serialized::Context};
/// Used for newly created [`Keyring`]s
const DEFAULT_ITERATION_COUNT: u32 = 100000;
const DEFAULT_SALT_SIZE: usize = 32;
const MIN_ITERATION_COUNT: u32 = 100000;
const MIN_SALT_SIZE: usize = 32;
// FIXME: choose a reasonable value
const MIN_PASSWORD_LENGTH: usize = 4;
const FILE_HEADER: &[u8] = b"GnomeKeyring\n\r\0\n";
const FILE_HEADER_LEN: usize = FILE_HEADER.len();
pub(super) const MAJOR_VERSION: u8 = 1;
const MINOR_VERSION: u8 = 0;
mod encrypted_item;
mod legacy_keyring;
pub(super) use encrypted_item::EncryptedItem;
pub(super) use legacy_keyring::{Keyring as LegacyKeyring, MAJOR_VERSION as LEGACY_MAJOR_VERSION};
use crate::{
AsAttributes, Key, Secret, crypto,
file::{Error, UnlockedItem, WeakKeyError},
pub(crate) fn data_dir() -> Option<PathBuf> {
std::env::var_os("XDG_DATA_HOME")
.and_then(|h| if h.is_empty() { None } else { Some(h) })
.map(PathBuf::from)
.and_then(|p| if p.is_absolute() { Some(p) } else { None })
.or_else(|| {
std::env::var_os("HOME")
.map(|p| p.join(".local/share"))
})
}
pub(crate) static GVARIANT_ENCODING: LazyLock<Context> =
LazyLock::new(|| Context::new_gvariant(Endian::Little, 0));
/// Logical contents of a keyring file
#[derive(Deserialize, Serialize, Type, Debug)]
pub struct Keyring {
salt_size: u32,
#[serde(with = "serde_bytes")]
salt: Vec<u8>,
iteration_count: u32,
modified_time: u64,
usage_count: u32,
pub(in crate::file) items: Vec<EncryptedItem>,
impl Keyring {
#[allow(clippy::new_without_default)]
pub(crate) fn new() -> Self {
let salt = rand::rng().random::<[u8; DEFAULT_SALT_SIZE]>().to_vec();
Self {
salt_size: salt.len() as u32,
salt,
iteration_count: DEFAULT_ITERATION_COUNT,
// TODO: UTC?
modified_time: std::time::SystemTime::UNIX_EPOCH
.elapsed()
.unwrap()
.as_secs(),
usage_count: 0,
items: Vec::new(),
pub fn key_strength(&self, secret: &[u8]) -> Result<(), WeakKeyError> {
if self.iteration_count < MIN_ITERATION_COUNT {
Err(WeakKeyError::IterationCountTooLow(self.iteration_count))
} else if self.salt.len() < MIN_SALT_SIZE {
Err(WeakKeyError::SaltTooShort(self.salt.len()))
} else if secret.len() < MIN_PASSWORD_LENGTH {
Err(WeakKeyError::PasswordTooShort(secret.len()))
} else {
Ok(())
/// Write to a keyring file
pub async fn dump(
&mut self,
path: impl AsRef<Path>,
mtime: Option<std::time::SystemTime>,
) -> Result<(), Error> {
let tmp_path = if let Some(parent) = path.as_ref().parent() {
let rnd: String = rand::rng()
.sample_iter(&rand::distr::Alphanumeric)
.take(16)
.map(char::from)
.collect();
let mut tmp_path = parent.to_path_buf();
tmp_path.push(format!(".tmpkeyring{rnd}"));
if !parent.exists() {
#[cfg(feature = "tracing")]
tracing::debug!("Parent directory {:?} doesn't exists, creating it", parent);
fs::DirBuilder::new()
.recursive(true)
.mode(0o700)
.create(parent)
.await?;
Ok(tmp_path)
Err(Error::NoParentDir(path.as_ref().display().to_string()))
}?;
tracing::debug!(
"Created a temporary file to store the keyring on {:?}",
tmp_path
);
let mut tmpfile_builder = fs::OpenOptions::new();
tmpfile_builder.write(true).create_new(true);
tmpfile_builder.mode(0o600);
let mut tmpfile = tmpfile_builder.open(&tmp_path).await?;
self.modified_time = std::time::SystemTime::UNIX_EPOCH
.as_secs();
self.usage_count += 1;
let blob = self.as_bytes()?;
tmpfile.write_all(&blob).await?;
tmpfile.sync_all().await?;
let target_file = fs::File::open(path.as_ref()).await;
let target_mtime = match target_file {
Err(err) if err.kind() == io::ErrorKind::NotFound => None,
Err(err) => return Err(err.into()),
Ok(file) => file.metadata().await?.modified().ok(),
if mtime != target_mtime {
return Err(Error::TargetFileChanged(
path.as_ref().display().to_string(),
));
fs::rename(tmp_path, path.as_ref()).await?;
pub fn search_items(
&self,
attributes: &impl AsAttributes,
key: &Key,
) -> Result<Vec<UnlockedItem>, Error> {
let hashed_search = attributes.hash(key);
self.items
.iter()
.filter(|e| {
hashed_search
.all(|(k, v)| v.as_ref().is_ok_and(|v| e.has_attribute(k.as_str(), v)))
.map(|e| (*e).clone().decrypt(key))
.collect()
pub fn lookup_item(
) -> Result<Option<UnlockedItem>, Error> {
.find(|e| {
.transpose()
pub fn lookup_item_index(&self, attributes: &impl AsAttributes, key: &Key) -> Option<usize> {
self.items.iter().position(|e| {
pub fn remove_items(&mut self, attributes: &impl AsAttributes, key: &Key) -> Result<(), Error> {
// Validate items to be removed before actually removing them
for item in &self.items {
if hashed_search
.all(|(k, v)| v.as_ref().is_ok_and(|v| item.has_attribute(k.as_str(), v)))
{
// Validate by checking if it can be decrypted
if !item.is_valid(key) {
return Err(Error::MacError);
// Remove matching items
self.items.retain(|e| {
!hashed_search
});
fn as_bytes(&self) -> Result<Vec<u8>, Error> {
let mut blob = FILE_HEADER.to_vec();
blob.push(MAJOR_VERSION);
blob.push(MINOR_VERSION);
blob.append(&mut zvariant::to_bytes(*GVARIANT_ENCODING, &self)?.to_vec());
Ok(blob)
pub(crate) fn path(name: &str, version: u8) -> Result<PathBuf, Error> {
if let Some(mut path) = data_dir() {
path.push("keyrings");
if version > 0 {
path.push(format!("v{version}"));
path.push(format!("{name}.keyring"));
Ok(path)
Err(Error::NoDataDir)
pub fn default_path() -> Result<PathBuf, Error> {
Self::path("default", LEGACY_MAJOR_VERSION)
pub fn derive_key(&self, secret: &Secret) -> Result<Key, crypto::Error> {
crypto::derive_key(
&**secret,
self.key_strength(secret),
&self.salt,
self.iteration_count.try_into().unwrap(),
)
/// Validate that a secret can decrypt the items in this keyring.
///
/// This is useful for checking if a password is correct without having to
/// re-open the keyring file.
pub fn validate_secret(&self, secret: &Secret) -> Result<bool, crypto::Error> {
let key = self.derive_key(secret)?;
// If there are no items, we can't validate (empty keyrings are valid with any
// password)
if self.items.is_empty() {
return Ok(true);
// Check if at least one item can be decrypted with this key
// We only need to check one item to validate the password
Ok(self.items.iter().any(|item| item.is_valid(&key)))
/// Get the modification timestamp
pub fn modified_time(&self) -> std::time::Duration {
std::time::Duration::from_secs(self.modified_time)
// Reset Keyring content
pub(crate) fn reset(&mut self) {
self.salt_size = salt.len() as u32;
self.salt = salt;
self.iteration_count = DEFAULT_ITERATION_COUNT;
self.usage_count = 0;
self.items = Vec::new();
impl TryFrom<&[u8]> for Keyring {
type Error = Error;
fn try_from(value: &[u8]) -> Result<Self, Error> {
let header = value.get(..FILE_HEADER.len());
if header != Some(FILE_HEADER) {
return Err(Error::FileHeaderMismatch(
header.map(|x| String::from_utf8_lossy(x).to_string()),
let version = value.get(FILE_HEADER_LEN..(FILE_HEADER_LEN + 2));
if version != Some(&[MAJOR_VERSION, MINOR_VERSION]) {
return Err(Error::VersionMismatch(version.map(|x| x.to_vec())));
if let Some(data) = value.get((FILE_HEADER_LEN + 2)..) {
let keyring: Self = zvariant::serialized::Data::new(data, *GVARIANT_ENCODING)
.deserialize()?
.0;
if keyring.salt.len() != keyring.salt_size as usize {
Err(Error::SaltSizeMismatch(
keyring.salt.len(),
keyring.salt_size,
))
Ok(keyring)
Err(Error::NoData)
#[cfg(test)]
mod tests {
use super::*;
use crate::secret::ContentType;
const SECRET: [u8; 64] = [
44, 173, 251, 20, 203, 56, 241, 169, 91, 54, 51, 244, 40, 40, 202, 92, 71, 233, 174, 17,
145, 58, 7, 107, 31, 204, 175, 245, 112, 174, 31, 198, 162, 149, 13, 127, 119, 113, 13, 3,
191, 143, 162, 153, 183, 7, 21, 116, 81, 45, 51, 198, 73, 127, 147, 40, 52, 25, 181, 188,
48, 159, 0, 146,
];
#[tokio::test]
async fn keyfile_add_remove() -> Result<(), Error> {
let needle = &[("key", "value")];
let mut keyring = Keyring::new();
let key = keyring.derive_key(&SECRET.to_vec().into())?;
keyring
.items
.push(UnlockedItem::new("Label", needle, Secret::blob("MyPassword")).encrypt(&key)?);
assert_eq!(keyring.search_items(needle, &key)?.len(), 1);
keyring.remove_items(needle, &key)?;
assert_eq!(keyring.search_items(needle, &key)?.len(), 0);
async fn keyfile_dump_load() -> Result<(), Error> {
let _silent = std::fs::remove_file("/tmp/test.keyring");
let mut new_keyring = Keyring::new();
let key = new_keyring.derive_key(&SECRET.to_vec().into())?;
new_keyring.items.push(
UnlockedItem::new("My Label", &[("my-tag", "my tag value")], "A Password")
.encrypt(&key)?,
new_keyring.dump("/tmp/test.keyring", None).await?;
let blob = tokio::fs::read("/tmp/test.keyring").await?;
let loaded_keyring = Keyring::try_from(blob.as_slice())?;
let loaded_items = loaded_keyring.search_items(&[("my-tag", "my tag value")], &key)?;
assert_eq!(loaded_items[0].secret(), Secret::text("A Password"));
assert_eq!(loaded_items[0].secret().content_type(), ContentType::Text);
async fn key_strength() {
keyring.iteration_count = 50000; // Less than MIN_ITERATION_COUNT (100000)
let secret = Secret::from("test-password-that-is-long-enough");
let result = keyring.key_strength(&secret);
assert!(matches!(
result,
Err(WeakKeyError::IterationCountTooLow(50000))
let keyring = Keyring::new();
let secret = Secret::from("ab");
assert!(matches!(result, Err(WeakKeyError::PasswordTooShort(2))));
keyring.salt = vec![1, 2, 3, 4]; // Less than MIN_SALT_SIZE (32)
assert!(matches!(result, Err(WeakKeyError::SaltTooShort(4))));