No project description provided
Project description
Sigma Command Line Interface
This is the Sigma command line interface using the pySigma library to manage, list and convert Sigma rules into query languages.
Getting Started
Installation
The easiest way to install the Sigma CLI is via pipx or pip. For this purpose run one of the following:
python -m pipx install sigma-cli
python -m pip install sigma-cli
Another way is to run this from source in a virtual environment managed by Poetry:
git clone https://github.com/SigmaHQ/sigma-cli.git
cd sigma-cli
poetry install
poetry shell
Usage
The CLI is available as sigma command. A typical invocation is:
sigma convert -t <backend> -p <processing pipeline 1> -p <processing pipeline 2> [...] <directory or file>
E.g. to convert process creation Sigma rules from a directory into Splunk queries for Sysmon logs run:
sigma convert -t splunk -p sysmon sigma/rules/windows/process_creation
Available conversion backends and processing pipelines can be listed with sigma list
.
Backends can support different output formats, e.g. plain queries and a file that can be imported into the target
system. These formats can be listed with sigma list formats <backend>
and specified for conversion with the -f
option.
In addition, an output file can be specified with -o
.
Example for output formats and files:
sigma convert -t splunk -f savedsearches -p sysmon -o savedsearches.conf sigma/rules/windows/process_creation
Outputs a Splunk savedsearches.conf containing the converted searches.
Maintainers
The project is currently maintained by:
- Thomas Patzke thomas@patzke.org
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sigma_cli-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92e35981ce35487201ee66a3bec5b3a600112aff4a4476c63d74c30be1a71e05 |
|
MD5 | 117046d150dfaaf2ef5b05fd8e4b9c3f |
|
BLAKE2b-256 | 518c8a6acdff8b23ccf2f9567608ad98c7cc14681af5d40781b35b6e70657186 |