rsigma-eval 0.12.0

Evaluator for Sigma detection and correlation rules — match rules against events
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
mod helpers;

use helpers::{corr_engine, corr_engine_with_config, process};
use rsigma_eval::{CorrelationConfig, CorrelationEventMode, CorrelationSnapshot};
use serde_json::json;

const EVENT_COUNT_YAML: &str = r#"
title: Login
id: login-rule
logsource:
    category: auth
detection:
    selection:
        EventType: login
    condition: selection
---
title: Many Logins
id: many-logins
correlation:
    type: event_count
    rules:
        - login-rule
    group-by:
        - User
    timespan: 300s
    condition:
        gte: 3
level: high
"#;

const VALUE_COUNT_YAML: &str = r#"
title: Login
id: login-rule
logsource:
    category: auth
detection:
    selection:
        EventType: login
    condition: selection
---
title: Many Sources
id: many-sources
correlation:
    type: value_count
    rules:
        - login-rule
    group-by:
        - User
    timespan: 300s
    condition:
        field: SourceIP
        gte: 3
level: high
"#;

const TEMPORAL_YAML: &str = r#"
title: Recon
id: recon-rule
logsource:
    category: network
detection:
    selection:
        EventType: recon
    condition: selection
---
title: Exploit
id: exploit-rule
logsource:
    category: network
detection:
    selection:
        EventType: exploit
    condition: selection
---
title: Recon Then Exploit
id: recon-exploit
correlation:
    type: temporal
    rules:
        - recon-rule
        - exploit-rule
    group-by:
        - Host
    timespan: 120s
    condition:
        gte: 2
level: critical
"#;

fn login_event(user: &str) -> serde_json::Value {
    json!({"EventType": "login", "User": user})
}

fn login_event_with_ip(user: &str, ip: &str) -> serde_json::Value {
    json!({"EventType": "login", "User": user, "SourceIP": ip})
}

// =============================================================================
// Snapshot round-trip serialization
// =============================================================================

#[test]
fn snapshot_empty_engine_exports_empty() {
    let engine = corr_engine(EVENT_COUNT_YAML);
    let snapshot = engine.export_state();
    assert!(snapshot.windows.is_empty());
    assert!(snapshot.last_alert.is_empty());
    assert!(snapshot.event_buffers.is_empty());
    assert!(snapshot.event_ref_buffers.is_empty());
}

#[test]
fn snapshot_json_round_trip() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);

    let snapshot = engine.export_state();
    let json = serde_json::to_string(&snapshot).unwrap();
    let restored: CorrelationSnapshot = serde_json::from_str(&json).unwrap();

    assert_eq!(snapshot.windows.len(), restored.windows.len());
    for (corr_id, entries) in &snapshot.windows {
        let restored_entries = restored.windows.get(corr_id).unwrap();
        assert_eq!(entries.len(), restored_entries.len());
    }
}

#[test]
fn snapshot_uses_stable_ids_not_indices() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);

    let snapshot = engine.export_state();
    assert!(
        snapshot.windows.contains_key("many-logins"),
        "snapshot should use correlation id as key, got: {:?}",
        snapshot.windows.keys().collect::<Vec<_>>()
    );
}

// =============================================================================
// Export → import preserves state
// =============================================================================

#[test]
fn export_import_preserves_event_count_state() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    // Feed 2 events (below threshold of 3)
    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);
    assert_eq!(engine.state_count(), 1);

    let snapshot = engine.export_state();

    // Create a fresh engine and import the snapshot
    let mut engine2 = corr_engine(EVENT_COUNT_YAML);
    assert_eq!(engine2.state_count(), 0);
    engine2.import_state(snapshot);
    assert_eq!(engine2.state_count(), 1);

    // One more event should trigger the correlation (2 restored + 1 new = 3)
    let result = process(&mut engine2, login_event("admin"), 1002);
    assert_eq!(
        result.correlations.len(),
        1,
        "correlation should fire with restored state + new event"
    );
    assert_eq!(result.correlations[0].aggregated_value, 3.0);
}

