Skip to content

Commit

Permalink
Added missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thomaspatzke committed Sep 2, 2024
1 parent d52d8b5 commit beb98f6
Showing 1 changed file with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions docs/Processing_Pipelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ definitions are available:
"convert_type", "ConvertTypeTransformation"
"rule_failure", "RuleFailureTransformation"
"detection_item_failure", "DetectionItemFailureTransformation"
"set_custom_attribute", "SetCustomAttributeTransformation"
"nest", "NestedProcessingTransformation"

.. autoclass:: sigma.processing.transformations.FieldMappingTransformation
Expand Down Expand Up @@ -320,25 +321,43 @@ This is useful if different data models are used in the same system.
.. autoclass:: sigma.processing.transformations.SetFieldTransformation
.. autoclass:: sigma.processing.transformations.ReplaceStringTransformation
.. autoclass:: sigma.processing.transformations.MapStringTransformation

YAML example:

.. code-block:: yaml
transformations:
type: map_string
mapping:
value1: mapped1
value2:
- mapped2A
- mapped2B
.. autoclass:: sigma.processing.transformations.SetStateTransformation
.. autoclass:: sigma.processing.transformations.RegexTransformation
.. autoclass:: sigma.processing.transformations.SetValueTransformation
.. autoclass:: sigma.processing.transformations.ConvertTypeTransformation
.. autoclass:: sigma.processing.transformations.RuleFailureTransformation
.. autoclass:: sigma.processing.transformations.DetectionItemFailureTransformation
.. autoclass:: sigma.processing.transformations.SetCustomAttributeTransformation
.. autoclass:: sigma.processing.transformations.NestedProcessingTransformation

YAML example:

.. code-block:: yaml
transformations:
type: map_string
mapping:
value1: mapped1
value2:
- mapped2A
- mapped2B
type: nest
items:
- type: field_name_mapping
mapping:
EventID: EventCode
CommandLine:
- command_line
- cmdline
- type: set_state
state: processed
.. autoclass:: sigma.processing.transformations.RegexTransformation
.. autoclass:: sigma.processing.transformations.SetValueTransformation
Expand All @@ -361,12 +380,14 @@ Query Post-Processing Transformations
"template", "QueryTemplateTransformation"
"json", "EmbedQueryInJSONTransformation"
"replace", "ReplaceQueryTransformation"
"nest", "NestedQueryPostprocessingTransformation"

.. autoclass:: sigma.processing.postprocessing.EmbedQueryTransformation
.. autoclass:: sigma.processing.postprocessing.QuerySimpleTemplateTransformation
.. autoclass:: sigma.processing.postprocessing.QueryTemplateTransformation
.. autoclass:: sigma.processing.postprocessing.EmbedQueryInJSONTransformation
.. autoclass:: sigma.processing.postprocessing.ReplaceQueryTransformation
.. autoclass:: sigma.processing.postprocessing.NestedQueryPostprocessingTransformation

Output Finalization Transformations
====================================
Expand All @@ -381,11 +402,13 @@ Output Finalization Transformations
"template", "TemplateFinalizer"
"json", "JSONFinalizer"
"yaml", "YAMLFinalizer"
"nested", "NestedFinalizer"

.. autoclass:: sigma.processing.finalization.ConcatenateQueriesFinalizer
.. autoclass:: sigma.processing.finalization.TemplateFinalizer
.. autoclass:: sigma.processing.finalization.JSONFinalizer
.. autoclass:: sigma.processing.finalization.YAMLFinalizer
.. autoclass:: sigma.processing.finalization.NestedFinalizer

Base Classes
============
Expand Down

0 comments on commit beb98f6

Please sign in to comment.