mal-toolbox 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

maltoolbox/visualization/graphviz_utils.py

@@ -1,8 +1,9 @@
 import random
+
 import graphviz
 
-from ..model import Model
 from ..attackgraph import AttackGraph
+from ..model import Model
 
 graphviz_bright_colors = [
     "aliceblue", "antiquewhite", "antiquewhite1", "antiquewhite2", "azure", "azure1", "azure2",
@@ -60,11 +61,12 @@ def render_model(model: Model):
                 )
     dot.render(directory='.', view=True)
 
+
 def render_attack_graph(attack_graph: AttackGraph):
     """Render attack graph graphviz, create pdf and open it"""
     assert attack_graph.model, "Attack graph needs a model"
     dot = graphviz.Graph(attack_graph.model.name)
-    dot.graph_attr['nodesep'] = '3.0' # Node separation
+    dot.graph_attr['nodesep'] = '3.0'  # Node separation
     dot.graph_attr['ratio'] = 'compress'
 
     # Create nodes

maltoolbox/visualization/neo4j_utils.py

@@ -1,24 +1,24 @@
-"""
-MAL-Toolbox Neo4j Ingestor Module
+"""MAL-Toolbox Neo4j Ingestor Module
 """
 # mypy: ignore-errors
 
 import logging
-
 from typing import Any
+
 from py2neo import Graph, Node, Relationship, Subgraph
 
 logger = logging.getLogger(__name__)
 
+
 def ingest_attack_graph_neo4j(
         graph,
         neo4j_config: dict[str, Any],
         delete: bool = True
     ) -> None:
-    """
-    Ingest an attack graph into a neo4j database
+    """Ingest an attack graph into a neo4j database
 
     Arguments:
+    ---------
     graph                - the attackgraph provided by the atkgraph.py module.
     uri                  - the URI to a running neo4j instance
     username             - the username to login on Neo4J
@@ -26,8 +26,8 @@ def ingest_attack_graph_neo4j(
     dbname               - the selected database
     delete               - if True, the previous content of the database is deleted
                            before ingesting the new attack graph
-    """
 
+    """
     uri = neo4j_config.get('uri')
     username = neo4j_config.get('username')
     password = neo4j_config.get('password')
@@ -43,13 +43,12 @@ def ingest_attack_graph_neo4j(
         node_dict = node.to_dict()
         nodes[node.id] = Node(
             node_dict['asset'] if 'asset' in node_dict else node_dict['id'],
-            name = node_dict['name'],
-            full_name = node.full_name,
-            type = node_dict['type'],
-            ttc = str(node_dict['ttc']),
+            name=node_dict['name'],
+            full_name=node.full_name,
+            type=node_dict['type'],
+            ttc=str(node_dict['ttc']),
         )
 
-
     for node in graph.nodes.values():
         for child in node.children:
             rels.append(Relationship(nodes[node.id], nodes[child.id]))
@@ -66,10 +65,10 @@ def ingest_model_neo4j(
         neo4j_config: dict[str, Any],
         delete: bool = True
     ) -> None:
-    """
-    Ingest an instance model graph into a Neo4J database
+    """Ingest an instance model graph into a Neo4J database
 
     Arguments:
+    ---------
     model                - the instance model dictionary as provided by the model.py module
     uri                  - the URI to a running neo4j instance
     username             - the username to login on Neo4J
@@ -77,8 +76,8 @@ def ingest_model_neo4j(
     dbname               - the selected database
     delete               - if True, the previous content of the database is deleted
                            before ingesting the new attack graph
-    """
 
+    """
     uri = neo4j_config.get('uri')
     username = neo4j_config.get('username')
     password = neo4j_config.get('password')

maltoolbox/visualization/utils.py

@@ -1,14 +1,13 @@
 from maltoolbox.model import Model
 
+
 def position_assets(model: Model):
-    """
-    Assigns (x, y) positions to assets in a graph where relations are stored
+    """Assigns (x, y) positions to assets in a graph where relations are stored
     in asset.associated_assets[relation_name] = [related_assets...].
     Positions are stored in asset.extras['position'] = {'x': ..., 'y': ...}.
     Layout is computed by traversing connected components.
     Adds uniform padding between assets.
     """
-
     visited = set()
     x_spacing = 200
     y_spacing = 200

mal_toolbox-1.1.1.dist-info/RECORD

