sudo-rs 0.2.0-dev.20230627

A memory safe implementation of sudo and su.
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::io::{Stderr, Write};

#[cfg(feature = "dev")]
use std::{path::Path, sync::Mutex};

use log::Log;

pub trait LoggerWrite {
    fn write_log(&self, buf: &[u8]) -> std::io::Result<usize>;
    fn flush_log(&self) -> std::io::Result<()>;
}

impl LoggerWrite for Stderr {
    fn write_log(&self, buf: &[u8]) -> std::io::Result<usize> {
        self.lock().write(buf)
    }

    fn flush_log(&self) -> std::io::Result<()> {
        self.lock().flush()
    }
}

pub struct SimpleLogger<W: LoggerWrite + Send + Sync> {
    target: W,
    prefix: &'static str,
}

impl<W: LoggerWrite + Send + Sync> Log for SimpleLogger<W> {
    fn enabled(&self, metadata: &log::Metadata) -> bool {
        metadata.level() <= log::max_level() && metadata.level() <= log::STATIC_MAX_LEVEL
    }

    fn log(&self, record: &log::Record) {
        let _ = self
            .target
            .write_log(format!("{}{}\n", self.prefix, record.args()).as_bytes());
    }

    fn flush(&self) {
        let _ = self.target.flush_log();
    }
}

impl SimpleLogger<std::io::Stderr> {
    pub fn to_stderr(prefix: &'static str) -> SimpleLogger<std::io::Stderr> {
        SimpleLogger {
            target: std::io::stderr(),
            prefix,
        }
    }
}

#[cfg(feature = "dev")]
pub struct MutexTarget(Box<Mutex<dyn Write + Send + Sync>>);

#[cfg(feature = "dev")]
impl LoggerWrite for MutexTarget {
    fn write_log(&self, buf: &[u8]) -> std::io::Result<usize> {
        self.0.lock().unwrap().write(buf)
    }

    fn flush_log(&self) -> std::io::Result<()> {
        self.0.lock().unwrap().flush()
    }
}

#[cfg(feature = "dev")]
impl SimpleLogger<MutexTarget> {
    pub fn to_file<P: AsRef<Path>>(
        name: P,
        prefix: &'static str,
    ) -> Result<SimpleLogger<MutexTarget>, std::io::Error> {
        let file = std::fs::OpenOptions::new()
            .append(true)
            .create(true)
            .open(name)?;
        Ok(SimpleLogger {
            target: MutexTarget(Box::new(Mutex::new(file))),
            prefix,
        })
    }
}

#[cfg(test)]
mod tests {
    use std::sync::{Arc, RwLock};

    use super::{LoggerWrite, SimpleLogger};
    use log::{LevelFilter, Log};

    impl LoggerWrite for Arc<RwLock<String>> {
        fn write_log(&self, buf: &[u8]) -> std::io::Result<usize> {
            self.write()
                .unwrap()
                .push_str(std::str::from_utf8(buf).unwrap());

            Ok(buf.len())
        }

        fn flush_log(&self) -> std::io::Result<()> {
            self.write().unwrap().push_str("flushed");

            Ok(())
        }
    }

    #[test]
    fn test_default_level() {
        let logger = SimpleLogger::to_stderr("test");
        let metadata = log::Metadata::builder().level(log::Level::Trace).build();

        log::set_max_level(LevelFilter::Trace);
        assert!(logger.enabled(&metadata));

        log::set_max_level(LevelFilter::Info);
        assert!(!logger.enabled(&metadata));
    }

    #[test]
    fn test_write_and_flush() {
        let target = Arc::new(RwLock::new(String::new()));
        let logger = SimpleLogger {
            target: target.clone(),
            prefix: "[test] ",
        };
        let record = log::Record::builder()
            .args(format_args!("Hello World!"))
            .level(log::Level::Info)
            .build();

        logger.log(&record);

        let value = target.read().unwrap();
        assert_eq!(*value, "[test] Hello World!\n");
        drop(value);

        logger.flush();

        let value = target.read().unwrap();
        assert_eq!(*value, "[test] Hello World!\nflushed");
        drop(value);
    }
}