copybook-core 0.4.3

Core COBOL copybook parser, schema, and validation primitives.
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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Audit Logger Framework
//!
//! Provides structured logging and audit trail management with cryptographic
//! integrity, enterprise format integration, and automated retention policies.

use serde::{Deserialize, Serialize};
use std::collections::VecDeque;
use std::fs::{File, OpenOptions};
use std::io::{BufWriter, Write};
use std::path::{Path, PathBuf};
use std::sync::{Arc, Mutex};

use super::{AuditError, AuditEvent, AuditResult, validate_audit_chain};

/// Enterprise audit logger with cryptographic integrity and retention management
pub struct AuditLogger {
    config: AuditLoggerConfig,
    event_buffer: Arc<Mutex<VecDeque<AuditEvent>>>,
    file_writer: Option<Arc<Mutex<BufWriter<File>>>>,
}

impl AuditLogger {
    /// Create a new audit logger with configuration
    pub fn new(config: AuditLoggerConfig) -> AuditResult<Self> {
        let file_writer = if let Some(ref log_file) = config.log_file_path {
            let file = OpenOptions::new()
                .create(true)
                .append(true)
                .open(log_file)?;
            Some(Arc::new(Mutex::new(BufWriter::new(file))))
        } else {
            None
        };

        Ok(Self {
            config,
            event_buffer: Arc::new(Mutex::new(VecDeque::new())),
            file_writer,
        })
    }

    /// Log an audit event with integrity chain validation
    pub fn log_event(&self, mut event: AuditEvent) -> AuditResult<()> {
        // Get the previous event hash for chain integrity
        if let Some(previous_hash) = self.get_last_event_hash()? {
            event = event.with_previous_hash(previous_hash);
        }

        // Add to buffer
        {
            let mut buffer = self
                .event_buffer
                .lock()
                .map_err(|_| AuditError::Configuration {
                    message: "Failed to acquire buffer lock".to_string(),
                })?;

            buffer.push_back(event.clone());

            // Enforce buffer size limit
            while buffer.len() > self.config.buffer_size {
                buffer.pop_front();
            }
        }

        // Write to file if configured
        if let Some(ref writer) = self.file_writer {
            self.write_event_to_file(writer, &event)?;
        }

        // Send to external systems if configured
        if !self.config.external_endpoints.is_empty() {
            self.send_to_external_systems(&event)?;
        }

        Ok(())
    }

    /// Get the last event hash for chain integrity
    fn get_last_event_hash(&self) -> AuditResult<Option<String>> {
        let buffer = self
            .event_buffer
            .lock()
            .map_err(|_| AuditError::Configuration {
                message: "Failed to acquire buffer lock".to_string(),
            })?;

        Ok(buffer.back().map(|event| event.integrity_hash.clone()))
    }

    /// Write event to log file
    fn write_event_to_file(
        &self,
        writer: &Arc<Mutex<BufWriter<File>>>,
        event: &AuditEvent,
    ) -> AuditResult<()> {
        let formatted_event = match self.config.format {
            LogFormat::Json => serde_json::to_string(event)?,
            LogFormat::JsonLines => format!("{}\n", serde_json::to_string(event)?),
            LogFormat::CEF => self.format_as_cef(event)?,
            LogFormat::Syslog => self.format_as_syslog(event)?,
        };

        let mut file_writer = writer.lock().map_err(|_| AuditError::Configuration {
            message: "Failed to acquire file writer lock".to_string(),
        })?;

        file_writer.write_all(formatted_event.as_bytes())?;
        file_writer.flush()?;

        Ok(())
    }

    /// Format event as Common Event Format (CEF) for SIEM integration
    fn format_as_cef(&self, event: &AuditEvent) -> AuditResult<String> {
        // CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Device Event Class ID|Name|Severity|[Extension]
        let event_class_id = format!("{:?}", event.event_type);
        let event_name = match &event.payload {
            super::AuditPayload::SecurityEvent { .. } => "SecurityEvent",
            super::AuditPayload::ComplianceCheck { .. } => "ComplianceEvent",
            super::AuditPayload::PerformanceMeasurement { .. } => "PerformanceEvent",
            super::AuditPayload::CopybookParse { .. } => "CopybookEvent",
            super::AuditPayload::DataValidation { .. } => "ValidationEvent",
            super::AuditPayload::DataTransformation { .. } => "TransformationEvent",
            super::AuditPayload::LineageTracking { .. } => "LineageEvent",
            super::AuditPayload::ErrorEvent { .. } => "ErrorEvent",
            super::AuditPayload::AccessEvent { .. } => "AccessEvent",
            super::AuditPayload::ConfigurationChange { .. } => "ConfigurationEvent",
        };

        let cef_event = format!(
            "CEF:0|copybook-rs|Enterprise Audit|{}|{}|{}|{}|src={} cs1Label=Operation cs1={} cs2Label=Context cs2={} cn1Label=Severity cn1={}\n",
            env!("CARGO_PKG_VERSION"),
            event_class_id,
            event_name,
            self.map_severity_to_cef(event.severity),
            event.source,
            event.context.operation_id,
            serde_json::to_string(&event.context).unwrap_or_default(),
            event.severity as u32,
        );

        Ok(cef_event)
    }