@@ -1,32 +0,0 @@
-mal_toolbox-1.1.1.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
-mal_toolbox-1.1.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-maltoolbox/__init__.py,sha256=XZ8sSK4zPhqPNVWRIy-JKgipTyX3dx6CpnloZs37xlY,2158
-maltoolbox/__main__.py,sha256=XREFzTuS_hIajSt1aNdzW8a5XFS3lAGrenEBnB_zzjI,3484
-maltoolbox/exceptions.py,sha256=0YjPx2v1yYumZ2o7pVZ1s_jS-GAb3Ng979KEFhROSNY,1399
-maltoolbox/file_utils.py,sha256=fYG3UsvPQcU0ES_WI3nLfuzSZgc0jtE4IAxdMGgs9aA,1876
-maltoolbox/model.py,sha256=0z0S0SH4lkslsAxPNxb7exfmNwBPXM_BK0Oujo899a4,18139
-maltoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maltoolbox/attackgraph/__init__.py,sha256=m_81AjzwXONdclcW_R7mF2f8p-4DvoSRVfQ3Nyh7fak,298
-maltoolbox/attackgraph/attackgraph.py,sha256=ux6TjBLfAgKEfwzGqNU6D_xDGCzc4UTCrdTh1ADoKeI,27722
-maltoolbox/attackgraph/node.py,sha256=F48FgCeYQFEiAq1HswjOnHImYSSRINZpHDvUZP0FqRk,4265
-maltoolbox/attackgraph/analyzers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maltoolbox/language/__init__.py,sha256=TsTTryEyjChwHN1o5F2BSUlFsAss2N6J0H0-nzvXiD8,489
-maltoolbox/language/languagegraph.py,sha256=fNQRSDE_XKQMGgxZe75kpBbLpqjhDD5guAmmx9nSZR0,72143
-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/patternfinder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-maltoolbox/patternfinder/attackgraph_patterns.py,sha256=jgW7UG1yBJ08jvuokdpSiHm7jDMg2PTcjfGXZ8UJAnw,5082
-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
-maltoolbox/visualization/__init__.py,sha256=JM-cfT_9wtA5GJOAiS_2jtY5TYsuHOFqgn1cZpmcAeE,349
-maltoolbox/visualization/draw_io_utils.py,sha256=7ZmhG5yTEYLZnMhOY9gfyKOb4Dmu2K9v1IdL6Qy-8i0,14372
-maltoolbox/visualization/graphviz_utils.py,sha256=dfQhPL6Z2hvlMFpThsDr-5tm4Pa22SGHEiXw5ym9JJc,3906
-maltoolbox/visualization/neo4j_utils.py,sha256=FHTkkaTvlrf36RXdVdD65TYtlKLNcna9pCl39d6o8wg,3487
-maltoolbox/visualization/utils.py,sha256=8SrGMUXJPFBjDd2Ujw7jgoR2zqCNFdoNHGmG4_tEhwQ,1485
-mal_toolbox-1.1.1.dist-info/METADATA,sha256=Fcv-ZEhpIHUPmGkmR7_QgfkxCt3fncco7BFVl_J9KAs,5960
-mal_toolbox-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mal_toolbox-1.1.1.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
-mal_toolbox-1.1.1.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
-mal_toolbox-1.1.1.dist-info/RECORD,,

maltoolbox/translators/securicad.py

