ssh2-config 0.8.0

an ssh configuration parser for ssh2-rs
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

//! Typed values for remote forwarding directives.

use std::fmt;
use std::path::{Path, PathBuf};

/// Describes a complete `RemoteForward` directive.
///
/// A missing destination represents SOCKS proxy mode.
///
/// # Examples
///
/// ```rust
/// use ssh2_config::{RemoteForward, RemoteForwardDestination, RemoteForwardListen};
///
/// let forward = RemoteForward::new(
///     RemoteForwardListen::Port(8080),
///     Some(RemoteForwardDestination::Host {
///         host: "localhost".to_string(),
///         port: 80,
///     }),
/// );
///
/// assert_eq!(forward.to_string(), "8080 localhost:80");
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RemoteForward {
    /// Listening endpoint on the remote machine.
    pub listen: RemoteForwardListen,
    /// Optional destination on the local machine.
    pub destination: Option<RemoteForwardDestination>,
}

impl RemoteForward {
    /// Creates a remote forwarding specification.
    pub fn new(listen: RemoteForwardListen, destination: Option<RemoteForwardDestination>) -> Self {
        Self {
            listen,
            destination,
        }
    }
}

impl fmt::Display for RemoteForward {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{listen}", listen = self.listen)?;
        if let Some(destination) = &self.destination {
            write!(f, " {destination}")?;
        }
        Ok(())
    }
}

/// Describes the listening endpoint of a remote forwarding directive.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RemoteForwardListen {
    /// Listen on a port using the server's default bind address.
    Port(u16),
    /// Listen on a host and port.
    Host {
        /// Bind host, address, wildcard, or empty string.
        host: String,
        /// Bind port.
        port: u16,
    },
    /// Listen on a Unix-domain socket.
    UnixSocket(PathBuf),
}

impl fmt::Display for RemoteForwardListen {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Port(port) => write!(f, "{port}"),
            Self::Host { host, port } => write_host_port(f, host, *port),
            Self::UnixSocket(path) => write_socket_path(f, path),
        }
    }
}

/// Describes the destination endpoint of a remote forwarding directive.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum RemoteForwardDestination {
    /// Connect to a host and port.
    Host {
        /// Destination host or address.
        host: String,
        /// Destination port.
        port: u16,
    },
    /// Connect to a Unix-domain socket.
    UnixSocket(PathBuf),
}

impl fmt::Display for RemoteForwardDestination {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Host { host, port } => write_host_port(f, host, *port),
            Self::UnixSocket(path) => write_socket_path(f, path),
        }
    }
}

fn write_host_port(f: &mut fmt::Formatter<'_>, host: &str, port: u16) -> fmt::Result {
    if host.contains(':') {
        write!(f, "[{host}]:{port}")
    } else {
        write!(f, "{host}:{port}")
    }
}

fn write_socket_path(f: &mut fmt::Formatter<'_>, path: &Path) -> fmt::Result {
    let path = path.display().to_string();
    if path.chars().any(char::is_whitespace) {
        write!(
            f,
            "\"{path}\"",
            path = path.replace('\\', "\\\\").replace('"', "\\\"")
        )
    } else {
        write!(f, "{path}")
    }
}