rust-threat-detector 2.0.0

Advanced memory-safe SIEM threat detection with ML-based scoring, automated incident response, and threat hunting capabilities
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
//! # SIEM Export Formats
//!
//! Provides multiple export formats for integration with various SIEM platforms.
//! Supports CEF, LEEF, JSON, Syslog, and CSV formats.

use crate::{ThreatAlert, ThreatSeverity};
use chrono::{DateTime, Utc};
use serde::Serialize;

/// SIEM export format types
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SIEMFormat {
    /// Common Event Format (ArcSight)
    CEF,
    /// Log Event Extended Format (QRadar)
    LEEF,
    /// JSON format (Splunk, Elasticsearch)
    JSON,
    /// Syslog RFC 5424
    Syslog,
    /// CSV for reporting
    CSV,
}

/// SIEM export configuration
#[derive(Debug, Clone)]
pub struct SIEMExporter {
    vendor: String,
    product: String,
    version: String,
    device_hostname: String,
}

impl SIEMExporter {
    /// Create new SIEM exporter with configuration
    pub fn new(vendor: String, product: String, version: String, device_hostname: String) -> Self {
        Self {
            vendor,
            product,
            version,
            device_hostname,
        }
    }

    /// Create default exporter
    pub fn new_default() -> Self {
        Self {
            vendor: "GuardsArm".to_string(),
            product: "RustThreatDetector".to_string(),
            version: "1.0".to_string(),
            device_hostname: hostname::get()
                .unwrap_or_default()
                .to_string_lossy()
                .to_string(),
        }
    }

    /// Export alert to specified format
    pub fn export(&self, alert: &ThreatAlert, format: SIEMFormat) -> String {
        match format {
            SIEMFormat::CEF => self.to_cef(alert),
            SIEMFormat::LEEF => self.to_leef(alert),
            SIEMFormat::JSON => self.to_json(alert),
            SIEMFormat::Syslog => self.to_syslog(alert),
            SIEMFormat::CSV => self.to_csv(alert),
        }
    }

    /// Export multiple alerts to specified format
    pub fn export_batch(&self, alerts: &[ThreatAlert], format: SIEMFormat) -> Vec<String> {
        alerts
            .iter()
            .map(|alert| self.export(alert, format))
            .collect()
    }

    /// Convert alert to CEF (Common Event Format)
    /// Format: CEF:Version|Device Vendor|Device Product|Device Version|Signature ID|Name|Severity|Extension
    fn to_cef(&self, alert: &ThreatAlert) -> String {
        let severity = self.severity_to_cef_level(alert.severity);
        let name = self.escape_cef(&alert.description);
        let signature_id = format!("{:?}", alert.category);

        let mut extensions = Vec::new();
        extensions.push(format!(
            "act={}",
            self.escape_cef(&alert.recommended_action)
        ));
        extensions.push("cs1Label=ThreatScore".to_string());
        extensions.push(format!("cs1={}", alert.threat_score));
        extensions.push("cs2Label=AlertID".to_string());
        extensions.push(format!("cs2={}", alert.alert_id));
        extensions.push("cs3Label=SourceLog".to_string());
        extensions.push(format!("cs3={}", self.escape_cef(&alert.source_log)));

        if !alert.indicators.is_empty() {
            extensions.push("cs4Label=Indicators".to_string());
            extensions.push(format!(
                "cs4={}",
                self.escape_cef(&alert.indicators.join(", "))
            ));
        }

        if !alert.correlated_alerts.is_empty() {
            extensions.push("cs5Label=CorrelatedAlerts".to_string());
            extensions.push(format!("cs5={}", alert.correlated_alerts.len()));
        }

        format!(
            "CEF:0|{}|{}|{}|{}|{}|{}|{}",
            self.vendor,
            self.product,
            self.version,
            signature_id,
            name,
            severity,
            extensions.join(" ")
        )
    }

