yaralyzer 0.9.2__tar.gz → 0.9.4__tar.gz

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/.yaralyzer.example

@@ -12,7 +12,7 @@
 # Expand the width of the output to the fit the display window (same as the --maximize-width options)
 #    YARALYZER_MAXIMIZE_WIDTH=True
 
-# Passed through to yara.set_config as the stack_size and
+# Passed through to yara.set_config() as the stack_size and max_match_data arguments
 #    YARALYZER_STACK_SIZE=10485760
 #    YARALYZER_MAX_MATCH_LENGTH=10737418240
 

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/CHANGELOG.md

@@ -1,5 +1,11 @@
 # NEXT RELEASE
 
+### 0.9.4
+* Bump `yara-python` to 4.3.0+ and deal with backwards incompatibility
+
+### 0.9.3
+* Lock `yara-python` at 4.2.3 bc 4.3.x causes problems
+
 ### 0.9.2
 * Fix PyPi screenshots
 * Raise better error message if yara rules file doesn't exist

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: yaralyzer
-Version: 0.9.2
+Version: 0.9.4
 Summary: Visualize and force decode YARA and regex matches found in a file or byte stream. With colors. Lots of colors.
 Home-page: https://github.com/michelcrypt4d4mus/yaralyzer
 License: GPL-3.0-or-later
@@ -19,14 +19,14 @@ Requires-Dist: chardet (>=5.0.0,<6.0.0)
 Requires-Dist: python-dotenv (>=0.21.0,<0.22.0)
 Requires-Dist: rich (>=12.5.1,<13.0.0)
 Requires-Dist: rich-argparse-plus (>=0.3.1,<0.4.0)
