Struct thrussh_keys::agent::client::AgentClient

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

SSH agent client.

Implementations

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

pub fn connect(stream: S) -> Self

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

impl AgentClient<UnixStream>

pub async fn connect_uds<P: AsRef<Path>>(path: P) -> Result<Self, Error>

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

pub async fn connect_env() -> Result<Self, Error>

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

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

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

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

pub async 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 async fn lock(&mut self, passphrase: &[u8]) -> Result<(), Error>

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

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

Unlock the agent, allowing it to sign again.

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

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

pub fn sign_request(
    self,
    public: &PublicKey,
    data: CryptoVec
) -> impl Future<Output = (Self, Result<CryptoVec, Error>)>

Ask the agent to sign the supplied piece of data.

pub fn sign_request_base64(
    self,
    public: &PublicKey,
    data: &[u8]
) -> impl Future<Output = (Self, Result<String, Error>)>

Ask the agent to sign the supplied piece of data.

pub fn sign_request_signature(
    self,
    public: &PublicKey,
    data: &[u8]
) -> impl Future<Output = Result<(Self, Signature), Error>>

Ask the agent to sign the supplied piece of data, and return a Signature.

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

Ask the agent to remove a key from its memory.

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

Ask the agent to remove a smartcard from its memory.

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

Ask the agent to forget all known keys.

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

Send a custom message to the agent.

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

Ask the agent what extensions about supported extensions.