    /// Convert alert to LEEF (Log Event Extended Format)
    /// Format: LEEF:Version|Vendor|Product|Version|EventID|Delimiter|Key-Value Pairs
    fn to_leef(&self, alert: &ThreatAlert) -> String {
        let event_id = format!("{:?}", alert.category);
        let delimiter = "\t";

        let mut fields = Vec::new();
        fields.push(format!("devTime={}", alert.timestamp.timestamp()));
        fields.push("devTimeFormat=epoch".to_string());
        fields.push(format!(
            "sev={}",
            self.severity_to_leef_level(alert.severity)
        ));
        fields.push(format!("cat={:?}", alert.category));
        fields.push(format!("desc={}", self.escape_leef(&alert.description)));
        fields.push(format!("threatScore={}", alert.threat_score));
        fields.push(format!("alertId={}", alert.alert_id));
        fields.push(format!(
            "recommendedAction={}",
            self.escape_leef(&alert.recommended_action)
        ));
        fields.push(format!("sourceLog={}", self.escape_leef(&alert.source_log)));

        if !alert.indicators.is_empty() {
            fields.push(format!(
                "indicators={}",
                self.escape_leef(&alert.indicators.join(", "))
            ));
        }

        format!(
            "LEEF:2.0|{}|{}|{}|{}|{}{}",
            self.vendor,
            self.product,
            self.version,
            event_id,
            delimiter,
            fields.join(delimiter)
        )
    }

    /// Convert alert to JSON (for Splunk, Elasticsearch)
    fn to_json(&self, alert: &ThreatAlert) -> String {
        #[derive(Serialize)]
        struct JSONAlert<'a> {
            timestamp: DateTime<Utc>,
            alert_id: &'a str,
            severity: &'a str,
            severity_level: u8,
            category: String,
            description: &'a str,
            threat_score: u32,
            risk_assessment: &'a str,
            source_log: &'a str,
            indicators: &'a [String],
            recommended_action: &'a str,
            correlated_alerts: &'a [String],
            correlated_count: usize,
            vendor: &'a str,
            product: &'a str,
            version: &'a str,
            device_hostname: &'a str,
        }

        let json_alert = JSONAlert {
            timestamp: alert.timestamp,
            alert_id: &alert.alert_id,
            severity: &format!("{:?}", alert.severity),
            severity_level: self.severity_to_numeric(alert.severity),
            category: format!("{:?}", alert.category),
            description: &alert.description,
            threat_score: alert.threat_score,
            risk_assessment: alert.risk_assessment(),
            source_log: &alert.source_log,
            indicators: &alert.indicators,
            recommended_action: &alert.recommended_action,
            correlated_alerts: &alert.correlated_alerts,
            correlated_count: alert.correlated_alerts.len(),
            vendor: &self.vendor,
            product: &self.product,
            version: &self.version,
            device_hostname: &self.device_hostname,
        };

