rneter 0.4.4

SSH connection manager for network devices with intelligent state machine handling
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

//! Cisco IOS/IOS-XE device template.

use crate::device::{DeviceHandler, DeviceHandlerConfig, input_rule, prompt_rule, transition_rule};
use crate::error::ConnectError;
use std::collections::HashMap;

/// Exports the underlying handler configuration for Cisco IOS/IOS-XE devices.
pub fn cisco_config() -> DeviceHandlerConfig {
    let write = vec![input_rule(
        "EnablePassword",
        true,
        "EnablePassword",
        true,
        &[r"^(Enable )?Password:"],
    )];

    DeviceHandlerConfig {
        prompt: vec![
            prompt_rule("Config", &[r"^\S+\(\S+\)#\s*$"]),
            prompt_rule("Enable", &[r"^[^\s#]+#\s*$"]),
            prompt_rule("Login", &[r"^[^\s<]+>\s*$"]),
        ],
        write,
        more_regex: vec![r"\s*<--- More --->\s*".to_string()],
        error_regex: vec![
            r"% Invalid command at '\^' marker\.".to_string(),
            r"% Invalid parameter detected at '\^' marker\.".to_string(),
            r"invalid vlan \(reserved value\) at '\^' marker\.".to_string(),
            r"ERROR: VLAN \d+ is not a primary vlan".to_string(),
            r"\^$".to_string(),
            r"^%.+".to_string(),
            r"^Command authorization failed.*".to_string(),
            r"^Command rejected:.*".to_string(),
            r"ERROR:.+".to_string(),
            r"Invalid password".to_string(),
            r"Access denied.".to_string(),
            r"End address less than start address".to_string(),
        ],
        edges: vec![
            transition_rule("Login", "enable", "Enable", false, false),
            transition_rule("Enable", "configure terminal", "Config", false, false),
            transition_rule("Config", "exit", "Enable", true, false),
            transition_rule("Enable", "disable", "Login", true, false),
        ],
        dyn_param: HashMap::new(),
        ..Default::default()
    }
}

/// Returns a `DeviceHandler` configured for Cisco IOS/IOS-XE devices.
pub fn cisco() -> Result<DeviceHandler, ConnectError> {
    cisco_config().build()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn enable_password_prompt_matches_with_or_without_carriage_return() {
        for prompt in ["Password: ", "\rPassword: "] {
            let mut handler = cisco().expect("create cisco device handler");
            handler
                .dyn_param
                .insert("EnablePassword".to_string(), "secret\n".to_string());

            assert_eq!(
                handler.read_need_write(prompt),
                Some(("secret\n".to_string(), true)),
                "prompt should match: {prompt:?}"
            );
        }
    }

    #[test]
    fn enable_to_login_transition_uses_disable() {
        let handler = cisco().expect("create cisco device handler");
        assert!(handler.edges().contains(&(
            "enable".to_string(),
            "disable".to_string(),
            "login".to_string(),
            true,
            false,
        )));
    }
}