ufwctl 0.1.0

Linux-only Rust library for managing UFW firewall rules
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
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
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
use std::net::IpAddr;

use crate::enums::{Action, Protocol, RuleStatus};
use crate::error::UfwError;
use crate::models::{IpRule, PortRule};

/// Parse the first line of `ufw status` output to determine if the firewall is enabled.
pub(crate) fn parse_is_enabled(raw: &str) -> Result<bool, UfwError> {
    let line = raw.lines().next().ok_or(UfwError::EmptyOutput)?;
    let trimmed = line.trim();
    if trimmed == "Status: active" {
        Ok(true)
    } else if trimmed == "Status: inactive" {
        Ok(false)
    } else {
        Err(UfwError::UnexpectedStatusLine(trimmed.to_string()))
    }
}

/// Parse the output of `ufw status numbered` into a list of port-based rules.
pub(crate) fn parse_port_rules(raw: &str) -> Result<Vec<PortRule>, UfwError> {
    let mut rules = Vec::new();

    for line in raw.lines() {
        let trimmed = line.trim();
        if !trimmed.starts_with('[') {
            continue;
        }

        let Some(content) = trimmed.split(']').nth(1) else {
            continue;
        };
        let content = content.trim();

        if let Some(parsed) = parse_port_rule_line(content) {
            rules.push(parsed);
        }
    }

    Ok(rules)
}

fn parse_port_rule_line(content: &str) -> Option<PortRule> {
    let (target, action) = split_at_action(content)?;

    let target = target.trim();
    let port_proto = target.split_whitespace().next()?;
    let port_proto = port_proto.strip_suffix("(v6)").unwrap_or(port_proto);

    let (port_str, proto_str) = port_proto.split_once('/')?;
    let port: u16 = port_str.parse().ok()?;

    let protocol = match proto_str {
        "tcp" => Protocol::Tcp,
        "udp" => Protocol::Udp,
        _ => return None,
    };

    let status = match action {
        Action::Allow => RuleStatus::Allowed,
        Action::Deny => RuleStatus::Denied,
    };

    Some(PortRule {
        port,
        protocol,
        status,
    })
}

/// Parse the output of `ufw status numbered` into a list of IP-based rules.
pub(crate) fn parse_ip_rules(raw: &str) -> Result<Vec<IpRule>, UfwError> {
    let mut rules = Vec::new();

    for line in raw.lines() {
        let trimmed = line.trim();
        if !trimmed.starts_with('[') {
            continue;
        }

        let Some(content) = trimmed.split(']').nth(1) else {
            continue;
        };
        let content = content.trim();

        if let Some(parsed) = parse_ip_rule_line(content) {
            rules.push(parsed);
        }
    }

    Ok(rules)
}

fn parse_ip_rule_line(content: &str) -> Option<IpRule> {
    let (target, action) = split_at_action(content)?;

    let target = target.trim();
    if !target.starts_with("Anywhere") {
        return None;
    }

    let action_marker = match action {
        Action::Allow => "ALLOW IN",
        Action::Deny => "DENY IN",
    };

    let source = content[content.find(action_marker)? + action_marker.len()..].trim();
    let source = source.strip_suffix(" (v6)").unwrap_or(source);

    let ip: IpAddr = source.parse().ok()?;

    let protocol = Protocol::Both;
    let status = match action {
        Action::Allow => RuleStatus::Allowed,
        Action::Deny => RuleStatus::Denied,
    };

    Some(IpRule {
        ip,
        protocol,
        status,
    })
}

fn split_at_action(content: &str) -> Option<(&str, Action)> {
    if let Some(pos) = content.find("ALLOW IN") {
        Some((&content[..pos], Action::Allow))
    } else if let Some(pos) = content.find("DENY IN") {
        Some((&content[..pos], Action::Deny))
    } else {
        None
    }
}

