mal-toolbox 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

{mal_toolbox-1.0.0.dist-info → mal_toolbox-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 1.0.0
+Version: 1.0.1
 Summary: A collection of tools used to create MAL models and attack graphs.
 Author-email: Andrei Buhaiu <buhaiu@kth.se>, Joakim Loxdal <loxdal@kth.se>, Nikolaos Kakouros <nkak@kth.se>, Jakob Nyberg <jaknyb@kth.se>, Giuseppe Nebbione <nebbione@kth.se>
 License: Apache Software License
@@ -18,7 +18,6 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: AUTHORS
-Requires-Dist: py2neo>=2021.2.3
 Requires-Dist: antlr4-tools
 Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt

{mal_toolbox-1.0.0.dist-info → mal_toolbox-1.0.1.dist-info}/RECORD

@@ -1,26 +1,26 @@
-mal_toolbox-1.0.0.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
-mal_toolbox-1.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-maltoolbox/__init__.py,sha256=Y_GfqlViiQEqrvkQX84F4xponM9OffWQD3CsIxcuxLo,2043
+mal_toolbox-1.0.1.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
+mal_toolbox-1.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+maltoolbox/__init__.py,sha256=AO8CtBtHZ2gaI_kkyQW51Wn44s9xb0ErllNbR_AB0Do,2043
 maltoolbox/__main__.py,sha256=QBloKCJ_RMsFPZ8qiWZQnoP2gnnRyECIJBfA1zTAYJM,2394
 maltoolbox/exceptions.py,sha256=0YjPx2v1yYumZ2o7pVZ1s_jS-GAb3Ng979KEFhROSNY,1399
 maltoolbox/file_utils.py,sha256=fYG3UsvPQcU0ES_WI3nLfuzSZgc0jtE4IAxdMGgs9aA,1876
-maltoolbox/model.py,sha256=f2j8GFwIWWD98f892dsH054PwDVpOjOMPQu2kPrZKr8,16644
+maltoolbox/model.py,sha256=xTK2jUr0Gz5pPVhdjh78zO5G46nV8N2ciIt6M5SwcGU,16058
 maltoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/attackgraph/__init__.py,sha256=m_81AjzwXONdclcW_R7mF2f8p-4DvoSRVfQ3Nyh7fak,298
-maltoolbox/attackgraph/attackgraph.py,sha256=Gw6xvBmI8p16Nun8F0XBHniwyWpUGjP7PLq3NMTzU9M,26626
+maltoolbox/attackgraph/attackgraph.py,sha256=fuhpfD3YnQEdDdG7QPdYSylOX3XPL2mbx4cX0_bmX3c,26870
 maltoolbox/attackgraph/node.py,sha256=Z2sdzXhPel9h7ySxP9fjgd1exVmpRbvRySVtLpI1_BM,3904
 maltoolbox/attackgraph/analyzers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/ingestors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/language/__init__.py,sha256=TsTTryEyjChwHN1o5F2BSUlFsAss2N6J0H0-nzvXiD8,489
-maltoolbox/language/languagegraph.py,sha256=wkv9WKje89uu2KDcm2dKS0st1IDz5xkYFkS4xVHQel8,73196
+maltoolbox/language/languagegraph.py,sha256=WLV0-CvfrB4yqaDW3NTLyVOVDduNeD1By3Yqmjzn00Y,73810
 maltoolbox/language/compiler/__init__.py,sha256=JQyAgDwJh1pU7AmuOhd1-d2b2PYXpgMVPtxnav8QHVc,15872
 maltoolbox/language/compiler/mal_lexer.py,sha256=BeifykDAt4PloRASOaLzBgWF35ev_zgD8lXMIsSHykc,12063
 maltoolbox/language/compiler/mal_parser.py,sha256=sUoaE43l2VKg-Dou30mk2wlVS1FvdOREwHNIyFe4IkY,114699
 maltoolbox/translators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/translators/securicad.py,sha256=F_rndv2JyKxfHAXPwf2RrdiFPnemJVArYUpVsFP6QQk,6997
 maltoolbox/translators/updater.py,sha256=UZPnx22udROiocCcSmtrgUJUupkjktkxl-M7rhBxUPc,8660
-mal_toolbox-1.0.0.dist-info/METADATA,sha256=K-hIqrvW9LgMHdsaoiEJRM0t2NbBLNptdYQsgGyXblE,5129
-mal_toolbox-1.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mal_toolbox-1.0.0.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
-mal_toolbox-1.0.0.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
-mal_toolbox-1.0.0.dist-info/RECORD,,
+mal_toolbox-1.0.1.dist-info/METADATA,sha256=LSJ7hnJewGb32qVSdpv-3KBinzJ_ZHUbsWxWhHEebII,5097
+mal_toolbox-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mal_toolbox-1.0.1.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
+mal_toolbox-1.0.1.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
+mal_toolbox-1.0.1.dist-info/RECORD,,

maltoolbox/__init__.py

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# MAL Toolbox v1.0.0
+# MAL Toolbox v1.0.1
 # Copyright 2025, Andrei Buhaiu.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,7 +21,7 @@ MAL-Toolbox Framework
 """
 
 __title__ = "maltoolbox"
-__version__ = "1.0.0"
+__version__ = "1.0.1"
 __authors__ = [
     "Andrei Buhaiu",
     "Giuseppe Nebbione",

maltoolbox/attackgraph/attackgraph.py

@@ -55,12 +55,12 @@ def create_attack_graph(
     else:
         raise TypeError("`lang` must be either string or LanguageGraph")
 
-    if log_configs['langspec_file']:
+    if 'langspec_file' in log_configs:
         lang_graph.save_language_specification_to_json(
             log_configs['langspec_file']
         )
 
-    if log_configs['langgraph_file']:
+    if 'langgraph_file' in log_configs:
         lang_graph.save_to_file(log_configs['langgraph_file'])
 
     # Load model
@@ -469,20 +469,24 @@ class AttackGraph():
                 existence_status = None
                 node_name = asset.name + ':' + attack_step.name
 
-                ttc_dist = attack_step.ttc
+                ttc_dist = copy.deepcopy(attack_step.ttc)
                 match (attack_step.type):
                     case 'defense':
                         # Set the TTC probability for defenses
-                        defense_value = float(asset.defenses[attack_step.name])
-                        ttc_dist = {
-                            'arguments': [defense_value],
-                            'name': 'Bernoulli',
-                            'type': 'function'
-                        }
-                        logger.debug(
-                            'Setting defense \"%s\" to "%s".',
-                            node_name, defense_value
-                        )
+                        # that were explicitly set in model
+                        if attack_step.name in asset.defenses:
+                            defense_value = float(
+                                asset.defenses[attack_step.name]
+                            )
+                            ttc_dist = {
+                                'arguments': [defense_value],
+                                'name': 'Bernoulli',
+                                'type': 'function'
+                            }
+                            logger.debug(
+                                'Setting defense \"%s\" to "%s".',
+                                node_name, defense_value
+                            )
 
                     case 'exist' | 'notExist':
                         # Resolve step expression associated with

maltoolbox/language/languagegraph.py

@@ -97,12 +97,60 @@ predef_ttcs: dict[str, dict] = {
     },
     'Disabled':
     {
-        'arguments': [1.0],
+        'arguments': [0.0],
         'name': 'Bernoulli',
         'type': 'function'
     },
 }
 
+def get_ttc_distribution(
+        step_dict: dict,
+        defense_default_ttc = None,
+        attack_default_ttc = None
+    ) -> Optional[dict]:
+    """Convert step TTC to a TTC distribution if needed
+
+    - If no TTC is set, set return default TTC.
+    - If the TTC provided is a predefined name replace it with the
+    probability distribution it corresponds to.
+    - Otherwise return the TTC distribution as is.
+
+    Arguments:
+    step_dict   - A dict with the attack step data
+    defense_default_ttc - the value to give a defense ttc if none is set
+    attack_default_ttc - the value to give an attack ttc if none is set
+
+    Returns:
+    A dict with the steps TTC distribution, or None if the step is not
+    a defense or attack step
+    """
+
+    if defense_default_ttc is None:
+        defense_default_ttc = predef_ttcs['Disabled'].copy()
+    if attack_default_ttc is None:
+        attack_default_ttc = predef_ttcs['Instant'].copy()
+
+    step_ttc = step_dict['ttc']
+
+    if step_dict['type'] == 'defense':
+        if step_ttc is None:
+            # No step ttc set in language for defense
+            step_ttc = defense_default_ttc
+    elif step_dict['type'] in ('or', 'and'):
+        if step_ttc is None:
+            # No step ttc set in language for attack
+            step_ttc = attack_default_ttc
+    else:
+        # No TTC for other step types
+        return None
+
+    if 'name' in step_ttc and step_ttc['name'] in predef_ttcs:
+        # Predefined step ttc set in language, fetch from dict
+        step_ttc = predef_ttcs[step_ttc['name']].copy()
+
+    return step_ttc
+
+
 
 def disaggregate_attack_step_full_name(
         attack_step_full_name: str) -> list[str]:
@@ -435,7 +483,7 @@ class LanguageGraphAttackStep:
     name: str
     type: str
     asset: LanguageGraphAsset
-    ttc: dict = field(default_factory = dict)
+    ttc: Optional[dict] = field(default_factory = dict)
     overrides: bool = False
     children: dict = field(default_factory = dict)
     parents: dict = field(default_factory = dict)
@@ -728,7 +776,6 @@ class LanguageGraph():
     """Graph representation of a MAL language"""
     def __init__(self, lang: Optional[dict] = None):
         self.assets: dict[str, LanguageGraphAsset] = {}
-        self.predef_ttcs: dict[str, dict] = predef_ttcs
         if lang is not None:
             self._lang_spec: dict = lang
             self.metadata = {
@@ -769,34 +816,6 @@ class LanguageGraph():
             langspec = archive.read('langspec.json')
             return LanguageGraph(json.loads(langspec))
 
-
-    def replace_if_predef_ttc(
-        self,
-        ttc_entry: Optional[dict]
-    ) -> dict:
-        """
-        If the TTC provided is a predefined name replace it with the
-        probability distribution it corresponds to. Otherwise, simply return
-        the TTC distribution provided as is.
-
-        Arguments:
-        ttc_entry   - the TTC entry to check for predefined names
-
-        Returns:
-        If the TTC entry provided contained a predefined name the TTC
-        probability distrubtion corresponding to it. Otherwise, the TTC
-        distribution provided as a parameter as is.
-        """
-        if ttc_entry is None:
-            return {}
-
-        ttc = self.predef_ttcs.get(str(ttc_entry.get('name')))
-        if ttc is not None:
-            return ttc
-        else:
-            return ttc_entry
-
-
     def _to_dict(self):
         """Converts LanguageGraph into a dict"""
 
@@ -940,13 +959,11 @@ class LanguageGraph():
                 asset_dict['name']
             )
             for attack_step_dict in asset_dict['attack_steps'].values():
-                ttc = lang_graph.replace_if_predef_ttc(
-                    attack_step_dict['ttc'])
                 attack_step_node = LanguageGraphAttackStep(
                     name = attack_step_dict['name'],
                     type = attack_step_dict['type'],
                     asset = asset,
-                    ttc = ttc,
+                    ttc = get_ttc_distribution(attack_step_dict),
                     overrides = attack_step_dict['overrides'],
                     children = {},
                     parents = {},
@@ -1663,12 +1680,11 @@ class LanguageGraph():
                     attack_step_attribs['name']
                 )
 
-                ttc = self.replace_if_predef_ttc(attack_step_attribs['ttc'])
                 attack_step_node = LanguageGraphAttackStep(
                     name = attack_step_attribs['name'],
                     type = attack_step_attribs['type'],
                     asset = asset,
-                    ttc = ttc,
+                    ttc = get_ttc_distribution(attack_step_attribs),
                     overrides = (
                         attack_step_attribs['reaches']['overrides']
                         if attack_step_attribs['reaches'] else False

maltoolbox/model.py

@@ -326,12 +326,6 @@ class ModelAsset:
         self._associated_assets: dict[str, set[ModelAsset]] = {}
         self.attack_step_nodes: list = []
 
-        for step in self.lg_asset.attack_steps.values():
-            if step.type == 'defense' and step.name not in self.defenses:
-                self.defenses[step.name] = 1.0 if step.ttc and \
-                    step.ttc['name'] == 'Enabled' else 0.0
-
-
     def _to_dict(self):
         """Get dictionary representation of the asset."""
 
@@ -345,14 +339,8 @@ class ModelAsset:
             'associated_assets': {}
         }
 
-        # Only add non-default values for defenses to improve legibility of
-        # the model format
         for defense, defense_value in self.defenses.items():
-            lg_step = self.lg_asset.attack_steps[defense]
-            default_defval = 1.0 if lg_step.ttc and \
-                    lg_step.ttc['name'] == 'Enabled' else 0.0
-            if defense_value != default_defval:
-                asset_dict['defenses'][defense] = defense_value
+            asset_dict['defenses'][defense] = defense_value
 
         for fieldname, assets in self.associated_assets.items():
             asset_dict['associated_assets'][fieldname] = {asset.id: asset.name