ssh_jumper_model 0.4.0

Async SSH tunnel through a jump host (data types).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use std::{borrow::Cow, path::Path};

use crate::AuthMethod;

/// Parameters to authenticate with the jump host.
#[derive(Clone, Debug, PartialEq)]
pub struct JumpHostAuthParams<'auth> {
    /// User to log in to the jump host as.
    pub user_name: Cow<'auth, str>,
    /// Authentication method and details.
    pub auth_method: AuthMethod<'auth>,
}

impl<'auth> JumpHostAuthParams<'auth> {
    /// Returns new [`JumpHostAuthParams`].
    ///
    /// The private key passphrase is defaulted to `None`.
    ///
    /// # Parameters:
    ///
    /// * `user_name`: Username to log into the jump host.
    /// * `private_key`: Path to the private key file.
    /// * `passphrase`: Passphrase to decrypt the private key.
    pub fn key_pair(
        user_name: Cow<'auth, str>,
        private_key: Cow<'auth, Path>,
        passphrase: Option<Cow<'auth, str>>,
    ) -> Self {
        Self {
            user_name,
            auth_method: AuthMethod::KeyPair {
                private_key,
                passphrase,
            },
        }
    }

    /// Returns new [`JumpHostAuthParams`].
    ///
    /// The private key passphrase is defaulted to `None`.
    ///
    /// # Parameters:
    ///
    /// * `user_name`: Username to log into the jump host.
    /// * `password`: Password to log in.
    pub fn password(user_name: Cow<'auth, str>, password: Cow<'auth, str>) -> Self {
        Self {
            user_name,
            auth_method: AuthMethod::Password { password },
        }
    }
}