omnisor 0.1.1

Omnisor is an asynchronous high-level SSH client library for Rust, with specialized support for network devices.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

//! Cisco device configurations.

use super::{DeviceConfig, SshAlgorithms};

/// Cisco device variants.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
#[non_exhaustive]
pub enum CiscoVariant {
    #[default]
    Ios,
    IosXe,
    IosXr,
    NxOs,
    Asa,
    Wlc,
    IosLegacy,
}

impl CiscoVariant {
    pub fn into_config(self) -> DeviceConfig {
        match self {
            Self::Ios | Self::IosXe => Self::ios_config(),
            Self::IosXr => Self::ios_xr_config(),
            Self::NxOs => Self::nxos_config(),
            Self::Asa => Self::asa_config(),
            Self::Wlc => Self::wlc_config(),
            Self::IosLegacy => Self::ios_legacy_config(),
        }
    }

    fn ios_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])[\w\-\.]+[#>]\s*$")
            .add_enable_mode_prompt_pattern(r"(?:^|[\r\n])[\w\-\.]+[#]\s*$")
            .add_enable_mode_password_prompt_pattern(r"(?i)password:")
            .add_disable_paging_command("terminal length 0")
            .add_disable_paging_command("terminal width 512")
            .add_error_pattern(r"% Invalid")
            .add_error_pattern(r"% Incomplete")
            .add_error_pattern(r"% Ambiguous")
            .add_error_pattern(r"% Unknown")
    }

    fn ios_xr_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])[\w\-\.:\/]+[#>]\s*$")
            .add_enable_mode_prompt_pattern(r"(?:^|[\r\n])[\w\-\.:\/]+[#]\s*$")
            .add_enable_mode_password_prompt_pattern(r"(?i)password:")
            .add_disable_paging_command("terminal length 0")
            .add_disable_paging_command("terminal width 512")
            .add_error_pattern(r"% Invalid")
            .add_error_pattern(r"% Incomplete")
            .add_error_pattern(r"% Ambiguous")
            .add_error_pattern(r"% Failed")
    }

    fn nxos_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])[\w\-\.]+[#>]\s*$")
            .add_enable_mode_prompt_pattern(r"(?:^|[\r\n])[\w\-\.]+[#]\s*$")
            .add_enable_mode_password_prompt_pattern(r"(?i)password:")
            .add_disable_paging_command("terminal length 0")
            .add_disable_paging_command("terminal width 511")
            .add_error_pattern(r"% Invalid")
            .add_error_pattern(r"% Incomplete")
            .add_error_pattern(r"% Ambiguous")
            .add_error_pattern(r"Syntax error")
    }

    fn asa_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])[\w\-\.\/]+[#>]\s*$")
            .add_enable_mode_prompt_pattern(r"(?:^|[\r\n])[\w\-\.\/]+[#]\s*$")
            .add_disable_paging_command("terminal pager 0")
            .add_error_pattern(r"ERROR:")
            .add_error_pattern(r"% Invalid")
            .add_error_pattern(r"% Incomplete")
    }

    fn wlc_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])\([^\)]+\)\s*[#>]\s*$")
            .add_disable_paging_command("config paging disable")
            .add_error_pattern(r"Incorrect usage")
            .add_error_pattern(r"Invalid")
    }

    fn ios_legacy_config() -> DeviceConfig {
        DeviceConfig::with_prompt(r"(?:^|[\r\n])[\w\-\.]+[#>$]\s*$")
            .add_enable_mode_prompt_pattern(r"(?:^|[\r\n])[\w\-\.]+[#]\s*$")
            .add_enable_mode_password_prompt_pattern(r"(?i)password:")
            .add_disable_paging_command("terminal length 0")
            .add_disable_paging_command("terminal width 512")
            .add_error_pattern(r"% Invalid")
            .add_error_pattern(r"% Incomplete")
            .add_error_pattern(r"% Ambiguous")
            .add_error_pattern(r"% Unknown")
            .ssh_algorithms(
                SshAlgorithms::new()
                    .kex(vec![
                        russh::kex::DH_G14_SHA1,
                        russh::kex::DH_G1_SHA1,
                        russh::kex::DH_GEX_SHA1,
                    ])
                    .cipher(vec![
                        russh::cipher::AES_256_CBC,
                        russh::cipher::AES_192_CBC,
                        russh::cipher::AES_128_CBC,
                        russh::cipher::AES_256_CTR,
                        russh::cipher::AES_128_CTR,
                    ])
                    .mac(vec![russh::mac::HMAC_SHA1]),
            )
    }
}

impl std::fmt::Display for CiscoVariant {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Ios => write!(f, "Cisco IOS"),
            Self::IosXe => write!(f, "Cisco IOS-XE"),
            Self::IosXr => write!(f, "Cisco IOS-XR"),
            Self::NxOs => write!(f, "Cisco NX-OS"),
            Self::Asa => write!(f, "Cisco ASA"),
            Self::Wlc => write!(f, "Cisco WLC"),
            Self::IosLegacy => write!(f, "Cisco IOS (Legacy)"),
        }
    }
}