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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
use std::env;
use std::path::Path;
use std::str::FromStr;

use log::LevelFilter;
use log4rs::append::console::ConsoleAppender;
use log4rs::append::rolling_file::policy::compound::roll::fixed_window::FixedWindowRoller;
use log4rs::append::rolling_file::policy::compound::trigger::size::SizeTrigger;
use log4rs::append::rolling_file::policy::compound::CompoundPolicy;
use log4rs::append::rolling_file::RollingFileAppender;
use log4rs::config::{load_config_file, Appender, Logger, Root};
use log4rs::encode::pattern::PatternEncoder;
use log4rs::filter::threshold::ThresholdFilter;
use log4rs::Config;

pub fn config_default(base_directory: &Path) -> Config {
    Config::builder()
        .appender(appender_stderr("stderr"))
        .appender(appender_tofile(
            "tofile",
            base_directory.join("stats_puffin_main_broker.log"),
        ))
        .build(
            Root::builder()
                .appender("stderr")
                .appender("tofile")
                .build(log_level()),
        )
        .unwrap()
}

pub fn load_fuzzing_client() -> Config {
    load_config_file("client_log_config.yml", Default::default()).unwrap()
}

fn appender_stderr<S>(name: S) -> Appender
where
    S: AsRef<str>,
{
    Appender::builder().build(
        name.as_ref(),
        Box::new(
            ConsoleAppender::builder()
                .target(log4rs::append::console::Target::Stderr)
                .encoder(Box::new(PatternEncoder::new(
                    "{h({d(%Y-%m-%dT%H:%M:%S%Z)}\t{m}{n})}",
                )))
                .build(),
        ),
    )
}

fn appender_tofile<S, P>(name: S, log_path: P) -> Appender
where
    S: AsRef<str>,
    P: AsRef<Path>,
{
    let window_size = 20; // log0, log1, log2, .., log19
    let fixed_window_roller = FixedWindowRoller::builder()
        .build("log{}", window_size)
        .unwrap();
    let size_limit = 100 * 1024 * 1024; // 100MB as max log file size to roll
    let size_trigger = SizeTrigger::new(size_limit);
    let compound_policy =
        CompoundPolicy::new(Box::new(size_trigger), Box::new(fixed_window_roller));

    Appender::builder().build(
        name.as_ref(),
        Box::new(
            RollingFileAppender::builder()
                .encoder(Box::new(PatternEncoder::new("{d}\t{l}\t{m}{n}")))
                .build(log_path, Box::new(compound_policy))
                .unwrap(),
        ),
    )
}

fn log_level() -> LevelFilter {
    // TODO allow fined-grain configuration of the log level
    //
    // At least for:
    //   - libafl* during fuzzing
    //   - tlspuffin's packages
    //   - tlspuffin's packages during fuzzing (libafl client)
    //
    // [MM] Maybe also allow package-level control like env_logger?
    env::var("RUST_LOG")
        .ok()
        .and_then(|level| LevelFilter::from_str(&level).ok())
        .unwrap_or(LevelFilter::Info)
}

pub fn set_experiment_fuzzing_client(base_directory: &Path, level_filter: LevelFilter) -> Config {
    // Common encoder
    let encoder = Box::new(PatternEncoder::new("{d}\t{l}\t{m}{n}"));

    // Console appender
    let stdout = ConsoleAppender::builder().build();

    // Helper to build a rolling file appender
    let max_log_size = 10 * 1024 * 1024; // 10 MB
    let build_rolling_appender = |path: &str, pattern: &str, filter: Option<LevelFilter>| {
        let trigger = Box::new(SizeTrigger::new(max_log_size));
        let roller = Box::new(
            FixedWindowRoller::builder()
                .base(1)
                .build(
                    &format!("{}{}", base_directory.to_str().unwrap(), pattern),
                    20,
                )
                .unwrap(),
        );

        let policy = Box::new(CompoundPolicy::new(trigger, roller));
        let rfa = RollingFileAppender::builder()
            .encoder(encoder.clone())
            .build(base_directory.join(path), policy)
            .unwrap();
        if let Some(filter) = filter {
            Appender::builder()
                .filter(Box::new(ThresholdFilter::new(filter)))
                .build(path, Box::new(rfa))
        } else {
            Appender::builder().build(path, Box::new(rfa))
        }
    };

    let fuzzer_log = build_rolling_appender("fuzzer.log", "fuzzer.{}.gz", None);
    let harness_log = build_rolling_appender("harness.log", "harness.{}.gz", None);
    let info_log = build_rolling_appender("info.log", "info.{}.gz", Some(LevelFilter::Info));
    let warn_log = build_rolling_appender("warn.log", "warn.{}.gz", Some(LevelFilter::Warn));
    let error_log = build_rolling_appender("error.log", "error.{}.gz", Some(LevelFilter::Error));

    let config = Config::builder()
        // appenders
        .appender(Appender::builder().build("stdout", Box::new(stdout)))
        .appender(fuzzer_log)
        .appender(harness_log)
        .appender(info_log)
        .appender(warn_log)
        .appender(error_log);

    let mut root_appenders = vec!["info.log", "warn.log", "error.log"];
    // Specific appenders and loggers for verbose modes (when RUST_LOG is set strictly more verbose
    // than INFO)
    let config = if level_filter >= LevelFilter::Debug {
        root_appenders.push("debug.log");
        let debug_log =
            build_rolling_appender("debug.log", "debug.{}.gz", Some(LevelFilter::Debug));
        config.appender(debug_log).logger(
            Logger::builder()
                .appenders(vec!["debug.log"])
                .additive(true)
                .build("debug", LevelFilter::Debug),
        )
    } else {
        config
    };

    let config = if level_filter >= LevelFilter::Trace {
        root_appenders.push("trace.log");
        let trace_log =
            build_rolling_appender("trace.log", "trace.{}.gz", Some(LevelFilter::Trace));
        config.appender(trace_log).logger(
            Logger::builder()
                .appenders(vec!["trace.log"])
                .additive(true)
                .build("trace", LevelFilter::Trace),
        )
    } else {
        config
    };

    // loggers
    config
        .logger(Logger::builder()
            .appenders(vec!["harness.log"])
            .additive(true)
            .build("puffin::harness", level_filter)) // Change to `Trace` for full verbosity
        .logger(Logger::builder()
            .appenders(vec!["fuzzer.log"])
            .additive(true)
            .build("puffin::fuzzer", level_filter))
        // Root logger
        .build(
            Root::builder()
                .appenders(root_appenders)
                .build(log_level()),
        )
        .unwrap()
}