config-lib 0.9.0

Enterprise-grade multi-format configuration library supporting 8 formats (CONF, INI, Properties, JSON, XML, HCL, TOML, NOML) with sub-50ns caching, hot reloading, and comprehensive validation.
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
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
//! Comprehensive Audit Logging System
//!
//! Enterprise-grade audit logging with:
//! - Structured logging for all configuration operations
//! - Access tracking with user context and timestamps
//! - Modification logging with before/after values
//! - Validation failure tracking
//! - Configurable log levels and outputs
//! - Performance-optimized with minimal overhead

use crate::value::Value;
use std::collections::HashMap;
use std::fmt;
use std::sync::{Arc, Mutex};
use std::time::{SystemTime, UNIX_EPOCH};

/// Audit event types for configuration operations
#[derive(Debug, Clone, PartialEq)]
pub enum AuditEventType {
    /// Configuration key was accessed/read
    Access,
    /// Configuration key was modified
    Modification,
    /// Configuration validation failed
    ValidationFailure,
    /// Configuration was reloaded from file
    Reload,
    /// Configuration file was loaded initially
    Load,
    /// Configuration was serialized/saved
    Save,
}

/// Severity levels for audit events
#[derive(Debug, Clone, PartialEq, PartialOrd)]
pub enum AuditSeverity {
    /// Informational events (normal operations)
    Info = 1,
    /// Warning events (potential issues)
    Warning = 2,
    /// Error events (failures)
    Error = 3,
    /// Critical events (security concerns)
    Critical = 4,
}

/// Comprehensive audit event record
#[derive(Debug, Clone)]
pub struct AuditEvent {
    /// Unique event ID
    pub id: String,
    /// Timestamp when the event occurred
    pub timestamp: SystemTime,
    /// Type of operation that triggered this event
    pub event_type: AuditEventType,
    /// Severity level of the event
    pub severity: AuditSeverity,
    /// Configuration key that was accessed/modified
    pub key: Option<String>,
    /// Previous value (for modifications)
    pub old_value: Option<Value>,
    /// New value (for modifications)
    pub new_value: Option<Value>,
    /// User or system context that triggered the event
    pub user_context: Option<String>,
    /// Additional contextual information
    pub metadata: HashMap<String, String>,
    /// Error message (for failures)
    pub error_message: Option<String>,
    /// Source location (file path, line number, etc.)
    pub source: Option<String>,
}

impl AuditEvent {
    /// Create a new audit event with minimal required fields
    pub fn new(event_type: AuditEventType, severity: AuditSeverity) -> Self {
        Self {
            id: generate_event_id(),
            timestamp: SystemTime::now(),
            event_type,
            severity,
            key: None,
            old_value: None,
            new_value: None,
            user_context: None,
            metadata: HashMap::new(),
            error_message: None,
            source: None,
        }
    }

    /// Set the configuration key for this event
    pub fn with_key(mut self, key: impl Into<String>) -> Self {
        self.key = Some(key.into());
        self
    }

    /// Set the old value (for modifications)
    pub fn with_old_value(mut self, value: Value) -> Self {
        self.old_value = Some(value);
        self
    }

    /// Set the new value (for modifications)
    pub fn with_new_value(mut self, value: Value) -> Self {
        self.new_value = Some(value);
        self
    }

    /// Set the user context
    pub fn with_user_context(mut self, context: impl Into<String>) -> Self {
        self.user_context = Some(context.into());
        self
    }

    /// Add metadata key-value pair
    pub fn with_metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.metadata.insert(key.into(), value.into());
        self
    }

    /// Set error message
    pub fn with_error(mut self, message: impl Into<String>) -> Self {
        self.error_message = Some(message.into());
        self
    }

    /// Set source location
    pub fn with_source(mut self, source: impl Into<String>) -> Self {
        self.source = Some(source.into());
        self
    }
}

impl fmt::Display for AuditEvent {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let timestamp_millis = self
            .timestamp
            .duration_since(UNIX_EPOCH)
            .unwrap_or_default()
            .as_millis();

        write!(
            f,
            "[{}] {:?}:{:?} id={} key={} user={}",
            timestamp_millis,
            self.event_type,
            self.severity,
            self.id,
            self.key.as_deref().unwrap_or("none"),
            self.user_context.as_deref().unwrap_or("system")
        )?;

        if let Some(error) = &self.error_message {
            write!(f, " error=\"{error}\"")?;
        }

        if let (Some(old), Some(new)) = (&self.old_value, &self.new_value) {
            write!(f, " change=\"{old:?}\" -> \"{new:?}\"")?;
        }

        for (key, value) in &self.metadata {
            write!(f, " {key}=\"{value}\"")?;
        }

        Ok(())
    }
}