#[test]
fn export_import_preserves_value_count_state() {
    let mut engine = corr_engine(VALUE_COUNT_YAML);
    process(&mut engine, login_event_with_ip("admin", "10.0.0.1"), 1000);
    process(&mut engine, login_event_with_ip("admin", "10.0.0.2"), 1001);

    let snapshot = engine.export_state();
    let mut engine2 = corr_engine(VALUE_COUNT_YAML);
    engine2.import_state(snapshot);

    // Third distinct SourceIP should trigger value_count >= 3
    let result = process(&mut engine2, login_event_with_ip("admin", "10.0.0.3"), 1002);
    assert_eq!(result.correlations.len(), 1);
    assert_eq!(result.correlations[0].aggregated_value, 3.0);
}

#[test]
fn export_import_preserves_temporal_state() {
    let mut engine = corr_engine(TEMPORAL_YAML);
    process(
        &mut engine,
        json!({"EventType": "recon", "Host": "srv1"}),
        1000,
    );

    let snapshot = engine.export_state();
    let mut engine2 = corr_engine(TEMPORAL_YAML);
    engine2.import_state(snapshot);

    // Exploit after recon should trigger temporal correlation
    let result = process(
        &mut engine2,
        json!({"EventType": "exploit", "Host": "srv1"}),
        1010,
    );
    assert_eq!(
        result.correlations.len(),
        1,
        "temporal correlation should fire with restored recon + new exploit"
    );
}

#[test]
fn export_import_preserves_multiple_groups() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);
    process(&mut engine, login_event("bob"), 1000);
    assert_eq!(engine.state_count(), 2);

    let snapshot = engine.export_state();
    let mut engine2 = corr_engine(EVENT_COUNT_YAML);
    engine2.import_state(snapshot);
    assert_eq!(engine2.state_count(), 2);

    // admin: 2 restored + 1 = 3 → fires
    let r = process(&mut engine2, login_event("admin"), 1002);
    assert_eq!(r.correlations.len(), 1);

    // bob: 1 restored + 1 = 2 → doesn't fire
    let r = process(&mut engine2, login_event("bob"), 1002);
    assert!(r.correlations.is_empty());
}

// =============================================================================
// Suppression state persistence
// =============================================================================

#[test]
fn export_import_preserves_suppression_state() {
    let config = CorrelationConfig {
        suppress: Some(60),
        ..CorrelationConfig::default()
    };
    let mut engine = corr_engine_with_config(EVENT_COUNT_YAML, config.clone());

    // Trigger correlation
    for i in 0..3 {
        process(&mut engine, login_event("admin"), 1000 + i);
    }
    // Should be suppressed now
    let r = process(&mut engine, login_event("admin"), 1004);
    assert!(r.correlations.is_empty(), "should be suppressed");

    let snapshot = engine.export_state();
    assert!(
        !snapshot.last_alert.is_empty(),
        "last_alert should be populated"
    );

    let mut engine2 = corr_engine_with_config(EVENT_COUNT_YAML, config);
    engine2.import_state(snapshot);

    // Should still be suppressed in the restored engine (within 60s window)
    for i in 0..3 {
        process(&mut engine2, login_event("admin"), 1010 + i);
    }
    let r = process(&mut engine2, login_event("admin"), 1013);
    assert!(
        r.correlations.is_empty(),
        "suppression should survive restore"
    );
}

// =============================================================================
// Event buffer persistence
// =============================================================================

