tirith-core 0.3.0

Terminal security analysis engine - homograph attacks, pipe-to-shell, ANSI injection
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

use crate::verdict::Severity;
use owo_colors::OwoColorize;

/// Which output stream color decisions should be based on.
/// Commands route human output to different streams (e.g., check uses stderr,
/// warnings uses stdout), so color must be evaluated per-stream.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Stream {
    Stdout,
    Stderr,
}

/// Check if color should be used for a given output stream.
/// Respects the `NO_COLOR` env var (https://no-color.org/) and TTY detection.
///
/// Per the NO_COLOR spec, the presence of the variable is sufficient to disable
/// color, regardless of its value (including empty string).
pub fn use_color_for(stream: Stream) -> bool {
    if std::env::var_os("NO_COLOR").is_some() {
        return false;
    }
    match stream {
        Stream::Stderr => is_terminal::is_terminal(std::io::stderr()),
        Stream::Stdout => is_terminal::is_terminal(std::io::stdout()),
    }
}

/// Format a severity label with color appropriate for the given stream.
/// Returns a bracketed severity label like `[CRITICAL]` with ANSI color when
/// color is supported, or plain text otherwise.
pub fn severity_label(severity: &Severity, stream: Stream) -> String {
    let label = format!("[{}]", severity);
    if !use_color_for(stream) {
        return label;
    }
    match severity {
        Severity::Critical => label.bright_red().to_string(),
        Severity::High => label.red().to_string(),
        Severity::Medium => label.yellow().to_string(),
        Severity::Low => label.cyan().to_string(),
        Severity::Info => label.dimmed().to_string(),
    }
}

/// Format text as bold if color is enabled for the stream.
pub fn bold(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.bold().to_string()
    } else {
        text.to_string()
    }
}

/// Format text as bold + red if color is enabled. Falls back to plain text.
pub fn bold_red(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.bold().red().to_string()
    } else {
        text.to_string()
    }
}

/// Format text as green if color is enabled.
pub fn green(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.green().to_string()
    } else {
        text.to_string()
    }
}

/// Format text as red if color is enabled.
pub fn red(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.red().to_string()
    } else {
        text.to_string()
    }
}

/// Format text as yellow if color is enabled.
pub fn yellow(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.yellow().to_string()
    } else {
        text.to_string()
    }
}

/// Format text as dimmed if color is enabled for the stream.
pub fn dim(text: &str, stream: Stream) -> String {
    if use_color_for(stream) {
        text.dimmed().to_string()
    } else {
        text.to_string()
    }
}

/// Format a pass/success marker (green checkmark or `[ok]`).
pub fn pass_mark(stream: Stream) -> String {
    if use_color_for(stream) {
        "\u{2713}".green().to_string()
    } else {
        "[ok]".to_string()
    }
}

/// Format a fail marker (red X or `[!!]`).
pub fn fail_mark(stream: Stream) -> String {
    if use_color_for(stream) {
        "\u{2717}".red().to_string()
    } else {
        "[!!]".to_string()
    }
}