You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/digging-deeper/pipelines.md
+47-32Lines changed: 47 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -189,7 +189,7 @@ transformations:
189
189
rule_conditions:
190
190
- type: logsource
191
191
product: m365
192
-
service: threat_detection
192
+
service: threat_detection
193
193
- id: defender_index
194
194
type: add_condition
195
195
conditions:
@@ -206,16 +206,16 @@ transformations:
206
206
207
207
### Rule-based Conditions
208
208
209
-
| Identifier |
210
-
| --------------------------- |
211
-
| logsource |
212
-
| contains_detection_item |
213
-
| processing_item_applied |
214
-
| processing_state |
215
-
| is_sigma_rule |
216
-
| is_sigma_correlation_rule |
217
-
| rule_attribute |
218
-
| tag |
209
+
| Identifier |
210
+
| ------------------------- |
211
+
| logsource |
212
+
| contains_detection_item |
213
+
| processing_item_applied |
214
+
| processing_state |
215
+
| is_sigma_rule |
216
+
| is_sigma_correlation_rule |
217
+
| rule_attribute |
218
+
| tag |
219
219
220
220
#### logsource
221
221
@@ -240,7 +240,7 @@ transformations:
240
240
rule_conditions:
241
241
- type: logsource
242
242
product: m365
243
-
service: threat_detection
243
+
service: threat_detection
244
244
```
245
245
246
246
:::
@@ -250,6 +250,7 @@ transformations:
250
250
Returns True if rule contains a detection item that matches the given field name and value.
251
251
252
252
**Parameters:**
253
+
253
254
- 'field': The field you'd like to match on.
254
255
- 'value': The value you'd like to match on.
255
256
@@ -274,6 +275,7 @@ transformations:
274
275
Checks if processing item was applied to rule.
275
276
276
277
**Parameters:**
278
+
277
279
- 'processing_item_id': The identifier of the processing item you'd like to match on
278
280
279
281
::: code-group
@@ -300,6 +302,7 @@ transformations:
300
302
Matches on processing pipeline state.
301
303
302
304
**Parameters:**
305
+
303
306
- 'key': The key for the processing state.
304
307
- 'val': The value for the processing state key.
305
308
@@ -324,6 +327,7 @@ transformations:
324
327
Checks if rule is a SigmaRule.
325
328
326
329
**Parameters:**
330
+
327
331
- N/A
328
332
329
333
::: code-group
@@ -345,6 +349,7 @@ transformations:
345
349
Checks if rule is a SigmaRule.
346
350
347
351
**Parameters:**
352
+
348
353
- N/A
349
354
350
355
::: code-group
@@ -374,6 +379,7 @@ Generic match on rule attributes with supported types:
374
379
- Fields that contain lists of values, maps or other complex data structures are not supported and raise a SigmaConfigurationError. If the type of the value doesn’t allows a particular relation, the condition also raises a SigmaConfigurationError on match.
375
380
376
381
**Parameters:**
382
+
377
383
- 'attribute': The attribute to match on.
378
384
- 'value': The value to match on.
379
385
- 'op': The relational comparison type to match on (eq (equals), ne (not equals), gte (greater than or equals), gt (greater than), lte (less than or equals), lt (less than)) with the default value of eq
@@ -391,7 +397,7 @@ transformations:
391
397
rule_conditions:
392
398
- type: rule_attribute
393
399
attribute: date
394
-
value: '2025-01-01'
400
+
value: "2025-01-01"
395
401
op: gte
396
402
```
397
403
@@ -400,6 +406,7 @@ transformations:
400
406
Matches if rule is tagged with a specific tag.
401
407
402
408
**Parameters:**
409
+
403
410
- 'tag': The tag to match on.
404
411
405
412
::: code-group
@@ -419,18 +426,19 @@ transformations:
419
426
420
427
### Detection-based Conditions
421
428
422
-
| Identifier |
423
-
| --------------------------- |
424
-
| match_string |
425
-
| is_null |
426
-
| processing_item_applied |
427
-
| processing_state |
429
+
| Identifier |
430
+
| ----------------------- |
431
+
| match_string |
432
+
| is_null |
433
+
| processing_item_applied |
434
+
| processing_state |
428
435
429
436
#### match_string
430
437
431
438
Match string values with a regular expression ‘pattern’. The parameter ‘cond’ determines for detection items with multiple values if any or all strings must match. Generally, values which aren’t strings are skipped in any mode or result in a false result in all match mode.
432
439
433
440
**Parameters:**
441
+
434
442
- 'cond': 'any'or 'all'
435
443
- 'pattern': The pattern to match on
436
444
- 'negate': Default to false, but can be changed to True to make a negated condition
@@ -448,7 +456,7 @@ transformations:
448
456
detection_item_conditions:
449
457
- type: match_string
450
458
cond: any
451
-
pattern: 'informational'
459
+
pattern: "informational"
452
460
negate: False
453
461
```
454
462
@@ -457,6 +465,7 @@ transformations:
457
465
Match null values. The parameter ‘cond’ determines for detection items with multiple values if any or all strings must match. Generally, values which aren’t strings are skipped in any mode or result in a false result in all match mode.
458
466
459
467
**Parameters:**
468
+
460
469
- 'cond': 'any'or 'all'
461
470
462
471
:::code-block
@@ -479,6 +488,7 @@ transformations:
479
488
Checks if processing item was applied to detection item.
480
489
481
490
**Parameters:**
491
+
482
492
- 'processing_item_id': The identifier of the processing item you'd like to match on
483
493
484
494
:::code-block
@@ -505,6 +515,7 @@ transformations:
505
515
Matches on processing pipeline state.
506
516
507
517
**Parameters:**
518
+
508
519
- 'key': The key for the processing state.
509
520
- 'val': The value for the processing state key.
510
521
@@ -526,18 +537,19 @@ transformations:
526
537
527
538
### Field-based Conditions
528
539
529
-
| Identifier |
530
-
| --------------------------- |
531
-
| include_fields |
532
-
| exclude_fields |
533
-
| processing_item_applied |
534
-
| processing_state |
540
+
| Identifier |
541
+
| ----------------------- |
542
+
| include_fields |
543
+
| exclude_fields |
544
+
| processing_item_applied |
545
+
| processing_state |
535
546
536
547
#### include_fields
537
548
538
549
Matches on field name if it is contained in fields list. The parameter ‘type’ determines if field names are matched as plain string (“plain”) or regular expressions (“re”).
539
550
540
551
**Parameters:**
552
+
541
553
- 'fields': The fields to match on
542
554
- 'type': Plain match or regex match using 'plain' or 're'.
543
555
@@ -551,14 +563,15 @@ transformations:
551
563
type: drop_detection_item
552
564
field_name_conditions:
553
565
- type: include_fields
554
-
fields:
555
-
- 'name'
556
-
- 'type'
566
+
fields:
567
+
- "name"
568
+
- "type"
557
569
```
558
570
559
571
#### exclude_fields
560
572
561
573
**Parameters:**
574
+
562
575
- 'fields': The fields to match on
563
576
- 'type': Plain match or regex match using 'plain' or 're'.
0 commit comments