async-ssh2-tokio

Docs.rs, Crates.io

This library is an asynchronous and easy-to-use high level ssh client library for rust with the tokio runtime. Powered by the rust ssh implementation russh.

Features

• Connect to a SSH Host
• Execute commands on the remote host
• Get the stdout and exit code of the command

Install

rust [dependencies] tokio = "1" async-ssh2-tokio = "0.6.1"

Usage

```rust use asyncssh2tokio::client::{Client, AuthMethod, ServerCheckMethod};

[tokio::main]

async fn main() -> Result<(), asyncssh2tokio::Error> { // if you want to use key auth, then use following: // AuthMethod::withkeyfile("keyfilename", Some("passphrase")); // or // AuthMethod::withkeyfile("keyfilename", None); // or // AuthMethod::withkey(key: &str, passphrase: Option<&str>) let authmethod = AuthMethod::withpassword("root"); let mut client = Client::connect( ("10.10.10.2", 22), "root", authmethod, ServerCheckMethod::NoCheck, ).await?;

let result = client.execute("echo Hello SSH").await?;
assert_eq!(result.output, "Hello SSH\n");
assert_eq!(result.exit_status, 0);

let result = client.execute("echo Hello Again :)").await?;
assert_eq!(result.output, "Hello Again :)\n");
assert_eq!(result.exit_status, 0);

Ok(())

} ```

Running Tests

In order to run the tests, either set up docker compose on your machine or set the following environment variables for a working ssh host:

• ASYNC_SSH2_TEST_HOST_IP: The ip, e.g. 127.0.0.1 when testing with localhost.
• ASYNC_SSH2_TEST_HOST_USER: The username to connect as.
• ASYNC_SSH2_TEST_HOST_PW: The corresponding password. Since this is plain text, creating a new unpriviledged user is recommended.

Note: The doc tests do not use these variables and are therefore not run, but only compiled.