@@ -1,179 +0,0 @@
-"""
-MAL-Toolbox securiCAD Translator Module
-"""
-
-import zipfile
-import json
-import logging
-import xml.etree.ElementTree as ET
-
-from typing import Optional
-
-from ..model import Model
-from ..language import LanguageGraph
-
-logger = logging.getLogger(__name__)
-
-# TODO: Update this at some point
-
-# def load_model_from_scad_archive(
-#         scad_archive: str,
-#         lang_graph: LanguageGraph
-#     ) -> Optional[Model]:
-#     """
-#     Reads a '.sCAD' archive generated by securiCAD representing an instance
-#     model and loads the information into a maltoobox.model.Model object.
-# 
-#     Arguments:
-#     scad_archive            - the path to a '.sCAD' archive
-#     lang_graph              - a language graph representing the MAL
-#                               language specification
-# 
-#     Return:
-#     A maltoobox.model.Model object containing the instance model.
-#     """
-#     with zipfile.ZipFile(scad_archive, 'r') as archive:
-#         filelist = archive.namelist()
-#         model_file = next(filter(lambda x: ( x[-4:] == '.eom'), filelist))
-#         scad_model = archive.read(model_file)
-#         root = ET.fromstring(scad_model)
-# 
-#     instance_model = Model(scad_archive,
-#         lang_classes_factory)
-# 
-#     for child in root.iter('objects'):
-# 
-#         if logger.isEnabledFor(logging.DEBUG):
-#             # Avoid running json.dumps when not in debug
-#             logger.debug(
-#                 'Loading asset from "%s": \n%s',
-#                 scad_archive, json.dumps(child.attrib, indent=2)
-#             )
-# 
-#         if child.attrib['metaConcept'] == 'Attacker':
-#             attacker_obj_id = int(child.attrib['id'])
-#             attacker_at = AttackerAttachment()
-#             attacker_at.entry_points = []
-#             instance_model.add_attacker(
-#                 attacker_at,
-#                 attacker_id = attacker_obj_id
-#             )
-#             continue
-# 
-#         if not hasattr(lang_classes_factory.ns,
-#             child.attrib['metaConcept']):
-#             logger.error(
-#                 'Failed to find %s asset in language specification!',
-#                 child.attrib["metaConcept"]
-#             )
-#             return None
-#         asset = getattr(lang_classes_factory.ns,
-#             child.attrib['metaConcept'])(name = child.attrib['name'])
-#         asset_id = int(child.attrib['id'])
-#         for subchild in child.iter('evidenceAttributes'):
-#             defense_name = subchild.attrib['metaConcept']
-#             defense_name = defense_name[0].lower() + defense_name[1:]
-#             for distrib in subchild.iter('evidenceDistribution'):
-#                 for d in distrib.iter('parameters'):
-#                     if 'value' in d.attrib:
-#                         dist_value = d.attrib['value']
-#                         setattr(asset, defense_name, float(dist_value))
-#         instance_model.add_asset(asset, asset_id)
-# 
-#     for child in root.iter('associations'):
-#         logger.debug(
-#             'Load association ("%s", "%s", "%s", "%s") from %s',
-#             child.attrib["sourceObject"], child.attrib["targetObject"],
-#             child.attrib["targetProperty"], child.attrib["sourceProperty"],
-#             scad_archive
-#         )
-#         # Note: This is not a bug in the code. The fields and assets are
-#         # listed incorrectly in the securiCAD format where the source asset
-#         # matches the target field and vice versa.
-#         left_id = int(child.attrib['targetObject'])
-#         right_id = int(child.attrib['sourceObject'])
-#         attacker_id = None
-#         if child.attrib['sourceProperty'] == 'firstSteps':
-#             attacker_id = right_id
-#             target_id = left_id
-#             target_prop = child.attrib['targetProperty']
-#         elif child.attrib['targetProperty'] == 'firstSteps':
-#             attacker_id = left_id
-#             target_id = right_id
-#             target_prop = child.attrib['sourceProperty']
-# 
-#         if attacker_id is not None:
-#             attacker = instance_model.get_attacker_by_id(attacker_id)
-#             if not attacker:
-#                 logger.error(
-#                     'Failed to find attacker with id %s in model!',
-#                     attacker_id
-#                 )
-#                 return None
-#             target_asset = instance_model.get_asset_by_id(target_id)
-#             if not target_asset:
-#                 logger.error(
-#                     'Failed to find asset with id %s in model!',
-#                     target_id
-#                 )
-#                 return None
-#             attacker.entry_points.append((target_asset,
-#                 [target_prop.split('.')[0]]))
-#             continue
-# 
-#         left_asset = instance_model.get_asset_by_id(left_id)
-#         if not left_asset:
-#             logger.error(
-#                 'Failed to find asset with id %s in model!', left_id
-#             )
-#             return None
-#         right_asset = instance_model.get_asset_by_id(right_id)
-#         if not right_asset:
-#             logger.error(
-#                 'Failed to find asset with id %s in model!', right_id
-#             )
-#             return None
-# 
-#         # Note: This is not a bug in the code. The fields and assets are
-#         # listed incorrectly in the securiCAD format where the source asset
-#         # matches the target field and vice versa.
-#         left_field = child.attrib['sourceProperty']
-#         right_field = child.attrib['targetProperty']
-#         lang_graph_assoc = None
-#         for assoc in left_asset.lg_asset.associations:
-#             if (assoc.left_field.fieldname == left_field and
-#                     assoc.right_field.fieldname == right_field) or \
-#                     (assoc.left_field.fieldname == right_field and
-#                     assoc.right_field.fieldname == left_field):
-#                 lang_graph_assoc = assoc
-#                 break
-# 
-#         if not lang_graph_assoc:
-#             raise LookupError(
-#                 'Failed to find ("%s", "%s", "%s", "%s")'
-#                 'association in lang specification.' %
-#                 (left_asset.type, right_asset.type,
-#                 left_field, right_field)
-#             )
-#             return None
-# 
-#         logger.debug('Found "%s" association.', lang_graph_assoc.name)
-#         assoc_name = lang_classes_factory.get_association_by_signature(
-#             lang_graph_assoc.name,
-#             left_asset.type,
-#             right_asset.type
-#         )
-# 
-#         if assoc_name is None:
-#             logger.error(
-#                 'Failed to find association with name \"%s\" in model!',
-#                 lang_graph_assoc.name
-#             )
-#             return None
-# 
-#         assoc = getattr(lang_classes_factory.ns, assoc_name)()
-#         setattr(assoc, left_field, [left_asset])
-#         setattr(assoc, right_field, [right_asset])
-#         instance_model.add_association(assoc)
-# 
-#     return instance_model