Struct KeyringClient 

pub struct KeyringClient<'a> { /* private fields */ }

This Keyring Client interacts with the OS specific keyring to store a secret.

Keyring Backends:

• Windows - wincred
• Linux - Secret Service
• Mac - Security Framework

Implementations

impl<'a> KeyringClient<'a>

pub fn new( username: &'a str, service: &'a str, application: &'a str, ) -> Result<Self>

Returns a new keyring client

Arguments

• username - The username to store secrets under
• service - A unique identifier within your application
• application - The name of your application

Examples found in repository

examples/example.rs (line 9)

fn main() -> Result<()> {
    let username = "tmuntaner";
    let service = "keyring-rs-example";
    let application = "keyring-rs";

    let keyring = KeyringClient::new(username, service, application)?;
    let password = String::from("foobar");

    println!("Setting password {}", password);
    keyring.set_password(password.clone())?;

    let result = keyring
        .get_password()?
        .ok_or_else(|| anyhow!("should have a password"))?;
    println!("Returned password: {}", password);
    assert_eq!(password, result);

    Ok(())
}

pub fn set_password(&self, password: String) -> Result<()>

Examples found in repository

examples/example.rs (line 13)

fn main() -> Result<()> {
    let username = "tmuntaner";
    let service = "keyring-rs-example";
    let application = "keyring-rs";

    let keyring = KeyringClient::new(username, service, application)?;
    let password = String::from("foobar");

    println!("Setting password {}", password);
    keyring.set_password(password.clone())?;

    let result = keyring
        .get_password()?
        .ok_or_else(|| anyhow!("should have a password"))?;
    println!("Returned password: {}", password);
    assert_eq!(password, result);

    Ok(())
}

pub fn get_password(&self) -> Result<Option<String>>

Examples found in repository

examples/example.rs (line 16)

fn main() -> Result<()> {
    let username = "tmuntaner";
    let service = "keyring-rs-example";
    let application = "keyring-rs";

    let keyring = KeyringClient::new(username, service, application)?;
    let password = String::from("foobar");

    println!("Setting password {}", password);
    keyring.set_password(password.clone())?;

    let result = keyring
        .get_password()?
        .ok_or_else(|| anyhow!("should have a password"))?;
    println!("Returned password: {}", password);
    assert_eq!(password, result);

    Ok(())
}