/// Trait for audit log outputs/sinks
pub trait AuditSink: Send + Sync {
    /// Write an audit event to this sink
    fn write_event(&self, event: &AuditEvent) -> Result<(), String>;

    /// Flush any buffered events
    fn flush(&self) -> Result<(), String>;
}

/// Console/stdout audit sink for development
pub struct ConsoleSink {
    level_filter: AuditSeverity,
}

impl ConsoleSink {
    /// Create a new console sink with minimum severity level
    pub fn new(min_level: AuditSeverity) -> Self {
        Self {
            level_filter: min_level,
        }
    }
}

impl AuditSink for ConsoleSink {
    fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
        if event.severity >= self.level_filter {
            println!("AUDIT: {event}");
        }
        Ok(())
    }

    fn flush(&self) -> Result<(), String> {
        Ok(()) // stdout auto-flushes
    }
}

/// File-based audit sink for production
pub struct FileSink {
    file_path: String,
    level_filter: AuditSeverity,
}

impl FileSink {
    /// Create a new file sink
    pub fn new(file_path: impl Into<String>, min_level: AuditSeverity) -> Self {
        Self {
            file_path: file_path.into(),
            level_filter: min_level,
        }
    }
}

impl AuditSink for FileSink {
    fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
        if event.severity >= self.level_filter {
            use std::fs::OpenOptions;
            use std::io::Write;

            let mut file = OpenOptions::new()
                .create(true)
                .append(true)
                .open(&self.file_path)
                .map_err(|e| format!("Failed to open audit log file: {e}"))?;

            writeln!(file, "{event}").map_err(|e| format!("Failed to write to audit log: {e}"))?;
        }
        Ok(())
    }

    fn flush(&self) -> Result<(), String> {
        // For append-only files, OS handles flushing
        Ok(())
    }
}

/// Main audit logger with multiple sinks
pub struct AuditLogger {
    sinks: Vec<Box<dyn AuditSink>>,
    enabled: bool,
}

impl AuditLogger {
    /// Create a new audit logger
    pub fn new() -> Self {
        Self {
            sinks: Vec::new(),
            enabled: true,
        }
    }

    /// Add a sink to the logger
    pub fn add_sink(mut self, sink: Box<dyn AuditSink>) -> Self {
        self.sinks.push(sink);
        self
    }

    /// Enable or disable audit logging
    pub fn set_enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    /// Log an audit event to all configured sinks
    pub fn log_event(&self, event: AuditEvent) {
        if !self.enabled {
            return;
        }

        for sink in &self.sinks {
            if let Err(e) = sink.write_event(&event) {
                eprintln!("Audit sink error: {e}");
            }
        }
    }

    /// Log a configuration access event
    pub fn log_access(&self, key: &str, user_context: Option<&str>) {
        let event = AuditEvent::new(AuditEventType::Access, AuditSeverity::Info)
            .with_key(key)
            .with_metadata("operation", "get");

        let event = if let Some(user) = user_context {
            event.with_user_context(user)
        } else {
            event
        };

        self.log_event(event);
    }

    /// Log a configuration modification event
    pub fn log_modification(
        &self,
        key: &str,
        old_value: Option<&Value>,
        new_value: &Value,
        user_context: Option<&str>,
    ) {
        let mut event = AuditEvent::new(AuditEventType::Modification, AuditSeverity::Warning)
            .with_key(key)
            .with_new_value(new_value.clone())
            .with_metadata("operation", "set");

        if let Some(old) = old_value {
            event = event.with_old_value(old.clone());
        }

        if let Some(user) = user_context {
            event = event.with_user_context(user);
        }

        self.log_event(event);
    }

    /// Log a validation failure event
    pub fn log_validation_failure(
        &self,
        key: &str,
        error: &str,
        value: &Value,
        user_context: Option<&str>,
    ) {
        let event = AuditEvent::new(AuditEventType::ValidationFailure, AuditSeverity::Error)
            .with_key(key)
            .with_new_value(value.clone())
            .with_error(error)
            .with_metadata("operation", "validate");

        let event = if let Some(user) = user_context {
            event.with_user_context(user)
        } else {
            event
        };

        self.log_event(event);
    }

    /// Log a configuration reload event
    pub fn log_reload(&self, source: &str, success: bool, error: Option<&str>) {
        let severity = if success {
            AuditSeverity::Info
        } else {
            AuditSeverity::Error
        };
        let mut event = AuditEvent::new(AuditEventType::Reload, severity)
            .with_source(source)
            .with_metadata("operation", "reload");

        if let Some(err) = error {
            event = event.with_error(err);
        }

        self.log_event(event);
    }

    /// Flush all sinks
    pub fn flush(&self) {
        for sink in &self.sinks {
            if let Err(e) = sink.flush() {
                eprintln!("Audit sink flush error: {e}");
            }
        }
    }
}