        serde_json::to_string(&json_alert).unwrap_or_default()
    }

    /// Convert alert to Syslog (RFC 5424)
    /// Format: <Priority>Version Timestamp Hostname App-Name ProcID MsgID SD Message
    fn to_syslog(&self, alert: &ThreatAlert) -> String {
        let priority = self.severity_to_syslog_priority(alert.severity);
        let timestamp = alert.timestamp.to_rfc3339();
        let app_name = &self.product;
        let proc_id = std::process::id();
        let msg_id = &alert.alert_id;

        // Structured data
        let sd = format!(
            "[threat@32473 category=\"{:?}\" severity=\"{:?}\" score=\"{}\" indicators=\"{}\"]",
            alert.category,
            alert.severity,
            alert.threat_score,
            alert.indicators.len()
        );

        let message = format!(
            "{} | {} | Action: {}",
            alert.description, alert.source_log, alert.recommended_action
        );

        format!(
            "<{}>1 {} {} {} {} {} {} {}",
            priority, timestamp, self.device_hostname, app_name, proc_id, msg_id, sd, message
        )
    }

    /// Convert alert to CSV format
    fn to_csv(&self, alert: &ThreatAlert) -> String {
        format!(
            "\"{}\",\"{}\",\"{:?}\",\"{:?}\",\"{}\",{},\"{}\",\"{}\",\"{}\",\"{}\"",
            alert.timestamp.to_rfc3339(),
            alert.alert_id,
            alert.severity,
            alert.category,
            self.escape_csv(&alert.description),
            alert.threat_score,
            alert.risk_assessment(),
            self.escape_csv(&alert.indicators.join("; ")),
            self.escape_csv(&alert.recommended_action),
            alert.correlated_alerts.len()
        )
    }

    /// Get CSV header
    pub fn csv_header() -> String {
        "Timestamp,Alert ID,Severity,Category,Description,Threat Score,Risk Assessment,Indicators,Recommended Action,Correlated Count".to_string()
    }

    // Helper methods for severity conversion

    fn severity_to_cef_level(&self, severity: ThreatSeverity) -> u8 {
        match severity {
            ThreatSeverity::Info => 0,
            ThreatSeverity::Low => 3,
            ThreatSeverity::Medium => 5,
            ThreatSeverity::High => 8,
            ThreatSeverity::Critical => 10,
        }
    }

    fn severity_to_leef_level(&self, severity: ThreatSeverity) -> u8 {
        match severity {
            ThreatSeverity::Info => 1,
            ThreatSeverity::Low => 2,
            ThreatSeverity::Medium => 5,
            ThreatSeverity::High => 7,
            ThreatSeverity::Critical => 10,
        }
    }

    fn severity_to_numeric(&self, severity: ThreatSeverity) -> u8 {
        match severity {
            ThreatSeverity::Info => 1,
            ThreatSeverity::Low => 2,
            ThreatSeverity::Medium => 3,
            ThreatSeverity::High => 4,
            ThreatSeverity::Critical => 5,
        }
    }

    fn severity_to_syslog_priority(&self, severity: ThreatSeverity) -> u8 {
        // Facility: Security (13), Severity levels: 0-7
        let facility = 13 << 3;
        let level = match severity {
            ThreatSeverity::Info => 6,     // Informational
            ThreatSeverity::Low => 5,      // Notice
            ThreatSeverity::Medium => 4,   // Warning
            ThreatSeverity::High => 3,     // Error
            ThreatSeverity::Critical => 2, // Critical
        };
        facility | level
    }

    // Escaping methods for different formats

    fn escape_cef(&self, s: &str) -> String {
        s.replace('\\', "\\\\")
            .replace('|', "\\|")
            .replace('=', "\\=")
            .replace('\n', "\\n")
            .replace('\r', "\\r")
    }

    fn escape_leef(&self, s: &str) -> String {
        s.replace('\\', "\\\\")
            .replace('\t', "\\t")
            .replace('\n', "\\n")
            .replace('\r', "\\r")
    }

    fn escape_csv(&self, s: &str) -> String {
        s.replace('"', "\"\"")
    }
}

/// Batch export utility
pub struct BatchExporter {
    exporter: SIEMExporter,
    format: SIEMFormat,
}

impl BatchExporter {
    /// Create new batch exporter
    pub fn new(format: SIEMFormat) -> Self {
        Self {
            exporter: SIEMExporter::new_default(),
            format,
        }
    }

    /// Export alerts and return as concatenated string
    pub fn export(&self, alerts: &[ThreatAlert]) -> String {
        let lines = self.exporter.export_batch(alerts, self.format);

        if self.format == SIEMFormat::CSV {
            let mut result = SIEMExporter::csv_header();
            result.push('\n');
            result.push_str(&lines.join("\n"));
            result
        } else {
            lines.join("\n")
        }
    }

    /// Export to file
    pub fn export_to_file(&self, alerts: &[ThreatAlert], path: &str) -> std::io::Result<()> {
        use std::fs::File;
        use std::io::Write;

        let content = self.export(alerts);
        let mut file = File::create(path)?;
        file.write_all(content.as_bytes())?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{ThreatCategory, ThreatSeverity};

    fn create_test_alert() -> ThreatAlert {
        ThreatAlert {
            alert_id: "ALERT-00001".to_string(),
            timestamp: Utc::now(),
            severity: ThreatSeverity::High,
            category: ThreatCategory::BruteForce,
            description: "Multiple failed login attempts detected".to_string(),
            source_log: "2025-01-15 10:30:45 - Failed login from 192.168.1.100".to_string(),
            indicators: vec!["192.168.1.100".to_string(), "user: admin".to_string()],
            recommended_action: "Block source IP, enable MFA".to_string(),
            threat_score: 75,
            correlated_alerts: vec!["ALERT-00000".to_string()],
        }
    }

    #[test]
    fn test_cef_export() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();
        let cef = exporter.to_cef(&alert);

        assert!(cef.starts_with("CEF:0|"));
        assert!(cef.contains("GuardsArm"));
        assert!(cef.contains("RustThreatDetector"));
        assert!(cef.contains("BruteForce"));
        assert!(cef.contains("cs1=75")); // Threat score
    }

