firewall_audit 0.1.0

Cross-platform firewall audit tool and library (YAML/JSON rules, CSV/HTML/JSON export)
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

use crate::audit::run::AuditMatch;
use std::fmt::Write as _;

/// Formats audit results as a human-readable text string for CLI output.
pub fn export_text(audit_results: &[AuditMatch]) -> String {
    let mut output = String::new();
    for audit in audit_results {
        writeln!(&mut output, "\nAudit Rule: {}", audit.rule_id).unwrap();
        writeln!(&mut output, "Description: {}", audit.description).unwrap();
        writeln!(&mut output, "Severity: {}", audit.severity).unwrap();
        writeln!(
            &mut output,
            "\t{} match(es) found:",
            audit.matched_firewall_rules.len()
        )
        .unwrap();
        for name in &audit.matched_firewall_rules {
            writeln!(&mut output, "\t- {name}").unwrap();
        }
    }
    output
}

#[cfg(test)]
mod tests {
    use crate::{audit::run::AuditMatch, export_text};

    #[test]
    fn test_export_text_empty() {
        let result = export_text(&[]);
        assert!(result.trim().is_empty(), "Should be empty for no results");
    }

    #[test]
    fn test_export_text_one_match() {
        let audit = AuditMatch {
            rule_id: "R1".into(),
            description: "desc1".into(),
            severity: "high".into(),
            matched_firewall_rules: vec!["RuleA".into()],
        };
        let result = export_text(&[audit]);
        assert!(result.contains("Audit Rule: R1"));
        assert!(result.contains("desc1"));
        assert!(result.contains("high"));
        assert!(result.contains("1 match(es)"));
        assert!(result.contains("- RuleA"));
    }

    #[test]
    fn test_export_text_multiple_matches() {
        let audit = AuditMatch {
            rule_id: "R2".into(),
            description: "desc2".into(),
            severity: "low".into(),
            matched_firewall_rules: vec!["RuleB".into(), "RuleC".into()],
        };
        let result = export_text(&[audit]);
        assert!(result.contains("2 match(es)"));
        assert!(result.contains("- RuleB"));
        assert!(result.contains("- RuleC"));
    }

    #[test]
    fn test_export_text_special_characters() {
        let audit = AuditMatch {
            rule_id: "R3".into(),
            description: "desc3".into(),
            severity: "medium".into(),
            matched_firewall_rules: vec!["Règle spéciale !@#".into()],
        };
        let result = export_text(&[audit]);
        assert!(result.contains("Règle spéciale !@#"));
    }
}