Skip to main content

KeychainPassphraseProvider

Struct KeychainPassphraseProvider 

Source
pub struct KeychainPassphraseProvider { /* private fields */ }
Expand description

A PassphraseProvider that wraps an inner provider with OS keychain caching.

On get_passphrase(), checks the OS keychain first via PassphraseCache::load. If a cached value exists and hasn’t expired per the configured policy/TTL, returns it immediately. Otherwise delegates to the inner provider, then stores the result in the OS keychain for subsequent invocations.

Args:

  • inner: The underlying provider to prompt the user when cache misses.
  • cache: Platform keychain cache (macOS Security Framework, Linux Secret Service, etc.).
  • alias: Key alias used as the cache key in the OS keychain.
  • policy: The configured PassphraseCachePolicy.
  • ttl_secs: Optional TTL in seconds (for Duration policy).

Usage:

use auths_core::signing::{KeychainPassphraseProvider, PassphraseProvider};
use auths_core::config::PassphraseCachePolicy;
use auths_core::storage::passphrase_cache::get_passphrase_cache;

let inner = Arc::new(some_provider);
let cache = get_passphrase_cache(true);
let provider = KeychainPassphraseProvider::new(
    inner, cache, "main".to_string(),
    PassphraseCachePolicy::Duration, Some(3600),
);
let passphrase = provider.get_passphrase("Enter passphrase:")?;

Implementations§

Source§

impl KeychainPassphraseProvider

Source

pub fn new( inner: Arc<dyn PassphraseProvider + Send + Sync>, cache: Box<dyn PassphraseCache>, alias: String, policy: PassphraseCachePolicy, ttl_secs: Option<i64>, ) -> Self

Creates a new KeychainPassphraseProvider.

Args:

  • inner: Fallback provider for cache misses.
  • cache: OS keychain cache implementation.
  • alias: Key alias used as the keychain entry identifier.
  • policy: Caching policy controlling storage/expiry behavior.
  • ttl_secs: TTL in seconds when policy is Duration.

Trait Implementations§

Source§

impl PassphraseProvider for KeychainPassphraseProvider

Source§

fn get_passphrase( &self, prompt_message: &str, ) -> Result<Zeroizing<String>, AgentError>

Securely obtains a passphrase, potentially by prompting the user. Read more
Source§

fn on_incorrect_passphrase(&self, prompt_message: &str)

Notifies the provider that the passphrase returned for prompt_message was wrong. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V