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

{mal_toolbox-1.1.1.dist-info → mal_toolbox-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mal-toolbox
-Version: 1.1.1
+Version: 1.1.3
 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
@@ -24,6 +24,7 @@ Requires-Dist: antlr4-python3-runtime
 Requires-Dist: docopt
 Requires-Dist: PyYAML
 Requires-Dist: py2neo
+Requires-Dist: networkx
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
@@ -178,8 +179,30 @@ attack_graph = AttackGraph(lang_graph, model)
 ```
 
 
+## Contributing
+
+# CI Pipeline
+
+Checks are made with:
+
+- `mypy`
+- `ruff`
+- `pytest`
+
+Make sure pipeline passes before PR is marked "Ready for review".
+
 # 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>`.
+
+# 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/).
+
+2. Get the PR reviewed and merged to `main`.
+
+3. Tag the latest commit on `main` with the new version number.
+
+4. Push the tag.

mal_toolbox-1.1.3.dist-info/RECORD

@@ -0,0 +1,32 @@
+mal_toolbox-1.1.3.dist-info/licenses/AUTHORS,sha256=zxLrLe8EY39WtRKlAY4Oorx4Z2_LHV2ApRvDGZgY7xY,127
+mal_toolbox-1.1.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+maltoolbox/__init__.py,sha256=XPlaa-uM8YDeYpOQ0BhxBvXUt3kZGeoYdboiIV9moig,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
+maltoolbox/model.py,sha256=bqYPYNW8MxuS2wUef51z6yjaA5F13YXbeicM2qaYUd4,18138
+maltoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+maltoolbox/attackgraph/__init__.py,sha256=l7dJ7jOqpcj7PdsOKZt1NuXlPyjd6vZYvcXlj8Kq09w,297
+maltoolbox/attackgraph/attackgraph.py,sha256=OH5GP5v8_RPeHIxzwy2qlctAvMQ_8YgfIKtJwE6Pqqc,26309
+maltoolbox/attackgraph/node.py,sha256=7NAdEl40w6KMt_gKK1mP4SRAmmyCQGSTMaD-GHMNXHk,4186
+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/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
+maltoolbox/translators/networkx.py,sha256=v1JQAqO7st6-ktx5P3oy93DsL2SEUPly_3zcALv08o8,1352
+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=PENKhcpeQkxczzoRwOIVFe_olMhGBeuZg1d8JSqXUQQ,3909
+maltoolbox/visualization/neo4j_utils.py,sha256=R2Qm2gC5GDpfiPhhB3oymuBI2W580SRXGVtQuFRYiIA,3496
+maltoolbox/visualization/utils.py,sha256=EZWsxukO5hbRwGFW9GM9ZemKT-nYg-VMCup-SsntaQM,1480
+mal_toolbox-1.1.3.dist-info/METADATA,sha256=vNtJhGzNG2bu5iRntbL_5ZKAPruvhuJAo-XSlzceT00,6298
+mal_toolbox-1.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mal_toolbox-1.1.3.dist-info/entry_points.txt,sha256=oqby5O6cUP_OHCm70k_iYPA6UlbTBf7se1i3XwdK3uU,56
+mal_toolbox-1.1.3.dist-info/top_level.txt,sha256=phqRVLRKGdSUgRY03mcpi2cmbbDo5YGjkV4gkqHFFcM,11
+mal_toolbox-1.1.3.dist-info/RECORD,,

maltoolbox/__init__.py

@@ -1,5 +1,4 @@
-# -*- encoding: utf-8 -*-
-# MAL Toolbox v1.1.1
+# MAL Toolbox v1.1.3
 # Copyright 2025, Andrei Buhaiu.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,12 +15,11 @@
 #
 
 
-"""
-MAL-Toolbox Framework
+"""MAL-Toolbox Framework
 """
 
 __title__ = "maltoolbox"
-__version__ = "1.1.1"
+__version__ = "1.1.3"
 __authors__ = [
     "Andrei Buhaiu",
     "Giuseppe Nebbione",
@@ -34,11 +32,12 @@ __docformat__ = "restructuredtext en"
 
 __all__ = ()
 
-import os
-import yaml
 import logging
+import os
 from typing import Any
 
+import yaml
+
 config: dict[str, Any] = {
     "logging": {
         "log_level": logging.INFO,

maltoolbox/__main__.py

@@ -1,5 +1,4 @@
-"""
-Command-line interface for MAL toolbox operations
+"""Command-line interface for MAL toolbox operations
 
 Usage:
     maltoolbox compile <lang_file> <output_file>
@@ -8,6 +7,7 @@ Usage:
     maltoolbox visualize-model [--neo4j] [--graphviz] [-drawio] <model_file> <lang_file>
 
 Arguments:
+---------
     <model_file>    Path to JSON instance model file.
     <lang_file>     Path to .mar or .mal file containing MAL spec.
     <output_file>   Path to write the result of the compilation (yml/json).
@@ -19,30 +19,34 @@ Options:
   -d --drawio       Export draw.io file
 
 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.
+
 """
 
-import logging
 import json
+import logging
+
 import docopt
 
 from . import log_configs, neo4j_configs
-from .attackgraph import create_attack_graph, AttackGraph
+from .attackgraph import AttackGraph, create_attack_graph
 from .language.compiler import MalCompiler
 from .language.languagegraph import LanguageGraph
+from .model import Model
 from .translators.updater import load_model_from_older_version
 from .visualization import (
-    render_model,
-    render_attack_graph,
-    ingest_model_neo4j,
+    create_drawio_file_with_images,
     ingest_attack_graph_neo4j,
-    create_drawio_file_with_images
+    ingest_model_neo4j,
+    render_attack_graph,
+    render_model,
 )
-from .model import Model
 
 logger = logging.getLogger(__name__)
 
+
 def generate_attack_graph(
         model_file: str,
         lang_file: str
@@ -50,8 +54,10 @@ def generate_attack_graph(
     """Create an attack graph
 
     Args:
+    ----
     model_file      - path to the model file
     lang_file       - path to the language file
+
     """
     attack_graph = create_attack_graph(lang_file, model_file)
     if log_configs['attackgraph_file']:
@@ -60,6 +66,7 @@ def generate_attack_graph(
         )
     return attack_graph
 
+
 def compile(lang_file: str, output_file: str) -> None:
     """Compile language and dump into output file"""
     compiler = MalCompiler()
@@ -107,5 +114,6 @@ def main():
         if args['--drawio']:
             create_drawio_file_with_images(model)
 
+
 if __name__ == "__main__":
     main()

maltoolbox/attackgraph/__init__.py

@@ -1,5 +1,4 @@
-"""
-Contains tools used to generate attack graphs from MAL instance
+"""Contains tools used to generate attack graphs from MAL instance
 models and analyze attack graphs.
 """
 
@@ -7,8 +6,8 @@ from .attackgraph import AttackGraph, create_attack_graph
 from .node import AttackGraphNode
 
 __all__ = [
-    "Attacker",
     "AttackGraph",
     "AttackGraphNode",
+    "Attacker",
     "create_attack_graph"
 ]