mal-toolbox 0.0.39__tar.gz → 0.1.0__tar.gz

{mal_toolbox-0.0.39/mal_toolbox.egg-info → mal_toolbox-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mal-toolbox
-Version: 0.0.39
+Version: 0.1.0
 Summary: A collection of tools used to create MAL models and attack graphs.
 Author-email: Andrei Buhaiu <buhaiu@kth.se>, Giuseppe Nebbione <nebbione@kth.se>, Nikolaos Kakouros <nkak@kth.se>, Jakob Nyberg <jaknyb@kth.se>, Joakim Loxdal <loxdal@kth.se>
 License: Apache Software License
@@ -23,17 +23,21 @@ Requires-Dist: python-jsonschema-objects>=0.4.1
 Requires-Dist: antlr4-tools
 Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt
+Requires-Dist: PyYAML
 
-# Overview
+# MAL Toolbox overview
 
-A collection of python modules to help developers create and work with MAL
-models and attack graphs.
+MAL Toolbox is a collection of python modules to help developers create and work with
+MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
-# The Language Module
+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.
+
+## The Language Module
 
 The language module provides various tools to process MAL languages.
 
-## The Language Specification Submodule
+### The Language Specification Submodule
 
 The language specification submodule provides functions to load the
 specification from a .mar archive(`load_language_specification_from_mar`) or a
@@ -42,7 +46,7 @@ then be used to generate python classes representing the assets and
 associations of the language and to determine the attack steps for each asset
 when generating the attack graph.
 
-## The Language Classes Factory Submodule
+### The Language Classes Factory Submodule
 
 The language classes factory submodule is used to generate python classes
 using the `python_jsonschema_objects` package from a language specification.
@@ -53,19 +57,23 @@ using JSON Schema validators they will enforce their restrictions when using
 the python objects created. These classes are typically used in conjunction
 with model module to create instance models.
 
-# The Model Module
+## The Model Module
+
+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`.
 
-The model module is used to create MAL instance models. 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. These assets and
-associations should be objects created using the language classes factory
-submodule. It also allows for `Attacker` objects to be created and associated
-with attack steps on assets in the model. The most relevant functions here are
-the ones used to add different elements to the model, `add_asset`,
-`add_association`, and `add_attacker`. Model objects can be used to generate
-attack graphs using the attack graph module.
+Model objects can be used to generate attack graphs with the AttackGraph module.
 
-# The Attack Graph Module
+## The Attack Graph Module
 
 The attack graph module contains tools used to generate attack graphs from
 existing MAL instance models and analyse MAL attack graphs. The function used
@@ -83,14 +91,21 @@ 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
+## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
 model or attack graph. Currently the Neo4J ingestor is the only one available
 and it can be used to visualise the instance model and the attack graph.
 
-# Command Line Client
 
+# Usage
+
+## Configuration
+A default configuration file `default.conf` can be found in the package
+directory. This contains the default values to use for logging and can also be
+used to store the information needed to access the local Neo4J instance.
+
+## Command Line Client
 In addition to the modules that make up the MAL-Toolbox package it also
 provides a simple command line client that can be used to easily generate
 attack graphs from a .mar language specification file and a JSON instance
@@ -102,7 +117,13 @@ The usage is: `maltoolbox gen_ag [--neo4j] <model_json_file>
 If the `--neo4j` flag is specified the model and attack graph will be loaded
 into a local Neo4J instance.
 
-# Configuration
-A default configuration file `default.conf` can be found in the package
-directory. This contains the default values to use for logging and can also be
-used to store the information needed to access the local Neo4J instance.
+## Code examples / Tutorial
+
+To find code examples and tutorials, visit the
+[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
+
+# Tests
+There are unit tests inside of ./tests.
+Before running the tests, make sure to install the requirements in ./tests/requirements.txt with `python -m pip install -r ./tests/requirements.txt`.
+
+To run all tests, use the `pytest` command. To run just a specific file or test function use `pytest tests/<filename>` or `pytest -k <function_name>`.

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0}/README.md

@@ -1,13 +1,16 @@
-# Overview
+# MAL Toolbox overview
 
-A collection of python modules to help developers create and work with MAL
-models and attack graphs.
+MAL Toolbox is a collection of python modules to help developers create and work with
+MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
-# The Language Module
+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.
+
+## The Language Module
 
 The language module provides various tools to process MAL languages.
 
-## The Language Specification Submodule
+### The Language Specification Submodule
 
 The language specification submodule provides functions to load the
 specification from a .mar archive(`load_language_specification_from_mar`) or a
@@ -16,7 +19,7 @@ then be used to generate python classes representing the assets and
 associations of the language and to determine the attack steps for each asset
 when generating the attack graph.
 
-## The Language Classes Factory Submodule
+### The Language Classes Factory Submodule
 
 The language classes factory submodule is used to generate python classes
 using the `python_jsonschema_objects` package from a language specification.
@@ -27,19 +30,23 @@ using JSON Schema validators they will enforce their restrictions when using
 the python objects created. These classes are typically used in conjunction
 with model module to create instance models.
 
-# The Model Module
+## The Model Module
+
+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`.
 
-The model module is used to create MAL instance models. 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. These assets and
-associations should be objects created using the language classes factory
-submodule. It also allows for `Attacker` objects to be created and associated
-with attack steps on assets in the model. The most relevant functions here are
-the ones used to add different elements to the model, `add_asset`,
-`add_association`, and `add_attacker`. Model objects can be used to generate
-attack graphs using the attack graph module.
+Model objects can be used to generate attack graphs with the AttackGraph module.
 
-# The Attack Graph Module
+## The Attack Graph Module
 
 The attack graph module contains tools used to generate attack graphs from
 existing MAL instance models and analyse MAL attack graphs. The function used
@@ -57,14 +64,21 @@ 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
+## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
 model or attack graph. Currently the Neo4J ingestor is the only one available
 and it can be used to visualise the instance model and the attack graph.
 
-# Command Line Client
 
+# Usage
+
+## Configuration
+A default configuration file `default.conf` can be found in the package
+directory. This contains the default values to use for logging and can also be
+used to store the information needed to access the local Neo4J instance.
+
+## Command Line Client
 In addition to the modules that make up the MAL-Toolbox package it also
 provides a simple command line client that can be used to easily generate
 attack graphs from a .mar language specification file and a JSON instance
@@ -76,7 +90,13 @@ The usage is: `maltoolbox gen_ag [--neo4j] <model_json_file>
 If the `--neo4j` flag is specified the model and attack graph will be loaded
 into a local Neo4J instance.
 
-# Configuration
-A default configuration file `default.conf` can be found in the package
-directory. This contains the default values to use for logging and can also be
-used to store the information needed to access the local Neo4J instance.
+## Code examples / Tutorial
+
+To find code examples and tutorials, visit the
+[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
+
+# Tests
+There are unit tests inside of ./tests.
+Before running the tests, make sure to install the requirements in ./tests/requirements.txt with `python -m pip install -r ./tests/requirements.txt`.
+
+To run all tests, use the `pytest` command. To run just a specific file or test function use `pytest tests/<filename>` or `pytest -k <function_name>`.

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0/mal_toolbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mal-toolbox
-Version: 0.0.39
+Version: 0.1.0
 Summary: A collection of tools used to create MAL models and attack graphs.
 Author-email: Andrei Buhaiu <buhaiu@kth.se>, Giuseppe Nebbione <nebbione@kth.se>, Nikolaos Kakouros <nkak@kth.se>, Jakob Nyberg <jaknyb@kth.se>, Joakim Loxdal <loxdal@kth.se>
 License: Apache Software License
@@ -23,17 +23,21 @@ Requires-Dist: python-jsonschema-objects>=0.4.1
 Requires-Dist: antlr4-tools
 Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt
+Requires-Dist: PyYAML
 
-# Overview
+# MAL Toolbox overview
 
-A collection of python modules to help developers create and work with MAL
-models and attack graphs.
+MAL Toolbox is a collection of python modules to help developers create and work with
+MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
-# The Language Module
+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.
+
+## The Language Module
 
 The language module provides various tools to process MAL languages.
 
-## The Language Specification Submodule
+### The Language Specification Submodule
 
 The language specification submodule provides functions to load the
 specification from a .mar archive(`load_language_specification_from_mar`) or a
@@ -42,7 +46,7 @@ then be used to generate python classes representing the assets and
 associations of the language and to determine the attack steps for each asset
 when generating the attack graph.
 
-## The Language Classes Factory Submodule
+### The Language Classes Factory Submodule
 
 The language classes factory submodule is used to generate python classes
 using the `python_jsonschema_objects` package from a language specification.
@@ -53,19 +57,23 @@ using JSON Schema validators they will enforce their restrictions when using
 the python objects created. These classes are typically used in conjunction
 with model module to create instance models.
 
-# The Model Module
+## The Model Module
+
+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`.
 
-The model module is used to create MAL instance models. 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. These assets and
-associations should be objects created using the language classes factory
-submodule. It also allows for `Attacker` objects to be created and associated
-with attack steps on assets in the model. The most relevant functions here are
-the ones used to add different elements to the model, `add_asset`,
-`add_association`, and `add_attacker`. Model objects can be used to generate
-attack graphs using the attack graph module.
+Model objects can be used to generate attack graphs with the AttackGraph module.
 
-# The Attack Graph Module
+## The Attack Graph Module
 
 The attack graph module contains tools used to generate attack graphs from
 existing MAL instance models and analyse MAL attack graphs. The function used
@@ -83,14 +91,21 @@ 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
+## Ingestors Module
 
 The ingestors module contains various tools that can make use of the instance
 model or attack graph. Currently the Neo4J ingestor is the only one available
 and it can be used to visualise the instance model and the attack graph.
 
-# Command Line Client
 
+# Usage
+
+## Configuration
+A default configuration file `default.conf` can be found in the package
+directory. This contains the default values to use for logging and can also be
+used to store the information needed to access the local Neo4J instance.
+
+## Command Line Client
 In addition to the modules that make up the MAL-Toolbox package it also
 provides a simple command line client that can be used to easily generate
 attack graphs from a .mar language specification file and a JSON instance
@@ -102,7 +117,13 @@ The usage is: `maltoolbox gen_ag [--neo4j] <model_json_file>
 If the `--neo4j` flag is specified the model and attack graph will be loaded
 into a local Neo4J instance.
 
-# Configuration
-A default configuration file `default.conf` can be found in the package
-directory. This contains the default values to use for logging and can also be
-used to store the information needed to access the local Neo4J instance.
+## Code examples / Tutorial
+
+To find code examples and tutorials, visit the
+[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
+
+# Tests
+There are unit tests inside of ./tests.
+Before running the tests, make sure to install the requirements in ./tests/requirements.txt with `python -m pip install -r ./tests/requirements.txt`.
+
+To run all tests, use the `pytest` command. To run just a specific file or test function use `pytest tests/<filename>` or `pytest -k <function_name>`.

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0}/mal_toolbox.egg-info/SOURCES.txt

@@ -11,13 +11,17 @@ maltoolbox/__init__.py
 maltoolbox/__main__.py
 maltoolbox/default.conf
 maltoolbox/exceptions.py
+maltoolbox/file_utils.py
 maltoolbox/model.py
+maltoolbox/wrappers.py
 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/classes_factory.py
@@ -27,4 +31,8 @@ maltoolbox/language/compiler/__init__.py
 maltoolbox/language/compiler/mal_lexer.py
 maltoolbox/language/compiler/mal_parser.py
 maltoolbox/language/compiler/mal_visitor.py
-maltoolbox/translators/securicad.py
+maltoolbox/translators/__init__.py
+maltoolbox/translators/securicad.py
+maltoolbox/translators/updater.py
+tests/test_model.py
+tests/test_wrappers.py

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0}/mal_toolbox.egg-info/requires.txt

@@ -3,3 +3,4 @@ python-jsonschema-objects>=0.4.1
 antlr4-tools
 antlr4-python3-runtime
 docopt
+PyYAML

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0}/maltoolbox/__init__.py

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-# MAL Toolbox v0.0.39
+# MAL Toolbox v0.1.0
 # Copyright 2024, Andrei Buhaiu.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,7 +21,7 @@ MAL-Toolbox Framework
 """
 
 __title__ = 'maltoolbox'
-__version__ = '0.0.39'
+__version__ = '0.1.0'
 __authors__ = ['Andrei Buhaiu',
     'Giuseppe Nebbione',
     'Nikolaos Kakouros',
@@ -33,7 +33,6 @@ __docformat__ = 'restructuredtext en'
 __all__ = ()
 
 import os
-import sys
 import configparser
 import logging
 
@@ -74,15 +73,18 @@ log_level = log_configs['log_level']
 if log_level != '':
     level = logging.getLevelName(log_level)
     logger.setLevel(level)
-    logger.info(f'Set loggin level of {__name__} to {log_level}.')
+    logger.info('Set loggin level of %s to %s.', __name__, log_level)
 
 if 'neo4j' in config:
     for term in ['uri', 'username', 'password', 'dbname']:
         if term not in config['neo4j']:
-            logger.critical('Config file is missing essential '\
-                f'Neo4J information: {term}, cannot proceed.')
-            raise ValueError('Config file is missing essential '\
-                f'Neo4J information: {term}, cannot proceed.')
+
+            msg = (
+                'Config file is missing essential Neo4J '
+                f'information: {term}, cannot proceed.'
+            )
+            logger.critical(msg)
+            raise ValueError(msg)
 
     neo4j_configs = {
         'uri': config['neo4j']['uri'],
@@ -90,4 +92,3 @@ if 'neo4j' in config:
         'password': config['neo4j']['password'],
         'dbname': config['neo4j']['dbname'],
     }
-

{mal_toolbox-0.0.39 → mal_toolbox-0.1.0}/maltoolbox/__main__.py

@@ -21,74 +21,56 @@ Notes:
       parameters required for this app to reach the Neo4j instance should be
       defined in the default.conf file.
 """
