rskit-process 0.1.0-alpha.1

Process and subprocess execution with timeout and signal handling
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

use std::ffi::OsString;
use std::fmt;

use crate::ArgRedaction;

pub(super) struct RedactedArgs<'a> {
    args: &'a [OsString],
    redaction: &'a ArgRedaction,
}

impl<'a> RedactedArgs<'a> {
    pub(super) fn new(args: &'a [OsString], redaction: &'a ArgRedaction) -> Self {
        Self { args, redaction }
    }
}

impl fmt::Debug for RedactedArgs<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut list = f.debug_list();
        let mut redact_next = false;
        for arg in self.args {
            let arg = arg.to_string_lossy();
            if redact_next {
                if let Some((key, _value)) = arg.split_once('=')
                    && self.redaction.is_sensitive_arg_name(key)
                {
                    let redacted = format!("{key}=<redacted>");
                    list.entry(&redacted);
                    redact_next = false;
                    continue;
                }

                if self.redaction.is_sensitive_arg_name(&arg) {
                    list.entry(&arg);
                    continue;
                }

                list.entry(&"<redacted>");
                redact_next = false;
                continue;
            }

            if let Some((key, _value)) = arg.split_once('=')
                && self.redaction.is_sensitive_arg_name(key)
            {
                let redacted = format!("{key}=<redacted>");
                list.entry(&redacted);
                continue;
            }

            if self.redaction.is_sensitive_arg_name(&arg) {
                list.entry(&arg);
                redact_next = true;
            } else {
                list.entry(&arg);
            }
        }
        list.finish()
    }
}

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

    #[test]
    fn redacted_args_masks_secret_values() {
        let args = vec![
            OsString::from("--token"),
            OsString::from("abc123"),
            OsString::from("--password=hunter2"),
            OsString::from("--auth-token=super-secret"),
            OsString::from("--author"),
            OsString::from("octocat"),
            OsString::from("--name"),
            OsString::from("visible"),
        ];

        let rendered = format!("{:?}", RedactedArgs::new(&args, &ArgRedaction::default()));

        assert!(rendered.contains("\"--token\""));
        assert!(rendered.contains("\"<redacted>\""));
        assert!(rendered.contains("\"--password=<redacted>\""));
        assert!(rendered.contains("\"--auth-token=<redacted>\""));
        assert!(rendered.contains("\"--author\""));
        assert!(rendered.contains("\"octocat\""));
        assert!(rendered.contains("\"visible\""));
        assert!(!rendered.contains("abc123"));
        assert!(!rendered.contains("hunter2"));
        assert!(!rendered.contains("super-secret"));
    }

    #[test]
    fn redacted_args_uses_custom_secret_names() {
        let args = vec![
            OsString::from("--license-key"),
            OsString::from("licensed"),
            OsString::from("--public-key"),
            OsString::from("visible"),
        ];
        let redaction = ArgRedaction::default().with_name("license-key");

        let rendered = format!("{:?}", RedactedArgs::new(&args, &redaction));

        assert!(rendered.contains("\"--license-key\""));
        assert!(rendered.contains("\"<redacted>\""));
        assert!(rendered.contains("\"--public-key\""));
        assert!(rendered.contains("\"visible\""));
        assert!(!rendered.contains("licensed"));
    }

    #[test]
    fn redacted_args_handles_adjacent_sensitive_flags() {
        let args = vec![
            OsString::from("--token"),
            OsString::from("--password"),
            OsString::from("hunter2"),
        ];

        let rendered = format!("{:?}", RedactedArgs::new(&args, &ArgRedaction::default()));

        assert!(rendered.contains("\"--token\""));
        assert!(rendered.contains("\"--password\""));
        assert!(rendered.contains("\"<redacted>\""));
        assert!(!rendered.contains("hunter2"));
    }

    #[test]
    fn redacted_args_preserves_sensitive_flag_when_next_arg_is_sensitive_assignment() {
        let args = vec![
            OsString::from("--token"),
            OsString::from("--password=hunter2"),
            OsString::from("visible"),
        ];

        let rendered = format!("{:?}", RedactedArgs::new(&args, &ArgRedaction::default()));

        assert!(rendered.contains("\"--token\""));
        assert!(rendered.contains("\"--password=<redacted>\""));
        assert!(rendered.contains("\"visible\""));
        assert!(!rendered.contains("hunter2"));
    }
}