Crate keyring

Expand description

§🔐 keyring-lib

High-level, asynchronous API for keyring-rs, a cross-platform Rust library to manage credentials.

This library can be seen as a convenient async wrapper around keyring-rs:

Default keystore based on target OS:
- OpenBSD and FreeBSD: Secret Service
- Linux: Secret Service + keyutils (secure in-memory kernel cache)
- MacOS and iOS: Security framework
- Windows: Security credentials
tokio async runtime support (requires tokio feature)
async-std async runtime support(requires async-std feature)
rustls crypto support (requires rustls feature)
openssl crypto support (requires openssl feature, and OpenSSL lib installed (or vendored feature))
serde de/serialization of the keyring entry from/to String (requires derive feature)
Global service name to avoid repetition
Convenient function to find a secret (Entry::find_secret -> Result<Option<String>>)

use keyring::{set_global_service_name, KeyringEntry};

#[tokio::main]
async fn main() {
    // define the global keyring service name once
    set_global_service_name("example");

    // create a keyring entry from a key string
    let entry = KeyringEntry::try_new("key").unwrap();

    // define a secret
    entry.set_secret("secret").await.unwrap();

    // get a secret
    entry.get_secret().await.unwrap();

    // find a secret
    entry.find_secret().await.unwrap();

    // delete a secret entry
    entry.delete_secret().await.unwrap();
}