Generate event rule documentation
This commit is contained in:
parent
e43d7689a0
commit
7f4d5b42fd
8 changed files with 378 additions and 5 deletions
|
|
@ -74,6 +74,7 @@ enodia-sentinel rules show <sid>
|
|||
enodia-sentinel rules show <sid> --json
|
||||
enodia-sentinel rules test <event-json>
|
||||
enodia-sentinel rules test <event-json> --json
|
||||
enodia-sentinel rules docs
|
||||
```
|
||||
|
||||
Inspects and tests event-driven detection rules without reading source code.
|
||||
|
|
@ -81,7 +82,9 @@ Inspects and tests event-driven detection rules without reading source code.
|
|||
from `exec_rules_file`. `rules show <sid>` prints the rule metadata and match
|
||||
conditions. `rules test <event-json>` loads an exec or syscall event JSON file,
|
||||
runs the matching rule engine, and prints any alerts that would fire. Use `-`
|
||||
instead of a path to read the event JSON from stdin.
|
||||
instead of a path to read the event JSON from stdin. `rules docs` emits Markdown
|
||||
rule documentation from the active rule metadata; the built-in snapshot lives in
|
||||
[RULES.md](RULES.md).
|
||||
|
||||
Exec event JSON shape:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue