Struct Client

pub struct Client<Stream>
where
    Stream: Debug + AsyncRead + AsyncWrite + Send + Unpin + 'static,
{ /* private fields */ }

SSH agent client

Implementations

impl<Stream> Client<Stream>

where Stream: Debug + AsyncRead + AsyncWrite + Send + Unpin + 'static,

pub fn new(socket: Stream) -> Self

Create a new SSH agent client wrapping a given socket.

Trait Implementations

impl<Stream> Debug for Client<Stream>

where Stream: Debug + AsyncRead + AsyncWrite + Send + Unpin + 'static + Debug,

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

Formats the value using the given formatter.

impl<Stream> Session for Client<Stream>

where Stream: Debug + AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static,

fn request_identities<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Identity>, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Request a list of keys managed by this session.

fn sign<'life0, 'async_trait>( &'life0 mut self, request: SignRequest, ) -> Pin<Box<dyn Future<Output = Result<Signature, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform a private key signature operation.

fn add_identity<'life0, 'async_trait>( &'life0 mut self, identity: AddIdentity, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add a private key to the agent.

fn add_identity_constrained<'life0, 'async_trait>( &'life0 mut self, identity: AddIdentityConstrained, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn remove_identity<'life0, 'async_trait>( &'life0 mut self, identity: RemoveIdentity, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove private key from an agent.

fn remove_all_identities<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove all keys from an agent.

fn add_smartcard_key<'life0, 'async_trait>( &'life0 mut self, key: SmartcardKey, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add a key stored on a smartcard.

fn add_smartcard_key_constrained<'life0, 'async_trait>( &'life0 mut self, key: AddSmartcardKeyConstrained, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn remove_smartcard_key<'life0, 'async_trait>( &'life0 mut self, key: SmartcardKey, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a smartcard key from the agent.

fn lock<'life0, 'async_trait>( &'life0 mut self, key: String, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Temporarily lock the agent with a password.

fn unlock<'life0, 'async_trait>( &'life0 mut self, key: String, ) -> Pin<Box<dyn Future<Output = Result<(), AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Unlock the agent with a password.

fn extension<'life0, 'async_trait>( &'life0 mut self, extension: Extension, ) -> Pin<Box<dyn Future<Output = Result<Option<Extension>, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

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

fn handle<'life0, 'async_trait>( &'life0 mut self, message: Request, ) -> Pin<Box<dyn Future<Output = Result<Response, AgentError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Handle a raw SSH agent request and return agent response.