A powerful, easily deployable network traffic analysis tool suite for network security monitoring
local.zeekSome Zeek behavior can be tweaked through the use of environment variables in the .env files beginning with zeek….
Other changes to Zeek’s behavior could be made by modifying local.zeek and either using a bind mount or rebuilding the zeek image with the modification. See the Zeek documentation for more information on customizing a Zeek instance. Note that changing Zeek’s behavior could result in changes to the format of the logs Zeek generates, which could break Malcolm’s parsing of those logs, so exercise caution.
Zeek packages are listed in zeek/zeek-packages.list, one per line, with the branch, tag or commit to track and any environment variables the install needs. The build doesn’t read the list directly: scripts/update_pins.py --zeek-packages --apply resolves each entry to a specific commit and writes zeek/zeek-packages.lock, and zeek_install_plugins.sh installs exactly what the lock file names (via the zkg command-line tool) when the zeek image is rebuilt. See Version Pinning for how the list and lock file work together.
A package that only adds detections or enriches existing logs needs nothing more. If the package writes new .log files, see Adding a new Zeek parser, which covers the whole process, from installing the package to building its dashboard.
See Zeek Intelligence Framework in the Malcolm README for information on how to use Zeek’s Intelligence Framework with Malcolm.