#ssh-client #ssh #async #execute-command #tokio #ssh2

async-ssh2-tokio

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

28 releases

0.8.12 Aug 17, 2024
0.8.11 Jul 28, 2024
0.8.10 Jun 10, 2024
0.8.7 Feb 9, 2024
0.1.0 Nov 30, 2021

#1447 in Network programming

Download history 460/week @ 2024-11-21 442/week @ 2024-11-28 444/week @ 2024-12-05 416/week @ 2024-12-12 245/week @ 2024-12-19 97/week @ 2024-12-26 302/week @ 2025-01-02 339/week @ 2025-01-09 356/week @ 2025-01-16 665/week @ 2025-01-23 638/week @ 2025-01-30 601/week @ 2025-02-06 490/week @ 2025-02-13 506/week @ 2025-02-20 758/week @ 2025-02-27 504/week @ 2025-03-06

2,356 downloads per month
Used in 3 crates

Custom license

47KB
986 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.12"

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

~17–29MB
~430K SLoC