gridl / pySigma

Python library to parse and convert Sigma rules into queries (and whatever else you could imagine)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pySigma

Tests Coverage Badge Status

pySigma is a python library that parses and converts Sigma rules into queries.

It replaces a lot of the logic found in the sigmac tool, and brings it into a modern Python library. For a CLI version of the new Sigma tool, see (TBA).

Getting Started

To start using pySigma, install it using your python package manager of choice. Documentation with some usage examples can be found here.

Poetry:

poetry add git+https://github.com/SigmaHQ/pySigma.git#main

Pipenv:

pipenv install git+https://github.com/SigmaHQ/pySigma.git#main

Features

pySigma brings a number of additional features over sigmac, as well as some changes.

Modifier compare from sigmac

Modifier Use sigmac legacy
contains the value is matched anywhere in the field X
startswith The value is expected at the beginning of the field's content X
endswith The value is expected at the end of the field's content X
base64 The value is encoded with Base64 X
base64offset If a value might appear somewhere in a base64-encoded value the representation might change depending on the position in the overall value X
wide transforms value to UTF16-LE encoding X
re value is handled as regular expression by backends X
re_contains value is handled as contains regular expression by backends
cidrv4 value is handled as a IPv4 CIDR by backends
all This modifier changes OR logic to AND X
lt Field is less than the value
lte Field is less or egal than the value
gt Field is Greater than the value
gte Field is Greater or egal than the value
expand Modifier for expansion of placeholders in values. It replaces placeholder strings (%something%)

Overview

Conversion Overview

Conversion Graph

Pipelines

Conversion Graph

More details are described in the documentation.

Testing

To run the pytest suite for pySigma, run the following command:

make test

Contributing

Pull requests are welcome. Please feel free to lodge any issues/PRs as discussion points.

Authors

Licence

GNU Lesser General Public License v2.1. For details, please see the full license file located here.

About

Python library to parse and convert Sigma rules into queries (and whatever else you could imagine)

License:GNU Lesser General Public License v2.1


Languages

Language:Python 100.0%Language:Makefile 0.0%