    /// Format event as Syslog format
    fn format_as_syslog(&self, event: &AuditEvent) -> AuditResult<String> {
        // RFC5424 Syslog format
        let priority = self.map_severity_to_syslog_priority(event.severity);
        let hostname = &event.context.environment.hostname;
        let app_name = "copybook-audit";
        let process_id = event.context.environment.process_id;

        let syslog_event = format!(
            "<{}>{} {} {} {} - - {}\n",
            priority,
            event.timestamp,
            hostname,
            app_name,
            process_id,
            serde_json::to_string(event)?,
        );

        Ok(syslog_event)
    }

    /// Map audit severity to CEF severity
    fn map_severity_to_cef(&self, severity: super::event::AuditSeverity) -> u32 {
        match severity {
            super::event::AuditSeverity::Info => 2,
            super::event::AuditSeverity::Low => 3,
            super::event::AuditSeverity::Medium => 6,
            super::event::AuditSeverity::High => 8,
            super::event::AuditSeverity::Critical => 10,
        }
    }

    /// Map audit severity to Syslog priority
    fn map_severity_to_syslog_priority(&self, severity: super::event::AuditSeverity) -> u32 {
        // Facility 16 (local0) + Severity
        let facility = 16 * 8; // local0 = 16, shifted left 3 bits
        let sev = match severity {
            super::event::AuditSeverity::Info => 6,     // info
            super::event::AuditSeverity::Low => 5,      // notice
            super::event::AuditSeverity::Medium => 4,   // warning
            super::event::AuditSeverity::High => 3,     // err
            super::event::AuditSeverity::Critical => 2, // crit
        };

        facility + sev
    }

    /// Send audit events to external systems
    fn send_to_external_systems(&self, event: &AuditEvent) -> AuditResult<()> {
        for endpoint in &self.config.external_endpoints {
            if let Err(e) = self.send_to_endpoint(endpoint, event) {
                eprintln!("Failed to send audit event to {:?}: {}", endpoint, e);
                // Continue with other endpoints rather than failing entirely
            }
        }
        Ok(())
    }

    /// Send audit event to specific endpoint
    fn send_to_endpoint(&self, endpoint: &ExternalEndpoint, event: &AuditEvent) -> AuditResult<()> {
        match endpoint {
            ExternalEndpoint::Http { url, headers } => self.send_http(url, headers, event),
            ExternalEndpoint::Syslog { host, port } => self.send_syslog(host, *port, event),
            ExternalEndpoint::Kafka { brokers, topic } => self.send_kafka(brokers, topic, event),
        }
    }

    /// Send audit event via HTTP
    fn send_http(
        &self,
        url: &str,
        _headers: &std::collections::HashMap<String, String>,
        event: &AuditEvent,
    ) -> AuditResult<()> {
        // HTTP client implementation would go here
        // For now, just log the attempt
        println!(
            "Would send audit event {} to HTTP endpoint {}",
            event.event_id, url
        );
        Ok(())
    }

    /// Send audit event via Syslog
    fn send_syslog(&self, host: &str, port: u16, event: &AuditEvent) -> AuditResult<()> {
        // Syslog client implementation would go here
        println!(
            "Would send audit event {} to Syslog {}:{}",
            event.event_id, host, port
        );
        Ok(())
    }

    /// Send audit event via Kafka
    fn send_kafka(&self, brokers: &[String], topic: &str, event: &AuditEvent) -> AuditResult<()> {
        // Kafka client implementation would go here
        println!(
            "Would send audit event {} to Kafka topic {} via brokers {:?}",
            event.event_id, topic, brokers
        );
        Ok(())
    }

    /// Validate audit trail integrity
    pub fn validate_integrity(&self) -> AuditResult<bool> {
        let buffer = self
            .event_buffer
            .lock()
            .map_err(|_| AuditError::Configuration {
                message: "Failed to acquire buffer lock".to_string(),
            })?;

        let events: Vec<AuditEvent> = buffer.iter().cloned().collect();
        validate_audit_chain(&events)
    }

