#ssh-client #ssh #async #high-level #execute-command #ssh2

async-ssh2-tokio

Asynchronous and easy-to-use high level ssh client library for rust

26 releases

0.8.10 Jun 10, 2024
0.8.8 Apr 30, 2024
0.8.7 Feb 9, 2024
0.8.4 Nov 25, 2023
0.1.0 Nov 30, 2021

#4 in #ssh2

Download history 200/week @ 2024-02-26 114/week @ 2024-03-04 121/week @ 2024-03-11 116/week @ 2024-03-18 56/week @ 2024-03-25 168/week @ 2024-04-01 163/week @ 2024-04-08 65/week @ 2024-04-15 174/week @ 2024-04-22 386/week @ 2024-04-29 134/week @ 2024-05-06 84/week @ 2024-05-13 105/week @ 2024-05-20 111/week @ 2024-05-27 184/week @ 2024-06-03 289/week @ 2024-06-10

702 downloads per month
Used in legba

Custom license

38KB
767 lines

async-ssh2-tokio

Unit Test Status Lint Status 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 an SSH Host
  • Execute commands on the remote host
  • Get the stdout and exit code of the command

Install

[dependencies]
tokio = "1"
async-ssh2-tokio = "0.8.10"

Usage

use async_ssh2_tokio::client::{Client, AuthMethod, ServerCheckMethod};

#[tokio::main]
async fn main() -> Result<(), async_ssh2_tokio::Error> {
    // if you want to use key auth, then use following:
    // AuthMethod::with_key_file("key_file_name", Some("passphrase"));
    // or
    // AuthMethod::with_key_file("key_file_name", None);
    // or
    // AuthMethod::with_key(key: &str, passphrase: Option<&str>)
    let auth_method = AuthMethod::with_password("root");
    let mut client = Client::connect(
        ("10.10.10.2", 22),
        "root",
        auth_method,
        ServerCheckMethod::NoCheck,
    ).await?;

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

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

    Ok(())
}

Running Tests

  1. install docker and docker-compose
  2. run shell script ./tests/run_unit_tests.sh

Dependencies

~13–27MB
~365K SLoC