keyring 0.10.3

Cross-platform library for managing passwords
Documentation

Keyring-rs

CI Crates.io API Documentation on docs.rs

A cross-platorm library and utility to manage passwords.

Online docs are currently limited to linux, as cross-platform autogenerated docs are not a thing yet. For osx or windows, try cargo doc -p keyring --open.

Published on crates.io

Usage

Currently supports Linux, macOS, and Windows. Please file issues if you have any problems or bugs!

To use this library in your project add the following to your Cargo.toml file:

[dependencies]
keyring = "0.10.1"

This will give you access to the keyring crate in your code. Now you can use the new function to get an instance of the Keyring struct. The new function expects a service name and an username with which it accesses the password.

You can get a password from the OS keyring with the get_password function.

extern crate keyring;

use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
  let service = "my_application_name";
  let username = "username";

  let keyring = keyring::Keyring::new(&service, &username);

  let password = keyring.get_password()?;
  println!("The password is '{}'", password);

  Ok(())
}

Passwords can also be added to the keyring using the set_password function.

extern crate keyring;

use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
  let service = "my_application_name";
  let username = "username";

  let keyring = keyring::Keyring::new(&service, &username);

  let password = "topS3cr3tP4$$w0rd";
  keyring.set_password(&password)?;

  let password = keyring.get_password()?;
  println!("The password is '{}'", password);

  Ok(())
}

And they can be deleted with the delete_password function.

extern crate keyring;

use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
  let service = "my_application_name";
  let username = "username";

  let keyring = keyring::Keyring::new(&service, &username);

  keyring.delete_password()?;

  println!("The password has been deleted");

  Ok(())
}

On macOS, keychain object from specific path can be opened using Keyring::use_keychain which gives the flexibility to open non-default keychains. Note that this is currently feature-gated, and is considered unstable, and is subject to change without a semver major version change.

In Cargo.toml, you need to turn the feature on:

keyring = { version = "0.10.0", features = ["macos-specify-keychain"] }

extern crate keyring;

use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
  let service = "my_application_name";
  let username = "username";

  let keyring = keyring::Keyring::use_keychain(Path::new("/Library/Keychains/System.keychain"), &service, &username);

  let password = "topS3cr3tP4$$w0rd";
  keyring.set_password(&password)?;

  let password = keyring.get_password()?;
  println!("The password is '{}'", password);

  Ok(())
}

Errors

The get_password, set_password and delete_password functions return a Result which, if the operation was unsuccessful, can yield a KeyringError.

The KeyringError struct implements the error::Error and fmt::Display traits, so it can be queried for a cause and an description using methods of the same name.

Caveats

Linux

  • The application name is hardcoded to be rust-keyring.
  • If you are running on a headless linux box, you will need to unlock the Gnome login keyring before you can use it. The following bash function may be very helpful.
function unlock-keyring ()
{
	read -rsp "Password: " pass
	echo -n "$pass" | gnome-keyring-daemon --unlock
	unset pass
}

Windows

  • The credential name is currently hardcoded to be username.service, due to a reported issue. This breaks compatibility with 3rd-party applications, and is being fixed.

MacOS

  • Accessing the keychain from multiple threads simultaneously is generally a bad idea, and can cause deadlocks.

Dev Notes

  • We build using GitHub CI.
  • Each tag is built on Ubuntu x64, Win 10 x64, and Mac x64. The cli example executable is posted with the tag.

License

Licensed under either of

at your option.

Contributors

Thanks to the following for helping make this library better, whether through contributing code, discussion, or bug reports!

  • @dario23
  • @dten
  • @jasikpark
  • @jonathanmorley
  • @lexxvir
  • @Phrohdoh
  • @Rukenshia
  • @samuela
  • @stankec
  • @steveatinfincia
  • @bhkaminski
  • @MaikKlein

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.