mal-toolbox 1.2.0__py3-none-any.whl → 2.0.0__py3-none-any.whl

{mal_toolbox-1.2.0.dist-info → mal_toolbox-2.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 1.2.0
+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.0.dist-info → mal_toolbox-2.0.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-mal_toolbox-1.2.0.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
-mal_toolbox-1.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-maltoolbox/__init__.py,sha256=477nzX87CW6thDBJ4BfSLW2xzvpqIHKL0llR7bJxXds,2132
+mal_toolbox-2.0.0.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
+mal_toolbox-2.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+maltoolbox/__init__.py,sha256=gxg271599Ua9ptG6IVi2BevMf_0lFpf8iuWi3m5-wrA,2132
 maltoolbox/__main__.py,sha256=aAm6NcZ-HtPmY9hfFlGNnTs5rydoI6NAc88RgXt1G9U,3515
 maltoolbox/exceptions.py,sha256=4rwqzu8Cgj0ShjUoCXP2yik-bJaqYqj6Y-0tqxHy4vs,1316
 maltoolbox/file_utils.py,sha256=IXA0cvyopjRFGGKqRPkRQ0RJOtKzq_XF13aHgcz-TFc,1911
@@ -9,13 +9,16 @@ maltoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/str_utils.py,sha256=zZXHOFfXguhpQQJ5nyGe1VGWchOkanQUc8viV7nhQho,639
 maltoolbox/attackgraph/__init__.py,sha256=l7dJ7jOqpcj7PdsOKZt1NuXlPyjd6vZYvcXlj8Kq09w,297
 maltoolbox/attackgraph/attackgraph.py,sha256=WBRwnVmQqwpjp3x_kSR8HH49MnlRIhF6tZ_r7nqTAJw,27162
-maltoolbox/attackgraph/node.py,sha256=7NAdEl40w6KMt_gKK1mP4SRAmmyCQGSTMaD-GHMNXHk,4186
+maltoolbox/attackgraph/node.py,sha256=aUlXbkwjcIxwEDWC1fAZl3343mF_Y1rxxF72ncNJcGY,4245
 maltoolbox/attackgraph/analyzers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/language/__init__.py,sha256=RTTfhnCYa5PRGJCgDAWLpLLAzNCvNMn91UHNiOXszbg,490
-maltoolbox/language/languagegraph.py,sha256=Tjqk5zv_37ghmepx8KBHPTH8tRlboaYcW836MiUS1d8,65140
-maltoolbox/language/compiler/__init__.py,sha256=Rbdeco6SWHyFw-VJfpxLRSZO3UMjJxPGenMR8OujVpA,15846
-maltoolbox/language/compiler/mal_lexer.py,sha256=TQvzEW7yCN0iY6Js5O6wCDFxSAE0_LAX4JVy96TnLro,14808
-maltoolbox/language/compiler/mal_parser.py,sha256=bVfYWRZyyhU-s2tJI-D_YwbVQkl3AHzdrD6LWM0BQbI,116108
+maltoolbox/language/languagegraph.py,sha256=DyNc2ev2492rBifrb5Ql_jfZ4-2rz0KTAmBt75R2FSc,65326
+maltoolbox/language/compiler/__init__.py,sha256=KCtjWlWY1qmDoTOOufZ0Y1b1zcH_W0IlsTLvTZAfS9w,72
+maltoolbox/language/compiler/distributions.py,sha256=i6SqskJy3y7fn9VS6c1aiNIm09Yxc5-cAZ09lz9ZwCk,5979
+maltoolbox/language/compiler/exceptions.py,sha256=nLXxo0JGmreKAMCJIjiODvB0pJ5q24twKSc3dRo81yY,740
+maltoolbox/language/compiler/lang.py,sha256=WHCU-3SFChr69LFFTle-qlnGov0-tc3tnMLwyYRficA,148
+maltoolbox/language/compiler/mal_analyzer.py,sha256=PJL-ubW4Ehif92QYz9fCNr3dPV6EAMt10VqAjbHWKRI,40837
+maltoolbox/language/compiler/mal_compiler.py,sha256=jD5l20106fQyrGK7msrvUFPnzm4iyDhWdgh47ee4GW8,36881
 maltoolbox/patternfinder/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maltoolbox/patternfinder/attackgraph_patterns.py,sha256=jw6BlQHXLmiWm9xajLHbUZUWVQGM2qAgMHOs0Yo2YsE,5168
 maltoolbox/translators/__init__.py,sha256=7qbhjeu--s2A-O_031a7xzSq794iQlrrUxM8gE1LxH4,201
@@ -23,11 +26,11 @@ maltoolbox/translators/networkx.py,sha256=v1JQAqO7st6-ktx5P3oy93DsL2SEUPly_3zcAL
 maltoolbox/translators/updater.py,sha256=mFmTT2GHCw6nsoHe_ChnvAHd5j6UxKnvAqLFDSziqC4,8566
 maltoolbox/visualization/__init__.py,sha256=7rrGclkGdP6LrxpfSh1esYFG_MnvnVruuEdUJI-DX-g,350
 maltoolbox/visualization/draw_io_utils.py,sha256=CgsD0HEFpxZ6ZIWtUZtMekdPB2Irtmvhz0TNEm7x1ig,14378
-maltoolbox/visualization/graphviz_utils.py,sha256=gA5WGnukZiis5RXIXtWyCy0QMFeSPucZMnFJSbbM8Xc,4687
+maltoolbox/visualization/graphviz_utils.py,sha256=87B2pxRMrlmm2RHu0JM7nQRHWZD0Yt3zCmEwl8xUXdU,4709
 maltoolbox/visualization/neo4j_utils.py,sha256=R2Qm2gC5GDpfiPhhB3oymuBI2W580SRXGVtQuFRYiIA,3496
 maltoolbox/visualization/utils.py,sha256=EZWsxukO5hbRwGFW9GM9ZemKT-nYg-VMCup-SsntaQM,1480
-mal_toolbox-1.2.0.dist-info/METADATA,sha256=b2NVXhY7knTCzoQrNpJXrHAIChJir16tQBFt2v4rjJk,6696
-mal_toolbox-1.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mal_toolbox-1.2.0.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
-mal_toolbox-1.2.0.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
-mal_toolbox-1.2.0.dist-info/RECORD,,
+mal_toolbox-2.0.0.dist-info/METADATA,sha256=jBkfjs3GBtO0pvOQYVBMpNt9z8nHgvMyjKaA7DxT_Wo,4632
+mal_toolbox-2.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mal_toolbox-2.0.0.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
+mal_toolbox-2.0.0.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
+mal_toolbox-2.0.0.dist-info/RECORD,,

maltoolbox/__init__.py

@@ -1,4 +1,4 @@
-# MAL Toolbox v1.2.0
+# 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.0"
+__version__ = "2.0.0"
 __authors__ = [
     "Andrei Buhaiu",
     "Giuseppe Nebbione",

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