Handle partial results

assemblyline/common/caching.py

@@ -149,7 +149,7 @@ def keys(self):
             return self.cache.keys()
 
 
-def generate_conf_key(service_tool_version: Optional[str] = None, task: Optional[Task] = None) -> str:
+def generate_conf_key(service_tool_version: Optional[str] = None, task: Optional[Task] = None, partial_result: bool = False) -> str:
     ignore_salt = None
     service_config = None
     submission_params_str = None
@@ -164,7 +164,7 @@ def generate_conf_key(service_tool_version: Optional[str] = None, task: Optional
         }
         submission_params_str = json.dumps(sorted(submission_params.items()))
 
-        if task.ignore_cache:
+        if task.ignore_cache or partial_result:
             ignore_salt = get_random_id()
 
     if service_tool_version is None and \

assemblyline/datastore/helper.py

@@ -510,7 +510,7 @@ def get_single_result(self, key, cl_engine=forge.get_classification(), as_obj=Fa
         if key.endswith(".e"):
             data = self.create_empty_result_from_key(key, cl_engine, as_obj=as_obj)
         else:
-            data = self.result.get(key, as_obj=False)
+            data = self.result.get(key, as_obj=as_obj)
 
         return data
 

assemblyline/odm/__init__.py

@@ -5,7 +5,7 @@
 
 # Imports that have the same effect as some part of the one above so that
 # type checking can use this file properly.
-from assemblyline.odm.base import Keyword, Optional, Boolean, Integer, Long, List, Compound, Mapping, Date
+from assemblyline.odm.base import Keyword, Optional, Boolean, Integer, List, Compound, Mapping, Date, Long, Enum
 from datetime import datetime
 
 _InnerType = typing.TypeVar("_InnerType")
@@ -57,3 +57,7 @@ def mapping(child_type: _InnerType, **kwargs) -> dict[str, _InnerType]:
 
 def compound(child_type: typing.Callable[..., _InnerType], **kwargs) -> _InnerType:
     return typing.cast(_InnerType, Compound(child_type, **kwargs))
+
+
+def enum(values: typing.Iterable[str], **kwargs) -> str:
+    return typing.cast(str, Enum(values, **kwargs))

assemblyline/odm/models/config.py

@@ -1979,6 +1979,14 @@ class MetadataConfig(odm.Model):
 }
 
 
+TEMPORARY_KEY_TYPE = [
+    # Keep this key as submission wide list merging equal items
+    'union',
+    # Keep this key submission wide on a "last write wins" basis
+    'overwrite',
+]
+
+
 @odm.model(index=False, store=False,
            description="Default values for parameters for submissions that may be overridden on a per submission basis")
 class Submission(odm.Model):
@@ -2007,8 +2015,16 @@ class Submission(odm.Model):
                              description="Tag types that show up in the submission summary")
     verdicts = odm.Compound(Verdicts, default=DEFAULT_VERDICTS,
                             description="Minimum score value to get the specified verdict.")
+    temporary_keys: dict[str, str] = odm.mapping(odm.enum(TEMPORARY_KEY_TYPE),
+                                                 description="Set the operation that will be used to update values "
+                                                             "using this key in the temporary submission data.")
 
 
+DEFAULT_TEMPORARY_KEYS = {
+    'passwords': 'union',
+    'email_body': 'union',
+}
+
 DEFAULT_SUBMISSION = {
     'default_max_extracted': 500,
     'default_max_supplementary': 500,
@@ -2023,7 +2039,8 @@ class Submission(odm.Model):
     'sha256_sources': [],
     'file_sources': [],
     'tag_types': DEFAULT_TAG_TYPES,
-    'verdicts': DEFAULT_VERDICTS
+    'verdicts': DEFAULT_VERDICTS,
+    'temporary_keys': DEFAULT_TEMPORARY_KEYS,
 }
 
 

assemblyline/odm/models/result.py

@@ -137,6 +137,7 @@ class Result(odm.Model):
     type = odm.Optional(odm.Keyword())
     size = odm.Optional(odm.Integer())
     drop_file = odm.Boolean(default=False, description="Use to not pass to other stages after this run", ai=False)
+    partial = odm.Boolean(default=False, description="Invalidate the current result cache creation", ai=False)
     from_archive = odm.Boolean(index=False, default=False, description="Was loaded from the archive", ai=False)
 
     def build_key(self, service_tool_version=None, task=None):
@@ -146,16 +147,17 @@ def build_key(self, service_tool_version=None, task=None):
             self.response.service_version,
             self.is_empty(),
             service_tool_version=service_tool_version,
-            task=task
+            task=task,
+            partial=self.partial
         )
 
     @staticmethod
-    def help_build_key(sha256, service_name, service_version, is_empty, service_tool_version=None, task=None):
+    def help_build_key(sha256, service_name, service_version, is_empty, service_tool_version=None, task=None, partial=False):
         key_list = [
             sha256,
             service_name.replace('.', '_'),
             f"v{service_version.replace('.', '_')}",
-            f"c{generate_conf_key(service_tool_version=service_tool_version, task=task)}",
+            f"c{generate_conf_key(service_tool_version=service_tool_version, task=task, partial_result=partial)}",
         ]
 
         if is_empty:
@@ -179,6 +181,6 @@ def is_empty(self) -> bool:
         if len(self.response.extracted) == 0 and \
                 len(self.response.supplementary) == 0 and \
                 len(self.result.sections) == 0 and \
-                self.result.score == 0:
+                self.result.score == 0 and not self.partial:
             return True
         return False

assemblyline/odm/models/service.py

@@ -140,6 +140,9 @@ class Service(odm.Model):
         default=False, description="Does this service use temp data from other services for analysis?")
     uses_metadata: bool = odm.Boolean(
         default=False, description="Does this service use submission metadata for analysis?")
+    monitored_keys: list[str] = odm.sequence(
+        odm.keyword(), default=[],
+        description="This service watches these temporary keys for changes when partial results are produced.")
 
     name: str = odm.Keyword(store=True, copyto="__text__", description="Name of service")
     version = odm.Keyword(store=True, description="Version of service")
@@ -151,9 +154,8 @@ class Service(odm.Model):
 
     stage = odm.Keyword(store=True, default="CORE", copyto="__text__",
                         description="Which execution stage does this service run in?")
-    submission_params: SubmissionParams = odm.List(
-        odm.Compound(SubmissionParams),
-        index=False, default=[],
+    submission_params: list[SubmissionParams] = odm.sequence(
+        odm.compound(SubmissionParams), index=False, default=[],
         description="Submission parameters of service")
     timeout: int = odm.Integer(default=60, description="Service task timeout, in seconds")
 

assemblyline/odm/models/service_delta.py

@@ -106,6 +106,7 @@ class ServiceDelta(odm.Model):
     uses_tag_scores: bool = odm.Optional(odm.Boolean(), description=REF_SERVICE)
     uses_temp_submission_data: bool = odm.Optional(odm.Boolean(), description=REF_SERVICE)
     uses_metadata: bool = odm.Optional(odm.Boolean(), description=REF_SERVICE)
+    monitored_keys = odm.optional(odm.sequence(odm.keyword()))
 
     name = odm.Optional(odm.Keyword(), store=True, copyto="__text__", description=REF_SERVICE)
     version = odm.Keyword(store=True, description=REF_SERVICE)