/// Find the status of a specific port/protocol among parsed port rules.
pub(crate) fn find_port_status(rules: &[PortRule], port: u16, protocol: Protocol) -> RuleStatus {
    match protocol {
        Protocol::Both => {
            let tcp = rules
                .iter()
                .find(|r| r.port == port && r.protocol == Protocol::Tcp);
            let udp = rules
                .iter()
                .find(|r| r.port == port && r.protocol == Protocol::Udp);

            match (tcp.map(|r| r.status), udp.map(|r| r.status)) {
                (Some(RuleStatus::Allowed), Some(RuleStatus::Allowed)) => RuleStatus::Allowed,
                (Some(RuleStatus::Denied), Some(RuleStatus::Denied)) => RuleStatus::Denied,
                (None, None) => RuleStatus::None,
                _ => RuleStatus::None,
            }
        }
        proto => {
            let matched = rules.iter().find(|r| r.port == port && r.protocol == proto);
            matched.map_or(RuleStatus::None, |r| r.status)
        }
    }
}

/// Find the status of a specific IP/protocol among parsed IP rules.
pub(crate) fn find_ip_status(rules: &[IpRule], ip: IpAddr, protocol: Protocol) -> RuleStatus {
    match protocol {
        Protocol::Both => {
            let matched = rules.iter().find(|r| r.ip == ip);
            matched.map_or(RuleStatus::None, |r| r.status)
        }
        _ => {
            let matched = rules.iter().find(|r| r.ip == ip);
            matched.map_or(RuleStatus::None, |r| r.status)
        }
    }
}

#[cfg(test)]
mod tests {
    use std::net::IpAddr;

    use super::*;

    // ---------------------------------------------------------------------------
    // parse_is_enabled
    // ---------------------------------------------------------------------------

    #[test]
    fn parse_is_enabled_active() {
        assert!(parse_is_enabled("Status: active\n").expect("valid active"));
    }

    #[test]
    fn parse_is_enabled_inactive() {
        assert!(!parse_is_enabled("Status: inactive\n").expect("valid inactive"));
    }

    #[test]
    fn parse_is_enabled_active_with_extra_lines() {
        let output = "\
Status: active

To                         Action      From
--                         ------      ----
22/tcp                     ALLOW IN    Anywhere
";
        assert!(parse_is_enabled(output).expect("active with trailing"));
    }

    #[test]
    fn parse_is_enabled_empty() {
        let result = parse_is_enabled("");
        assert!(matches!(result, Err(UfwError::EmptyOutput)));
    }

    #[test]
    fn parse_is_enabled_unexpected_line() {
        let result = parse_is_enabled("Something weird\n");
        match result {
            Err(UfwError::UnexpectedStatusLine(line)) => {
                assert_eq!(line, "Something weird");
            }
            _ => panic!("expected UnexpectedStatusLine"),
        }
    }

    #[test]
    fn parse_is_enabled_whitespace_padded() {
        assert!(parse_is_enabled("  Status: active  \n").expect("whitespace active"));
        assert!(!parse_is_enabled("\tStatus: inactive\n").expect("tab inactive"));
    }

    // ---------------------------------------------------------------------------
    // parse_port_rules
    // ---------------------------------------------------------------------------

    const PORT_RULES_BASIC: &str = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] 22/tcp                     ALLOW IN    Anywhere
[ 2] 8080/udp                   DENY IN     Anywhere
[ 3] 443/tcp                    ALLOW IN    Anywhere
[ 4] 53/udp                     ALLOW IN    Anywhere
";

    #[test]
    fn parse_port_rules_basic_allow() {
        let rules = parse_port_rules(PORT_RULES_BASIC).expect("parse");
        let rule = rules
            .iter()
            .find(|r| r.port == 22 && r.protocol == Protocol::Tcp);
        let rule = rule.expect("22/tcp rule");
        assert_eq!(rule.status, RuleStatus::Allowed);
    }

    #[test]
    fn parse_port_rules_basic_deny() {
        let rules = parse_port_rules(PORT_RULES_BASIC).expect("parse");
        let rule = rules
            .iter()
            .find(|r| r.port == 8080 && r.protocol == Protocol::Udp);
        let rule = rule.expect("8080/udp rule");
        assert_eq!(rule.status, RuleStatus::Denied);
    }

    #[test]
    fn parse_port_rules_basic_multiple() {
        let rules = parse_port_rules(PORT_RULES_BASIC).expect("parse");
        assert_eq!(rules.len(), 4);
        assert!(
            rules
                .iter()
                .any(|r| r.port == 443 && r.protocol == Protocol::Tcp)
        );
        assert!(
            rules
                .iter()
                .any(|r| r.port == 53 && r.protocol == Protocol::Udp)
        );
    }

    #[test]
    fn parse_port_rules_no_match_returns_empty_vec() {
        let rules = parse_port_rules("").expect("empty");
        assert!(rules.is_empty());
    }

    #[test]
    fn parse_port_rules_header_only_returns_empty() {
        let output = "\
Status: active

     To                         Action      From
     --                         ------      ----
";
        let rules = parse_port_rules(output).expect("header only");
        assert!(rules.is_empty());
    }

    // ---------------------------------------------------------------------------
    // IPv6 port rules
    // ---------------------------------------------------------------------------

    const PORT_RULES_V6: &str = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] 22/tcp                     ALLOW IN    Anywhere
