Struct radicle_ssh::agent::client::AgentClient

pub struct AgentClient<S> { /* private fields */ }

SSH agent client.

Implementations

impl<S> AgentClient<S>

pub fn connect(stream: S) -> Self

Connect to an SSH agent via the provided stream (on Unix, usually a Unix-domain socket).

pub fn pid(&self) -> Option<u32>

Get the agent PID.

impl<S: ClientStream> AgentClient<S>

pub fn add_identity<K>( &mut self, key: &K, constraints: &[Constraint] ) -> Result<(), Error>

where K: Encodable, K::Error: Error + Send + Sync + 'static,

Send a key to the agent, with a (possibly empty) slice of constraints to apply when using the key to sign.

pub fn add_smartcard_key( &mut self, id: &str, pin: &[u8], constraints: &[Constraint] ) -> Result<(), Error>

Add a smart card to the agent, with a (possibly empty) set of constraints to apply when signing.

pub fn lock(&mut self, passphrase: &[u8]) -> Result<(), Error>

Lock the agent, making it refuse to sign until unlocked.

pub fn unlock(&mut self, passphrase: &[u8]) -> Result<(), Error>

Unlock the agent, allowing it to sign again.

pub fn request_identities<K>(&mut self) -> Result<Vec<K>, Error>

where K: Encodable, K::Error: Error + Send + Sync + 'static,

Ask the agent for a list of the currently registered secret keys.

pub fn sign<K>(&mut self, public: &K, data: &[u8]) -> Result<Signature, Error>

where K: Encodable + Debug,

Ask the agent to sign the supplied piece of data.

pub fn remove_identity<K>(&mut self, public: &K) -> Result<(), Error>

where K: Encodable,

Ask the agent to remove a key from its memory.

pub fn remove_smartcard_key( &mut self, id: &str, pin: &[u8] ) -> Result<(), Error>

Ask the agent to remove a smartcard from its memory.

pub fn remove_all_identities(&mut self) -> Result<(), Error>

Ask the agent to forget all known keys.

pub fn extension(&mut self, typ: &[u8], ext: &[u8]) -> Result<(), Error>

Send a custom message to the agent.

pub fn query_extension( &mut self, typ: &[u8], ext: Buffer ) -> Result<bool, Error>

Ask the agent about supported extensions.