somo 1.2.0

A human-friendly alternative to netstat for socket and port monitoring on Linux and macOS.
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

use crate::schemas::{AddressType, Connection, FilterOptions};

/// Checks if a connection should be filtered out based on options provided by the user.
///
/// # Arguments
/// * `connection_details`: The connection to check for filtering.
/// * `filter_options`: The filter options provided by the user.
///
/// # Returns
/// `true` if the connection should be filtered out, `false` if not.
pub fn filter_out_connection(
    connection_details: &Connection,
    filter_options: &FilterOptions,
) -> bool {
    match &filter_options.by_remote_port {
        Some(filter_remote_port) if &connection_details.remote_port != filter_remote_port => {
            return true
        }
        _ => {}
    }
    match &filter_options.by_local_port {
        Some(filter_local_port) if &connection_details.local_port != filter_local_port => {
            return true
        }
        _ => {}
    }
    match &filter_options.by_remote_address {
        Some(filter_remote_address)
            if &connection_details.remote_address != filter_remote_address =>
        {
            return true
        }
        _ => {}
    }
    match &filter_options.by_program {
        Some(filter_program) if &connection_details.program != filter_program => return true,
        _ => {}
    }
    match &filter_options.by_pid {
        Some(filter_pid) if &connection_details.pid != filter_pid => return true,
        _ => {}
    }
    if filter_options.by_listen && connection_details.state != "listen" {
        return true;
    }
    if filter_options.by_open && connection_details.state == "close" {
        return true;
    }
    if filter_options.by_established && connection_details.state != "established" {
        return true;
    }

    false
}

/// Checks if a given IP address is either "unspecified", localhost or an extern address.
///
/// * `0.0.0.0` or `[::]` -> unspecified
/// * `127.0.0.1` or `[::1]` -> localhost
/// * else -> extern address
///
/// # Arguments
/// * `remote_address`: The address to be checked.
///
/// # Returns
/// The address-type as an AddressType enum.
pub fn get_address_type(remote_address: &str) -> AddressType {
    if remote_address == "127.0.0.1" || remote_address == "[::1]" || remote_address == "::1" {
        return AddressType::Localhost;
    } else if remote_address == "0.0.0.0" || remote_address == "[::]" || remote_address == "::" {
        return AddressType::Unspecified;
    }
    AddressType::Extern
}

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

    #[test]
    fn test_get_address_type() {
        use crate::schemas::AddressType;

        assert_eq!(get_address_type("127.0.0.1"), AddressType::Localhost);
        assert_eq!(get_address_type("[::1]"), AddressType::Localhost);
        assert_eq!(get_address_type("0.0.0.0"), AddressType::Unspecified);
        assert_eq!(get_address_type("[::]"), AddressType::Unspecified);
        assert_eq!(get_address_type("8.8.8.8"), AddressType::Extern);
    }

    #[test]
    fn test_filter_out_connection_by_port() {
        use crate::schemas::{AddressType, Connection, FilterOptions};

        let conn = Connection {
            proto: "tcp".to_string(),
            local_port: "8080".to_string(),
            remote_port: "443".to_string(),
            remote_address: "8.8.8.8".to_string(),
            program: "nginx".to_string(),
            pid: "123".to_string(),
            state: "established".to_string(),
            address_type: AddressType::Extern,
            ipvx_raw: Ipv4Addr::new(8, 8, 8, 8).into(),
        };

        let filter_by_matching_port = FilterOptions {
            by_local_port: Some("8080".to_string()),
            ..Default::default()
        };
        assert!(!filter_out_connection(&conn, &filter_by_matching_port));

        let filter_by_non_matching_port = FilterOptions {
            by_local_port: Some("8181".to_string()),
            ..Default::default()
        };
        assert!(filter_out_connection(&conn, &filter_by_non_matching_port));
    }

    #[test]
    fn test_filter_out_connection_by_state() {
        use crate::schemas::{AddressType, Connection, FilterOptions};

        let mut conn = Connection {
            proto: "udp".to_string(),
            local_port: "8080".to_string(),
            remote_port: "443".to_string(),
            remote_address: "8.8.8.8".to_string(),
            program: "nginx".to_string(),
            pid: "123".to_string(),
            state: "close".to_string(),
            address_type: AddressType::Extern,
            ipvx_raw: Ipv4Addr::new(8, 8, 8, 8).into(),
        };

        let filter_by_open_state = FilterOptions {
            by_open: true,
            ..Default::default()
        };
        assert!(filter_out_connection(&conn, &filter_by_open_state));

        let no_active_open_filter = FilterOptions {
            by_open: false,
            ..Default::default()
        };
        assert!(!filter_out_connection(&conn, &no_active_open_filter));

        conn.state = "listen".to_string();

        let filter_by_listen_state = FilterOptions {
            by_listen: true,
            ..Default::default()
        };
        assert!(!filter_out_connection(&conn, &filter_by_listen_state));

        let no_active_listen_filter = FilterOptions {
            by_listen: false,
            ..Default::default()
        };
        assert!(!filter_out_connection(&conn, &no_active_listen_filter));
    }

    #[test]
    fn test_filter_out_connection_by_pid_and_program() {
        use crate::schemas::{AddressType, Connection, FilterOptions};

        let conn = Connection {
            proto: "tcp".to_string(),
            local_port: "8080".to_string(),
            remote_port: "443".to_string(),
            remote_address: "8.8.8.8".to_string(),
            program: "nginx".to_string(),
            pid: "123".to_string(),
            state: "close".to_string(),
            address_type: AddressType::Extern,
            ipvx_raw: Ipv4Addr::new(8, 8, 8, 8).into(),
        };

        let filter_by_open_state = FilterOptions {
            by_pid: Some("123".to_string()),
            ..Default::default()
        };
        assert!(!filter_out_connection(&conn, &filter_by_open_state));

        let no_active_open_filter = FilterOptions {
            by_program: Some("postgres".to_string()),
            ..Default::default()
        };
        assert!(filter_out_connection(&conn, &no_active_open_filter));
    }

    #[test]
    fn test_filter_out_connection_by_multiple_conditions() {
        use crate::schemas::{AddressType, Connection, FilterOptions};

        let mut conn = Connection {
            proto: "tcp".to_string(),
            local_port: "8080".to_string(),
            remote_port: "443".to_string(),
            remote_address: "8.8.8.8".to_string(),
            program: "python".to_string(),
            pid: "123".to_string(),
            state: "listen".to_string(),
            address_type: AddressType::Extern,
            ipvx_raw: Ipv4Addr::new(8, 8, 8, 8).into(),
        };

        let filter_by_multiple_conditions = FilterOptions {
            by_local_port: Some("8080".to_string()),
            by_pid: Some("123".to_string()),
            by_program: Some("python".to_string()),
            by_listen: true,
            ..Default::default()
        };
        assert!(!filter_out_connection(
            &conn,
            &filter_by_multiple_conditions
        ));

        conn.state = "close".to_string();
        assert!(filter_out_connection(&conn, &filter_by_multiple_conditions));
    }
}