-Requires-Dist: yara-python (>=4.2.3,<5.0.0)
+Requires-Dist: yara-python (>=4.3.0,<5.0.0)
 Project-URL: Documentation, https://github.com/michelcrypt4d4mus/yaralyzer
 Project-URL: Repository, https://github.com/michelcrypt4d4mus/yaralyzer
 Description-Content-Type: text/markdown
 
 <!-- ![Tests](https://img.shields.io/github/workflow/status/michelcrypt4d4mus/yaralyzer/tests?label=tests) -->
 ![Python Version](https://img.shields.io/pypi/pyversions/yaralyzer)
-![Release](https://img.shields.io/github/v/release/michelcrypt4d4mus/yaralyzer?sort=semver)
+![Release](https://img.shields.io/pypi/v/yaralyzer)
 ![Downloads](https://img.shields.io/pypi/dm/yaralyzer)
 
 # THE YARALYZER
@@ -52,8 +52,8 @@ yaralyze --hex-pattern 'd0 93 d0 a3 d0 [-] 9b d0 90 d0 93' one_day_in_the_life_o
 #### What It Do
 1. **See the actual bytes your YARA rules are matching.** No more digging around copy/pasting the start positions reported by YARA into your favorite hex editor. Displays both the bytes matched by YARA as well as a configurable number of bytes before and after each match in hexadecimal and "raw" python string representation.
 1. **Do the same for byte patterns and regular expressions without writing a YARA file.** If you're too lazy to write a YARA file but are trying to determine, say, whether there's a regular expression hidden somewhere in the file you could scan for the pattern `'/.+/'` and immediately get a window into all the bytes in the file that live between front slashes. Same story for quotes, BOMs, etc. Any regex YARA can handle is supported so the sky is the limit.
-1. **Detect the possible encodings of each set of matched bytes.** [The `chardet` library](https://github.com/chardet/chardet) is a sophisticated library for guessing character encodings and it is leveraged here.
-1. **Display the result of forcing various character encodings upon the matched areas.** Several default character encodings will be _forcibly_ attempted in the region around the match. [`chardet`](https://github.com/chardet/chardet) will also be leveraged to see if the bytes fit the pattern of _any_ known encoding. If `chardet` is confident enough (configurable), an attempt at decoding the bytes using that encoding will be displayed.
+1. **Detect the possible encodings of each set of matched bytes.** [`chardet`](https://github.com/chardet/chardet) is a sophisticated library for guessing character encodings and it is leveraged here.
+1. **Display the result of forcing various character encodings upon the matched areas.** Several default character encodings will be _forcibly_ attempted in the region around the match. [`chardet`](https://github.com/chardet/chardet) will also be leveraged to see if the bytes fit the pattern of _any_ known encoding. If `chardet` is confident enough (configurable) an attempt at decoding the bytes using that encoding will be displayed.
 1. **Export the matched regions/decodings to SVG, HTML, and colored text files.** Show off your ASCII art.
 
 #### Why It Do
@@ -87,7 +87,7 @@ Run `yaralyze -h` to see the command line options (screenshot below).
 For info on exporting SVG images, HTML, etc., see [Example Output](#example-output).
 
 ### Configuration
-If you place a filed called `.yaralyzer` in your home directory or the current working directory then environment variables specified in that `.yaralyzer` file will be added to the environment each time yaralyzer is invoked. This provides a mechanism for permanently configuring various command line options so you can avoid typing them over and over. See the example file [`.yaralyzer.example`](.yaralyzer.example) to see which options can be configured this way.
+If you place a file called `.yaralyzer` in your home directory or the current working directory then environment variables specified in that `.yaralyzer` file will be added to the environment each time yaralyzer is invoked. This provides a mechanism for permanently configuring various command line options so you can avoid typing them over and over. See the example file [`.yaralyzer.example`](.yaralyzer.example) to see which options can be configured this way.
 
 Only one `.yaralyzer` file will be loaded and the working directory's `.yaralyzer` takes precedence over the home directory's `.yaralyzer`.
 
@@ -131,6 +131,7 @@ The Yaralyzer can export visualizations to HTML, ANSI colored text, and SVG vect
 
 
 # TODO
+* For some reason when displaying matches the output to a file iterates over all matches in a different way than just running in the console. Presumably this is related to the `rich` rendering engine in some way. For now the console output is the "more correct" one so it's generally OK. See [`issue_with_output_to_console_correct`](doc/rendered_images/issue_with_output_to_console_correct.png) vs. [`doc/rendered_images/issue_with_output_to_txt_file_incorrect.png`](doc/rendered_images/issue_with_output_to_txt_file_incorrect.png)
 * highlight decodes done at `chardet`s behest
 * deal with repetitive matches
 

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/README.md

@@ -1,6 +1,6 @@
 <!-- ![Tests](https://img.shields.io/github/workflow/status/michelcrypt4d4mus/yaralyzer/tests?label=tests) -->
 ![Python Version](https://img.shields.io/pypi/pyversions/yaralyzer)
-![Release](https://img.shields.io/github/v/release/michelcrypt4d4mus/yaralyzer?sort=semver)
+![Release](https://img.shields.io/pypi/v/yaralyzer)
 ![Downloads](https://img.shields.io/pypi/dm/yaralyzer)
 
 # THE YARALYZER
@@ -26,8 +26,8 @@ yaralyze --hex-pattern 'd0 93 d0 a3 d0 [-] 9b d0 90 d0 93' one_day_in_the_life_o
 #### What It Do
 1. **See the actual bytes your YARA rules are matching.** No more digging around copy/pasting the start positions reported by YARA into your favorite hex editor. Displays both the bytes matched by YARA as well as a configurable number of bytes before and after each match in hexadecimal and "raw" python string representation.
 1. **Do the same for byte patterns and regular expressions without writing a YARA file.** If you're too lazy to write a YARA file but are trying to determine, say, whether there's a regular expression hidden somewhere in the file you could scan for the pattern `'/.+/'` and immediately get a window into all the bytes in the file that live between front slashes. Same story for quotes, BOMs, etc. Any regex YARA can handle is supported so the sky is the limit.
-1. **Detect the possible encodings of each set of matched bytes.** [The `chardet` library](https://github.com/chardet/chardet) is a sophisticated library for guessing character encodings and it is leveraged here.
-1. **Display the result of forcing various character encodings upon the matched areas.** Several default character encodings will be _forcibly_ attempted in the region around the match. [`chardet`](https://github.com/chardet/chardet) will also be leveraged to see if the bytes fit the pattern of _any_ known encoding. If `chardet` is confident enough (configurable), an attempt at decoding the bytes using that encoding will be displayed.
+1. **Detect the possible encodings of each set of matched bytes.** [`chardet`](https://github.com/chardet/chardet) is a sophisticated library for guessing character encodings and it is leveraged here.
+1. **Display the result of forcing various character encodings upon the matched areas.** Several default character encodings will be _forcibly_ attempted in the region around the match. [`chardet`](https://github.com/chardet/chardet) will also be leveraged to see if the bytes fit the pattern of _any_ known encoding. If `chardet` is confident enough (configurable) an attempt at decoding the bytes using that encoding will be displayed.
 1. **Export the matched regions/decodings to SVG, HTML, and colored text files.** Show off your ASCII art.
 
 #### Why It Do
@@ -61,7 +61,7 @@ Run `yaralyze -h` to see the command line options (screenshot below).
 For info on exporting SVG images, HTML, etc., see [Example Output](#example-output).
 
 ### Configuration
-If you place a filed called `.yaralyzer` in your home directory or the current working directory then environment variables specified in that `.yaralyzer` file will be added to the environment each time yaralyzer is invoked. This provides a mechanism for permanently configuring various command line options so you can avoid typing them over and over. See the example file [`.yaralyzer.example`](.yaralyzer.example) to see which options can be configured this way.
+If you place a file called `.yaralyzer` in your home directory or the current working directory then environment variables specified in that `.yaralyzer` file will be added to the environment each time yaralyzer is invoked. This provides a mechanism for permanently configuring various command line options so you can avoid typing them over and over. See the example file [`.yaralyzer.example`](.yaralyzer.example) to see which options can be configured this way.
 
 Only one `.yaralyzer` file will be loaded and the working directory's `.yaralyzer` takes precedence over the home directory's `.yaralyzer`.
 
@@ -105,6 +105,7 @@ The Yaralyzer can export visualizations to HTML, ANSI colored text, and SVG vect
 
 
 # TODO
+* For some reason when displaying matches the output to a file iterates over all matches in a different way than just running in the console. Presumably this is related to the `rich` rendering engine in some way. For now the console output is the "more correct" one so it's generally OK. See [`issue_with_output_to_console_correct`](doc/rendered_images/issue_with_output_to_console_correct.png) vs. [`doc/rendered_images/issue_with_output_to_txt_file_incorrect.png`](doc/rendered_images/issue_with_output_to_txt_file_incorrect.png)
 * highlight decodes done at `chardet`s behest
 * deal with repetitive matches
 

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "yaralyzer"
-version = "0.9.2"
+version = "0.9.4"
 description = "Visualize and force decode YARA and regex matches found in a file or byte stream. With colors. Lots of colors."
 authors = ["Michel de Cryptadamus <michel@cryptadamus.com>"]
 readme = "README.md"
@@ -44,7 +44,7 @@ chardet = "^5.0.0"
 python-dotenv = "^0.21.0"
 rich = "^12.5.1"
 rich-argparse-plus = "^0.3.1"
-yara-python = "^4.2.3"
+yara-python = "^4.3.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.1.3"

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/bytes_match.py

@@ -10,6 +10,7 @@ from typing import Iterator, Optional
 
 from rich.table import Table
 from rich.text import Text
+from yara import StringMatch, StringMatchInstance
 
 from yaralyzer.config import YaralyzerConfig
 from yaralyzer.helpers.rich_text_helper import prefix_with_plain_text_obj
@@ -41,10 +42,10 @@ class BytesMatch:
         self.label: str = label
         self.ordinal: int = ordinal
         self.match: Optional[re.Match] = match
-        # Maybe should be called "matched_bytes"
-        self.bytes = matched_against[start_idx:self.end_idx]
+        self.bytes = matched_against[start_idx:self.end_idx]  # TODO: Maybe should be called "matched_bytes"
         self.match_groups: Optional[tuple] = match.groups() if match else None
         self._find_surrounding_bytes()
+
         # Adjust the highlighting start point in case this match is very early in the stream
         self.highlight_start_idx = start_idx - self.surrounding_start_idx
         self.highlight_end_idx = self.highlight_start_idx + self.length
@@ -65,14 +66,15 @@ class BytesMatch:
             cls,
             matched_against: bytes,
             rule_name: str,
-            yara_str: dict,
+            yara_str_match: StringMatch,
+            yara_str_match_instance: StringMatchInstance,
             ordinal: int,
             highlight_style: str = YaralyzerConfig.HIGHLIGHT_STYLE
         ) -> 'BytesMatch':
-        """Build a BytesMatch from a yara string match. matched_against is the set of bytes yara was run against"""
-        # Don't duplicate the labeling if rule_name and yara_str are the same
-        pattern_label = yara_str[1]
+        """Build a BytesMatch from a yara string match. 'matched_against' is the set of bytes yara was run against."""
+        pattern_label = yara_str_match.identifier
 
+        # Don't duplicate the labeling if rule_name and yara_str are the same
         if pattern_label == '$' + rule_name:
             label = pattern_label
         else:
@@ -80,8 +82,8 @@ class BytesMatch:
 
         return cls(
             matched_against=matched_against,
-            start_idx=yara_str[0],
-            length=len(yara_str[2]),
+            start_idx=yara_str_match_instance.offset,
+            length=yara_str_match_instance.matched_length,
             label=label,
             ordinal=ordinal,
             highlight_style=highlight_style)
@@ -94,8 +96,20 @@ class BytesMatch:
             highlight_style: str = YaralyzerConfig.HIGHLIGHT_STYLE
         ) -> Iterator['BytesMatch']:
         """Iterator w/a BytesMatch for each string returned as part of a YARA match result dict."""
-        for i, yara_str in enumerate(yara_match['strings']):
-            yield(cls.from_yara_str(matched_against, yara_match['rule'], yara_str, i + 1, highlight_style))
+        i = 0  # For numbered labeling
+
+        # yara-python's internals changed with 4.3.0: https://github.com/VirusTotal/yara-python/releases/tag/v4.3.0
+        for yara_str_match in yara_match['strings']:
+            for yara_str_match_instance in yara_str_match.instances:
+                i += 1
+
+                yield(cls.from_yara_str(
+                    matched_against,
+                    yara_match['rule'],
+                    yara_str_match,
+                    yara_str_match_instance,
+                    i,
+                    highlight_style))
 
     def style_at_position(self, idx) -> str:
         """Get the style for the byte at position idx within the matched bytes"""

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/config.py

@@ -13,10 +13,9 @@ MEGABYTE = 1024 * KILOBYTE
 
 def config_var_name(env_var: str) -> str:
     """
-    Get the name of env_var and strip off 'YARALYZER_':
-
-    SURROUNDING_BYTES_ENV_VAR = 'YARALYZER_SURROUNDING_BYTES'
-    config_var_name(SURROUNDING_BYTES_ENV_VAR) => 'SURROUNDING_BYTES'
+    Get the name of env_var and strip off 'YARALYZER_', e.g.:
+        SURROUNDING_BYTES_ENV_VAR = 'YARALYZER_SURROUNDING_BYTES'
+        config_var_name(SURROUNDING_BYTES_ENV_VAR) => 'SURROUNDING_BYTES'
     """
     env_var = env_var.removeprefix("YARALYZER_")
     return f'{env_var=}'.partition('=')[0]
@@ -71,7 +70,7 @@ class YaralyzerConfig:
     ]
 
     @classmethod
-    def set_argument_parser(cls, parser):
+    def set_argument_parser(cls, parser: ArgumentParser) -> None:
         cls._argument_parser: ArgumentParser = parser
         cls._argparse_keys: List[str] = sorted([action.dest for action in parser._actions])
 
@@ -93,7 +92,7 @@ class YaralyzerConfig:
             if isinstance(arg_value, bool):
                 setattr(args, option, arg_value or is_env_var_set_and_not_false(env_var))
             elif isinstance(arg_value, (int, float)):
-                # Check against defaults to avoid overriding env var configured optoins
+                # Check against defaults to avoid overriding env var configured options
                 if arg_value == default_value and env_value is not None:
                     setattr(args, option, int(env_value) or arg_value)  # TODO: float args not handled
             else:

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/helpers/string_helper.py

@@ -1,6 +1,9 @@
 from functools import partial
 from typing import Any, Callable, List
 
+INDENT_DEPTH = 4
+INDENT_SPACES = INDENT_DEPTH * ' '
+
 
 def escape_yara_pattern(pattern: str) -> str:
     return pattern.replace('/', '\\/')

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/util/argument_parser.py

@@ -161,7 +161,7 @@ export = parser.add_argument_group(
     'FILE EXPORT',
     "Multiselect. Choosing nothing is choosing nothing. Sends what you see on the screen to various file " + \
         "formats in parallel. Writes files to the current directory if --output-dir is not provided. " + \
-        "Filenames are expansion of the scanned filename though you can use --file-prefix to make your " +
+        "Filenames are expansions of the scanned filename though you can use --file-prefix to make your " +
         "filenames more unique and beautiful to their beholder.")
 
 export.add_argument('-svg', '--export-svg',

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/yara/yara_match.py

@@ -8,12 +8,13 @@ Rich text decorator for YARA match dicts, which look like this:
     'rule': 'my_rule',
     'meta': {},
     'strings': [
-        (81L, '$a', 'abc'),
-        (141L, '$b', 'def')
+        StringMatch1,
+        StringMatch2
     ]
 }
 """
 import re
+from copy import deepcopy
 from numbers import Number
 from typing import Any, Dict
 
@@ -21,9 +22,11 @@ from rich.console import Console, ConsoleOptions, RenderResult
 from rich.padding import Padding
 from rich.panel import Panel
 from rich.text import Text
+from yara import StringMatch
 
 from yaralyzer.helpers.bytes_helper import clean_byte_string
 from yaralyzer.helpers.rich_text_helper import CENTER
+from yaralyzer.helpers.string_helper import INDENT_SPACES
 from yaralyzer.output.rich_console import console_width, theme_colors_with_prefix
 from yaralyzer.util.logging import log
 
@@ -56,16 +59,16 @@ class YaraMatch:
 
     def __rich_console__(self, _console: Console, options: ConsoleOptions) -> RenderResult:
         """Renders a panel showing the color highlighted raw YARA match info."""
-        yield(Text("\n"))
+        yield Text("\n")
         yield Padding(Panel(self.label, expand=False, style=f"on color(251) reverse"), MATCH_PADDING)
-        yield(RAW_YARA_THEME_TXT)
+        yield RAW_YARA_THEME_TXT
         yield Padding(Panel(_rich_yara_match(self.match)), MATCH_PADDING)
 
 
 def _rich_yara_match(element: Any, depth: int = 0) -> Text:
-    """Mildly painful/hacky way of coloring a yara result hash."""
-    indent = Text((depth + 1) * 4 * ' ')
-    end_indent = Text(depth * 4 * ' ')
+    """Painful/hacky way of recursively coloring a yara result hash."""
+    indent = Text((depth + 1) * INDENT_SPACES)
+    end_indent = Text(depth * INDENT_SPACES)
 
     if isinstance(element, str):
         txt = _yara_string(element)
@@ -79,6 +82,17 @@ def _rich_yara_match(element: Any, depth: int = 0) -> Text:
         if len(element) == 0:
             txt = Text('[]', style='white')
         else:
+            if isinstance(element[0], StringMatch):
+                # In yara-python 4.3.0 the StringMatch type was introduced so we just make it look like
+                # the old list of tuples format (see: https://github.com/VirusTotal/yara-python/releases/tag/v4.3.0)
+                match_tuples = [
+                    (match.identifier, match_instance.offset, match_instance.matched_data)
+                    for match in element
+                    for match_instance in match.instances
+                ]
+
+                return _rich_yara_match(match_tuples, depth)
+
             total_length = sum([len(str(e)) for e in element]) + ((len(element) - 1) * 2) + len(indent) + 2
             elements_txt = [_rich_yara_match(e, depth + 1) for e in element]
             list_txt = Text('[', style='white')

{yaralyzer-0.9.2 → yaralyzer-0.9.4}/yaralyzer/yaralyzer.py

@@ -30,6 +30,7 @@ from yaralyzer.yara.yara_match import YaraMatch
 from yaralyzer.yara.yara_rule_builder import yara_rule_string
 
 YARA_EXT = 'yara'
+YARA_FILE_DOES_NOT_EXIST_ERROR_MSG = "is not a valid yara rules file (it doesn't exist)"
 
 
 # TODO: might be worth introducing a Scannable namedtuple or similar
@@ -93,7 +94,7 @@ class Yaralyzer:
 
         for file in yara_rules_files:
             if not path.exists(file):
-                raise ValueError(f"'{file}' is not a valid yara rules file (it doesn't exist)")
+                raise ValueError(f"'{file}' {YARA_FILE_DOES_NOT_EXIST_ERROR_MSG}")
 
         filepaths_arg = {path.basename(file): file for file in yara_rules_files}
         yara_rules = yara.compile(filepaths=filepaths_arg)

yaralyzer-0.9.2/setup.py

@@ -1,46 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['yaralyzer',
- 'yaralyzer.decoding',
- 'yaralyzer.encoding_detection',
- 'yaralyzer.helpers',
- 'yaralyzer.output',
- 'yaralyzer.util',
- 'yaralyzer.yara']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['chardet>=5.0.0,<6.0.0',
- 'python-dotenv>=0.21.0,<0.22.0',
- 'rich-argparse-plus>=0.3.1,<0.4.0',
- 'rich>=12.5.1,<13.0.0',
- 'yara-python>=4.2.3,<5.0.0']
-
-entry_points = \
-{'console_scripts': ['yaralyze = yaralyzer:yaralyze',
-                     'yaralyzer_show_color_theme = '
-                     'yaralyzer.helpers.rich_text_helper:yaralyzer_show_color_theme']}
-
-setup_kwargs = {
-    'name': 'yaralyzer',
-    'version': '0.9.2',
-    'description': 'Visualize and force decode YARA and regex matches found in a file or byte stream. With colors. Lots of colors.',
-    'long_description': '<!-- ![Tests](https://img.shields.io/github/workflow/status/michelcrypt4d4mus/yaralyzer/tests?label=tests) -->\n![Python Version](https://img.shields.io/pypi/pyversions/yaralyzer)\n![Release](https://img.shields.io/github/v/release/michelcrypt4d4mus/yaralyzer?sort=semver)\n![Downloads](https://img.shields.io/pypi/dm/yaralyzer)\n\n# THE YARALYZER\n\n![YARA match](https://github.com/michelcrypt4d4mus/yaralyzer/raw/master/doc/rendered_images/top_of_readme.png)\n\nVisually inspect all of the regex matches (and their sexier, more cloak and dagger cousins, the [YARA](https://github.com/VirusTotal/yara-python) matches) found in binary data and/or text. See what happens when you force various character encodings upon those matched bytes. [With colors](https://github.com/michelcrypt4d4mus/yaralyzer#example-output).\n\n#### Quick Start\n```sh\npipx install yaralyzer\n\n# Scan against YARA definitions in a file:\nyaralyze --yara-rules /secret/vault/sigmunds_malware_rules.yara lacan_buys_the_dip.pdf\n\n# Scan against an arbitrary regular expression:\nyaralyze --regex-pattern \'good and evil.*of\\s+\\w+byte\' the_crypto_archipelago.exe\n\n# Scan against an arbitrary YARA hex pattern\nyaralyze --hex-pattern \'d0 93 d0 a3 d0 [-] 9b d0 90 d0 93\' one_day_in_the_life_of_ivan_cryptosovich.bin\n```\n\n#### What It Do\n1. **See the actual bytes your YARA rules are matching.** No more digging around copy/pasting the start positions reported by YARA into your favorite hex editor. Displays both the bytes matched by YARA as well as a configurable number of bytes before and after each match in hexadecimal and "raw" python string representation.\n1. **Do the same for byte patterns and regular expressions without writing a YARA file.** If you\'re too lazy to write a YARA file but are trying to determine, say, whether there\'s a regular expression hidden somewhere in the file you could scan for the pattern `\'/.+/\'` and immediately get a window into all the bytes in the file that live between front slashes. Same story for quotes, BOMs, etc. Any regex YARA can handle is supported so the sky is the limit.\n1. **Detect the possible encodings of each set of matched bytes.** [The `chardet` library](https://github.com/chardet/chardet) is a sophisticated library for guessing character encodings and it is leveraged here.\n1. **Display the result of forcing various character encodings upon the matched areas.** Several default character encodings will be _forcibly_ attempted in the region around the match. [`chardet`](https://github.com/chardet/chardet) will also be leveraged to see if the bytes fit the pattern of _any_ known encoding. If `chardet` is confident enough (configurable), an attempt at decoding the bytes using that encoding will be displayed.\n1. **Export the matched regions/decodings to SVG, HTML, and colored text files.** Show off your ASCII art.\n\n#### Why It Do\nThe Yaralyzer\'s functionality was extracted from [The Pdfalyzer](https://github.com/michelcrypt4d4mus/pdfalyzer) when it became apparent that visualizing and decoding pattern matches in binaries had more utility than just in a PDF analysis tool.\n\n[YARA](https://github.com/VirusTotal/yara-python), for those who are unaware[^1], is branded as a malware analysis/alerting tool but it\'s actually both a lot more and a lot less than that. One way to think about it is that YARA is a regular expression matching engine on steroids. It can locate regex matches in binaries like any regex engine but it can also do far wilder things like combine regexes in logical groups, compare regexes against all 256 XORed versions of a binary, check for `base64` and other encodings of the pattern, and more.  Maybe most importantly of all YARA provides a standard text based format for\npeople to _share_ their \'roided regexes with the world. All these features are particularly useful when analyzing or reverse engineering malware, whose authors tend to invest a great deal of time into making stuff hard to find.\n\nBut... that\'s also all YARA does. Everything else is up to the user. YARA\'s just a match engine and if you don\'t know what to match (or even what character encoding you might be able to match in) it only gets you so far. I found myself a bit frustrated trying to use YARA to look at all the matches of a few critical patterns:\n\n1. Bytes between escaped quotes (`\\".+\\"` and `\\\'.+\\\'`)\n1. Bytes between front slashes (`/.+/`). Front slashes demarcate a regular expression in many implementations and I was trying to see if any of the bytes matching this pattern were _actually_ regexes.\n\nYARA just tells you the byte position and the matched string but it can\'t tell you whether those bytes are UTF-8, UTF-16, Latin-1, etc. etc. (or none of the above). I also found myself wanting to understand what was going _in the region_ of the matched bytes and not just _in_ the matched bytes. In other words I wanted to scope the bytes immediately before and after whatever got matched.\n\nEnter **The Yaralyzer**, which lets you quickly scan the regions around matches while also showing you what those regions would look like if they were forced into various character encodings.\n\nIt\'s important to note that **The Yaralyzer** isn\'t a full on malware reversing tool. It can\'t do all the things a tool like [CyberChef](https://gchq.github.io/CyberChef/) does and it doesn\'t try to. It\'s more intended to give you a quick visual overview of suspect regions in the binary so you can hone in on the areas you might want to inspect with a more serious tool like [CyberChef](https://gchq.github.io/CyberChef/).\n\n# Installation\nInstall it with [`pipx`](https://pypa.github.io/pipx/) or `pip3`. `pipx` is a marginally better solution as it guarantees any packages installed with it will be isolated from the rest of your local python environment. Of course if you don\'t really have a local python environment this is a moot point and you can feel free to install with `pip`/`pip3`.\n```\npipx install yaralyzer\n```\n\n# Usage\nRun `yaralyze -h` to see the command line options (screenshot below).\n\n![](https://github.com/michelcrypt4d4mus/yaralyzer/raw/master/doc/rendered_images/yaralyze_help.png)\n\nFor info on exporting SVG images, HTML, etc., see [Example Output](#example-output).\n\n### Configuration\nIf you place a filed called `.yaralyzer` in your home directory or the current working directory then environment variables specified in that `.yaralyzer` file will be added to the environment each time yaralyzer is invoked. This provides a mechanism for permanently configuring various command line options so you can avoid typing them over and over. See the example file [`.yaralyzer.example`](.yaralyzer.example) to see which options can be configured this way.\n\nOnly one `.yaralyzer` file will be loaded and the working directory\'s `.yaralyzer` takes precedence over the home directory\'s `.yaralyzer`.\n\n### As A Library\n[`Yaralyzer`](yaralyzer/yaralyzer.py) is the main class. It has a variety of constructors supporting:\n\n1. Precompiled YARA rules\n1. Creating a YARA rule from a string\n1. Loading YARA rules from files\n1. Loading YARA rules from all `.yara` file in a directory\n1. Scanning `bytes`\n1. Scanning a file\n\nShould you want to iterate over the `BytesMatch` (like a `re.Match` object for a YARA match) and `BytesDecoder` (tracks decoding attempt stats) objects returned by The Yaralyzer, you can do so like this:\n\n```python\nfrom yaralyzer.yaralyzer import Yaralyzer\n\nyaralyzer = Yaralyzer.for_rules_files([\'/secret/rule.yara\'], \'lacan_buys_the_dip.pdf\')\n\nfor bytes_match, bytes_decoder in yaralyzer.match_iterator():\n    do_stuff()\n```\n\n# Example Output\nThe Yaralyzer can export visualizations to HTML, ANSI colored text, and SVG vector images using the file export functionality that comes with [Rich](https://github.com/Textualize/rich). SVGs can be turned into `png` format images with a tool like [Inkscape](https://inkscape.org/) or `cairosvg`. In our experience they both work though we\'ve seen some glitchiness with `cairosvg`.\n\n**PyPi Users:** If you are reading this document [on PyPi](https://pypi.org/project/yaralyzer/) be aware that it renders a lot better [over on GitHub](https://github.com/michelcrypt4d4mus/yaralyzer). Pretty pictures, footnotes that work, etc.\n\n#### Raw YARA match result:\n\n![](https://github.com/michelcrypt4d4mus/yaralyzer/raw/master/doc/rendered_images/yara_match_result.jpg)\n\n#### Display hex, raw python string, and various attempted decodings of both the match and the bytes before and after the match (configurable):\n\n![](https://github.com/michelcrypt4d4mus/yaralyzer/raw/master/doc/rendered_images/font_34_frontslash_scan.png)\n\n#### Bonus: see what `chardet.detect()` thinks about the likelihood your bytes are in a given encoding/language:\n\n![](https://github.com/michelcrypt4d4mus/yaralyzer/raw/master/doc/rendered_images/decoding_and_chardet_table_2.png)\n\n\n# TODO\n* highlight decodes done at `chardet`s behest\n* deal with repetitive matches\n\n[^1]: As I was until recently.\n',
-    'author': 'Michel de Cryptadamus',
-    'author_email': 'michel@cryptadamus.com',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'https://github.com/michelcrypt4d4mus/yaralyzer',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.9,<4.0',
-}
-
-
-setup(**setup_kwargs)