Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

Rulesets are collections of rules that can be managed and deployed together. They provide a way to organize and group related rules, making it easier to manage and apply them to different sets of images or scenarios.

​
Creating a Ruleset

Rulesets are packaged and stored as OCI artifacts. To create a Ruleset, you can use the oras CLI tool.

​
Ruleset Structure

A Ruleset can contain rules of different types, such as Yara rules, FwHunt rules, VulHunt rules, etc. Generally speaking, you can follow any structure you want and group rules in any way you want. Example: 
rules/
├── yara/
│   ├── rule1.yar
│   ├── rule2.yar
│   └── ...
├── fwhunt/
│   ├── rule1.yaml
│   ├── rule2.yaml
│   └── ...

​
Pushing a Ruleset

Once the ruleset is ready, you can push it to the Binarly Registry using the oras CLI tool. First, make sure you are logged in to the Binarly Registry: 
oras login -u {EMAIL} -p {PASSWORD} registry-<ID>.binarly.cloud
Then, you can push the ruleset: 
oras push registry-<ID>.binarly.cloud/ruleset_name:latest ./

​
Working with a Ruleset in Binarly Transparency Platform

Once the Ruleset is pushed to the Binarly Registry, you can use it in the Binarly Transparency Platform, for example work with the rules in the Playground or deploy the Ruleset.