config_lib/
audit.rs

1//! Comprehensive Audit Logging System
2//!
3//! Enterprise-grade audit logging with:
4//! - Structured logging for all configuration operations
5//! - Access tracking with user context and timestamps
6//! - Modification logging with before/after values
7//! - Validation failure tracking
8//! - Configurable log levels and outputs
9//! - Performance-optimized with minimal overhead
10
11use crate::value::Value;
12use std::collections::HashMap;
13use std::fmt;
14use std::sync::{Arc, Mutex};
15use std::time::{SystemTime, UNIX_EPOCH};
16
17/// Audit event types for configuration operations
18#[derive(Debug, Clone, PartialEq)]
19pub enum AuditEventType {
20    /// Configuration key was accessed/read
21    Access,
22    /// Configuration key was modified
23    Modification,
24    /// Configuration validation failed
25    ValidationFailure,
26    /// Configuration was reloaded from file
27    Reload,
28    /// Configuration file was loaded initially
29    Load,
30    /// Configuration was serialized/saved
31    Save,
32}
33
34/// Severity levels for audit events
35#[derive(Debug, Clone, PartialEq, PartialOrd)]
36pub enum AuditSeverity {
37    /// Informational events (normal operations)
38    Info = 1,
39    /// Warning events (potential issues)
40    Warning = 2,
41    /// Error events (failures)
42    Error = 3,
43    /// Critical events (security concerns)
44    Critical = 4,
45}
46
47/// Comprehensive audit event record
48#[derive(Debug, Clone)]
49pub struct AuditEvent {
50    /// Unique event ID
51    pub id: String,
52    /// Timestamp when the event occurred
53    pub timestamp: SystemTime,
54    /// Type of operation that triggered this event
55    pub event_type: AuditEventType,
56    /// Severity level of the event
57    pub severity: AuditSeverity,
58    /// Configuration key that was accessed/modified
59    pub key: Option<String>,
60    /// Previous value (for modifications)
61    pub old_value: Option<Value>,
62    /// New value (for modifications)
63    pub new_value: Option<Value>,
64    /// User or system context that triggered the event
65    pub user_context: Option<String>,
66    /// Additional contextual information
67    pub metadata: HashMap<String, String>,
68    /// Error message (for failures)
69    pub error_message: Option<String>,
70    /// Source location (file path, line number, etc.)
71    pub source: Option<String>,
72}
73
74impl AuditEvent {
75    /// Create a new audit event with minimal required fields
76    pub fn new(event_type: AuditEventType, severity: AuditSeverity) -> Self {
77        Self {
78            id: generate_event_id(),
79            timestamp: SystemTime::now(),
80            event_type,
81            severity,
82            key: None,
83            old_value: None,
84            new_value: None,
85            user_context: None,
86            metadata: HashMap::new(),
87            error_message: None,
88            source: None,
89        }
90    }
91
92    /// Set the configuration key for this event
93    pub fn with_key(mut self, key: impl Into<String>) -> Self {
94        self.key = Some(key.into());
95        self
96    }
97
98    /// Set the old value (for modifications)
99    pub fn with_old_value(mut self, value: Value) -> Self {
100        self.old_value = Some(value);
101        self
102    }
103
104    /// Set the new value (for modifications)
105    pub fn with_new_value(mut self, value: Value) -> Self {
106        self.new_value = Some(value);
107        self
108    }
109
110    /// Set the user context
111    pub fn with_user_context(mut self, context: impl Into<String>) -> Self {
112        self.user_context = Some(context.into());
113        self
114    }
115
116    /// Add metadata key-value pair
117    pub fn with_metadata(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
118        self.metadata.insert(key.into(), value.into());
119        self
120    }
121
122    /// Set error message
123    pub fn with_error(mut self, message: impl Into<String>) -> Self {
124        self.error_message = Some(message.into());
125        self
126    }
127
128    /// Set source location
129    pub fn with_source(mut self, source: impl Into<String>) -> Self {
130        self.source = Some(source.into());
131        self
132    }
133}
134
135impl fmt::Display for AuditEvent {
136    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
137        let timestamp_millis = self
138            .timestamp
139            .duration_since(UNIX_EPOCH)
140            .unwrap_or_default()
141            .as_millis();
142
143        write!(
144            f,
145            "[{}] {:?}:{:?} id={} key={} user={}",
146            timestamp_millis,
147            self.event_type,
148            self.severity,
149            self.id,
150            self.key.as_deref().unwrap_or("none"),
151            self.user_context.as_deref().unwrap_or("system")
152        )?;
153
154        if let Some(error) = &self.error_message {
155            write!(f, " error=\"{error}\"")?;
156        }
157
158        if let (Some(old), Some(new)) = (&self.old_value, &self.new_value) {
159            write!(f, " change=\"{old:?}\" -> \"{new:?}\"")?;
160        }
161
162        for (key, value) in &self.metadata {
163            write!(f, " {key}=\"{value}\"")?;
164        }
165
166        Ok(())
167    }
168}
169
170/// Trait for audit log outputs/sinks
171pub trait AuditSink: Send + Sync {
172    /// Write an audit event to this sink
173    fn write_event(&self, event: &AuditEvent) -> Result<(), String>;
174
175    /// Flush any buffered events
176    fn flush(&self) -> Result<(), String>;
177}
178
179/// Console/stdout audit sink for development
180pub struct ConsoleSink {
181    level_filter: AuditSeverity,
182}
183
184impl ConsoleSink {
185    /// Create a new console sink with minimum severity level
186    pub fn new(min_level: AuditSeverity) -> Self {
187        Self {
188            level_filter: min_level,
189        }
190    }
191}
192
193impl AuditSink for ConsoleSink {
194    fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
195        if event.severity >= self.level_filter {
196            println!("AUDIT: {event}");
197        }
198        Ok(())
199    }
200
201    fn flush(&self) -> Result<(), String> {
202        Ok(()) // stdout auto-flushes
203    }
204}
205
206/// File-based audit sink for production
207pub struct FileSink {
208    file_path: String,
209    level_filter: AuditSeverity,
210}
211
212impl FileSink {
213    /// Create a new file sink
214    pub fn new(file_path: impl Into<String>, min_level: AuditSeverity) -> Self {
215        Self {
216            file_path: file_path.into(),
217            level_filter: min_level,
218        }
219    }
220}
221
222impl AuditSink for FileSink {
223    fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
224        if event.severity >= self.level_filter {
225            use std::fs::OpenOptions;
226            use std::io::Write;
227
228            let mut file = OpenOptions::new()
229                .create(true)
230                .append(true)
231                .open(&self.file_path)
232                .map_err(|e| format!("Failed to open audit log file: {e}"))?;
233
234            writeln!(file, "{event}").map_err(|e| format!("Failed to write to audit log: {e}"))?;
235        }
236        Ok(())
237    }
238
239    fn flush(&self) -> Result<(), String> {
240        // For append-only files, OS handles flushing
241        Ok(())
242    }
243}
244
245/// Main audit logger with multiple sinks
246pub struct AuditLogger {
247    sinks: Vec<Box<dyn AuditSink>>,
248    enabled: bool,
249}
250
251impl AuditLogger {
252    /// Create a new audit logger
253    pub fn new() -> Self {
254        Self {
255            sinks: Vec::new(),
256            enabled: true,
257        }
258    }
259
260    /// Add a sink to the logger
261    pub fn add_sink(mut self, sink: Box<dyn AuditSink>) -> Self {
262        self.sinks.push(sink);
263        self
264    }
265
266    /// Enable or disable audit logging
267    pub fn set_enabled(mut self, enabled: bool) -> Self {
268        self.enabled = enabled;
269        self
270    }
271
272    /// Log an audit event to all configured sinks
273    pub fn log_event(&self, event: AuditEvent) {
274        if !self.enabled {
275            return;
276        }
277
278        for sink in &self.sinks {
279            if let Err(e) = sink.write_event(&event) {
280                eprintln!("Audit sink error: {e}");
281            }
282        }
283    }
284
285    /// Log a configuration access event
286    pub fn log_access(&self, key: &str, user_context: Option<&str>) {
287        let event = AuditEvent::new(AuditEventType::Access, AuditSeverity::Info)
288            .with_key(key)
289            .with_metadata("operation", "get");
290
291        let event = if let Some(user) = user_context {
292            event.with_user_context(user)
293        } else {
294            event
295        };
296
297        self.log_event(event);
298    }
299
300    /// Log a configuration modification event
301    pub fn log_modification(
302        &self,
303        key: &str,
304        old_value: Option<&Value>,
305        new_value: &Value,
306        user_context: Option<&str>,
307    ) {
308        let mut event = AuditEvent::new(AuditEventType::Modification, AuditSeverity::Warning)
309            .with_key(key)
310            .with_new_value(new_value.clone())
311            .with_metadata("operation", "set");
312
313        if let Some(old) = old_value {
314            event = event.with_old_value(old.clone());
315        }
316
317        if let Some(user) = user_context {
318            event = event.with_user_context(user);
319        }
320
321        self.log_event(event);
322    }
323
324    /// Log a validation failure event
325    pub fn log_validation_failure(
326        &self,
327        key: &str,
328        error: &str,
329        value: &Value,
330        user_context: Option<&str>,
331    ) {
332        let event = AuditEvent::new(AuditEventType::ValidationFailure, AuditSeverity::Error)
333            .with_key(key)
334            .with_new_value(value.clone())
335            .with_error(error)
336            .with_metadata("operation", "validate");
337
338        let event = if let Some(user) = user_context {
339            event.with_user_context(user)
340        } else {
341            event
342        };
343
344        self.log_event(event);
345    }
346
347    /// Log a configuration reload event
348    pub fn log_reload(&self, source: &str, success: bool, error: Option<&str>) {
349        let severity = if success {
350            AuditSeverity::Info
351        } else {
352            AuditSeverity::Error
353        };
354        let mut event = AuditEvent::new(AuditEventType::Reload, severity)
355            .with_source(source)
356            .with_metadata("operation", "reload");
357
358        if let Some(err) = error {
359            event = event.with_error(err);
360        }
361
362        self.log_event(event);
363    }
364
365    /// Flush all sinks
366    pub fn flush(&self) {
367        for sink in &self.sinks {
368            if let Err(e) = sink.flush() {
369                eprintln!("Audit sink flush error: {e}");
370            }
371        }
372    }
373}
374
375impl Default for AuditLogger {
376    fn default() -> Self {
377        Self::new()
378    }
379}
380
381/// Thread-safe global audit logger
382static GLOBAL_AUDIT_LOGGER: Mutex<Option<Arc<AuditLogger>>> = Mutex::new(None);
383
384/// Initialize the global audit logger
385pub fn init_audit_logger(logger: AuditLogger) {
386    let mut global = GLOBAL_AUDIT_LOGGER.lock().unwrap();
387    *global = Some(Arc::new(logger));
388}
389
390/// Get the global audit logger
391pub fn get_audit_logger() -> Option<Arc<AuditLogger>> {
392    GLOBAL_AUDIT_LOGGER.lock().unwrap().clone()
393}
394
395/// Log an event using the global audit logger
396pub fn audit_log(event: AuditEvent) {
397    if let Some(logger) = get_audit_logger() {
398        logger.log_event(event);
399    }
400}
401
402/// Generate a unique event ID
403fn generate_event_id() -> String {
404    use std::sync::atomic::{AtomicU64, Ordering};
405    static COUNTER: AtomicU64 = AtomicU64::new(1);
406
407    let timestamp = SystemTime::now()
408        .duration_since(UNIX_EPOCH)
409        .unwrap_or_default()
410        .as_secs();
411    let counter = COUNTER.fetch_add(1, Ordering::Relaxed);
412
413    format!("{timestamp:x}-{counter:x}")
414}
415
416#[cfg(test)]
417mod tests {
418    use super::*;
419    use std::sync::{Arc, Mutex};
420
421    struct TestSink {
422        events: Arc<Mutex<Vec<AuditEvent>>>,
423    }
424
425    impl TestSink {
426        fn new() -> (Self, Arc<Mutex<Vec<AuditEvent>>>) {
427            let events = Arc::new(Mutex::new(Vec::new()));
428            (
429                Self {
430                    events: Arc::clone(&events),
431                },
432                events,
433            )
434        }
435    }
436
437    impl AuditSink for TestSink {
438        fn write_event(&self, event: &AuditEvent) -> Result<(), String> {
439            self.events.lock().unwrap().push(event.clone());
440            Ok(())
441        }
442
443        fn flush(&self) -> Result<(), String> {
444            Ok(())
445        }
446    }
447
448    #[test]
449    fn test_audit_event_creation() {
450        let event = AuditEvent::new(AuditEventType::Access, AuditSeverity::Info)
451            .with_key("test.key")
452            .with_user_context("test_user")
453            .with_metadata("operation", "get");
454
455        assert_eq!(event.event_type, AuditEventType::Access);
456        assert_eq!(event.severity, AuditSeverity::Info);
457        assert_eq!(event.key, Some("test.key".to_string()));
458        assert_eq!(event.user_context, Some("test_user".to_string()));
459        assert_eq!(event.metadata.get("operation"), Some(&"get".to_string()));
460    }
461
462    #[test]
463    fn test_audit_logger_basic() {
464        let (sink, events) = TestSink::new();
465        let logger = AuditLogger::new().add_sink(Box::new(sink));
466
467        logger.log_access("test.key", Some("test_user"));
468        logger.log_modification(
469            "test.key",
470            None,
471            &Value::String("new_value".to_string()),
472            Some("test_user"),
473        );
474
475        let events = events.lock().unwrap();
476        assert_eq!(events.len(), 2);
477
478        assert_eq!(events[0].event_type, AuditEventType::Access);
479        assert_eq!(events[0].key, Some("test.key".to_string()));
480
481        assert_eq!(events[1].event_type, AuditEventType::Modification);
482        assert_eq!(events[1].key, Some("test.key".to_string()));
483    }
484
485    #[test]
486    fn test_console_sink() {
487        let sink = ConsoleSink::new(AuditSeverity::Info);
488        let event =
489            AuditEvent::new(AuditEventType::Access, AuditSeverity::Info).with_key("test.key");
490
491        // This should not panic
492        assert!(sink.write_event(&event).is_ok());
493    }
494
495    #[test]
496    fn test_event_display() {
497        let event = AuditEvent::new(AuditEventType::Modification, AuditSeverity::Warning)
498            .with_key("test.key")
499            .with_user_context("test_user")
500            .with_old_value(Value::String("old".to_string()))
501            .with_new_value(Value::String("new".to_string()))
502            .with_metadata("operation", "set");
503
504        let display = format!("{event}");
505        assert!(display.contains("Modification"));
506        assert!(display.contains("Warning"));
507        assert!(display.contains("test.key"));
508        assert!(display.contains("test_user"));
509    }
510
511    #[test]
512    fn test_severity_filtering() {
513        let (sink, events) = TestSink::new();
514        let logger = AuditLogger::new().add_sink(Box::new(sink));
515
516        // Log events of different severities
517        logger.log_event(AuditEvent::new(AuditEventType::Access, AuditSeverity::Info));
518        logger.log_event(AuditEvent::new(
519            AuditEventType::ValidationFailure,
520            AuditSeverity::Error,
521        ));
522
523        let events = events.lock().unwrap();
524        assert_eq!(events.len(), 2);
525        assert_eq!(events[0].severity, AuditSeverity::Info);
526        assert_eq!(events[1].severity, AuditSeverity::Error);
527    }
528}
config_lib/audit.rs

config_lib/
audit.rs