    /// Get audit events within time range
    pub fn get_events_in_range(
        &self,
        start_time: chrono::DateTime<chrono::Utc>,
        end_time: chrono::DateTime<chrono::Utc>,
    ) -> AuditResult<Vec<AuditEvent>> {
        let buffer = self
            .event_buffer
            .lock()
            .map_err(|_| AuditError::Configuration {
                message: "Failed to acquire buffer lock".to_string(),
            })?;

        let events = buffer
            .iter()
            .filter(|event| {
                if let Ok(event_time) = chrono::DateTime::parse_from_rfc3339(&event.timestamp) {
                    let event_utc = event_time.with_timezone(&chrono::Utc);
                    event_utc >= start_time && event_utc <= end_time
                } else {
                    false
                }
            })
            .cloned()
            .collect();

        Ok(events)
    }

    /// Perform log rotation based on retention policy
    pub fn rotate_logs(&self) -> AuditResult<()> {
        if let Some(ref retention) = self.config.retention_policy {
            self.enforce_retention_policy(retention)?;
        }

        if let Some(ref log_file) = self.config.log_file_path {
            self.rotate_log_file(log_file)?;
        }

        Ok(())
    }

    /// Enforce retention policy
    fn enforce_retention_policy(&self, retention: &RetentionPolicy) -> AuditResult<()> {
        let cutoff_time =
            chrono::Utc::now() - chrono::Duration::days(retention.retention_days as i64);

        let mut buffer = self
            .event_buffer
            .lock()
            .map_err(|_| AuditError::Configuration {
                message: "Failed to acquire buffer lock".to_string(),
            })?;

        // Remove events older than retention period
        buffer.retain(|event| {
            if let Ok(event_time) = chrono::DateTime::parse_from_rfc3339(&event.timestamp) {
                event_time.with_timezone(&chrono::Utc) >= cutoff_time
            } else {
                true // Keep events with invalid timestamps for manual review
            }
        });

        Ok(())
    }

    /// Rotate log file
    fn rotate_log_file(&self, log_file: &Path) -> AuditResult<()> {
        // Simple rotation: rename current file with timestamp suffix
        let timestamp = chrono::Utc::now().format("%Y%m%d_%H%M%S");
        let rotated_name = format!("{}.{}", log_file.display(), timestamp);

        if log_file.exists() {
            std::fs::rename(log_file, &rotated_name)?;
        }

        // Recreate the log file
        if let Some(ref writer) = self.file_writer {
            let new_file = File::create(log_file)?;
            let mut writer_guard = writer.lock().map_err(|_| AuditError::Configuration {
                message: "Failed to acquire file writer lock".to_string(),
            })?;
            *writer_guard = BufWriter::new(new_file);
        }

        Ok(())
    }
}

/// Audit logger configuration
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AuditLoggerConfig {
    /// Log file path (None for memory-only logging)
    pub log_file_path: Option<PathBuf>,

    /// Log format for output
    pub format: LogFormat,

    /// Buffer size for in-memory events
    pub buffer_size: usize,

    /// Retention policy for log rotation
    pub retention_policy: Option<RetentionPolicy>,

    /// External endpoints for audit event forwarding
    pub external_endpoints: Vec<ExternalEndpoint>,

    /// Enable real-time event forwarding
    pub real_time_forwarding: bool,

    /// Batch size for event forwarding
    pub batch_size: usize,

    /// Flush interval in seconds
    pub flush_interval_seconds: u64,
}

impl Default for AuditLoggerConfig {
    fn default() -> Self {
        Self {
            log_file_path: Some(PathBuf::from("audit.jsonl")),
            format: LogFormat::JsonLines,
            buffer_size: 10000,
            retention_policy: Some(RetentionPolicy::default()),
            external_endpoints: Vec::new(),
            real_time_forwarding: false,
            batch_size: 100,
            flush_interval_seconds: 60,
        }
    }
}

/// Log output formats
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub enum LogFormat {
    /// Standard JSON format
    Json,
    /// JSON Lines format (one JSON object per line)
    JsonLines,
    /// Common Event Format (CEF) for SIEM integration
    CEF,
    /// Syslog format (RFC5424)
    Syslog,
}

/// Log retention policy
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RetentionPolicy {
    /// Number of days to retain audit logs
    pub retention_days: u32,

    /// Maximum log file size in MB before rotation
    pub max_file_size_mb: u64,

    /// Maximum number of rotated files to keep
    pub max_rotated_files: u32,

    /// Compress rotated files
    pub compress_rotated: bool,

    /// Archive location for long-term storage
    pub archive_path: Option<PathBuf>,
}

impl Default for RetentionPolicy {
    fn default() -> Self {
        Self {
            retention_days: 2555, // 7 years for SOX compliance
            max_file_size_mb: 100,
            max_rotated_files: 50,
            compress_rotated: true,
            archive_path: None,
        }
    }
}

