howler-api 2.10.0.dev54__tar.gz → 2.10.0.dev62__tar.gz

{howler_api-2.10.0.dev54 → howler_api-2.10.0.dev62}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: howler-api
-Version: 2.10.0.dev54
+Version: 2.10.0.dev62
 Summary: Howler - API server
 License: MIT
 Keywords: howler,alerting,gc,canada,cse-cst,cse,cst,cyber,cccs

{howler_api-2.10.0.dev54 → howler_api-2.10.0.dev62}/howler/services/hit_service.py

@@ -8,12 +8,7 @@ from prometheus_client import Counter
 
 import howler.services.event_service as event_service
 from howler.actions.promote import Escalation
-from howler.common.exceptions import (
-    HowlerTypeError,
-    HowlerValueError,
-    NotFoundException,
-    ResourceExists,
-)
+from howler.common.exceptions import HowlerTypeError, HowlerValueError, NotFoundException, ResourceExists
 from howler.common.loader import APP_NAME, datastore
 from howler.common.logging import get_logger
 from howler.datastore.collection import ESCollection
@@ -33,15 +28,10 @@ from howler.helper.workflow import Transition, Workflow
 from howler.odm.base import BANNED_FIELDS
 from howler.odm.models.ecs.event import Event
 from howler.odm.models.hit import Hit
-from howler.odm.models.howler_data import (
-    HitOperationType,
-    HitStatus,
-    HitStatusTransition,
-    Log,
-)
+from howler.odm.models.howler_data import HitOperationType, HitStatus, HitStatusTransition, Log
 from howler.odm.models.user import User
 from howler.services import action_service
-from howler.utils.dict_utils import flatten
+from howler.utils.dict_utils import extra_keys, flatten
 from howler.utils.uid import get_random_id
 
 log = get_logger(__file__)
@@ -313,7 +303,8 @@ def convert_hit(data: dict[str, Any], unique: bool, ignore_extra_values: bool =
 
     # Check for deprecated field and unused fields
     odm_flatten = odm.flat_fields(show_compound=True)
-    unused_keys = set(data.keys()) - set(odm_flatten.keys()) - BANNED_FIELDS
+    unused_keys = extra_keys(data, set(odm_flatten.keys()) - BANNED_FIELDS)
+
     if unused_keys and not ignore_extra_values:
         raise HowlerValueError(f"Hit was created with invalid parameters: {', '.join(unused_keys)}")
     deprecated_keys = set(key for key in odm_flatten.keys() & data.keys() if odm_flatten[key].deprecated)

{howler_api-2.10.0.dev54 → howler_api-2.10.0.dev62}/howler/utils/dict_utils.py

@@ -94,7 +94,7 @@ def flatten(data: _Mapping, parent_key: Optional[str] = None, odm: Optional[type
 
 
 def unflatten(data: _Mapping) -> _Mapping:
-    "Unflatted a nested dict"
+    "Unflatten a nested dict"
     out: dict[str, Any] = dict()
     for k, v in data.items():
         parts = k.split(".")
@@ -107,6 +107,36 @@ def unflatten(data: _Mapping) -> _Mapping:
     return out
 
 
+def extra_keys(data: _Mapping, keys: set[str], parent_key: Optional[str] = None) -> set[str]:
+    "Geta list of extra keys when compared to a list of permitted keys"
+    result: set[str] = set()
+    for key in data.keys():
+        if isinstance(data[key], dict):
+            result = result | extra_keys(
+                data[key],
+                {sub_key[(len(sub_key) + 1) :] for sub_key in keys if sub_key.startswith(f"{key}.")},
+                parent_key=key if not parent_key else f"{parent_key}.{key}",
+            )
+        elif isinstance(data[key], list):
+            if key in keys:
+                continue
+
+            for entry in data[key]:
+                if not isinstance(entry, dict):
+                    result.add(key if not parent_key else f"{parent_key}.{key}")
+                    break
+                else:
+                    result = result | extra_keys(
+                        entry,
+                        {sub_key[(len(key) + 1) :] for sub_key in keys if sub_key.startswith(f"{key}.")},
+                        parent_key=key if not parent_key else f"{parent_key}.{key}",
+                    )
+        elif key not in keys:
+            result.add(key if not parent_key else f"{parent_key}.{key}")
+
+    return result
+
+
 def prune(  # noqa: C901
     data: _Mapping, keys: list[str], fields: dict[str, "_Field"], mapping_class: type, parent_key: Optional[str] = None
 ) -> dict[str, Any]:

{howler_api-2.10.0.dev54 → howler_api-2.10.0.dev62}/pyproject.toml

@@ -147,7 +147,7 @@ suppress-none-returning = true
 [tool.poetry]
 package-mode = true
 name = "howler-api"
-version = "2.10.0.dev54"
+version = "2.10.0.dev62"
 description = "Howler - API server"
 authors = [
     "Canadian Centre for Cyber Security <howler@cyber.gc.ca>",