maco 1.1.14__tar.gz → 1.2.1__tar.gz

maco-1.2.1/PKG-INFO

@@ -0,0 +1,274 @@
+Metadata-Version: 2.1
+Name: maco
+Version: 1.2.1
+Author: sl-govau
+Maintainer: cccs-rs
+License: MIT License
+        
+        Copyright (c) 2022 Crown Copyright, Government of Canada (Canadian Centre for Cyber Security / Communications Security Establishment) and Government of Australia (Australian Cyber Security Centre / Australian Signals Directorate)
+        
+        Copyright title to all 3rd party software distributed with maco is held by the respective copyright holders as noted in those files. Users are asked to read the 3rd Party Licenses referenced with those assets.
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: Repository, https://github.com/CybercentreCanada/Maco
+Project-URL: Issues, https://github.com/CybercentreCanada/Maco/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: cart
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: tomli>=1.1.0; python_version < "3.11"
+Requires-Dist: uv
+Requires-Dist: yara-python
+Requires-Dist: yara-x==0.11.0
+
+# Maco - Malware config extractor framework
+
+## Maco is a framework for ***ma***lware ***co***nfig extractors.
+
+It aims to solve two problems:
+
+- Define a standardize ontology (or model) for extractor output. This greatly helps for databasing extracted values.
+- Provide a standard way of identifying which parsers to run and how to execute them.
+
+## Maco components
+
+- `model.py`
+  - A data model for the common output of an extractor
+- `extractor.py`
+  - Base class for extractors to implement
+- `collector.py`
+  - Utilities for loading and running extractors
+- `cli.py`
+  - A CLI tool `maco` to assist with running your extractors locally
+- `base_test.py`
+  - Assist with writing unit tests for your extractors
+
+**Note: If you're interested in using only the model in your project, you can `pip install maco-model` which is a smaller package containing only the model definition**
+
+## Project Integrations 🛠️
+
+This framework is actively being used by:
+
+|                                                                                                              Project                                                                                                               | Description                                                                                                                                                                                                                                                   |                                                                                License                                                                                 |
+| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+|        <a href="https://cybercentrecanada.github.io/assemblyline4_docs/"><img src="https://images.weserv.nl/?url=cybercentrecanada.github.io/assemblyline4_docs/images/crane.png?v=4&h=100&w=100&fit=cover&maxage=7d"></a>         | A malware analysis platform that uses the MACO model to export malware configuration extractions into a parseable, machine-friendly format                                                                                                                    |       [![License](https://img.shields.io/github/license/CybercentreCanada/assemblyline)](https://github.com/CybercentreCanada/assemblyline/blob/main/LICENSE.md)       |
+|                                                                           [configextractor-py](https://github.com/CybercentreCanada/configextractor-py)                                                                            | A tool designed to run extractors from multiple frameworks and uses the MACO model for output harmonization                                                                                                                                                   | [![License](https://img.shields.io/github/license/CybercentreCanada/configextractor-py)](https://github.com/CybercentreCanada/configextractor-py/blob/main/LICENSE.md) |
+| <a href="https://github.com/jeFF0Falltrades/rat_king_parser"><img src="https://images.weserv.nl/?url=raw.githubusercontent.com/jeFF0Falltrades/rat_king_parser/master/.github/logo.png?v=4&h=100&w=100&fit=cover&maxage=7d"/> </a> | A robust, multiprocessing-capable, multi-family RAT config parser/extractor that is compatible with MACO                                                                                                                                                      |      [![License](https://img.shields.io/github/license/jeFF0Falltrades/rat_king_parser)](https://github.com/jeFF0Falltrades/rat_king_parser/blob/master/LICENSE)       |
+|                              <a href="https://github.com/apophis133/apophis-YARA-Rules"><img src="https://images.weserv.nl/?url=github.com/apophis133.png?v=4&h=100&w=100&fit=cover&maxage=7d"/> </a>                              | A parser/extractor repository that supports MACO for performing malware configuration extraction with YARA rule detection                                                                                                                                     |                                                                                                                                                                        |
+|                           <a href="https://github.com/CAPESandbox/community"><img src="https://images.weserv.nl/?url=github.com/CAPESandbox.png?v=4&h=100&w=100&fit=cover&maxage=7d0&mask=circle"/> </a>                           | A parser/extractor repository containing MACO extractors that's authored by the CAPE community but is integrated in [CAPE](https://github.com/kevoreilly/CAPEv2) deployments.<br>**Note: These MACO extractors wrap and parse the original CAPE extractors.** |                  [![License](https://img.shields.io/badge/license-GPL--3.0-informational)](https://github.com/kevoreilly/CAPEv2/blob/master/LICENSE)                   |
+
+## Model Example
+
+See [the model definition](https://github.com/CybercentreCanada/Maco/blob/0f447a66de5e5ce8770ef3fe2325aec002842e63/maco/model.py#L127) for all the supported fields.
+You can use the model independently of the rest of the framework.
+This is still useful for compatibility between systems!
+
+```python
+from maco import model
+# 'family' is the only required property on the model
+output = model.ExtractorModel(family="wanabee")
+output.version = "2019"  # variant first found in 2019
+output.category.extend([model.CategoryEnum.cryptominer, model.CategoryEnum.clickfraud])
+output.http.append(model.ExtractorModel.Http(protocol="https",
+                                             uri="https://bad-domain.com/c2_payload",
+                                             usage="c2"))
+output.tcp.append(model.ExtractorModel.Connection(server_ip="127.0.0.1",
+                                           usage="ransom"))
+output.campaign_id.append("859186-3224-9284")
+output.inject_exe.append("explorer.exe")
+output.binaries.append(
+    output.Binary(
+        data=b"sam I am",
+        datatype=output.Binary.TypeEnum.config,
+        encryption=output.Binary.Encryption(
+            algorithm="rot26",
+            mode="block",
+        ),
+    )
+)
+# data about the malware that doesn't fit the model
+output.other["author_lunch"] = "green eggs and ham"
+output.other["author_lunch_time"] = "3pm"
+print(output.model_dump(exclude_defaults=True))
+
+# Generated model
+{
+    'family': 'wanabee',
+    'version': '2019',
+    'category': ['cryptominer', 'clickfraud'],
+    'campaign_id': ['859186-3224-9284'],
+    'inject_exe': ['explorer.exe'],
+    'other': {'author_lunch': 'green eggs and ham', 'author_lunch_time': '3pm'},
+    'http': [{'uri': 'https://bad-domain.com/c2_payload', 'usage': 'c2', 'protocol': 'https'}],
+    'tcp': [{'server_ip': '127.0.0.1', 'usage': 'ransom'}],
+    'binaries': [{
+        'datatype': 'config', 'data': b'sam I am',
+        'encryption': {'algorithm': 'rot26', 'mode': 'block'}
+    }]
+}
+```
+
+And you can create model instances from dictionaries:
+
+```python
+from maco import model
+output = {
+    "family": "wanabee2",
+    "version": "2022",
+    "ssh": [
+        {
+            "username": "wanna",
+            "password": "bee2",
+            "hostname": "10.1.10.100",
+        }
+    ],
+}
+print(model.ExtractorModel(**output))
+
+# Generated model
+family='wanabee2' version='2022' category=[] attack=[] capability_enabled=[]
+capability_disabled=[] campaign_id=[] identifier=[] decoded_strings=[]
+password=[] mutex=[] pipe=[] sleep_delay=None inject_exe=[] other={}
+binaries=[] ftp=[] smtp=[] http=[]
+ssh=[SSH(username='wanna', password='bee2', hostname='10.1.10.100', port=None, usage=None)]
+proxy=[] dns=[] tcp=[] udp=[] encryption=[] service=[] cryptocurrency=[]
+paths=[] registry=[]
+```
+
+## Extractor Example
+
+The following extractor will trigger on any file with more than 50 ELF sections,
+and set some properties in the model.
+
+Your extractors will do a better job of finding useful information than this one!
+
+```python
+class Elfy(extractor.Extractor):
+    """Check basic elf property."""
+
+    family = "elfy"
+    author = "blue"
+    last_modified = "2022-06-14"
+    yara_rule = """
+        import "elf"
+
+        rule Elfy
+        {
+            condition:
+                elf.number_of_sections > 50
+        }
+        """
+
+    def run(
+        self, stream: BytesIO, matches: List[yara.Match]
+    ) -> Optional[model.ExtractorModel]:
+        # return config model formatted results
+        ret = model.ExtractorModel(family=self.family)
+        # the list for campaign_id already exists and is empty, so we just add an item
+        ret.campaign_id.append(str(len(stream.read())))
+        return ret
+```
+
+## Writing Extractors
+
+There are several examples that use Maco in the '`demo_extractors`' folder.
+
+Some things to keep in mind:
+
+- The Yara rule names must be prefixed with the extractor class name.
+  - e.g. Class 'MyScript' has Yara rules named 'MyScriptDetect1' and 'MyScriptDetect2', not 'Detect1'
+- You can load other scripts contained within the same folder via a Python relative import
+  - See `complex.py` for details
+- You can standardise your usage of the '`other`' dict
+  - This is optional, see `limit_other.py` for details
+  - Consider instead making a PR with the properties you are frequently using
+
+# Requirements
+
+Python 3.8+.
+
+Install this package with `pip install maco`.
+
+All required Python packages are in the `requirements.txt`.
+
+# CLI Usage
+
+```bash
+> maco --help
+usage: maco [-h] [-v] [--pretty] [--base64] [--logfile LOGFILE] [--include INCLUDE] [--exclude EXCLUDE] [-f] [--create_venv] extractors samples
+
+Run extractors over samples.
+
+positional arguments:
+  extractors         path to extractors
+  samples            path to samples
+
+optional arguments:
+  -h, --help         show this help message and exit
+  -v, --verbose      print debug logging. -v extractor info, -vv extractor debug, -vvv cli debug
+  --pretty           pretty print json output
+  --base64           Include base64 encoded binary data in output (can be large, consider printing to file rather than console)
+  --logfile LOGFILE  file to log output
+  --include INCLUDE  comma separated extractors to run
+  --exclude EXCLUDE  comma separated extractors to not run
+  -f, --force        ignore yara rules and execute all extractors
+  --create_venv      Creates venvs for every requirements.txt found (only applies when extractor path is a directory)
+```
+
+## CLI output example
+
+The CLI is helpful for using your extractors in a standalone system, such as in a reverse engineering environment.
+
+```bash
+> maco demo_extractors/ /usr/lib --include Complex
+extractors loaded: ['Complex']
+
+complex by blue 2022-06-14 TLP:WHITE
+This script has multiple yara rules and coverage of the data model.
+
+path: /usr/lib/udev/hwdb.bin
+run Complex extractor from rules ['ComplexAlt']
+{"family": "complex", "version": "5", "decoded_strings": ["Paradise"],
+"binaries": [{"datatype": "payload", "size": 9, "hex_sample": "736F6D652064617461", "sha256": "1307990e6ba5ca145eb35e99182a9bec46531bc54ddf656a602c780fa0240dee",
+"encryption": {"algorithm": "something"}}],
+"http": [{"protocol": "https", "hostname": "blarg5.com", "path": "/malz/9956330", "usage": "c2"}],
+"encryption": [{"algorithm": "sha256"}]}
+
+path: /usr/lib/udev/hwdb.d/20-OUI.hwdb
+run Complex extractor from rules ['ComplexAlt']
+{"family": "complex", "version": "5", "decoded_strings": ["Paradise"],
+"binaries": [{"datatype": "payload", "size": 9, "hex_sample": "736F6D652064617461", "sha256": "1307990e6ba5ca145eb35e99182a9bec46531bc54ddf656a602c780fa0240dee",
+"encryption": {"algorithm": "something"}}],
+"http": [{"protocol": "https", "hostname": "blarg5.com", "path": "/malz/1986908", "usage": "c2"}],
+"encryption": [{"algorithm": "sha256"}]}
+
+path: /usr/lib/udev/hwdb.d/20-usb-vendor-model.hwdb
+run Complex extractor from rules ['ComplexAlt']
+{"family": "complex", "version": "5", "decoded_strings": ["Paradise"],
+"binaries": [{"datatype": "payload", "size": 9, "hex_sample": "736F6D652064617461", "sha256": "1307990e6ba5ca145eb35e99182a9bec46531bc54ddf656a602c780fa0240dee",
+"encryption": {"algorithm": "something"}}],
+"http": [{"protocol": "https", "hostname": "blarg5.com", "path": "/malz/1257481", "usage": "c2"}],
+"encryption": [{"algorithm": "sha256"}]}
+
+
+15884 analysed, 3 hits, 3 extracted
+```
+
+The demo extractors are designed to trigger when run over the '`demo_extractors`' folder.
+
+e.g. `maco demo_extractors demo_extractors`

{maco-1.1.14 → maco-1.2.1}/demo_extractors/complex/complex.py

@@ -1,11 +1,9 @@
 from io import BytesIO
-from typing import Dict, List, Optional
+from typing import List, Optional
 
-import yara
+from maco import extractor, model, yara
 
-from maco import extractor, model
-
-from . import complex_utils
+from complex import complex_utils
 
 
 class Complex(extractor.Extractor):
@@ -41,9 +39,7 @@ class Complex(extractor.Extractor):
         }
         """
 
-    def run(
-        self, stream: BytesIO, matches: List[yara.Match]
-    ) -> Optional[model.ExtractorModel]:
+    def run(self, stream: BytesIO, matches: List[yara.Match]) -> Optional[model.ExtractorModel]:
         self.logger.info("starting run")
         self.logger.debug(f"{[x.rule for x in matches]=}")
         data = stream.read()
@@ -54,7 +50,7 @@ class Complex(extractor.Extractor):
         other = complex_utils.getdata()["result"]
         self.logger.debug("got data from lib")
         # example - accessing yara strings
-        strings = {y[2].decode("utf8") for x in matches for y in x.strings}
+        strings = sorted({z.plaintext().decode("utf8") for x in matches for y in x.strings for z in y.instances})
         self.logger.debug(f"{strings=}")
         # construct model of results
         tmp = model.ExtractorModel(family=self.family)

{maco-1.1.14 → maco-1.2.1}/demo_extractors/elfy.py

@@ -1,9 +1,7 @@
 from io import BytesIO
 from typing import Dict, List, Optional
 
-import yara
-
-from maco import extractor, model
+from maco import extractor, model, yara
 
 
 class Elfy(extractor.Extractor):
@@ -22,9 +20,7 @@ class Elfy(extractor.Extractor):
         }
         """
 
-    def run(
-        self, stream: BytesIO, matches: List[yara.Match]
-    ) -> Optional[model.ExtractorModel]:
+    def run(self, stream: BytesIO, matches: List[yara.Match]) -> Optional[model.ExtractorModel]:
         # return config model formatted results
         ret = model.ExtractorModel(family=self.family)
         # the list for campaign_id already exists and is empty, so we just add an item

{maco-1.1.14 → maco-1.2.1}/demo_extractors/limit_other.py

@@ -1,9 +1,7 @@
 from io import BytesIO
 from typing import Dict, List, Optional
 
-import yara
-
-from maco import extractor, model
+from maco import extractor, model, yara
 
 from . import shared
 
@@ -25,9 +23,7 @@ class LimitOther(extractor.Extractor):
         }
         """
 
-    def run(
-        self, stream: BytesIO, matches: List[yara.Match]
-    ) -> Optional[model.ExtractorModel]:
+    def run(self, stream: BytesIO, matches: List[yara.Match]) -> Optional[model.ExtractorModel]:
         # use a custom model that inherits from ExtractorModel
         # this model defines what can go in the 'other' dict
         tmp = shared.MyCustomModel(family="specify_other")

{maco-1.1.14 → maco-1.2.1}/demo_extractors/nothing.py

@@ -1,9 +1,7 @@
 from io import BytesIO
 from typing import Dict, List, Optional
 
-import yara
-
-from maco import extractor, model
+from maco import extractor, model, yara
 
 
 class Nothing(extractor.Extractor):
@@ -23,8 +21,6 @@ class Nothing(extractor.Extractor):
         }
         """
 
-    def run(
-        self, stream: BytesIO, matches: List[yara.Match]
-    ) -> Optional[model.ExtractorModel]:
+    def run(self, stream: BytesIO, matches: List[yara.Match]) -> Optional[model.ExtractorModel]:
         # return config model formatted results
         return

maco-1.2.1/maco/collector.py

@@ -0,0 +1,137 @@
+"""Convenience functions for discovering your extractors."""
+
+import inspect
+import logging
+import os
+from multiprocessing import Manager, Process
+from tempfile import NamedTemporaryFile
+from types import ModuleType
+from typing import Any, BinaryIO, Dict, List, Union
+
+from pydantic import BaseModel
+
+from maco import extractor, model, utils, yara
+
+
+class ExtractorLoadError(Exception):
+    pass
+
+
+logger = logging.getLogger("maco.lib.helpers")
+
+
+def _verify_response(resp: Union[BaseModel, dict]) -> Dict:
+    """Enforce types and verify properties, and remove defaults."""
+    if not resp:
+        return None
+    # check the response is valid for its own model
+    # this is useful if a restriction on the 'other' dictionary is needed
+    resp_model = type(resp)
+    if resp_model != model.ExtractorModel and hasattr(resp_model, "model_validate"):
+        resp = resp_model.model_validate(resp)
+    # check the response is valid according to the ExtractorModel
+    resp = model.ExtractorModel.model_validate(resp)
+    # coerce sets to correct types
+    # otherwise we end up with sets where we expect lists
+    resp = model.ExtractorModel(**resp.model_dump())
+    # dump model to dict
+    return resp.model_dump(exclude_defaults=True)
+
+
+class Collector:
+    def __init__(
+        self, path_extractors: str, include: List[str] = None, exclude: List[str] = None, create_venv: bool = False
+    ):
+        """Discover and load extractors from file system."""
+        path_extractors = os.path.realpath(path_extractors)
+        self.path: str = path_extractors
+        self.extractors: Dict[str, Dict[str, str]] = {}
+
+        with Manager() as manager:
+            extractors = manager.dict()
+            namespaced_rules = manager.dict()
+
+            def extractor_module_callback(module: ModuleType, venv: str):
+                members = inspect.getmembers(module, predicate=utils.maco_extractor_validation)
+                for member in members:
+                    name, member = member
+                    if exclude and name in exclude:
+                        # Module is part of the exclusion list, skip
+                        logger.debug(f"exclude excluded '{name}'")
+                        return
+
+                    if include and name not in include:
+                        # Module wasn't part of the inclusion list, skip
+                        logger.debug(f"include excluded '{name}'")
+                        return
+
+                    # initialise and register
+                    logger.debug(f"register '{name}'")
+                    extractors[name] = dict(
+                        venv=venv,
+                        module_path=module.__file__,
+                        module_name=member.__module__,
+                        extractor_class=member.__name__,
+                    )
+                    namespaced_rules[name] = member.yara_rule or extractor.DEFAULT_YARA_RULE.format(name=name)
+
+            # Find the extractors within the given directory
+            # Execute within a child process to ensure main process interpreter is kept clean
+            p = Process(
+                target=utils.import_extractors,
+                args=(
+                    path_extractors,
+                    yara.compile(source=utils.MACO_YARA_RULE),
+                    extractor_module_callback,
+                    logger,
+                    create_venv and os.path.isdir(path_extractors),
+                ),
+            )
+            p.start()
+            p.join()
+
+            self.extractors = dict(extractors)
+            if not self.extractors:
+                raise ExtractorLoadError("no extractors were loaded")
+            logger.debug(f"found extractors {list(self.extractors.keys())}\n")
+
+            # compile yara rules gathered from extractors
+            self.rules = yara.compile(sources=dict(namespaced_rules))
+
+    def match(self, stream: BinaryIO) -> Dict[str, List[yara.Match]]:
+        """Return extractors that should run based on yara rules."""
+        # execute yara rules on file to find extractors we should run
+        # yara can't run on a stream so we give it a bytestring
+        matches = self.rules.match(data=stream.read())
+        stream.seek(0)
+        if not matches:
+            return
+        # get all rules that hit for each extractor
+        runs = {}
+        for match in matches:
+            runs.setdefault(match.namespace, []).append(match)
+
+        return runs
+
+    def extract(
+        self,
+        stream: BinaryIO,
+        matches: List[yara.Match],
+        extractor_name: str,
+    ) -> Dict[str, Any]:
+        """Run extractor with stream and verify output matches the model."""
+        extractor = self.extractors[extractor_name]
+        try:
+            # Run extractor on a copy of the sample
+            with NamedTemporaryFile() as sample_path:
+                sample_path.write(stream.read())
+                sample_path.flush()
+                # enforce types and verify properties, and remove defaults
+                return _verify_response(utils.run_extractor(sample_path.name, **extractor))
+        except Exception:
+            # caller can deal with the exception
+            raise
+        finally:
+            # make sure to reset where we are in the file
+            # otherwise follow on extractors are going to read 0 bytes
+            stream.seek(0)

{maco-1.1.14 → maco-1.2.1}/maco/extractor.py

@@ -4,7 +4,7 @@ import logging
 import textwrap
 from typing import BinaryIO, List, Optional, Union
 
-import yara
+from maco import yara
 
 from . import model
 
@@ -12,8 +12,8 @@ from . import model
 class InvalidExtractor(ValueError):
     pass
 
-DEFAULT_YARA_RULE = \
-"""
+
+DEFAULT_YARA_RULE = """
 rule {name}
 {{
     condition:
@@ -21,6 +21,7 @@ rule {name}
 }}
 """
 
+
 class Extractor:
     """Base class for an analysis extractor with common entrypoint and metadata.