Struct thrussh_keys::agent::client::AgentClient

pub struct AgentClient<S: AsyncRead + AsyncWrite> { /* private fields */ }

SSH agent client.

Implementations

impl<S: AsyncRead + AsyncWrite> AgentClient<S>

pub fn connect(stream: S) -> AgentClient<S>

Build a future that connects to an SSH agent via the provided stream (on Unix, usually a Unix-domain socket).

pub fn add_identity(
    self,
    key: &KeyPair,
    constraints: &[Constraint]
) -> ReadResponse<S>

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(
    self,
    id: &str,
    pin: &[u8],
    constraints: &[Constraint]
) -> ReadResponse<S>

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

pub fn lock(self, passphrase: &[u8]) -> ReadResponse<S>

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

pub fn unlock(self, passphrase: &[u8]) -> ReadResponse<S>

Unlock the agent, allowing it to sign again.

pub fn request_identities(self) -> RequestIdentities<S>

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

pub fn sign_request(self, public: &PublicKey, data: &[u8]) -> SignRequest<S>

Ask the agent to sign the supplied piece of data.

pub fn remove_identity(self, public: &PublicKey) -> ReadResponse<S>

Ask the agent to remove a key from its memory.

pub fn remove_smartcard_key(self, id: &str, pin: &[u8]) -> ReadResponse<S>

Ask the agent to remove a smartcard from its memory.

pub fn remove_all_identities(self) -> ReadResponse<S>

Ask the agent to forget all known keys.

pub fn extension(self, typ: &[u8], ext: &[u8]) -> ReadResponse<S>

Send a custom message to the agent.

pub fn query_extension(self, typ: &[u8], ext: CryptoVec) -> QueryExtension<S>

Ask the agent what extensions about supported extensions.