Skip to content
This repository has been archived by the owner on Feb 21, 2022. It is now read-only.

zeek/zeek-agent

Repository files navigation

Zeek Agent

The Zeek Agent is an endpoint monitoring tool for Linux and macOS that reports, by default, file, socket, and process events to Zeek. On Linux, event data is captured from Linux Audit using the Unix domain socket plugin that comes with Audisp. On macOS, Zeek Agent leverages Endpoint Security framework to capture file and process events while to collect socket events Zeek Agent uses OpenBSM. Collected event data from endpoint is stored in an SQL database (using SQLite virtual tables internally) on the host. Events from this database are later fetched by Zeek using scheduled queries.

Zeek Agent can optionally also interface to osquery, allowing Zeek to access almost all the endpoint information that it provides (excluding only event tables).

Pre-built, statically linked zeek-agent packages are available on the releases page.

On the Zeek side, the Zeek Agent Framework provides the API access Zeek Agents, as well as some default scripts recording endpoint activity into Zeek logs.

Documentation

The documentation has been moved to the Zeek Agent Wiki, and contains guides on building, configuring, and extending the Zeek Agent project.

For convenience, use the following links to build and configure Zeek Agent:

History

Zeek Agent supersedes an earlier osquery extension for Zeek that focused on providing osquery's tables to Zeek. Zeek Agent provides all the same functionality, but can operate independent from osquery as well. We plan to further extend the events/tables that the agent provides natively.

License

Zeek Agent comes with a BSD license, allowing for free use with virtually no restrictions. You can find it in LICENSE.