Merge branch 'version-1'

SigmaHQ · Nov 13, 2024 · 3f88199 · 3f88199
2 parents aa8719a + 447fdf3
commit 3f88199
Show file tree

Hide file tree

Showing 42 changed files with 3,946 additions and 2,500 deletions.
diff --git a/docs/Breaking_Changes.rst b/docs/Breaking_Changes.rst
@@ -0,0 +1,13 @@
+Breaking Changes
+================
+
+This page documents breaking changes in pySigma. Normally, we try to avoid breaking changes in minor
+versions and generally try to keep pySigma backwards compatible, but sometimes they are necessary to
+improve the library.
+
+Version 1.0
+-----------
+
+* The class `CompareOperators` was moved out of `SigmaCompatreExpression` into the root of the
+  containing module `sigma.types`. If the class was formerly used, it has now to be imported
+  explicitly from the module.
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ pySigma Documentation
    Backends
    Rule_Validation
    Plugin_System
+   Breaking_Changes
 
 Overview
 ********

diff --git a/sigma/backends/test/backend.py b/sigma/backends/test/backend.py
@@ -7,7 +7,7 @@
 from sigma.pipelines.test import dummy_test_pipeline
 from sigma.processing.pipeline import ProcessingItem, ProcessingPipeline
 from sigma.processing.transformations import FieldMappingTransformation
-from sigma.types import SigmaCompareExpression
+from sigma.types import CompareOperators, SigmaCompareExpression
 
 
 class TextQueryTestBackend(TextQueryBackend):
@@ -62,11 +62,11 @@ class TextQueryTestBackend(TextQueryBackend):
     cidr_expression: ClassVar[str] = "cidrmatch('{field}', \"{value}\")"
 
     compare_op_expression: ClassVar[str] = "{field}{operator}{value}"
-    compare_operators: ClassVar[Dict[SigmaCompareExpression.CompareOperators, str]] = {
-        SigmaCompareExpression.CompareOperators.LT: "<",
-        SigmaCompareExpression.CompareOperators.LTE: "<=",
-        SigmaCompareExpression.CompareOperators.GT: ">",
-        SigmaCompareExpression.CompareOperators.GTE: ">=",
+    compare_operators: ClassVar[Dict[CompareOperators, str]] = {
+        CompareOperators.LT: "<",
+        CompareOperators.LTE: "<=",
+        CompareOperators.GT: ">",
+        CompareOperators.GTE: ">=",
     }
 
     field_equals_field_expression: ClassVar[str] = "{field1}=fieldref({field2})"

diff --git a/sigma/conversion/base.py b/sigma/conversion/base.py
@@ -38,6 +38,7 @@
     ConditionType,
 )
 from sigma.types import (
+    CompareOperators,
     SigmaBool,
     SigmaCasedString,
     SigmaExists,
@@ -883,7 +884,7 @@ class variables. If this is not sufficient, the respective methods can be implem
     compare_op_expression: ClassVar[Optional[str]] = (
         None  # Compare operation query as format string with placeholders {field}, {operator} and {value}
     )
-    compare_operators: ClassVar[Optional[Dict[SigmaCompareExpression.CompareOperators, str]]] = (
+    compare_operators: ClassVar[Optional[Dict[CompareOperators, str]]] = (
         None  # Mapping between CompareOperators elements and strings used as replacement for {operator} in compare_op_expression
     )
 

diff --git a/sigma/exceptions.py b/sigma/exceptions.py
@@ -145,6 +145,12 @@ class SigmaPipelineParsingError(SigmaError):
     pass
 
 
+class SigmaProcessingItemError(SigmaError):
+    """Error in definition or state of processing item."""
+
+    pass
+
+
 class SigmaPlaceholderError(SigmaValueError):
     """Attempted to convert an unhandled Placeholder into a query"""
 

diff --git a/sigma/modifiers.py b/sigma/modifiers.py
@@ -15,6 +15,7 @@
 from collections.abc import Sequence as SequenceABC
 from base64 import b64encode
 from sigma.types import (
+    CompareOperators,
     Placeholder,
     SigmaBool,
     SigmaCasedString,
@@ -321,7 +322,7 @@ def modify(self, val: Sequence[SigmaType]) -> List[SigmaType]:
 class SigmaCompareModifier(SigmaValueModifier):
     """Base class for numeric comparison operator modifiers."""
 
-    op: ClassVar[SigmaCompareExpression.CompareOperators]
+    op: ClassVar[CompareOperators]
 
     def modify(self, val: SigmaNumber) -> SigmaCompareExpression:
         return SigmaCompareExpression(val, self.op, self.source)
@@ -330,33 +331,25 @@ def modify(self, val: SigmaNumber) -> SigmaCompareExpression:
 class SigmaLessThanModifier(SigmaCompareModifier):
     """Numeric less than (<) matching."""
 
-    op: ClassVar[SigmaCompareExpression.CompareOperators] = (
-        SigmaCompareExpression.CompareOperators.LT
-    )
+    op: ClassVar[CompareOperators] = CompareOperators.LT
 
 
 class SigmaLessThanEqualModifier(SigmaCompareModifier):
     """Numeric less than or equal (<=) matching."""
 
-    op: ClassVar[SigmaCompareExpression.CompareOperators] = (
-        SigmaCompareExpression.CompareOperators.LTE
-    )
+    op: ClassVar[CompareOperators] = CompareOperators.LTE
 
 
 class SigmaGreaterThanModifier(SigmaCompareModifier):
     """Numeric greater than (>) matching."""
 
-    op: ClassVar[SigmaCompareExpression.CompareOperators] = (
-        SigmaCompareExpression.CompareOperators.GT
-    )
+    op: ClassVar[CompareOperators] = CompareOperators.GT
 
 
 class SigmaGreaterThanEqualModifier(SigmaCompareModifier):
     """Numeric greater than or equal (>=) matching."""
 
-    op: ClassVar[SigmaCompareExpression.CompareOperators] = (
-        SigmaCompareExpression.CompareOperators.GTE
-    )
+    op: ClassVar[CompareOperators] = CompareOperators.GTE
 
 
 class SigmaFieldReferenceModifier(SigmaValueModifier):