mal-toolbox 0.3.11__tar.gz → 1.0.0__tar.gz

{mal_toolbox-0.3.11/mal_toolbox.egg-info → mal_toolbox-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 0.3.11
+Version: 1.0.0
 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
@@ -23,6 +23,7 @@ Requires-Dist: antlr4-tools
 Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt
 Requires-Dist: PyYAML
+Dynamic: license-file
 
 # MAL Toolbox overview
 
@@ -30,7 +31,6 @@ MAL Toolbox is a collection of python modules to help developers create and work
 MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations (see MAL Simulator) or analysis.
-MAL Toolbox also gives the ability to view the AttackGraph/Model graphically in neo4j.
 
 [Documentation](https://mal-lang.org/mal-toolbox/index.html)(Work in progress)
 
@@ -53,13 +53,7 @@ With a MAL language a Model (a MAL instance model) can be created either
 from a model file or empty.
 
 The model class will store all of the relevant information to the MAL
-instance model, most importantly the assets and associations that make it up.
-
-Assets and associations are objects of classes created using the language
-classes factory submodule in runtime. It also allows for `Attacker` objects
-to be created and associated with attack steps on assets in the model.
-The most relevant methods of the Model are the ones used to add different
-elements to the model, `add_asset`, `add_association`, and `add_attacker`.
+instance model, most importantly the assets and their associations.
 
 Model objects can be used to generate attack graphs with the AttackGraph module.
 
@@ -76,11 +70,6 @@ nodes related and the asset field which will contain the object in the model
 instance to which this attack step belongs to, if this information is
 available.
 
-If it is relevant the `attach_attackers` function can be called on the
-resulting attack graph with the instance model given as a parameter in order
-to create attack step nodes that represent the entry points of the attackers
-and attach them to the attack steps specified in the instance model.
-
 ## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
@@ -131,16 +120,9 @@ Arguments:
     <lang_file>     Path to .mar or .mal file containing MAL spec.
     <output_file>   Path to write the result of the compilation (yml/json).
 
-Options:
-    --neo4j         Ingest attack graph and instance model into a Neo4j instance
-
 Notes:
     - <lang_file> can be either a .mar file (generated by the older MAL
       compiler) or a .mal file containing the DSL written in MAL.
-
-    - If --neo4j is used, the Neo4j instance should be running. The connection
-      parameters required for this app to reach the Neo4j instance should be
-      defined in the default.conf file.
 ```
 
 ## Code examples / Tutorial

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0}/README.md

@@ -4,7 +4,6 @@ MAL Toolbox is a collection of python modules to help developers create and work
 MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations (see MAL Simulator) or analysis.
-MAL Toolbox also gives the ability to view the AttackGraph/Model graphically in neo4j.
 
 [Documentation](https://mal-lang.org/mal-toolbox/index.html)(Work in progress)
 
@@ -27,13 +26,7 @@ With a MAL language a Model (a MAL instance model) can be created either
 from a model file or empty.
 
 The model class will store all of the relevant information to the MAL
-instance model, most importantly the assets and associations that make it up.
-
-Assets and associations are objects of classes created using the language
-classes factory submodule in runtime. It also allows for `Attacker` objects
-to be created and associated with attack steps on assets in the model.
-The most relevant methods of the Model are the ones used to add different
-elements to the model, `add_asset`, `add_association`, and `add_attacker`.
+instance model, most importantly the assets and their associations.
 
 Model objects can be used to generate attack graphs with the AttackGraph module.
 
@@ -50,11 +43,6 @@ nodes related and the asset field which will contain the object in the model
 instance to which this attack step belongs to, if this information is
 available.
 
-If it is relevant the `attach_attackers` function can be called on the
-resulting attack graph with the instance model given as a parameter in order
-to create attack step nodes that represent the entry points of the attackers
-and attach them to the attack steps specified in the instance model.
-
 ## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
@@ -105,16 +93,9 @@ Arguments:
     <lang_file>     Path to .mar or .mal file containing MAL spec.
     <output_file>   Path to write the result of the compilation (yml/json).
 
-Options:
-    --neo4j         Ingest attack graph and instance model into a Neo4j instance
-
 Notes:
     - <lang_file> can be either a .mar file (generated by the older MAL
       compiler) or a .mal file containing the DSL written in MAL.
-
-    - If --neo4j is used, the Neo4j instance should be running. The connection
-      parameters required for this app to reach the Neo4j instance should be
-      defined in the default.conf file.
 ```
 
 ## Code examples / Tutorial

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0/mal_toolbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 0.3.11
+Version: 1.0.0
 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
@@ -23,6 +23,7 @@ Requires-Dist: antlr4-tools
 Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt
 Requires-Dist: PyYAML
+Dynamic: license-file
 
 # MAL Toolbox overview
 
@@ -30,7 +31,6 @@ MAL Toolbox is a collection of python modules to help developers create and work
 MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations (see MAL Simulator) or analysis.
-MAL Toolbox also gives the ability to view the AttackGraph/Model graphically in neo4j.
 
 [Documentation](https://mal-lang.org/mal-toolbox/index.html)(Work in progress)
 
@@ -53,13 +53,7 @@ With a MAL language a Model (a MAL instance model) can be created either
 from a model file or empty.
 
 The model class will store all of the relevant information to the MAL
-instance model, most importantly the assets and associations that make it up.
-
-Assets and associations are objects of classes created using the language
-classes factory submodule in runtime. It also allows for `Attacker` objects
-to be created and associated with attack steps on assets in the model.
-The most relevant methods of the Model are the ones used to add different
-elements to the model, `add_asset`, `add_association`, and `add_attacker`.
+instance model, most importantly the assets and their associations.
 
 Model objects can be used to generate attack graphs with the AttackGraph module.
 
@@ -76,11 +70,6 @@ nodes related and the asset field which will contain the object in the model
 instance to which this attack step belongs to, if this information is
 available.
 
-If it is relevant the `attach_attackers` function can be called on the
-resulting attack graph with the instance model given as a parameter in order
-to create attack step nodes that represent the entry points of the attackers
-and attach them to the attack steps specified in the instance model.
-
 ## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
@@ -131,16 +120,9 @@ Arguments:
     <lang_file>     Path to .mar or .mal file containing MAL spec.
     <output_file>   Path to write the result of the compilation (yml/json).
 
-Options:
-    --neo4j         Ingest attack graph and instance model into a Neo4j instance
-
 Notes:
     - <lang_file> can be either a .mar file (generated by the older MAL
       compiler) or a .mal file containing the DSL written in MAL.
-
-    - If --neo4j is used, the Neo4j instance should be running. The connection
-      parameters required for this app to reach the Neo4j instance should be
-      defined in the default.conf file.
 ```
 
 ## Code examples / Tutorial

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0}/mal_toolbox.egg-info/SOURCES.txt

@@ -13,15 +13,12 @@ maltoolbox/__main__.py
 maltoolbox/exceptions.py
 maltoolbox/file_utils.py
 maltoolbox/model.py
+maltoolbox/py.typed
 maltoolbox/attackgraph/__init__.py
-maltoolbox/attackgraph/attacker.py
 maltoolbox/attackgraph/attackgraph.py
 maltoolbox/attackgraph/node.py
-maltoolbox/attackgraph/query.py
 maltoolbox/attackgraph/analyzers/__init__.py
-maltoolbox/attackgraph/analyzers/apriori.py
 maltoolbox/ingestors/__init__.py
-maltoolbox/ingestors/neo4j.py
 maltoolbox/language/__init__.py
 maltoolbox/language/languagegraph.py
 maltoolbox/language/compiler/__init__.py

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0}/maltoolbox/__init__.py

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# MAL Toolbox v0.3.11
+# MAL Toolbox v1.0.0
 # Copyright 2025, Andrei Buhaiu.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,7 +21,7 @@ MAL-Toolbox Framework
 """
 
 __title__ = "maltoolbox"
-__version__ = "0.3.11"
+__version__ = "1.0.0"
 __authors__ = [
     "Andrei Buhaiu",
     "Giuseppe Nebbione",
@@ -45,9 +45,9 @@ config: dict[str, Any] = {
         "log_file": "logs/log.txt",
         "attackgraph_file": "logs/attackgraph.yml",
         "model_file": "logs/model.yml",
-        "langspec_file": "logs/langspec_file.yml",
+        "langspec_file": "logs/langspec_file.json",
+        "langgraph_file": "logs/langgraph.yml",
     },
-    "neo4j": {"uri": None, "username": None, "password": None, "dbname": None},
 }
 
 config_file = os.getenv("MALTOOLBOX_CONFIG", "maltoolbox.yml")
@@ -56,8 +56,7 @@ if os.path.exists(config_file):
     with open(config_file) as f:
         config |= yaml.safe_load(f)
 
-log_configs, neo4j_configs = config.values()
-
+log_configs = config['logging']
 os.makedirs(os.path.dirname(log_configs["log_file"]), exist_ok=True)
 
 formatter = logging.Formatter(

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0}/maltoolbox/__main__.py

@@ -11,26 +11,18 @@ Arguments:
     <lang_file>     Path to .mar or .mal file containing MAL spec.
     <output_file>   Path to write the result of the compilation (yml/json).
 
-Options:
-    --neo4j         Ingest attack graph and instance model into a Neo4j instance
-
 Notes:
     - <lang_file> can be either a .mar file (generated by the older MAL
       compiler) or a .mal file containing the DSL written in MAL.
-
-    - If --neo4j is used, the Neo4j instance should be running. The connection
-      parameters required for this app to reach the Neo4j instance should be
-      defined in the default.conf file.
 """
 
 import logging
 import json
 import docopt
 
-from . import log_configs, neo4j_configs
+from . import log_configs
 from .attackgraph import create_attack_graph
 from .language.compiler import MalCompiler
-from .ingestors import neo4j
 from .language.languagegraph import LanguageGraph
 from .translators.updater import load_model_from_older_version
 
@@ -39,14 +31,12 @@ logger = logging.getLogger(__name__)
 def generate_attack_graph(
         model_file: str,
         lang_file: str,
-        send_to_neo4j: bool
     ) -> None:
-    """Create an attack graph and optionally send to neo4j
+    """Create an attack graph
 
     Args:
     model_file      - path to the model file
     lang_file       - path to the language file
-    send_to_neo4j   - whether to ingest into neo4j or not
     """
     attack_graph = create_attack_graph(lang_file, model_file)
     if log_configs['attackgraph_file']:
@@ -54,27 +44,6 @@ def generate_attack_graph(
             log_configs['attackgraph_file']
         )
 
-    if send_to_neo4j:
-        logger.debug('Ingest model graph into Neo4J database.')
-        neo4j.ingest_model(
-            attack_graph.model,
-            neo4j_configs['uri'],
-            neo4j_configs['username'],
-            neo4j_configs['password'],
-            neo4j_configs['dbname'],
-            delete=True
-        )
-        logger.debug('Ingest attack graph into Neo4J database.')
-        neo4j.ingest_attack_graph(
-            attack_graph,
-            neo4j_configs['uri'],
-            neo4j_configs['username'],
-            neo4j_configs['password'],
-            neo4j_configs['dbname'],
-            delete=False
-        )
-
-
 def compile(lang_file: str, output_file: str) -> None:
     """Compile language and dump into output file"""
     compiler = MalCompiler()
@@ -97,7 +66,7 @@ def main():
 
     if args['attack-graph'] and args['generate']:
         generate_attack_graph(
-            args['<model_file>'], args['<lang_file>'], args['--neo4j']
+            args['<model_file>'], args['<lang_file>']
         )
     elif args['compile']:
         compile(

{mal_toolbox-0.3.11 → mal_toolbox-1.0.0}/maltoolbox/attackgraph/__init__.py

@@ -3,6 +3,12 @@ Contains tools used to generate attack graphs from MAL instance
 models and analyze attack graphs.
 """
 
-from .attacker import Attacker
 from .attackgraph import AttackGraph, create_attack_graph
 from .node import AttackGraphNode
+
+__all__ = [
+    "Attacker",
+    "AttackGraph",
+    "AttackGraphNode",
+    "create_attack_graph"
+]