Struct Client

pub struct Client<S: Read + Write> { /* private fields */ }

Blocking SSH agent client.

Implementations

impl<S: Read + Write> Client<S>

pub fn new(stream: S) -> Self

Construct a new SSH agent client for the given transport stream.

pub fn into_inner(self) -> S

Extracts inner stream by consuming this object.

pub fn request_identities(&mut self) -> Result<Vec<Identity>, AgentError>

Request a list of keys managed by this session.

pub fn sign(&mut self, request: SignRequest) -> Result<Signature, AgentError>

Perform a private key signature operation.

pub fn add_identity(&mut self, identity: AddIdentity) -> Result<(), AgentError>

Add a private key to the agent.

pub fn add_identity_constrained( &mut self, identity: AddIdentityConstrained, ) -> Result<(), AgentError>

Add a private key to the agent with a set of constraints.

pub fn remove_identity( &mut self, identity: RemoveIdentity, ) -> Result<(), AgentError>

Remove private key from an agent.

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

Remove all keys from an agent.

pub fn add_smartcard_key(&mut self, key: SmartcardKey) -> Result<(), AgentError>

Add a key stored on a smartcard.

pub fn add_smartcard_key_constrained( &mut self, key: AddSmartcardKeyConstrained, ) -> Result<(), AgentError>

Add a key stored on a smartcard with a set of constraints.

pub fn remove_smartcard_key( &mut self, key: SmartcardKey, ) -> Result<(), AgentError>

Remove a smartcard key from the agent.

pub fn lock(&mut self, key: String) -> Result<(), AgentError>

Temporarily lock the agent with a password.

pub fn unlock(&mut self, key: String) -> Result<(), AgentError>

Unlock the agent with a password.

pub fn extension( &mut self, extension: Extension, ) -> Result<Option<Extension>, AgentError>

Invoke a custom, vendor-specific extension on the agent.

Trait Implementations

impl<S: Debug + Read + Write> Debug for Client<S>

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

Formats the value using the given formatter.