[ 2] 22/tcp (v6)                ALLOW IN    Anywhere (v6)
[ 3] 8080/udp (v6)              DENY IN     Anywhere (v6)
";

    #[test]
    fn parse_port_rules_v6_does_not_crash() {
        let rules = parse_port_rules(PORT_RULES_V6).expect("parse");
        // (v6) rules should parse the same as v4 rules
        assert!(
            rules
                .iter()
                .any(|r| r.port == 22 && r.protocol == Protocol::Tcp)
        );
        assert!(
            rules
                .iter()
                .any(|r| r.port == 8080 && r.protocol == Protocol::Udp)
        );
    }

    #[test]
    fn parse_port_rules_v6_correct_status() {
        let rules = parse_port_rules(PORT_RULES_V6).expect("parse");
        let rule = rules
            .iter()
            .find(|r| r.port == 8080 && r.protocol == Protocol::Udp);
        let rule = rule.expect("8080/udp rule from v6 output");
        assert_eq!(rule.status, RuleStatus::Denied);
    }

    // ---------------------------------------------------------------------------
    // Duplicated rules
    // ---------------------------------------------------------------------------

    const PORT_RULES_DUPLICATE: &str = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] 22/tcp                     ALLOW IN    Anywhere
[ 2] 22/tcp                     ALLOW IN    Anywhere
";

    #[test]
    fn parse_port_rules_duplicates_are_not_deduplicated() {
        let rules = parse_port_rules(PORT_RULES_DUPLICATE).expect("parse");
        // Parser returns exactly what UFW shows — no dedup
        assert_eq!(rules.len(), 2);
        let count = rules
            .iter()
            .filter(|r| r.port == 22 && r.protocol == Protocol::Tcp)
            .count();
        assert_eq!(count, 2);
    }

    // ---------------------------------------------------------------------------
    // Malformed / edge-case input
    // ---------------------------------------------------------------------------

    const PORT_RULES_MALFORMED: &str = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] Not a real rule
[ 2] 22/tcp                     ALLOW IN    Anywhere
random garbage
[ 3] also-bad
";

    #[test]
    fn parse_port_rules_malformed_lines_are_skipped() {
        let rules = parse_port_rules(PORT_RULES_MALFORMED).expect("parse");
        // Only line 2 should parse successfully
        let rule = rules
            .iter()
            .find(|r| r.port == 22 && r.protocol == Protocol::Tcp);
        assert!(rule.is_some(), "22/tcp should still be parsed");
        assert_eq!(rule.expect("22/tcp").status, RuleStatus::Allowed);
        // Should not panic on any malformed lines
    }

    #[test]
    fn parse_port_rules_malformed_does_not_panic() {
        let rules = parse_port_rules(PORT_RULES_MALFORMED).expect("parse");
        assert_eq!(rules.len(), 1);
    }

    #[test]
    fn parse_port_rules_empty_line_between_rules_skipped() {
        let input = "\
[ 1] 22/tcp  ALLOW IN  Anywhere

[ 2] 443/tcp  ALLOW IN  Anywhere
";
        let rules = parse_port_rules(input).expect("parse");
        assert_eq!(rules.len(), 2);
    }

    // ---------------------------------------------------------------------------
    // parse_ip_rules
    // ---------------------------------------------------------------------------

    const IP_RULES_BASIC: &str = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] Anywhere                   ALLOW IN    192.168.1.10
