Struct AgentClient 

pub struct AgentClient { /* private fields */ }

Client for querying and controlling the local unlock agent. Client used by runtime command paths to communicate with the unlock agent.

Implementations

impl AgentClient

pub fn new() -> Result<Self, AgentError>

Create a client bound to the default ~/.color-ssh runtime paths.

pub fn status(&self) -> Result<VaultStatus, AgentError>

Query current vault status.

pub fn unlock( &self, master_password: &str, policy: UnlockPolicy, ) -> Result<VaultStatus, AgentError>

Unlock the vault using a master password and timeout policy.

pub fn entry_status(&self, name: &str) -> Result<AgentEntryStatus, AgentError>

Query whether a vault entry exists and whether the vault is unlocked.

pub fn authorize_askpass( &self, name: &str, ) -> Result<SensitiveString, AgentError>

Authorize one short-lived askpass token for the named vault entry.

pub fn get_secret(&self, token: &str) -> Result<SensitiveString, AgentError>

Resolve a secret by askpass token.

pub fn lock(&self) -> Result<VaultStatus, AgentError>

Request an explicit vault lock and agent shutdown.

Trait Implementations

impl Clone for AgentClient

fn clone(&self) -> AgentClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AgentClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.