1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
//Copyright 2022 secret-service-rs Developers
//
// Licensed under the Apache License, Version 2.0, <LICENSE-APACHE or
// http://apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or
// http://opensource.org/licenses/MIT>, at your option. This file may not be
// copied, modified, or distributed except according to those terms.
//! # Secret Service libary
//!
//! This library implements a rust interface to the Secret Service API which is implemented
//! in Linux.
//!
//! ## About Secret Service API
//! <https://standards.freedesktop.org/secret-service/>
//!
//! Secret Service provides a secure place to store secrets.
//! Gnome keyring and KWallet implement the Secret Service API.
//!
//! ## Basic Usage
//! ```
//! use secret_service::SecretService;
//! use secret_service::EncryptionType;
//! use std::collections::HashMap;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//! // initialize secret service (dbus connection and encryption session)
//! let ss = SecretService::connect(EncryptionType::Dh).await.unwrap();
//!
//! // get default collection
//! let collection = ss.get_default_collection().await.unwrap();
//!
//! let mut properties = HashMap::new();
//! properties.insert("test", "test_value");
//!
//! //create new item
//! collection.create_item(
//! "test_label", // label
//! properties,
//! b"test_secret", //secret
//! false, // replace item with same attributes
//! "text/plain" // secret content type
//! ).await.unwrap();
//!
//! // search items by properties
//! let search_items = ss.search_items(
//! HashMap::from([("test", "test_value")])
//! ).await.unwrap();
//!
//! // retrieve one item, first by checking the unlocked items
//! let item = match search_items.unlocked.first() {
//! Some(item) => item,
//! None => {
//! // if there aren't any, check the locked items and unlock the first one
//! let locked_item = search_items
//! .locked
//! .first()
//! .expect("Search didn't return any items!");
//! locked_item.unlock().await.unwrap();
//! locked_item
//! }
//! };
//!
//! // retrieve secret from item
//! let secret = item.get_secret().await.unwrap();
//! assert_eq!(secret, b"test_secret");
//!
//! // delete item (deletes the dbus object, not the struct instance)
//! item.delete().await.unwrap()
//! }
//! ```
//!
//! ## Overview of this library:
//! ### Entry point
//! The entry point for this library is the `SecretService` struct. A new instance of
//! `SecretService` will initialize the dbus connection and negotiate an encryption session.
//!
//! ```
//! # use secret_service::SecretService;
//! # use secret_service::EncryptionType;
//! # async fn call() {
//! SecretService::connect(EncryptionType::Plain).await.unwrap();
//! # }
//! ```
//!
//! or
//!
//! ```
//! # use secret_service::SecretService;
//! # use secret_service::EncryptionType;
//! # async fn call() {
//! SecretService::connect(EncryptionType::Dh).await.unwrap();
//! # }
//! ```
//!
//! Once the SecretService struct is initialized, it can be used to navigate to a collection.
//! Items can also be directly searched for without getting a collection first.
//!
//! ### Collections and Items
//! The Secret Service API organizes secrets into collections, and holds each secret
//! in an item.
//!
//! Items consist of a label, attributes, and the secret. The most common way to find
//! an item is a search by attributes.
//!
//! While it's possible to create new collections, most users will simply create items
//! within the default collection.
//!
//! ### Actions overview
//! The most common supported actions are `create`, `get`, `search`, and `delete` for
//! `Collections` and `Items`. For more specifics and exact method names, please see
//! each struct's documentation.
//!
//! In addition, `set` and `get` actions are available for secrets contained in an `Item`.
//!
//! ### Crypto
//! Specifics in SecretService API Draft Proposal:
//! <https://standards.freedesktop.org/secret-service/>
//!
//! ### Async
//!
//! This crate, following `zbus`, is async by default. If you want a synchronous interface
//! that blocks, see the [blocking] module instead.
//
// Util currently has interfaces (dbus method namespace) to make it easier to call methods.
// Util contains function to execute prompts (used in many collection and item methods, like
// delete)
pub mod blocking;
mod error;
mod proxy;
mod session;
mod ss;
mod util;
mod collection;
pub use collection::Collection;
pub use error::Error;
mod item;
pub use item::Item;
pub use session::EncryptionType;
use crate::proxy::service::ServiceProxy;
use crate::session::Session;
use crate::ss::SS_COLLECTION_LABEL;
use crate::util::exec_prompt;
use futures_util::TryFutureExt;
use std::collections::HashMap;
use zbus::zvariant::{ObjectPath, Value};
/// Secret Service Struct.
///
/// This the main entry point for usage of the library.
///
/// Creating a new [SecretService] will also initialize dbus
/// and negotiate a new cryptographic session
/// ([EncryptionType::Plain] or [EncryptionType::Dh])
pub struct SecretService<'a> {
conn: zbus::Connection,
session: Session,
service_proxy: ServiceProxy<'a>,
}
/// Used to indicate locked and unlocked items in the
/// return value of [SecretService::search_items]
/// and [blocking::SecretService::search_items].
pub struct SearchItemsResult<T> {
pub unlocked: Vec<T>,
pub locked: Vec<T>,
}
impl<'a> SecretService<'a> {
/// Create a new `SecretService` instance.
pub async fn connect(encryption: EncryptionType) -> Result<SecretService<'a>, Error> {
let conn = zbus::Connection::session()
.await
.map_err(util::handle_conn_error)?;
let service_proxy = ServiceProxy::new(&conn)
.await
.map_err(util::handle_conn_error)?;
let session = Session::new(&service_proxy, encryption).await?;
Ok(SecretService {
conn,
session,
service_proxy,
})
}
/// Get all collections
pub async fn get_all_collections(&self) -> Result<Vec<Collection<'_>>, Error> {
let collections = self.service_proxy.collections().await?;
futures_util::future::join_all(collections.into_iter().map(|object_path| {
Collection::new(
self.conn.clone(),
&self.session,
&self.service_proxy,
object_path.into(),
)
}))
.await
.into_iter()
.collect::<Result<_, _>>()
}
/// Get collection by alias.
///
/// Most common would be the `default` alias, but there
/// is also a specific method for getting the collection
/// by default alias.
pub async fn get_collection_by_alias(&self, alias: &str) -> Result<Collection<'_>, Error> {
let object_path = self.service_proxy.read_alias(alias).await?;
if object_path.as_str() == "/" {
Err(Error::NoResult)
} else {
Collection::new(
self.conn.clone(),
&self.session,
&self.service_proxy,
object_path,
)
.await
}
}
/// Get default collection.
/// (The collection whos alias is `default`)
pub async fn get_default_collection(&self) -> Result<Collection<'_>, Error> {
self.get_collection_by_alias("default").await
}
/// Get any collection.
/// First tries `default` collection, then `session`
/// collection, then the first collection when it
/// gets all collections.
pub async fn get_any_collection(&self) -> Result<Collection<'_>, Error> {
// default first, then session, then first
self.get_default_collection()
.or_else(|_| self.get_collection_by_alias("session"))
.or_else(|_| async {
let mut collections = self.get_all_collections().await?;
if collections.is_empty() {
Err(Error::NoResult)
} else {
Ok(collections.swap_remove(0))
}
})
.await
}
/// Creates a new collection with a label and an alias.
pub async fn create_collection(
&self,
label: &str,
alias: &str,
) -> Result<Collection<'_>, Error> {
let mut properties: HashMap<&str, Value> = HashMap::new();
properties.insert(SS_COLLECTION_LABEL, label.into());
let created_collection = self
.service_proxy
.create_collection(properties, alias)
.await?;
// This prompt handling is practically identical to create_collection
let collection_path: ObjectPath = {
// Get path of created object
let created_path = created_collection.collection;
// Check if that path is "/", if so should execute a prompt
if created_path.as_str() == "/" {
let prompt_path = created_collection.prompt;
// Exec prompt and parse result
let prompt_res = exec_prompt(self.conn.clone(), &prompt_path).await?;
prompt_res.try_into()?
} else {
// if not, just return created path
created_path.into()
}
};
Collection::new(
self.conn.clone(),
&self.session,
&self.service_proxy,
collection_path.into(),
)
.await
}
/// Searches all items by attributes
pub async fn search_items(
&self,
attributes: HashMap<&str, &str>,
) -> Result<SearchItemsResult<Item<'_>>, Error> {
let items = self.service_proxy.search_items(attributes).await?;
let object_paths_to_items = |items: Vec<_>| {
futures_util::future::join_all(items.into_iter().map(|item_path| {
Item::new(
self.conn.clone(),
&self.session,
&self.service_proxy,
item_path,
)
}))
};
Ok(SearchItemsResult {
unlocked: object_paths_to_items(items.unlocked)
.await
.into_iter()
.collect::<Result<_, _>>()?,
locked: object_paths_to_items(items.locked)
.await
.into_iter()
.collect::<Result<_, _>>()?,
})
}
}
#[cfg(test)]
mod test {
use super::*;
use std::convert::TryFrom;
use zbus::zvariant::ObjectPath;
#[tokio::test]
async fn should_create_secret_service() {
SecretService::connect(EncryptionType::Plain).await.unwrap();
}
#[tokio::test]
async fn should_get_all_collections() {
// Assumes that there will always be a default collection
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collections = ss.get_all_collections().await.unwrap();
assert!(!collections.is_empty(), "no collections found");
}
#[tokio::test]
async fn should_get_collection_by_alias() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
ss.get_collection_by_alias("session").await.unwrap();
}
#[tokio::test]
async fn should_return_error_if_collection_doesnt_exist() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
match ss
.get_collection_by_alias("definitely_defintely_does_not_exist")
.await
{
Err(Error::NoResult) => {}
_ => panic!(),
};
}
#[tokio::test]
async fn should_get_default_collection() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
ss.get_default_collection().await.unwrap();
}
#[tokio::test]
async fn should_get_any_collection() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let _ = ss.get_any_collection().await.unwrap();
}
#[test_with::no_env(GITHUB_ACTIONS)]
#[tokio::test]
async fn should_create_and_delete_collection() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let test_collection = ss.create_collection("Test", "").await.unwrap();
assert_eq!(
ObjectPath::from(test_collection.collection_path.clone()),
ObjectPath::try_from("/org/freedesktop/secrets/collection/Test").unwrap()
);
test_collection.delete().await.unwrap();
}
#[tokio::test]
async fn should_search_items() {
let ss = SecretService::connect(EncryptionType::Plain).await.unwrap();
let collection = ss.get_default_collection().await.unwrap();
// Create an item
let item = collection
.create_item(
"test",
HashMap::from([("test_attribute_in_ss", "test_value")]),
b"test_secret",
false,
"text/plain",
)
.await
.unwrap();
// handle empty vec search
ss.search_items(HashMap::new()).await.unwrap();
// handle no result
let bad_search = ss
.search_items(HashMap::from([("test", "test")]))
.await
.unwrap();
assert_eq!(bad_search.unlocked.len(), 0);
assert_eq!(bad_search.locked.len(), 0);
// handle correct search for item and compare
let search_item = ss
.search_items(HashMap::from([("test_attribute_in_ss", "test_value")]))
.await
.unwrap();
assert_eq!(item.item_path, search_item.unlocked[0].item_path);
assert_eq!(search_item.locked.len(), 0);
item.delete().await.unwrap();
}
}