Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3c7/yaramanager
Simple yara rule manager
https://github.com/3c7/yaramanager
cli sqlite yara
Last synced: 3 months ago
JSON representation
Simple yara rule manager
- Host: GitHub
- URL: https://github.com/3c7/yaramanager
- Owner: 3c7
- License: mit
- Archived: true
- Created: 2021-03-25T21:51:16.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-27T17:39:10.000Z (almost 2 years ago)
- Last Synced: 2024-07-12T21:00:48.121Z (4 months ago)
- Topics: cli, sqlite, yara
- Language: Python
- Homepage:
- Size: 244 KB
- Stars: 64
- Watchers: 2
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/InQuest/awesome-yara)
# Yara Manager
A simple program to manage your yara ruleset in a database. By default sqlite will be used, but using MySQL/MariaDB or
Postgres is also possible.
## Todos
- [ ] Implement backup and sharing possibilities
## Installation
Install it using pip:
```shell
pip install yaramanager
```
Or grab one of the prebuilt binaries from the release page.
**If you want to use other databases than SQLite, you need to install the specific extra dependencies:**
```shell
pip install yaramanager[mysql]
pip install yaramanager[pgsql]
```
## Configuration
Yara Manager creates a fresh config if none exists. If you update from an older version, please pay attention to freshly
added [config options](resources/config.toml). You can reset you configuration using `ym config reset`, however, this
will also overwrite any custom changes you made.
```toml
## Editor
# editor contains the command used to start the editor. Note that this must be a list of the command and the needed
# parameters, e.g. `editor = ["codium", "-w"]`.
editor = [ "codium", "-w" ]
```
The most important configuration to change is probably your editor. The default configuration uses `codium -w` for
opening rules. You can use e.g. `EDITOR=vim DISABLE_STATUS=1 ym config edit` to open you config in Vim (and you can type
`:wq` to save your changes and quit :P). After changing the editor path, you are good to go! The following asciinema
shows how to quickly overwrite the editor set in the config:
[](https://asciinema.org/a/auX5tjpeUiHCnsfCrO0MEPRY9)
```toml
# Databases
# A list of databases. Every database needs to define a driver and a path, such as
#
# [[yaramanager.db.databases]]
# driver = "sqlite"
# path = "/home/user/.config/yaramanager/data.db"
[[yaramanager.db.databases]]
driver = "sqlite"
path = "/home/3c7/.config/yaramanager/myrules.db"
```
If you want to use multiple databases (which is pretty useful if you use rules from different sources or with different
classifications), you can add them to the config file, too.
In order to use MySQL/MariaDB or Postgres, you need to specify the specific database driver, e.g.:
```toml
[[yaramanager.db.databases]]
driver = "mysql+pymysql"
path = "user:[email protected]/database"
[[yaramanager.db.databases]]
driver = "postgresql+psycopg2"
path = "user:[email protected]/database"
```
## Features
### General usage
```
$ ym
Usage: ym [OPTIONS] COMMAND [ARGS]...
ym - yaramanager. Use the commands shown below to manage your yara
ruleset. By default, the manager uses codium as editor. You can change
that in the config file or using EDITOR environment variable. When using
editors in the console, you might want to disable the status display using
DISABLE_STATUS.
Options:
--help Show this message and exit.
Commands:
add Add a new rule to the database.
config Review and change yaramanager configuration.
db Manage your databases
del Delete a rule by its ID or name.
edit Edits a rule with your default editor.
export Export rules from the database.
get Get rules from the database.
help Displays help about commands
list Lists rules available in DB.
new Create a new rule using you preferred editor.
parse Parses rule files.
read Read rules from stdin.
ruleset Manage your rulesets
scan Scan files using your rulesets.
search Searches through your rules.
stats Prints stats about the database contents.
tags Show tags and the number of tagged rules
version Displays the current version.
```
### Yara Manager Showcase
[](https://asciinema.org/a/8QbXQoBEeJIwVcf2mWqiRTNBj)