plyara

Build Status Documentation Status Code Health Test Coverage PyPi Version

Parse YARA rules into a dictionary representation.

Plyara is a script and library that lexes and parses a file consisting of one more YARA rules into a python dictionary representation. The goal of this tool is to make it easier to perform bulk operations or transformations of large sets of YARA rules, such as extracting indicators, updating attributes, and analyzing a corpus. Other applications include linters and dependency checkers.

Plyara leverages the Python module PLY for lexing YARA rules.

This is a community-maintained fork of the original plyara by 8u1a. The “plyara” trademark is used with permission.

Installation

Install with pip:

pip install plyara

Usage

Use the plyara Python library in your own applications:

>>> import plyara
>>> parser = plyara.Plyara()
>>> mylist = parser.parse_string('rule MyRule { strings: $a="1" \n condition: false }')
>>>
>>> import pprint
>>> pprint.pprint(mylist)
[{'condition_terms': ['false'],
  'raw_condition': 'condition: false',
  'raw_strings': 'strings: $a="1" \n',
  'rule_name': 'MyRule',
  'start_line': 1,
  'stop_line': 2,
  'strings': [{'name': '$a', 'value': '"1"'}]}]
>>>

Or, use the included plyara script from the command line:

$ plyara -h
usage: plyara.py [-h] [--log] FILE

Parse YARA rules into a dictionary representation.

positional arguments:
  FILE        File containing YARA rules to parse.

optional arguments:
  -h, --help  show this help message and exit
  --log       Enable debug logging to the console.

The command-line tool will print valid JSON output when parsing rules:

$ cat example.yar
rule silent_banker : banker
{
    meta:
        description = "This is just an example"
        thread_level = 3
        in_the_wild = true
    strings:
        $a = {6A 40 68 00 30 00 00 6A 14 8D 91}
        $b = {8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}
        $c = "UVODFRYSIHLNWPEJXQZAKCBGMT"
    condition:
        $a or $b or $c
}

$ plyara example.yar
[
    {
        "condition_terms": [
            "$a",
            "or",
            "$b",
            "or",
            "$c"
        ],
        "metadata": {
            "description": "This is just an example",
            "in_the_wild": "true",
            "thread_level": "3"
        },
        "raw_condition": "condition:\n        $a or $b or $c\n",
        "raw_meta": "meta:\n        description = \"This is just an example\"\n        thread_level = 3\n        in_the_wild = true\n    ",
        "raw_strings": "strings:\n        $a = {6A 40 68 00 30 00 00 6A 14 8D 91}\n        $b = {8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}\n        $c = \"UVODFRYSIHLNWPEJXQZAKCBGMT\"\n    ",
        "rule_name": "silent_banker",
        "start_line": 1,
        "stop_line": 13,
        "strings": [
            {
                "name": "$a",
                "value": "{6A 40 68 00 30 00 00 6A 14 8D 91}"
            },
            {
                "name": "$b",
                "value": "{8D 4D B0 2B C1 83 C0 27 99 6A 4E 59 F7 F9}"
            },
            {
                "name": "$c",
                "value": "\"UVODFRYSIHLNWPEJXQZAKCBGMT\""
            }
        ],
        "tags": [
            "banker"
        ]
    }
]

Migration

If you used an older version of plyara, and want to migrate to this version, there will be some changes required. Most importantly, the parser object instantiation has changed. It was:

# Old style - don't do this!
import plyara.interp as interp
rules_list = interp.parseString(open('myfile.yar').read())

But is now:

# New style - do this instead!
import plyara
parser = plyara.Plyara()
rules_list = parser.parse_string(open('myfile.yar').read())

The existing parsed keys have stayed the same, and new ones have been added.

When reusing a parser for multiple rules and/or files, be aware that imports are now shared across all rules - if one rule has an import, that import will be added to all rules in your parser object.

Contributing

  • If you find a bug, or would like to see a new feature, Pull Requests and Issues are always welcome.
  • By submitting changes, you agree to release those changes under the terms of the LICENSE.
  • Writing passing unit tests for your changes, while not required, is highly encouraged and appreciated.

Discussion

  • You may join our IRC channel on irc.freenode.net #plyara
  • Additionally, project developers can join our slack http://plyara.slack.com (If you need an invite, please ask in the IRC channel.)

Module Documentation

class plyara.Parser(console_logging=False, store_raw_sections=True)

Bases: object

Interpret the output of the parser and produce an alternative representation of YARA rules.

COMPARISON_OPERATORS = ('==', '!=', '>', '<', '>=', '<=')
FUNCTION_KEYWORDS = ('uint8', 'uint16', 'uint32', 'uint8be', 'uint16be', 'uint32be')
IMPORT_OPTIONS = ('pe', 'elf', 'cuckoo', 'magic', 'hash', 'math', 'dotnet', 'androguard')
KEYWORDS = ('all', 'and', 'any', 'ascii', 'at', 'condition', 'contains', 'entrypoint', 'false', 'filesize', 'fullword', 'for', 'global', 'in', 'import', 'include', 'int8', 'int16', 'int32', 'int8be', 'int16be', 'int32be', 'matches', 'meta', 'nocase', 'not', 'or', 'of', 'private', 'rule', 'strings', 'them', 'true', 'uint8', 'uint16', 'uint32', 'uint8be', 'uint16be', 'uint32be', 'wide')
static detect_dependencies(rule)

Takes a parsed yararule and provide a list of external rule dependencies.

static detect_imports(rule)

Takes a parsed yararule and provide a list of required imports based on condition.

static generate_logic_hash(rule)

Calculate hash value of rule strings and condition.

static is_valid_rule_name(entry)

Checks to see if entry is a valid rule name.

static is_valid_rule_tag(entry)

Checks to see if entry is a valid rule tag.

parse_string(input_string)

Take a string input expected to consist of YARA rules, and return list of dictionaries representing them.

static rebuild_yara_rule(rule)

Take a parsed yararule and rebuild it into a usable one.

class plyara.Plyara(console_logging=False, store_raw_sections=True)

Bases: plyara.Parser

Class to define the lexer and the parser rules.

Indices and tables