mal-toolbox 1.2.1__tar.gz → 2.0.0__tar.gz

{mal_toolbox-1.2.1/mal_toolbox.egg-info → mal_toolbox-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 1.2.1
+Version: 2.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>, Sandor Berglund <sandor@kth.se>
 License: Apache Software License
@@ -25,6 +25,8 @@ Requires-Dist: docopt
 Requires-Dist: PyYAML
 Requires-Dist: py2neo
 Requires-Dist: networkx
+Requires-Dist: tree-sitter-mal~=1.0.0
+Requires-Dist: tree-sitter
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
@@ -36,37 +38,9 @@ MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations in [MAL Simulator](https://github.com/mal-lang/mal-simulator) or run your own custom analysis on.
 
-- [MAL Toolbox Documentation](https://mal-lang.org/mal-toolbox/index.html)
+- [MAL Toolbox Documentation](https://github.com/mal-lang/mal-toolbox/wiki)
 - [MAL Toolbox tutorial](https://github.com/mal-lang/mal-toolbox-tutorial)
 
-## The Language Module
-
-The language module provides various tools to process MAL languages.
-
-## 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 their associations.
-
-Model objects can be used to generate attack graphs with the AttackGraph 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
-to generate the attack graph is `generate_graph` and it requires the instance
-model and language specification. The resulting attack graph will contain
-nodes for each of the attack steps. The structure of the attack node data
-class can be seen in `attackgraph/node.py` file. Of note are the lists of
-children and parents which allow for easy reference to the other attack step
-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.
-
-
 # Usage
 
 ## Installation
@@ -147,50 +121,9 @@ Notes:
       compiler) or a .mal file containing the DSL written in MAL.```
 ```
 
-## Code examples / Tutorial
-
-To find more code examples and tutorials, visit the
-[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
-
-### Load a language
-```python
-
-from maltoolbox.language import LanguageGraph
-
-# Will load the MAL language (.mal/.mar) or a saved language graph (yml/json)
-lang_graph = LanguageGraph.load_from_file(lang_file_path)
-
-```
-
-### Generate a model
-```python
-from maltoolbox.model import Model
-
-# Create an empty model
-instance_model = Model("Example Model", lang_graph)
-
-# Create and add assets of type supported by the MAL language
-asset1 = instance_model.add_asset('Application', 'Application1')
-asset2 = instance_model.add_asset('Application', 'Application2')
-
-# Create association between the assets
-asset1.add_associated_assets('appExecutedApps', asset2)
-```
-
-## Generate an attack graph
-
-```python
-
-from maltoolbox.attackgraph import AttackGraph
-
-attack_graph = AttackGraph(lang_graph, model)
-
-```
-
-
-## Contributing
+# Contributing
 
-# CI Pipeline
+## CI Pipeline
 
 Checks are made with:
 
@@ -200,12 +133,12 @@ Checks are made with:
 
 Make sure pipeline passes before PR is marked "Ready for review".
 
-# Tests
+## Tests
 There are unit tests inside of ./tests.
 
 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>`.
 
-# Making a release
+## Making a release
 
 1. Make a PR with one commit that updates the version number in `pyproject.toml` and `maltoolbox/__init__.py`.
 Follow [Semantic versioning](https://semver.org/).

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0}/README.md

@@ -5,37 +5,9 @@ MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations in [MAL Simulator](https://github.com/mal-lang/mal-simulator) or run your own custom analysis on.
 
-- [MAL Toolbox Documentation](https://mal-lang.org/mal-toolbox/index.html)
+- [MAL Toolbox Documentation](https://github.com/mal-lang/mal-toolbox/wiki)
 - [MAL Toolbox tutorial](https://github.com/mal-lang/mal-toolbox-tutorial)
 
-## The Language Module
-
-The language module provides various tools to process MAL languages.
-
-## 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 their associations.
-
-Model objects can be used to generate attack graphs with the AttackGraph 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
-to generate the attack graph is `generate_graph` and it requires the instance
-model and language specification. The resulting attack graph will contain
-nodes for each of the attack steps. The structure of the attack node data
-class can be seen in `attackgraph/node.py` file. Of note are the lists of
-children and parents which allow for easy reference to the other attack step
-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.
-
-
 # Usage
 
 ## Installation
@@ -116,50 +88,9 @@ Notes:
       compiler) or a .mal file containing the DSL written in MAL.```
 ```
 
-## Code examples / Tutorial
-
-To find more code examples and tutorials, visit the
-[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
-
-### Load a language
-```python
-
-from maltoolbox.language import LanguageGraph
-
-# Will load the MAL language (.mal/.mar) or a saved language graph (yml/json)
-lang_graph = LanguageGraph.load_from_file(lang_file_path)
-
-```
-
-### Generate a model
-```python
-from maltoolbox.model import Model
-
-# Create an empty model
-instance_model = Model("Example Model", lang_graph)
-
-# Create and add assets of type supported by the MAL language
-asset1 = instance_model.add_asset('Application', 'Application1')
-asset2 = instance_model.add_asset('Application', 'Application2')
-
-# Create association between the assets
-asset1.add_associated_assets('appExecutedApps', asset2)
-```
-
-## Generate an attack graph
-
-```python
-
-from maltoolbox.attackgraph import AttackGraph
-
-attack_graph = AttackGraph(lang_graph, model)
-
-```
-
-
-## Contributing
+# Contributing
 
-# CI Pipeline
+## CI Pipeline
 
 Checks are made with:
 
@@ -169,12 +100,12 @@ Checks are made with:
 
 Make sure pipeline passes before PR is marked "Ready for review".
 
-# Tests
+## Tests
 There are unit tests inside of ./tests.
 
 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>`.
 
-# Making a release
+## Making a release
 
 1. Make a PR with one commit that updates the version number in `pyproject.toml` and `maltoolbox/__init__.py`.
 Follow [Semantic versioning](https://semver.org/).

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0/mal_toolbox.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 1.2.1
+Version: 2.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>, Sandor Berglund <sandor@kth.se>
 License: Apache Software License
@@ -25,6 +25,8 @@ Requires-Dist: docopt
 Requires-Dist: PyYAML
 Requires-Dist: py2neo
 Requires-Dist: networkx
+Requires-Dist: tree-sitter-mal~=1.0.0
+Requires-Dist: tree-sitter
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
@@ -36,37 +38,9 @@ MAL ([Meta Attack Language](https://mal-lang.org/)) models and attack graphs.
 
 Attack graphs can be used to run simulations in [MAL Simulator](https://github.com/mal-lang/mal-simulator) or run your own custom analysis on.
 
-- [MAL Toolbox Documentation](https://mal-lang.org/mal-toolbox/index.html)
+- [MAL Toolbox Documentation](https://github.com/mal-lang/mal-toolbox/wiki)
 - [MAL Toolbox tutorial](https://github.com/mal-lang/mal-toolbox-tutorial)
 
-## The Language Module
-
-The language module provides various tools to process MAL languages.
-
-## 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 their associations.
-
-Model objects can be used to generate attack graphs with the AttackGraph 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
-to generate the attack graph is `generate_graph` and it requires the instance
-model and language specification. The resulting attack graph will contain
-nodes for each of the attack steps. The structure of the attack node data
-class can be seen in `attackgraph/node.py` file. Of note are the lists of
-children and parents which allow for easy reference to the other attack step
-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.
-
-
 # Usage
 
 ## Installation
@@ -147,50 +121,9 @@ Notes:
       compiler) or a .mal file containing the DSL written in MAL.```
 ```
 
-## Code examples / Tutorial
-
-To find more code examples and tutorials, visit the
-[MAL Toolbox Tutorial](https://github.com/mal-lang/mal-toolbox-tutorial/tree/main) repository.
-
-### Load a language
-```python
-
-from maltoolbox.language import LanguageGraph
-
-# Will load the MAL language (.mal/.mar) or a saved language graph (yml/json)
-lang_graph = LanguageGraph.load_from_file(lang_file_path)
-
-```
-
-### Generate a model
-```python
-from maltoolbox.model import Model
-
-# Create an empty model
-instance_model = Model("Example Model", lang_graph)
-
-# Create and add assets of type supported by the MAL language
-asset1 = instance_model.add_asset('Application', 'Application1')
-asset2 = instance_model.add_asset('Application', 'Application2')
-
-# Create association between the assets
-asset1.add_associated_assets('appExecutedApps', asset2)
-```
-
-## Generate an attack graph
-
-```python
-
-from maltoolbox.attackgraph import AttackGraph
-
-attack_graph = AttackGraph(lang_graph, model)
-
-```
-
-
-## Contributing
+# Contributing
 
-# CI Pipeline
+## CI Pipeline
 
 Checks are made with:
 
@@ -200,12 +133,12 @@ Checks are made with:
 
 Make sure pipeline passes before PR is marked "Ready for review".
 
-# Tests
+## Tests
 There are unit tests inside of ./tests.
 
 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>`.
 
-# Making a release
+## Making a release
 
 1. Make a PR with one commit that updates the version number in `pyproject.toml` and `maltoolbox/__init__.py`.
 Follow [Semantic versioning](https://semver.org/).

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0}/mal_toolbox.egg-info/SOURCES.txt

@@ -22,8 +22,11 @@ maltoolbox/attackgraph/analyzers/__init__.py
 maltoolbox/language/__init__.py
 maltoolbox/language/languagegraph.py
 maltoolbox/language/compiler/__init__.py
-maltoolbox/language/compiler/mal_lexer.py
-maltoolbox/language/compiler/mal_parser.py
+maltoolbox/language/compiler/distributions.py
+maltoolbox/language/compiler/exceptions.py
+maltoolbox/language/compiler/lang.py
+maltoolbox/language/compiler/mal_analyzer.py
+maltoolbox/language/compiler/mal_compiler.py
 maltoolbox/patternfinder/__init__.py
 maltoolbox/patternfinder/attackgraph_patterns.py
 maltoolbox/translators/__init__.py

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0}/mal_toolbox.egg-info/requires.txt

@@ -5,6 +5,8 @@ docopt
 PyYAML
 py2neo
 networkx
+tree-sitter-mal~=1.0.0
+tree-sitter
 
 [dev]
 pytest

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0}/maltoolbox/__init__.py

@@ -1,4 +1,4 @@
-# MAL Toolbox v1.2.1
+# MAL Toolbox v2.0.0
 # Copyright 2025, Andrei Buhaiu.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,7 @@
 """
 
 __title__ = "maltoolbox"
-__version__ = "1.2.1"
+__version__ = "2.0.0"
 __authors__ = [
     "Andrei Buhaiu",
     "Giuseppe Nebbione",

{mal_toolbox-1.2.1 → mal_toolbox-2.0.0}/maltoolbox/attackgraph/node.py

@@ -28,6 +28,7 @@ class AttackGraphNode:
         self.lg_attack_step = lg_attack_step
         self.name = lg_attack_step.name
         self.type = lg_attack_step.type
+        self.causal_mode = self.lg_attack_step.causal_mode
         self.ttc = ttc_dist if ttc_dist is not None else lg_attack_step.ttc
         self.tags = lg_attack_step.tags
         self.detectors = lg_attack_step.detectors

mal_toolbox-2.0.0/maltoolbox/language/compiler/__init__.py

@@ -0,0 +1,5 @@
+from .mal_compiler import MalCompiler
+
+__all__ = [
+    'MalCompiler',
+]

mal_toolbox-2.0.0/maltoolbox/language/compiler/distributions.py

@@ -0,0 +1,158 @@
+class DistributionsException(Exception):
+    def __init__(self, error_message):
+        self._error_message = error_message
+        super().__init__(self._error_message)
+
+
+class Distributions:
+    @staticmethod
+    def validate(distribution_name: str, params: list) -> None:
+        match distribution_name:
+            case 'Bernoulli':
+                Bernoulli.validate(params)
+            case 'Binomial':
+                Binomial.validate(params)
+            case 'Exponential':
+                Exponential.validate(params)
+            case 'Gamma':
+                Gamma.validate(params)
+            case 'LogNormal':
+                LogNormal.validate(params)
+            case 'Pareto':
+                Pareto.validate(params)
+            case 'TruncatedNormal':
+                TruncatedNormal.validate(params)
+            case 'Uniform':
+                Uniform.validate(params)
+            case (
+                'Enabled'
+                | 'Disabled'
+                | 'Zero'
+                | 'Infinity'
+                | 'EasyAndCertain'
+                | 'EasyAndUncertain'
+                | 'HardAndCertain'
+                | 'HardAndUncertain'
+                | 'VeryHardAndCertain'
+                | 'VeryHardAndUncertain'
+            ):
+                Combination.validate(params)
+            case _:
+                err_msg = f'Distribution {distribution_name} is not supported'
+                raise (DistributionsException(err_msg))
+
+
+class Bernoulli:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 1:
+            err_msg = 'Expected exactly one parameter (probability), for Bernoulli distribution'
+            raise (DistributionsException(err_msg))
+        if not 0 <= params[0] <= 1:
+            err_msg = f"{params[0]} is not in valid range '0 <= probability <= 1', for Bernoulli distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Binomial:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = 'Expected exactly two parameters (trials, probability), for Binomial distribution'
+            raise (DistributionsException(err_msg))
+        if not 0 <= params[1] <= 1:
+            err_msg = f"{params[1]} is not in valid range '0 <= probability <= 1', for Binomial distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Exponential:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 1:
+            err_msg = (
+                'Expected exactly one parameter (lambda), for Exponential distribution'
+            )
+            raise (DistributionsException(err_msg))
+        if params[0] <= 0:
+            err_msg = f"{params[0]} is not in valid range 'lambda > 0', for Exponential distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Gamma:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = (
+                'Expected exactly two parameters (shape, scale), for Gamma distribution'
+            )
+            raise (DistributionsException(err_msg))
+        if params[0] <= 0:
+            err_msg = (
+                f"{params[0]} is not in valid range 'shape > 0', for Gamma distribution"
+            )
+            raise (DistributionsException(err_msg))
+        if params[1] <= 0:
+            err_msg = (
+                f"{params[1]} is not in valid range 'scale > 0', for Gamma distribution"
+            )
+            raise (DistributionsException(err_msg))
+
+
+class LogNormal:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = 'Expected exactly two parameters (mean, standardDeviation), for LogNormal distribution'
+            raise (DistributionsException(err_msg))
+        if params[1] <= 0:
+            err_msg = f"{params[1]} is not in valid range 'standardDeviation > 0', for LogNormal distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Pareto:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = (
+                'Expected exactly two parameters (min, shape), for Pareto distribution'
+            )
+            raise (DistributionsException(err_msg))
+        if params[0] <= 0:
+            err_msg = (
+                f"{params[0]} is not in valid range 'min > 0', for Pareto distribution"
+            )
+            raise (DistributionsException(err_msg))
+        if params[1] <= 0:
+            err_msg = f"{params[1]} is not in valid range 'shape > 0', for Pareto distribution"
+            raise (DistributionsException(err_msg))
+
+
+class TruncatedNormal:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = 'Expected exactly two parameters (mean, standardDeviation), for TruncatedNormal distribution'
+            raise (DistributionsException(err_msg))
+        if params[1] <= 0:
+            err_msg = f"{params[1]} is not in valid range 'standardDeviation > 0', for TruncatedNormal distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Uniform:
+    @staticmethod
+    def validate(params: list) -> None:
+        if not params or len(params) != 2:
+            err_msg = (
+                'Expected exactly two parameters (min, max), for Uniform distribution'
+            )
+            raise (DistributionsException(err_msg))
+        if params[0] > params[1]:
+            err_msg = f"({params[0]}, {params[1]}) does not meet requirement 'min <= max', for Uniform distribution"
+            raise (DistributionsException(err_msg))
+
+
+class Combination:
+    @staticmethod
+    def validate(params: list) -> None:
+        if params and len(params) != 0:
+            err_msg = 'Expected exactly zero parameters, for combination distributions'
+            raise (DistributionsException(err_msg))

mal_toolbox-2.0.0/maltoolbox/language/compiler/exceptions.py

@@ -0,0 +1,37 @@
+class MalCompilerError(Exception):
+    """Base exception for MalCompiler errors."""
+
+    pass
+
+
+class MalSyntaxError(MalCompilerError):
+    """Raised when syntax error is encountered during compilation."""
+
+    def __init__(self, message, line=None, column=None):
+        self.line = line
+        self.column = column
+        super().__init__(message)
+
+
+class MalParseError(MalCompilerError):
+    """Raised when parsing fails."""
+
+    pass
+
+
+class MalTypeError(MalCompilerError):
+    """Raised when type checking fails."""
+
+    pass
+
+
+class MalNameError(MalCompilerError):
+    """Raised when an undefined name is referenced."""
+
+    pass
+
+
+class MalCompilationError(MalCompilerError):
+    """Raised when code generation fails."""
+
+    pass

mal_toolbox-2.0.0/maltoolbox/language/compiler/lang.py

@@ -0,0 +1,5 @@
+from tree_sitter import Language, Parser
+import tree_sitter_mal as ts_mal
+
+MAL_LANGUAGE = Language(ts_mal.language())
+PARSER = Parser(MAL_LANGUAGE)