Struct Keychain 

pub struct Keychain;

Stateless entry point for generic-password keychain operations.

Implementations

impl Keychain

pub fn entry( account: impl Into<String>, service: impl Into<String>, ) -> KeychainEntry

Build a typed keychain entry for (account, service).

pub fn set(account: &str, service: &str, password: &str) -> Result<()>

Upsert a generic-password keychain item.

Errors

Returns an error if Security.framework rejects the item or the strings contain NUL bytes.

Examples found in repository

examples/01_smoke.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let account = "doom-fish-smoke";
    let service = format!("doom-fish-smoke-test-{}", std::process::id());

    let _ = Keychain::delete(account, &service);
    Keychain::set(account, &service, "hunter2")?;

    let value = Keychain::get(account, &service)?;
    assert_eq!(value, "hunter2");

    let accounts = Keychain::list_accounts(&service)?;
    assert!(accounts.iter().any(|candidate| candidate == account));

    Keychain::delete(account, &service)?;

    let random = SecureRandom::bytes(32)?;
    assert!(random.iter().any(|&byte| byte != 0));

    println!("✅ security keychain + RNG OK");
    Ok(())
}

pub fn get(account: &str, service: &str) -> Result<String>

Fetch a generic-password keychain item as UTF-8 text.

Errors

Returns an error if the item does not exist, the stored bytes are not UTF-8, or Security.framework rejects the query.

Examples found in repository

examples/01_smoke.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let account = "doom-fish-smoke";
    let service = format!("doom-fish-smoke-test-{}", std::process::id());

    let _ = Keychain::delete(account, &service);
    Keychain::set(account, &service, "hunter2")?;

    let value = Keychain::get(account, &service)?;
    assert_eq!(value, "hunter2");

    let accounts = Keychain::list_accounts(&service)?;
    assert!(accounts.iter().any(|candidate| candidate == account));

    Keychain::delete(account, &service)?;

    let random = SecureRandom::bytes(32)?;
    assert!(random.iter().any(|&byte| byte != 0));

    println!("✅ security keychain + RNG OK");
    Ok(())
}

pub fn delete(account: &str, service: &str) -> Result<()>

Delete a generic-password keychain item.

Missing items are treated as success to make cleanup ergonomic.

Errors

Returns an error if Security.framework rejects the delete request for another reason.

Examples found in repository

examples/01_smoke.rs (line 7)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let account = "doom-fish-smoke";
    let service = format!("doom-fish-smoke-test-{}", std::process::id());

    let _ = Keychain::delete(account, &service);
    Keychain::set(account, &service, "hunter2")?;

    let value = Keychain::get(account, &service)?;
    assert_eq!(value, "hunter2");

    let accounts = Keychain::list_accounts(&service)?;
    assert!(accounts.iter().any(|candidate| candidate == account));

    Keychain::delete(account, &service)?;

    let random = SecureRandom::bytes(32)?;
    assert!(random.iter().any(|&byte| byte != 0));

    println!("✅ security keychain + RNG OK");
    Ok(())
}

pub fn list_accounts(service: &str) -> Result<Vec<String>>

List all account names for the given generic-password service.

Errors

Returns an error if Security.framework rejects the query.

Examples found in repository

examples/01_smoke.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let account = "doom-fish-smoke";
    let service = format!("doom-fish-smoke-test-{}", std::process::id());

    let _ = Keychain::delete(account, &service);
    Keychain::set(account, &service, "hunter2")?;

    let value = Keychain::get(account, &service)?;
    assert_eq!(value, "hunter2");

    let accounts = Keychain::list_accounts(&service)?;
    assert!(accounts.iter().any(|candidate| candidate == account));

    Keychain::delete(account, &service)?;

    let random = SecureRandom::bytes(32)?;
    assert!(random.iter().any(|&byte| byte != 0));

    println!("✅ security keychain + RNG OK");
    Ok(())
}