#[test]
fn export_import_preserves_event_buffers_full_mode() {
    let config = CorrelationConfig {
        correlation_event_mode: CorrelationEventMode::Full,
        max_correlation_events: 10,
        ..CorrelationConfig::default()
    };
    let mut engine = corr_engine_with_config(EVENT_COUNT_YAML, config.clone());

    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);

    let snapshot = engine.export_state();
    assert!(
        !snapshot.event_buffers.is_empty(),
        "event_buffers should be populated in Full mode"
    );

    // Serialize and deserialize the snapshot (simulates SQLite round-trip)
    let json = serde_json::to_string(&snapshot).unwrap();
    let restored: CorrelationSnapshot = serde_json::from_str(&json).unwrap();

    let mut engine2 = corr_engine_with_config(EVENT_COUNT_YAML, config);
    engine2.import_state(restored);

    // Third event triggers correlation with events from buffer
    let r = process(&mut engine2, login_event("admin"), 1002);
    assert_eq!(r.correlations.len(), 1);
    assert!(
        r.correlations[0].events.is_some(),
        "events should be included from restored buffer"
    );
}

#[test]
fn export_import_preserves_event_ref_buffers() {
    let config = CorrelationConfig {
        correlation_event_mode: CorrelationEventMode::Refs,
        max_correlation_events: 10,
        ..CorrelationConfig::default()
    };
    let mut engine = corr_engine_with_config(EVENT_COUNT_YAML, config.clone());

    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);

    let snapshot = engine.export_state();
    assert!(
        !snapshot.event_ref_buffers.is_empty(),
        "event_ref_buffers should be populated in Refs mode"
    );

    let json = serde_json::to_string(&snapshot).unwrap();
    let restored: CorrelationSnapshot = serde_json::from_str(&json).unwrap();

    let mut engine2 = corr_engine_with_config(EVENT_COUNT_YAML, config);
    engine2.import_state(restored);

    let r = process(&mut engine2, login_event("admin"), 1002);
    assert_eq!(r.correlations.len(), 1);
    assert!(
        r.correlations[0].event_refs.is_some(),
        "event_refs should be included from restored buffer"
    );
}

// =============================================================================
// Edge cases
// =============================================================================

#[test]
fn import_drops_unknown_correlation_ids() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);

    let mut snapshot = engine.export_state();
    // Rename the correlation id to something that doesn't exist
    let entries = snapshot.windows.remove("many-logins").unwrap();
    snapshot
        .windows
        .insert("nonexistent-rule".to_string(), entries);

    let mut engine2 = corr_engine(EVENT_COUNT_YAML);
    engine2.import_state(snapshot);
    assert_eq!(
        engine2.state_count(),
        0,
        "unknown correlation ids should be dropped"
    );
}

#[test]
fn import_into_empty_engine_is_noop() {
    let yaml = r#"
title: Login
id: login-rule
logsource:
    category: auth
detection:
    selection:
        EventType: login
    condition: selection
"#;
    // Engine with only detection rules, no correlations
    let mut engine = corr_engine(yaml);
    let snapshot = CorrelationSnapshot {
        version: 1,
        windows: Default::default(),
        last_alert: Default::default(),
        event_buffers: Default::default(),
        event_ref_buffers: Default::default(),
    };
    assert!(engine.import_state(snapshot));
    assert_eq!(engine.state_count(), 0);
}

#[test]
fn expired_state_not_restored_after_window() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);

    let snapshot = engine.export_state();

    let mut engine2 = corr_engine(EVENT_COUNT_YAML);
    engine2.import_state(snapshot);

    // Process event far in the future (past the 300s window)
    // The restored timestamps (1000, 1001) should be evicted
    let r = process(&mut engine2, login_event("admin"), 2000);
    assert!(
        r.correlations.is_empty(),
        "old restored events should be evicted by the time window"
    );
}

#[test]
fn import_rejects_incompatible_version() {
    let mut engine = corr_engine(EVENT_COUNT_YAML);
    process(&mut engine, login_event("admin"), 1000);
    process(&mut engine, login_event("admin"), 1001);

    let mut snapshot = engine.export_state();
    snapshot.version = 999;

    let mut engine2 = corr_engine(EVENT_COUNT_YAML);
    assert!(
        !engine2.import_state(snapshot),
        "import should reject incompatible version"
    );
    assert_eq!(engine2.state_count(), 0, "no state should be imported");
}