mal-toolbox 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

maltoolbox/language/compiler/mal_visitor.py

@@ -1,416 +0,0 @@
-# mypy: ignore-errors
-from collections.abc import MutableMapping, MutableSequence
-
-from antlr4 import ParseTreeVisitor
-from .mal_parser import malParser
-
-# In a rule like `rule: one? two* three`:
-#   - ctx.one() would be None if the token was not found on a matching line
-#   - ctx.two() would be []
-
-class malVisitor(ParseTreeVisitor):
-    def __init__(self, compiler, *args, **kwargs):
-        self.compiler = compiler
-        self.current_file = compiler.current_file  # for debug purposes
-
-        super().__init__(*args, **kwargs)
-
-    def visitMal(self, ctx):
-        langspec = {
-            "formatVersion": "1.0.0",
-            "defines": {},
-            "categories": [],
-            "assets": [],
-            "associations": [],
-        }
-
-        # no visitDeclaration method needed, `declaration` is a thin rule
-        for declaration in (d.getChild(0) for d in ctx.declaration()):
-            if result := self.visit(declaration) or True:
-                key, value = result
-
-                if key == "categories":
-                    category, assets = value
-                    langspec["categories"].extend(category)
-                    langspec["assets"].extend(assets)
-                    continue
-
-                if key == "defines":
-                    langspec[key].update(value)
-
-                if key == "associations":
-                    langspec[key].extend(value)
-
-                if key == "include":
-                    included_file = self.compiler.compile(value)
-                    for k, v in langspec.items():
-                        if isinstance(v, MutableMapping):
-                            langspec[k].update(included_file.get(k, {}))
-                        if isinstance(v, MutableSequence) and k in included_file:
-                            langspec[k].extend(included_file[k])
-
-        for key in ("categories", "assets", "associations"):
-            unique = []
-            for item in langspec[key]:
-                if item not in unique:
-                    unique.append(item)
-            langspec[key] = unique
-
-        return langspec
-
-    def visitInclude(self, ctx):
-        return ("include", ctx.STRING().getText().strip('"'))
-
-    def visitDefine(self, ctx):
-        return ("defines", {ctx.ID().getText(): ctx.STRING().getText().strip('"')})
-
-    def visitCategory(self, ctx):
-        category = {}
-        category["name"] = ctx.ID().getText()
-        category["meta"] = {k: v for meta in ctx.meta() for k, v in self.visit(meta)}
-
-        assets = [self.visit(asset) for asset in ctx.asset()]
-
-        return ("categories", ([category], assets))
-
-    def visitMeta(self, ctx):
-        return ((ctx.ID().getText(), ctx.STRING().getText().strip('"')),)
-
-    def visitAsset(self, ctx):
-        asset = {}
-        asset["name"] = ctx.ID()[0].getText()
-        asset["meta"] = {k: v for meta in ctx.meta() for k, v in self.visit(meta)}
-        asset["category"] = ctx.parentCtx.ID().getText()
-        asset["isAbstract"] = ctx.ABSTRACT() is not None
-
-        asset["superAsset"] = None
-        if len(ctx.ID()) > 1 and ctx.ID()[1]:
-            asset["superAsset"] = ctx.ID()[1].getText()
-
-        asset["variables"] = [self.visit(variable) for variable in ctx.variable()]
-        asset["attackSteps"] = [self.visit(step) for step in ctx.step()]
-
-        return asset
-
-    def visitStep(self, ctx):
-        step = {}
-        step["name"] = ctx.ID().getText()
-        step["meta"] = {k: v for meta in ctx.meta() for k, v in self.visit(meta)}
-        step["type"] = self.visit(ctx.steptype())
-        step["tags"] = [self.visit(tag) for tag in ctx.tag()]
-        step["risk"] = self.visit(ctx.cias()) if ctx.cias() else None
-        step["ttc"] = self.visit(ctx.ttc()) if ctx.ttc() else None
-        step["requires"] = (
-            self.visit(ctx.precondition()) if ctx.precondition() else None
-        )
-        step["reaches"] = self.visit(ctx.reaches()) if ctx.reaches() else None
-
-        return step
-
-    def visitSteptype(self, ctx):
-        return (
-            "or"
-            if ctx.OR()
-            else "and"
-            if ctx.AND()
-            else "defense"
-            if ctx.HASH()
-            else "exist"
-            if ctx.EXISTS()
-            else "notExist"
-            if ctx.NOTEXISTS()
-            else None  # should never happen, the grammar limits it
-        )
-
-    def visitTag(self, ctx):
-        return ctx.ID().getText()
-
-    def visitCias(self, ctx):
-        risk = {
-            "isConfidentiality": False,
-            "isIntegrity": False,
-            "isAvailability": False,
-        }
-
-        for cia in ctx.cia():
-            risk.update(self.visit(cia))
-
-        return risk
-
-    def visitCia(self, ctx):
-        key = (
-            "isConfidentiality"
-            if ctx.C()
-            else "isIntegrity"
-            if ctx.I()
-            else "isAvailability"
-            if ctx.A()
-            else None
-        )
-
-        return {key: True}
-
-    def visitTtc(self, ctx):
-        ret = self.visit(ctx.ttcexpr())
-
-        return ret
-
-    def visitTtcexpr(self, ctx):
-        if len(terms := ctx.ttcterm()) == 1:
-            return self.visit(terms[0])
-
-        ret = {}
-
-        lhs = self.visit(terms[0])
-        for i in range(1, len(terms)):
-            ret["type"] = (
-                "addition"
-                if ctx.children[2 * i - 1].getText() == "+"
-                else "subtraction"
-            )
-            ret["lhs"] = lhs
-            ret["rhs"] = self.visit(terms[i])
-
-            lhs = ret.copy()
-
-        return ret
-
-    def visitTtcterm(self, ctx):
-        if len(factors := ctx.ttcfact()) == 1:
-            ret = self.visit(factors[0])
-        else:
-            ret = {}
-            ret["type"] = "multiplication" if ctx.STAR() else "division"
-            ret["lhs"] = self.visit(factors[0])
-            ret["rhs"] = self.visit(factors[1])
-
-        return ret
-
-    def visitTtcfact(self, ctx):
-        if len(atoms := ctx.ttcatom()) == 1:
-            ret = self.visit(atoms[0])
-        else:
-            ret = {}
-            ret["type"] = "exponentiation"
-            ret["lhs"] = self.visit(atoms[0])
-            ret["rhs"] = self.visit(atoms[1])
-
-        return ret
-
-    def visitTtcatom(self, ctx):
-        if ctx.ttcdist():
-            ret = self.visit(ctx.ttcdist())
-        elif ctx.ttcexpr():
-            ret = self.visit(ctx.ttcexpr())
-        elif ctx.number():
-            ret = self.visit(ctx.number())
-
-        return ret
-
-    def visitTtcdist(self, ctx):
-        ret = {"type": "function"}
-        ret["name"] = ctx.ID().getText()
-        ret["arguments"] = []
-
-        if ctx.LPAREN():
-            ret["arguments"] = [self.visit(number)["value"] for number in ctx.number()]
-
-        return ret
-
-    def visitPrecondition(self, ctx):
-        ret = {}
-        ret["overrides"] = True
-        ret["stepExpressions"] = [self.visit(expr) for expr in ctx.expr()]
-        return ret
-
-    def visitReaches(self, ctx):
-        ret = {}
-        ret["overrides"] = ctx.INHERITS() is None
-        ret["stepExpressions"] = [self.visit(expr) for expr in ctx.expr()]
-
-        return ret
-
-    def visitNumber(self, ctx):
-        ret = {"type": "number"}
-        ret["value"] = float(ctx.getText())
-
-        return ret
-
-    def visitVariable(self, ctx):
-        ret = {}
-        ret["name"] = ctx.ID().getText()
-        ret["stepExpression"] = self.visit(ctx.expr())
-
-        return ret
-
-    def visitExpr(self, ctx):
-        if len(ctx.parts()) == 1:
-            return self.visit(ctx.parts()[0])
-
-        ret = {}
-        lhs = self.visit(ctx.parts()[0])
-        for i in range(1, len(ctx.parts())):
-            ret["type"] = self.visit(ctx.children[2 * i - 1])
-            ret["lhs"] = lhs
-            ret["rhs"] = self.visit(ctx.parts()[i])
-            lhs = ret.copy()
-
-        return ret
-
-    def visitParts(self, ctx):
-        if len(ctx.part()) == 1:
-            return self.visit(ctx.part()[0])
-
-        ret = {}
-
-        lhs = self.visit(ctx.part()[0])
-
-        for i in range(1, len(ctx.part())):
-            ret["type"] = "collect"
-            ret["lhs"] = lhs
-            ret["rhs"] = self.visit(ctx.part()[i])
-
-            lhs = ret.copy()
-
-        return ret
-
-    def visitPart(self, ctx):
-        ret = {}
-        if ctx.varsubst():
-            ret["type"] = "variable"
-            ret["name"] = self.visit(ctx.varsubst())
-        elif ctx.LPAREN():
-            ret = self.visit(ctx.expr())
-        else:  # ctx.ID()
-            # Resolve type: field or attackStep?
-            ret["type"] = self._resolve_part_ID_type(ctx)
-
-            ret["name"] = ctx.ID().getText()
-
-        if ctx.STAR():
-            ret = {"type": "transitive", "stepExpression": ret}
-
-        for type_ in ctx.type_():  # mind the trailing underscore
-            ret = {
-                "type": "subType",
-                "subType": self.visit(type_),
-                "stepExpression": ret,
-            }
-
-        return ret
-
-    def _resolve_part_ID_type(self, ctx):
-        pctx = ctx.parentCtx
-
-        # Traverse up the tree until we find the parent of the topmost expr
-        # (saying "topmost" as expr can be nested) or the root of the tree.
-        while pctx and not isinstance(
-            pctx,
-            malParser.ReachesContext
-            # Expressions are also valid in `let` variable assignments, but
-            # there every lexical component of expr is considered a "field",
-            # no need to resolve the type in that case. Similarly, preconditions
-            # (`<-`) only accept fields.
-        ):
-            pctx = pctx.parentCtx
-
-        if pctx is None:
-            # ctx (the `part`) belongs to a "let" assignment or a precondition.
-            return "field"
-
-        # scan for a dot to the right of `ctx`
-        file_tokens = ctx.parser.getTokenStream().tokens
-        for i in range(ctx.start.tokenIndex, pctx.stop.tokenIndex + 1):
-            if file_tokens[i].type == malParser.DOT:
-                return "field"
-
-            # We are looping until the end of pctx (which is a `reaches` or
-            # `precondition` context). This could include multiple comma
-            # separated `expr`s, we only care for the current one.
-            if file_tokens[i].type == malParser.COMMA:  # end of current `expr`
-                return "attackStep"
-
-        return "attackStep"
-
-    def visitVarsubst(self, ctx):
-        return ctx.ID().getText()
-
-    def visitType(self, ctx):
-        return ctx.ID().getText()
-
-    def visitSetop(self, ctx):
-        return (
-            "union"
-            if ctx.UNION()
-            else "intersection"
-            if ctx.INTERSECT()
-            else "difference"
-            if ctx.INTERSECT
-            else None
-        )
-
-    def visitAssociations(self, ctx):
-        associations = []
-        for assoc in ctx.association():
-            associations.append(self.visit(assoc))
-
-        return ("associations", associations)
-
-    def visitAssociation(self, ctx):
-        association = {}
-        association["name"] = self.visit(ctx.linkname())
-        association["meta"] = {k: v for meta in ctx.meta() for k, v in self.visit(meta)}
-        association["leftAsset"] = ctx.ID()[0].getText()
-        association["leftField"] = self.visit(ctx.field()[0])
-
-        # no self.visitMult or self.visitMultatom methods, reading them here
-        # directly
-        association["leftMultiplicity"] = {
-            "min": (multatoms := ctx.mult()[0].multatom()).pop(0).getText(),
-            "max": multatoms.pop().getText() if multatoms else None,
-        }
-        association["rightAsset"] = ctx.ID()[1].getText()
-        association["rightField"] = self.visit(ctx.field()[1])
-        association["rightMultiplicity"] = {
-            "min": (multatoms := ctx.mult()[1].multatom()).pop(0).getText(),
-            "max": multatoms.pop().getText() if multatoms else None,
-        }
-
-        self._post_process_multitudes(association)
-        return association
-
-    def _post_process_multitudes(self, association):
-        mult_keys = [
-            # start the multatoms from right to left to make sure the rules
-            # below get applied cleanly
-            "rightMultiplicity.max",
-            "rightMultiplicity.min",
-            "leftMultiplicity.max",
-            "leftMultiplicity.min",
-        ]
-
-        for mult_key in mult_keys:
-            key, subkey = mult_key.split(".")
-
-            # upper limit equals lower limit if not given
-            if subkey == "max" and association[key][subkey] is None:
-                association[key][subkey] = association[key]["min"]
-
-            if association[key][subkey] == "*":
-                # 'any' as lower limit means start from 0
-                if subkey == "min":
-                    association[key][subkey] = 0
-
-                # 'any' as upper limit means not limit
-                else:
-                    association[key][subkey] = None
-
-            # cast numerical strings to integers
-            if (multatom := association[key][subkey]) and multatom.isdigit():
-                association[key][subkey] = int(association[key][subkey])
-
-    def visitField(self, ctx):
-        return ctx.ID().getText()
-
-    def visitLinkname(self, ctx):
-        return ctx.ID().getText()

