opseclint 1.0.0

Detection-coverage analyzer for Linux/auditd, Windows/Sysmon, and macOS/Endpoint Security: resolve shell/command actions to ATT&CK techniques, the telemetry they emit, and the detections that would fire.
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

//! Rendering: a human-readable terminal report and a machine-readable JSON
//! form for CI consumption.

use std::fmt::Write as _;

use crate::model::{Report, Severity};
use crate::theme::{self, Painter};

const WIDTH: usize = 60;
const INDENT: &str = "                "; // 16 spaces, aligns sub-lines

fn plural(n: usize) -> &'static str {
    if n == 1 { "" } else { "s" }
}

/// Render the report for a terminal in the Tokyo Night palette. `color` toggles
/// ANSI escapes.
pub fn render_human(report: &Report, color: bool) -> String {
    let p = Painter::new(color);
    let mut out = String::new();

    let _ = writeln!(
        out,
        "{}{}",
        p.bold(theme::BLUE, "opseclint"),
        p.paint(
            theme::COMMENT,
            &format!(" · detection-coverage · {}", report.platform)
        )
    );

    if report.findings.is_empty() {
        let _ = writeln!(
            out,
            "{}",
            p.paint(
                theme::COMMENT,
                &format!(
                    "{} line{} · 0 findings",
                    report.lines_analyzed,
                    plural(report.lines_analyzed)
                )
            )
        );
        let _ = writeln!(
            out,
            "\n  {}",
            p.paint(
                theme::FG_DIM,
                "No modeled actions matched — which is not proof of stealth, only that"
            )
        );
        let _ = writeln!(
            out,
            "  {}",
            p.paint(
                theme::FG_DIM,
                "nothing in the knowledge base matched this input."
            )
        );
        return out;
    }

    let sev = report.max_severity();
    let _ = writeln!(
        out,
        "{}{}",
        p.paint(
            theme::COMMENT,
            &format!(
                "{} line{} · {} finding{} · loudest ",
                report.lines_analyzed,
                plural(report.lines_analyzed),
                report.findings.len(),
                plural(report.findings.len())
            )
        ),
        p.paint(
            sev.color(),
            &format!("● {} ({})", sev.label(), report.max_noise)
        )
    );
    let _ = writeln!(out, "{}", p.rule(WIDTH));

    for f in &report.findings {
        let s = f.severity;
        let _ = writeln!(
            out,
            " {}  {}  {}",
            p.paint(s.color(), &format!("● {:<8} {:>2}", s.label(), f.noise)),
            p.paint(theme::COMMENT, &format!("L{}", f.line)),
            p.paint(theme::FG, &f.description),
        );

        // Build sub-lines, then draw the tree (├ for all but the last, └ last).
        let mut subs: Vec<String> = Vec::new();
        if !f.techniques.is_empty() {
            let techs = f
                .techniques
                .iter()
                .map(|t| {
                    format!(
                        "{} {}",
                        p.paint(theme::PURPLE, &t.id),
                        p.paint(theme::FG_DIM, &t.name)
                    )
                })
                .collect::<Vec<_>>()
                .join(&p.paint(theme::COMMENT, " · "));
            subs.push(techs);
        }
        for tel in &f.telemetry {
            subs.push(p.paint(theme::COMMENT, &format!("◈ {tel}")));
        }
        for d in &f.detections {
            let mut line = p.paint(theme::CYAN, &format!("◆ {}: {}", d.source, d.rule));
            if let Some(v) = &d.verdict {
                let vcol = if v.starts_with("fires") {
                    theme::GREEN
                } else if v.starts_with("indeterminate") {
                    theme::YELLOW
                } else {
                    theme::COMMENT
                };
                line.push_str(&format!(" {}", p.paint(vcol, v)));
            }
            line.push_str(&format!(
                " {}",
                p.paint(theme::COMMENT, &format!("({})", d.confidence))
            ));
            subs.push(line);
        }

        let last = subs.len().saturating_sub(1);
        for (i, sub) in subs.iter().enumerate() {
            let glyph = if i == last { "└" } else { "├" };
            let _ = writeln!(out, "{INDENT}{} {sub}", p.paint(theme::COMMENT, glyph));
        }
    }

    let _ = writeln!(out, "{}", p.rule(WIDTH));
    let _ = writeln!(
        out,
        " {}  {}",
        p.bold(theme::FG, "summary"),
        p.paint(
            sev.color(),
            &format!("● {} ({})", sev.label(), report.max_noise)
        )
    );
    if !report.note.is_empty() {
        let _ = writeln!(out, "\n{}", p.paint(theme::COMMENT, &report.note));
    }
    out
}

/// Render the report as pretty JSON.
pub fn render_json(report: &Report) -> String {
    serde_json::to_string_pretty(report).unwrap_or_else(|e| format!("{{\"error\":\"{e}\"}}"))
}

/// Human-readable one-liner for a severity, used in CI gate messages.
pub fn severity_word(sev: Severity) -> &'static str {
    sev.label()
}