Rename falco_mitre_checker into falco_mitre_attack_checker

Signed-off-by: Louis Cailliot <louis.cailliot@thalesgroup.com>
falcosecurity · Nov 27, 2023 · c37400d · c37400d
1 parent 65d5f64
commit c37400d
Show file tree

Hide file tree

Showing 36 changed files with 864 additions and 839 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
 # Specific project files
-build/mitre_checker/build
-build/mitre_checker/reports
+build/mitre_attack_checker/build
+build/mitre_attack_checker/reports
 **/falco_rules_mitre_errors.json
 **/application_rules_errors.json
 

diff --git a/build/mitre_checker/.python-version → build/mitre_attack_checker/.python-version b/build/mitre_checker/.python-version → build/mitre_attack_checker/.python-version
diff --git a/build/mitre_checker/README.md → build/mitre_attack_checker/README.md b/build/mitre_checker/README.md → build/mitre_attack_checker/README.md
@@ -1,15 +1,15 @@
-# Mitre Checker Module
+# Mitre ATT&CK Checker Module
 
-The Mitre Checker module aims to check the compliance of the Falco rules against the Mitre ATT&CK
-Framework. This module provides to Falco experts and Falco users a way to check default and custom
+The Mitre ATT&CK Checker module aims to check the compliance of the Falco rules against the Mitre ATT&CK
+framework. This module provides to Falco experts and Falco users a way to check default and custom
 rules for Mitre ATT&CK extra tags.
 This module uses STIX from the OASIS standards. Structured Threat Information Expression (STIX™) is a
 language and serialization format used to exchange cyber threat intelligence (CTI) :
 
 - [STIX CTI documentation](https://oasis-open.github.io/cti-documentation/stix/intro)
 
-Leveraging STIX, Mitre Checker fetches the ATT&CK® STIX Data from MITRE ATT&CK repositories using the
-`python-stix2` library implemented by OASIS:
+Leveraging STIX, Mitre ATT&CK Checker fetches the ATT&CK® STIX Data from MITRE ATT&CK repositories using
+the `python-stix2` library implemented by OASIS:
 
 - [ATT&CK STIX Data repository](https://github.com/mitre-attack/attack-stix-data)
 - [Python STIX2 repository](https://github.com/oasis-open/cti-python-stix2)
@@ -45,19 +45,19 @@ Requirements :
 Or manualy using `pip` :
 
 ```sh
-pip install dist/mitre_checker-0.1.0-py3-none-any.whl
+pip install dist/falco_mitre_attack_checker-0.1.0-py3-none-any.whl
 ```
 
 ## Usage
 
 ```sh
-python -m falco_mitre_checker --help
+python -m falco_mitre_attack_checker --help
 ```
 
 Using the stable falco rules :
 
 ```sh
-python -m falco_mitre_checker -f ../../rules/falco_rules.yaml -o /tmp/
+python -m falco_mitre_attack_checker -f ../../rules/falco_rules.yaml -o /tmp/
 ```
 
 ## Development
@@ -79,7 +79,7 @@ With coverage :
 
 ```sh
 poetry update
-poetry run python -m pytest falco_mitre_checker/tests --cov=falco_mitre_checker
+poetry run python -m pytest --cov=falco_mitre_attack_checker
 ```
 
 ```

diff --git a/build/mitre_checker/build.sh → build/mitre_attack_checker/build.sh b/build/mitre_checker/build.sh → build/mitre_attack_checker/build.sh
diff --git a/...e_checker/falco_mitre_checker/__init__.py → ...er/falco_mitre_attack_checker/__init__.py b/...e_checker/falco_mitre_checker/__init__.py → ...er/falco_mitre_attack_checker/__init__.py
diff --git a/...e_checker/falco_mitre_checker/__main__.py → ...er/falco_mitre_attack_checker/__main__.py b/...e_checker/falco_mitre_checker/__main__.py → ...er/falco_mitre_attack_checker/__main__.py
@@ -1,5 +1,5 @@
-from falco_mitre_checker.cli.core import cli
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.cli.core import cli
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 
 def main():

diff --git a/...ecker/falco_mitre_checker/api/__init__.py → ...alco_mitre_attack_checker/api/__init__.py b/...ecker/falco_mitre_checker/api/__init__.py → ...alco_mitre_attack_checker/api/__init__.py
diff --git a/...e_checker/falco_mitre_checker/api/core.py → ...er/falco_mitre_attack_checker/api/core.py b/...e_checker/falco_mitre_checker/api/core.py → ...er/falco_mitre_attack_checker/api/core.py
@@ -2,9 +2,9 @@
 from pathlib import Path
 from typing import List, Dict
 
-from falco_mitre_checker.engine.mitre_checker import FalcoMitreChecker
-from falco_mitre_checker.models.falco_mitre_errors import FalcoMitreError
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.engine.mitre_checker import FalcoMitreChecker
+from falco_mitre_attack_checker.models.falco_mitre_errors import FalcoMitreError
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 logger = logging.getLogger(MitreCheckerLogger.name)
 

diff --git a/...ecker/falco_mitre_checker/cli/__init__.py → ...alco_mitre_attack_checker/cli/__init__.py b/...ecker/falco_mitre_checker/cli/__init__.py → ...alco_mitre_attack_checker/cli/__init__.py
diff --git a/...e_checker/falco_mitre_checker/cli/core.py → ...er/falco_mitre_attack_checker/cli/core.py b/...e_checker/falco_mitre_checker/cli/core.py → ...er/falco_mitre_attack_checker/cli/core.py
@@ -4,9 +4,9 @@
 
 import typer
 
-from falco_mitre_checker.api.core import mitre_checker_engine
-from falco_mitre_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.api.core import mitre_checker_engine
+from falco_mitre_attack_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 app = typer.Typer(help=f"Mitre Checker",
                   no_args_is_help=True,

diff --git a/...er/falco_mitre_checker/engine/__init__.py → ...o_mitre_attack_checker/engine/__init__.py b/...er/falco_mitre_checker/engine/__init__.py → ...o_mitre_attack_checker/engine/__init__.py
diff --git a/...lco_mitre_checker/engine/mitre_checker.py → ...re_attack_checker/engine/mitre_checker.py b/...lco_mitre_checker/engine/mitre_checker.py → ...re_attack_checker/engine/mitre_checker.py
@@ -2,13 +2,13 @@
 from pathlib import Path
 from typing import List
 
-from falco_mitre_checker.models.falco_mitre_errors import \
+from falco_mitre_attack_checker.models.falco_mitre_errors import \
     ErrorReason, FalcoMitreError, FalcoRulesErrors
-from falco_mitre_checker.models.falco_mitre_relations import MitreRelations
-from falco_mitre_checker.parsers.falco_rules import FalcoRulesParser
-from falco_mitre_checker.parsers.mitre_stix import MitreParser
-from falco_mitre_checker.utils.file import write_file
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.models.falco_mitre_relations import MitreRelations
+from falco_mitre_attack_checker.parsers.falco_rules import FalcoRulesParser
+from falco_mitre_attack_checker.parsers.mitre_stix import MitreParser
+from falco_mitre_attack_checker.utils.file import write_file
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 logger = logging.getLogger(MitreCheckerLogger.name)
 

diff --git a/...alco_mitre_checker/exceptions/__init__.py → ...tre_attack_checker/exceptions/__init__.py b/...alco_mitre_checker/exceptions/__init__.py → ...tre_attack_checker/exceptions/__init__.py
diff --git a/...re_checker/exceptions/rules_exceptions.py → ...ck_checker/exceptions/rules_exceptions.py b/...re_checker/exceptions/rules_exceptions.py → ...ck_checker/exceptions/rules_exceptions.py
diff --git a/...er/falco_mitre_checker/models/__init__.py → ...o_mitre_attack_checker/models/__init__.py b/...er/falco_mitre_checker/models/__init__.py → ...o_mitre_attack_checker/models/__init__.py
diff --git a/...itre_checker/models/falco_mitre_errors.py → ...tack_checker/models/falco_mitre_errors.py b/...itre_checker/models/falco_mitre_errors.py → ...tack_checker/models/falco_mitre_errors.py
diff --git a/...e_checker/models/falco_mitre_relations.py → ...k_checker/models/falco_mitre_relations.py b/...e_checker/models/falco_mitre_relations.py → ...k_checker/models/falco_mitre_relations.py
diff --git a/...r/falco_mitre_checker/parsers/__init__.py → ..._mitre_attack_checker/parsers/__init__.py b/...r/falco_mitre_checker/parsers/__init__.py → ..._mitre_attack_checker/parsers/__init__.py
diff --git a/...alco_mitre_checker/parsers/falco_rules.py → ...tre_attack_checker/parsers/falco_rules.py b/...alco_mitre_checker/parsers/falco_rules.py → ...tre_attack_checker/parsers/falco_rules.py
@@ -2,9 +2,9 @@
 from pathlib import Path
 from typing import Dict
 
-from falco_mitre_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
-from falco_mitre_checker.models.falco_mitre_relations import MitreRelations
-from falco_mitre_checker.utils.file import read_yaml
+from falco_mitre_attack_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
+from falco_mitre_attack_checker.models.falco_mitre_relations import MitreRelations
+from falco_mitre_attack_checker.utils.file import read_yaml
 
 
 class FalcoRulesParser(object):

diff --git a/...falco_mitre_checker/parsers/mitre_stix.py → ...itre_attack_checker/parsers/mitre_stix.py b/...falco_mitre_checker/parsers/mitre_stix.py → ...itre_attack_checker/parsers/mitre_stix.py
@@ -4,7 +4,7 @@
 import requests
 from stix2 import MemoryStore, Filter, AttackPattern
 
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 logger = logging.getLogger(MitreCheckerLogger.name)
 

diff --git a/...ker/falco_mitre_checker/tests/__init__.py → ...co_mitre_attack_checker/tests/__init__.py b/...ker/falco_mitre_checker/tests/__init__.py → ...co_mitre_attack_checker/tests/__init__.py
diff --git a/...co_mitre_checker/tests/engine/__init__.py → ...e_attack_checker/tests/engine/__init__.py b/...co_mitre_checker/tests/engine/__init__.py → ...e_attack_checker/tests/engine/__init__.py
diff --git a/...hecker/tests/engine/test_mitre_checker.py → ...hecker/tests/engine/test_mitre_checker.py b/...hecker/tests/engine/test_mitre_checker.py → ...hecker/tests/engine/test_mitre_checker.py
@@ -1,9 +1,9 @@
 from pathlib import Path
 from typing import List
 
-from falco_mitre_checker.engine.mitre_checker import FalcoMitreChecker
-from falco_mitre_checker.models.falco_mitre_errors import ErrorReason, FalcoRulesErrors, FalcoMitreError
-from falco_mitre_checker.tests.test_common import MITRE_DOMAIN, MITRE_VERSION, FALCO_RULES_FILE
+from falco_mitre_attack_checker.engine.mitre_checker import FalcoMitreChecker
+from falco_mitre_attack_checker.models.falco_mitre_errors import ErrorReason, FalcoRulesErrors, FalcoMitreError
+from falco_mitre_attack_checker.tests.test_common import MITRE_DOMAIN, MITRE_VERSION, FALCO_RULES_FILE
 
 # global
 mitre_checker = FalcoMitreChecker(MITRE_DOMAIN, MITRE_VERSION)

diff --git a/...o_mitre_checker/tests/parsers/__init__.py → ..._attack_checker/tests/parsers/__init__.py b/...o_mitre_checker/tests/parsers/__init__.py → ..._attack_checker/tests/parsers/__init__.py
diff --git a/...checker/tests/parsers/test_falco_rules.py → ...checker/tests/parsers/test_falco_rules.py b/...checker/tests/parsers/test_falco_rules.py → ...checker/tests/parsers/test_falco_rules.py
@@ -1,8 +1,8 @@
 import pytest
 
-from falco_mitre_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
-from falco_mitre_checker.parsers.falco_rules import FalcoRulesParser
-from falco_mitre_checker.tests.test_common import NOT_FALCO_RULES_FILE, FALCO_RULES_FILE
+from falco_mitre_attack_checker.exceptions.rules_exceptions import FalcoRulesFileContentError
+from falco_mitre_attack_checker.parsers.falco_rules import FalcoRulesParser
+from falco_mitre_attack_checker.tests.test_common import NOT_FALCO_RULES_FILE, FALCO_RULES_FILE
 
 # test falco rules file validation
 with pytest.raises(FalcoRulesFileContentError):

diff --git a/..._checker/tests/parsers/test_mitre_stix.py → ..._checker/tests/parsers/test_mitre_stix.py b/..._checker/tests/parsers/test_mitre_stix.py → ..._checker/tests/parsers/test_mitre_stix.py
@@ -1,5 +1,5 @@
-from falco_mitre_checker.parsers.mitre_stix import MitreParser
-from falco_mitre_checker.tests.test_common import RESOURCES_DIR, MITRE_VERSION, MITRE_DOMAIN
+from falco_mitre_attack_checker.parsers.mitre_stix import MitreParser
+from falco_mitre_attack_checker.tests.test_common import RESOURCES_DIR, MITRE_VERSION, MITRE_DOMAIN
 
 MITRE_STIX_DATAFILE = f"{RESOURCES_DIR}/mitre_cti_stix_13_1.json"
 

diff --git a/...ker/tests/resources/falco_rules_test.yaml → ...ker/tests/resources/falco_rules_test.yaml b/...ker/tests/resources/falco_rules_test.yaml → ...ker/tests/resources/falco_rules_test.yaml
diff --git a/...tests/resources/not_falco_rules_test.yaml → ...tests/resources/not_falco_rules_test.yaml b/...tests/resources/not_falco_rules_test.yaml → ...tests/resources/not_falco_rules_test.yaml
diff --git a/.../falco_mitre_checker/tests/test_common.py → ...mitre_attack_checker/tests/test_common.py b/.../falco_mitre_checker/tests/test_common.py → ...mitre_attack_checker/tests/test_common.py
@@ -1,7 +1,7 @@
 import os
 from pathlib import Path
 
-from falco_mitre_checker.utils.logger import MitreCheckerLogger
+from falco_mitre_attack_checker.utils.logger import MitreCheckerLogger
 
 MitreCheckerLogger()
 

diff --git a/...ker/falco_mitre_checker/utils/__init__.py → ...co_mitre_attack_checker/utils/__init__.py b/...ker/falco_mitre_checker/utils/__init__.py → ...co_mitre_attack_checker/utils/__init__.py
diff --git a/...checker/falco_mitre_checker/utils/file.py → .../falco_mitre_attack_checker/utils/file.py b/...checker/falco_mitre_checker/utils/file.py → .../falco_mitre_attack_checker/utils/file.py
diff --git a/...ecker/falco_mitre_checker/utils/logger.py → ...alco_mitre_attack_checker/utils/logger.py b/...ecker/falco_mitre_checker/utils/logger.py → ...alco_mitre_attack_checker/utils/logger.py
diff --git a/build/mitre_checker/install.sh → build/mitre_attack_checker/install.sh b/build/mitre_checker/install.sh → build/mitre_attack_checker/install.sh