maltoolbox/wrappers.py

@@ -1,62 +0,0 @@
-"""Contains wrappers combining more than one of the maltoolbox submodules"""
-
-import logging
-import sys
-import zipfile
-
-from maltoolbox.model import Model
-from maltoolbox.language import LanguageGraph, LanguageClassesFactory
-from maltoolbox.attackgraph import AttackGraph
-from maltoolbox.attackgraph.analyzers.apriori import (
-    calculate_viability_and_necessity
-)
-from maltoolbox.exceptions import AttackGraphStepExpressionError
-from maltoolbox import log_configs
-
-
-logger = logging.getLogger(__name__)
-
-def create_attack_graph(
-        lang_file: str,
-        model_file: str,
-        attach_attackers=True,
-        calc_viability_and_necessity=True
-    ) -> AttackGraph:
-    """Create and return an attack graph
-
-    Args:
-    lang_file                       - path to language file (.mar or .mal)
-    model_file                      - path to model file (yaml or json)
-    attach_attackers                - whether to run attach_attackers or not
-    calc_viability_and_necessity    - whether run apriori calculations or not
-    """
-    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_to_file(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:
-        attack_graph = AttackGraph(lang_graph, instance_model)
-    except AttackGraphStepExpressionError:
-        logger.error(
-            'Attack graph generation failed when attempting '
-            'to resolve attack step expression!'
-        )
-        sys.exit(1)
-
-    if attach_attackers:
-        attack_graph.attach_attackers()
-
-    if calc_viability_and_necessity:
-        calculate_viability_and_necessity(attack_graph)
-
-    return attack_graph