-import docopt
+
 import logging
 import json
-import sys
-import zipfile
+import docopt
 
+from maltoolbox.wrappers import create_attack_graph
 from . import log_configs, neo4j_configs
-from .language import LanguageClassesFactory, LanguageGraph
 from .language.compiler import MalCompiler
-from .model import Model
-from .attackgraph import AttackGraph
-from .attackgraph.analyzers.apriori import calculate_viability_and_necessity
 from .ingestors import neo4j
-from .exceptions import AttackGraphStepExpressionError
 
 logger = logging.getLogger(__name__)
 
-
-def generate_attack_graph(model_file: str, lang_file: str, send_to_neo4j: bool) -> None:
-    try:
-        lang_graph = LanguageGraph.from_mar_archive(lang_file)
-    except zipfile.BadZipFile:
-        lang_graph = LanguageGraph.from_mal_spec(lang_file)
-
-    if log_configs['langspec_file']:
-        lang_graph.save_language_specification_to_json(log_configs['langspec_file'])
-
-    lang_classes_factory = LanguageClassesFactory(lang_graph)
-
-    instance_model = Model.load_from_file(model_file, lang_classes_factory)
-
-    if log_configs['model_file']:
-        instance_model.save_to_file(log_configs['model_file'])
-
-    try:
-        graph = AttackGraph(lang_graph, instance_model)
-    except AttackGraphStepExpressionError:
-        logger.error('Attack graph generation failed when attempting ' \
-            'to resolve attack step expression!')
-        sys.exit(1)
-
-    calculate_viability_and_necessity(graph)
-
-    graph.attach_attackers()
-
+def generate_attack_graph(
+        model_file: str,
+        lang_file: str,
+        send_to_neo4j: bool
+    ) -> None:
+    """Create an attack graph and optionally send to neo4j
+    
+    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']:
-        graph.save_to_file(
-            log_configs['attackgraph_file'])
+        attack_graph.save_to_file(
+            log_configs['attackgraph_file']
+        )
 
     if send_to_neo4j:
         logger.debug('Ingest model graph into Neo4J database.')
-        neo4j.ingest_model(instance_model,
+        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(graph,
+        neo4j.ingest_attack_graph(attack_graph,
             neo4j_configs['uri'],
             neo4j_configs['username'],
             neo4j_configs['password'],
             neo4j_configs['dbname'],
             delete=False)
 
-def compile(lang_file, output_file):
-    compiler = MalCompiler()
 
+def compile(lang_file: str, output_file: str) -> None:
+    """Compile language and dump into output file"""
+    compiler = MalCompiler()
     with open(output_file, "w") as f:
         json.dump(compiler.compile(lang_file), f, indent=2)