impl Default for AuditLogger {
    fn default() -> Self {
        Self::new()
    }
}

/// Thread-safe global audit logger
static GLOBAL_AUDIT_LOGGER: Mutex<Option<Arc<AuditLogger>>> = Mutex::new(None);

/// Initialize the global audit logger
pub fn init_audit_logger(logger: AuditLogger) {
    if let Ok(mut global) = GLOBAL_AUDIT_LOGGER.lock() {
        *global = Some(Arc::new(logger));
    }
    // If mutex is poisoned, we can't initialize the logger but we don't panic
}

/// Get the global audit logger
pub fn get_audit_logger() -> Option<Arc<AuditLogger>> {
    GLOBAL_AUDIT_LOGGER
        .lock()
        .ok()
        .and_then(|guard| guard.clone())
}

/// Log an event using the global audit logger
pub fn audit_log(event: AuditEvent) {
    if let Some(logger) = get_audit_logger() {
        logger.log_event(event);
    }
}

/// Generate a unique event ID
fn generate_event_id() -> String {
    use std::sync::atomic::{AtomicU64, Ordering};
    static COUNTER: AtomicU64 = AtomicU64::new(1);

    let timestamp = SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .unwrap_or_default()
        .as_secs();
    let counter = COUNTER.fetch_add(1, Ordering::Relaxed);

    format!("{timestamp:x}-{counter:x}")
}

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

    struct TestSink {
        events: Arc<Mutex<Vec<AuditEvent>>>,
    }

    impl TestSink {
        fn new() -> (Self, Arc<Mutex<Vec<AuditEvent>>>) {
            let events = Arc::new(Mutex::new(Vec::new()));
            (
                Self {
                    events: Arc::clone(&events),
                },
                events,
            )
        }
    }

    impl AuditSink for TestSink {
        fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
            self.events.lock().unwrap().push(event.clone());
            Ok(())
        }

        fn flush(&self) -> Result<(), String> {
            Ok(())
        }
    }

    #[test]
    fn test_audit_event_creation() {
        let event = AuditEvent::new(AuditEventType::Access, AuditSeverity::Info)
            .with_key("test.key")
            .with_user_context("test_user")
            .with_metadata("operation", "get");

        assert_eq!(event.event_type, AuditEventType::Access);
        assert_eq!(event.severity, AuditSeverity::Info);
        assert_eq!(event.key, Some("test.key".to_string()));
        assert_eq!(event.user_context, Some("test_user".to_string()));
        assert_eq!(event.metadata.get("operation"), Some(&"get".to_string()));
    }

    #[test]
    fn test_audit_logger_basic() {
        let (sink, events) = TestSink::new();
        let logger = AuditLogger::new().add_sink(Box::new(sink));

        logger.log_access("test.key", Some("test_user"));
        logger.log_modification(
            "test.key",
            None,
            &Value::String("new_value".to_string()),
            Some("test_user"),
        );

        let events = events.lock().unwrap();
        assert_eq!(events.len(), 2);

        assert_eq!(events[0].event_type, AuditEventType::Access);
        assert_eq!(events[0].key, Some("test.key".to_string()));

        assert_eq!(events[1].event_type, AuditEventType::Modification);
        assert_eq!(events[1].key, Some("test.key".to_string()));
    }

    #[test]
    fn test_console_sink() {
        let sink = ConsoleSink::new(AuditSeverity::Info);
        let event =
            AuditEvent::new(AuditEventType::Access, AuditSeverity::Info).with_key("test.key");

        // This should not panic
        assert!(sink.write_event(&event).is_ok());
    }

    #[test]
    fn test_event_display() {
        let event = AuditEvent::new(AuditEventType::Modification, AuditSeverity::Warning)
            .with_key("test.key")
            .with_user_context("test_user")
            .with_old_value(Value::String("old".to_string()))
            .with_new_value(Value::String("new".to_string()))
            .with_metadata("operation", "set");

        let display = format!("{event}");
        assert!(display.contains("Modification"));
        assert!(display.contains("Warning"));
        assert!(display.contains("test.key"));
        assert!(display.contains("test_user"));
    }

    #[test]
    fn test_severity_filtering() {
        let (sink, events) = TestSink::new();
        let logger = AuditLogger::new().add_sink(Box::new(sink));

        // Log events of different severities
        logger.log_event(AuditEvent::new(AuditEventType::Access, AuditSeverity::Info));
        logger.log_event(AuditEvent::new(
            AuditEventType::ValidationFailure,
            AuditSeverity::Error,
        ));

        let events = events.lock().unwrap();
        assert_eq!(events.len(), 2);
        assert_eq!(events[0].severity, AuditSeverity::Info);
        assert_eq!(events[1].severity, AuditSeverity::Error);
    }
}