Keyring-rs
A cross-platorm library and utility to manage passwords.
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:
= "0.3.0"
keyring
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;
Passwords can also be added to the keyring using the set_password
function.
extern crate keyring;
And they can be deleted with the delete_password
function.
extern crate keyring;
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
macOS
- Special characters support is experimental. Please file an issue if this gives you trouble.
Linux
- The application name is hardcoded to be
rust-keyring
.