[ 2] Anywhere                   DENY IN     10.0.0.5
[ 3] Anywhere                   ALLOW IN    2001:db8::1
[ 4] Anywhere                   DENY IN     ::1
";

    #[test]
    fn parse_ip_rules_ipv4_allow() {
        let rules = parse_ip_rules(IP_RULES_BASIC).expect("parse");
        let ip: IpAddr = "192.168.1.10".parse().expect("valid ip");
        let rule = rules.iter().find(|r| r.ip == ip);
        let rule = rule.expect("192.168.1.10 rule");
        assert_eq!(rule.status, RuleStatus::Allowed);
    }

    #[test]
    fn parse_ip_rules_ipv4_deny() {
        let rules = parse_ip_rules(IP_RULES_BASIC).expect("parse");
        let ip: IpAddr = "10.0.0.5".parse().expect("valid ip");
        let rule = rules.iter().find(|r| r.ip == ip);
        let rule = rule.expect("10.0.0.5 rule");
        assert_eq!(rule.status, RuleStatus::Denied);
    }

    #[test]
    fn parse_ip_rules_ipv6_allow() {
        let rules = parse_ip_rules(IP_RULES_BASIC).expect("parse");
        let ip: IpAddr = "2001:db8::1".parse().expect("valid ip");
        let rule = rules.iter().find(|r| r.ip == ip);
        let rule = rule.expect("2001:db8::1 rule");
        assert_eq!(rule.status, RuleStatus::Allowed);
    }

    #[test]
    fn parse_ip_rules_ipv6_deny() {
        let rules = parse_ip_rules(IP_RULES_BASIC).expect("parse");
        let ip: IpAddr = "::1".parse().expect("valid ip");
        let rule = rules.iter().find(|r| r.ip == ip);
        let rule = rule.expect("::1 rule");
        assert_eq!(rule.status, RuleStatus::Denied);
    }

    #[test]
    fn parse_ip_rules_missing_returns_empty() {
        let rules = parse_ip_rules("").expect("empty");
        assert!(rules.is_empty());
    }

    #[test]
    fn parse_ip_rules_skips_port_lines() {
        // Lines with port/protocol targets should not appear as IP rules
        let input = "\
Status: active

     To                         Action      From
     --                         ------      ----
[ 1] 22/tcp                     ALLOW IN    Anywhere
[ 2] Anywhere                   ALLOW IN    192.168.1.10
";
        let rules = parse_ip_rules(input).expect("parse");
        assert_eq!(rules.len(), 1);
        let ip: IpAddr = "192.168.1.10".parse().expect("valid ip");
        assert!(rules.iter().any(|r| r.ip == ip));
    }

    // ---------------------------------------------------------------------------
    // IP rules with protocol (Anywhere/tcp format) — not currently supported
    // ---------------------------------------------------------------------------

    #[test]
    #[ignore]
    fn todo_parse_ip_rules_with_protocol_format() {
        // UFW does not natively produce "Anywhere/tcp" in the To column for
        // `ufw status numbered`.  If a future version or variant does, the
        // parser can be extended to extract the protocol from the target.
        //
        // Example of the unsupported format:
        //   [ 1] Anywhere/tcp   ALLOW IN    192.168.1.10
    }

    // ---------------------------------------------------------------------------
    // find_port_status
    // ---------------------------------------------------------------------------

    const PORT_RULES_STATUS: &str = "\
[ 1] 22/tcp   ALLOW IN   Anywhere
[ 2] 53/udp   ALLOW IN   Anywhere
[ 3] 8080/udp DENY IN    Anywhere
";

    #[test]
    fn find_port_status_tcp_allowed() {
        let rules = parse_port_rules(PORT_RULES_STATUS).expect("parse");
        assert_eq!(
            find_port_status(&rules, 22, Protocol::Tcp),
            RuleStatus::Allowed
        );
    }

    #[test]
    fn find_port_status_udp_denied() {
        let rules = parse_port_rules(PORT_RULES_STATUS).expect("parse");
        assert_eq!(
            find_port_status(&rules, 8080, Protocol::Udp),
            RuleStatus::Denied
        );
    }

    #[test]
    fn find_port_status_nonexistent_port() {
        let rules = parse_port_rules(PORT_RULES_STATUS).expect("parse");
        assert_eq!(
            find_port_status(&rules, 9999, Protocol::Tcp),
            RuleStatus::None
        );
    }

    #[test]
    fn find_port_status_wrong_protocol() {
        // 53 is ALLOW IN for UDP, not TCP
        let rules = parse_port_rules(PORT_RULES_STATUS).expect("parse");
        assert_eq!(
            find_port_status(&rules, 53, Protocol::Tcp),
            RuleStatus::None
        );
    }

    #[test]
    fn find_port_status_both_both_allowed() {
        let input = "\
[ 1] 22/tcp  ALLOW IN  Anywhere
[ 2] 22/udp  ALLOW IN  Anywhere
";
        let rules = parse_port_rules(input).expect("parse");
        assert_eq!(
            find_port_status(&rules, 22, Protocol::Both),
            RuleStatus::Allowed
        );
    }

    #[test]
    fn find_port_status_both_both_denied() {
        let input = "\
[ 1] 22/tcp  DENY IN  Anywhere
[ 2] 22/udp  DENY IN  Anywhere
";
        let rules = parse_port_rules(input).expect("parse");
        assert_eq!(
            find_port_status(&rules, 22, Protocol::Both),
            RuleStatus::Denied
        );
    }

    #[test]
    fn find_port_status_both_mixed_returns_none() {
        let input = "\
[ 1] 22/tcp  ALLOW IN  Anywhere
[ 2] 22/udp  DENY IN  Anywhere
";
        let rules = parse_port_rules(input).expect("parse");
        // TCP allowed, UDP denied → Both returns None per spec
        assert_eq!(
            find_port_status(&rules, 22, Protocol::Both),
            RuleStatus::None
        );
    }

    #[test]
    fn find_port_status_both_one_missing_returns_none() {
        let input = "\
[ 1] 22/tcp  ALLOW IN  Anywhere
";
        let rules = parse_port_rules(input).expect("parse");
        // TCP only, no UDP → Both returns None
        assert_eq!(
            find_port_status(&rules, 22, Protocol::Both),
            RuleStatus::None
        );
    }

    #[test]
    fn find_port_status_both_neither_exists() {
        let rules = parse_port_rules("").expect("parse");
        assert_eq!(
            find_port_status(&rules, 99, Protocol::Both),
            RuleStatus::None
        );
    }

    // ---------------------------------------------------------------------------
    // find_ip_status
    // ---------------------------------------------------------------------------

    const IP_RULES_STATUS: &str = "\
[ 1] Anywhere  ALLOW IN  192.168.1.10
[ 2] Anywhere  DENY IN   10.0.0.5
";

    #[test]
    fn find_ip_status_both_allowed() {
        let rules = parse_ip_rules(IP_RULES_STATUS).expect("parse");
        let ip: IpAddr = "192.168.1.10".parse().expect("valid ip");
        assert_eq!(
            find_ip_status(&rules, ip, Protocol::Both),
            RuleStatus::Allowed
        );
    }

    #[test]
    fn find_ip_status_both_denied() {
        let rules = parse_ip_rules(IP_RULES_STATUS).expect("parse");
        let ip: IpAddr = "10.0.0.5".parse().expect("valid ip");
        assert_eq!(
            find_ip_status(&rules, ip, Protocol::Both),
            RuleStatus::Denied
        );
    }

    #[test]
    fn find_ip_status_both_nonexistent() {
        let rules = parse_ip_rules(IP_RULES_STATUS).expect("parse");
        let ip: IpAddr = "127.0.0.1".parse().expect("valid ip");
        assert_eq!(find_ip_status(&rules, ip, Protocol::Both), RuleStatus::None);
    }

    #[test]
    fn find_ip_status_tcp_with_generic_rule() {
        // IP rules are always parsed with Protocol::Both; looking up with
        // Protocol::Tcp still returns the rule.
        let rules = parse_ip_rules(IP_RULES_STATUS).expect("parse");
        let ip: IpAddr = "192.168.1.10".parse().expect("valid ip");
        assert_eq!(
            find_ip_status(&rules, ip, Protocol::Tcp),
            RuleStatus::Allowed
        );
    }

    // ---------------------------------------------------------------------------
    // Action as_str helpers (pub(crate))
    // ---------------------------------------------------------------------------

    #[test]
    fn action_as_str() {
        assert_eq!(Action::Allow.as_str(), "allow");
        assert_eq!(Action::Deny.as_str(), "deny");
    }
}