Awesome
What?
This project builds an OSQuery module libbro.so
for loading bro
logs as tables in osquery.
The logs are dynamically loaded into tables from the bro
logs installation directory. They are created as tables based on their
log file name, except pre-pended with bro_
. E.g., conn.log
-> table bro_conn
.
Example
From EnvDB UI:
Building and Installing
To build, you need cmake
, clang
, git
(for both osquery and module builds).
make deps
make
This will create the module ./build/src/libbro.<dylib|so>
You will then need to copy this to /usr/local/lib/libbro.<dylib|so>
and then you can add an entry to /etc/osquery/modules.load
:
$ sudo cp -r ./build/src/libbro.<dylib|so> /usr/local/lib
$ sudo mkdir -p /etc/osquery/
$ sudo sh -c 'echo "/usr/local/lib/libbro.<so|dylib>" >> /etc/osquery/modules.load'
You can now run osqueryi
with the location of $BROLOGS
set to the bro logs path, where it will attempt to load log tables from $BROLOGS
.
Example:
sudo BROLOGS="$PWD/bro/logs" osqueryi
Without BROLOGS set, it will try to load logs from the following common Bro installation locations:
/usr/local/bro/logs/current
/opt/bro/logs
/nsm/bro/logs/current
Installing for EnvDB
To get it to work with EnvDB, you need to create a wrapper script for osqueryi
that supplies the correct environment variable
for the BROPATH
. This should be in your path before osqueryi.
E.g., add this to your path:
root@vagrant-ubuntu-trusty-64:~# more /usr/bin/osqueryi
#!/bin/sh
BROLOGS="/path/to/bro/logs" /path/to/real/osqueryi "$@"
You can also try setting BROLOGS=xxx in EnvDB startup although I'm not certain that works.
TODO
- Better Bro log path detection.
- Add variable
BROLOGS
to specify where the bro logs are, or maybe a more flexible way to supply this to osquery. - Better type handling? Better error handling?
General wishlist: I wish osquery had a nicer way of loading any log dynamically into its framework. :)