Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
theflakes committed Aug 11, 2023
1 parent f14c233 commit f6667a5
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ cargo build --release
* ~~Setuid / setgid~~
* Traps
* Document parent and child data type relation
* Add more interesting strings / commands to search for in file contents specific to Linux
* ...

## Output format
Expand All @@ -113,6 +114,9 @@ Output is in Json for import into ELK or any other Json indexer. I may add other
No configuration files are currently included. Everything is compiled in to acheive easier remote use of the tool. Just copy file to host and run. Pipe / redirect the output with standard Linux tools. At some point I will probably add a network send option.

## About the logs
- `parent_data_type` - if a log was generated due to something found in another log this field will hold the `data_type` of the parent log that caused this log to be generated (e.g. file path was found in a file's content and therefore the tool went and gathered metadata on that file referenced in the first file's content)
- `data_type` - the source of telemetry the log is reporting on
- `tags` - tags are added to this array field when something interesting is found by a built-in hunt
Anything of interest (a hunt, e.g. for rootkits or interesting stings/content) will be noted in the `tags` field.

Information gathered on:
Expand Down

0 comments on commit f6667a5

Please sign in to comment.