    #[test]
    fn test_leef_export() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();
        let leef = exporter.to_leef(&alert);

        assert!(leef.starts_with("LEEF:2.0|"));
        assert!(leef.contains("GuardsArm"));
        assert!(leef.contains("threatScore=75"));
        assert!(leef.contains("alertId=ALERT-00001"));
    }

    #[test]
    fn test_json_export() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();
        let json = exporter.to_json(&alert);

        assert!(json.contains("\"alert_id\":\"ALERT-00001\""));
        assert!(json.contains("\"threat_score\":75"));
        assert!(json.contains("\"severity\":\"High\""));
        assert!(json.contains("\"category\":\"BruteForce\""));
    }

    #[test]
    fn test_syslog_export() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();
        let syslog = exporter.to_syslog(&alert);

        assert!(syslog.starts_with("<")); // Priority
        assert!(syslog.contains("ALERT-00001"));
        assert!(syslog.contains("[threat@32473"));
        assert!(syslog.contains("category=\"BruteForce\""));
    }

    #[test]
    fn test_csv_export() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();
        let csv = exporter.to_csv(&alert);

        assert!(csv.contains("ALERT-00001"));
        assert!(csv.contains("High"));
        assert!(csv.contains("BruteForce"));
        assert!(csv.contains("75"));
    }

    #[test]
    fn test_csv_header() {
        let header = SIEMExporter::csv_header();
        assert!(header.contains("Timestamp"));
        assert!(header.contains("Alert ID"));
        assert!(header.contains("Severity"));
        assert!(header.contains("Threat Score"));
    }

    #[test]
    fn test_severity_conversions() {
        let exporter = SIEMExporter::new_default();

        assert_eq!(exporter.severity_to_cef_level(ThreatSeverity::Critical), 10);
        assert_eq!(exporter.severity_to_cef_level(ThreatSeverity::Low), 3);

        assert_eq!(
            exporter.severity_to_leef_level(ThreatSeverity::Critical),
            10
        );
        assert_eq!(exporter.severity_to_leef_level(ThreatSeverity::Medium), 5);

        assert_eq!(exporter.severity_to_numeric(ThreatSeverity::Critical), 5);
        assert_eq!(exporter.severity_to_numeric(ThreatSeverity::Info), 1);
    }

    #[test]
    fn test_cef_escaping() {
        let exporter = SIEMExporter::new_default();
        let input = "test|value=with\\special\nchars";
        let escaped = exporter.escape_cef(input);

        assert!(escaped.contains("\\|"));
        assert!(escaped.contains("\\="));
        assert!(escaped.contains("\\\\"));
        assert!(escaped.contains("\\n"));
    }

    #[test]
    fn test_csv_escaping() {
        let exporter = SIEMExporter::new_default();
        let input = "test \"quoted\" value";
        let escaped = exporter.escape_csv(input);

        assert!(escaped.contains("\"\""));
    }

    #[test]
    fn test_batch_export() {
        let exporter = SIEMExporter::new_default();
        let alerts = vec![create_test_alert(), create_test_alert()];
        let batch = exporter.export_batch(&alerts, SIEMFormat::JSON);

        assert_eq!(batch.len(), 2);
        assert!(batch[0].contains("ALERT-00001"));
        assert!(batch[1].contains("ALERT-00001"));
    }

    #[test]
    fn test_batch_exporter() {
        let batch_exporter = BatchExporter::new(SIEMFormat::CSV);
        let alerts = vec![create_test_alert()];
        let output = batch_exporter.export(&alerts);

        assert!(output.contains("Timestamp,Alert ID")); // Header
        assert!(output.contains("ALERT-00001")); // Data
    }

    #[test]
    fn test_all_formats() {
        let exporter = SIEMExporter::new_default();
        let alert = create_test_alert();

        // Test that all formats produce non-empty output
        let formats = vec![
            SIEMFormat::CEF,
            SIEMFormat::LEEF,
            SIEMFormat::JSON,
            SIEMFormat::Syslog,
            SIEMFormat::CSV,
        ];

        for format in formats {
            let output = exporter.export(&alert, format);
            assert!(!output.is_empty());
        }
    }
}