/// External endpoints for audit event forwarding
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ExternalEndpoint {
    /// HTTP endpoint for webhook-style audit event delivery
    Http {
        /// Target URL for HTTP POST requests
        url: String,
        /// Custom HTTP headers to include with each request
        headers: std::collections::HashMap<String, String>,
    },
    /// Syslog endpoint for RFC5424-compatible log forwarding
    Syslog {
        /// Syslog server hostname or IP address
        host: String,
        /// Syslog server port number
        port: u16,
    },
    /// Kafka endpoint for streaming audit event ingestion
    Kafka {
        /// List of Kafka broker addresses
        brokers: Vec<String>,
        /// Kafka topic name for audit events
        topic: String,
    },
}

#[cfg(test)]
#[allow(clippy::expect_used)]
mod tests {
    use super::*;
    use crate::audit::event::{ParseResult, SecurityEventType};
    use crate::audit::{AuditContext, AuditEvent, AuditEventType, AuditPayload};
    use tempfile::tempdir;

    #[tokio::test]
    async fn test_audit_logger_creation() {
        let config = AuditLoggerConfig::default();
        let logger = AuditLogger::new(config).expect("Failed to create audit logger");

        // Should be able to create logger with default config
        assert!(
            logger
                .event_buffer
                .lock()
                .expect("Lock should work")
                .is_empty()
        );
    }

    #[tokio::test]
    async fn test_event_logging() {
        let dir = tempdir().expect("Failed to create temp directory");
        let log_path = dir.path().join("test_audit.jsonl");

        let config = AuditLoggerConfig {
            log_file_path: Some(log_path.clone()),
            format: LogFormat::JsonLines,
            buffer_size: 100,
            ..Default::default()
        };

        let logger = AuditLogger::new(config).expect("Failed to create audit logger");

        // Create a test audit event
        let context = AuditContext::new();
        let payload = AuditPayload::CopybookParse {
            copybook_path: "test.cpy".to_string(),
            schema_fingerprint: "abc123".to_string(),
            parse_result: ParseResult::Success,
            parsing_duration_ms: 100,
            field_count: 10,
            level_88_count: 2,
            error_count: 0,
            warnings: vec![],
        };

        let event = AuditEvent::new(AuditEventType::CopybookParse, context, payload);

        // Log the event
        logger.log_event(event).expect("Failed to log event");

        // Verify event was buffered
        let buffer = logger.event_buffer.lock().expect("Lock should work");
        assert_eq!(buffer.len(), 1);

        // Verify event was written to file
        assert!(log_path.exists());
        let file_content = std::fs::read_to_string(&log_path).expect("Failed to read log file");
        assert!(file_content.contains("CopybookParse"));
    }

    #[tokio::test]
    async fn test_integrity_validation() {
        let config = AuditLoggerConfig::default();
        let logger = AuditLogger::new(config).expect("Failed to create audit logger");

        // Add multiple events to establish chain
        let context = AuditContext::new();

        for i in 0..3 {
            let payload = AuditPayload::CopybookParse {
                copybook_path: format!("test{}.cpy", i),
                schema_fingerprint: format!("abc{}", i),
                parse_result: ParseResult::Success,
                parsing_duration_ms: 100,
                field_count: 10,
                level_88_count: 2,
                error_count: 0,
                warnings: vec![],
            };

            let event = AuditEvent::new(AuditEventType::CopybookParse, context.clone(), payload);

            logger.log_event(event).expect("Failed to log event");
        }

        // Validate chain integrity
        let is_valid = logger
            .validate_integrity()
            .expect("Failed to validate integrity");
        assert!(is_valid);
    }

    #[test]
    fn test_cef_formatting() {
        let config = AuditLoggerConfig {
            format: LogFormat::CEF,
            ..Default::default()
        };

        let logger = AuditLogger::new(config).expect("Failed to create audit logger");

        let context = AuditContext::new();
        let payload = AuditPayload::SecurityEvent {
            security_event_type: SecurityEventType::UnauthorizedAccess,
            severity: "High".to_string(),
            affected_resources: vec!["customer_data".to_string()],
            threat_indicators: vec![],
            remediation_actions: vec![],
            incident_id: Some("INC-001".to_string()),
        };

        let event = AuditEvent::new(AuditEventType::SecurityEvent, context, payload);

        let cef_format = logger
            .format_as_cef(&event)
            .expect("Failed to format as CEF");
        assert!(cef_format.starts_with("CEF:0|copybook-rs|Enterprise Audit|"));
        assert!(cef_format.contains("SecurityEvent"));
    }

    #[test]
    fn test_retention_policy_default() {
        let policy = RetentionPolicy::default();
        assert_eq!(policy.retention_days, 2555); // 7 years for SOX compliance
        assert!(policy.compress_rotated);
        assert_eq!(policy.max_rotated_files, 50);
    }
}