zeek/scripts/base/frameworks/netcontrol
Christian Kreibich 1bd658da8f Support for log filter policy hooks
This adds a "policy" hook into the logging framework's streams and
filters to replace the existing log filter predicates. The hook
signature is as follows:

    hook(rec: any, id: Log::ID, filter: Log::Filter);

The logging manager invokes hooks on each log record. Hooks can veto
log records via a break, and modify them if necessary. Log filters
inherit the stream-level hook, but can override or remove the hook as
needed.

The distribution's existing log streams now come with pre-defined
hooks that users can add handlers to. Their name is standardized as
"log_policy" by convention, with additional suffixes when a module
provides multiple streams. The following adds a handler to the Conn
module's default log policy hook:

    hook Conn::log_policy(rec: Conn::Info, id: Log::ID, filter: Log::Filter)
            {
            if ( some_veto_reason(rec) )
                break;
            }

By default, this handler will get invoked for any log filter
associated with the Conn::LOG stream.

The existing predicates are deprecated for removal in 4.1 but continue
to work.
2020-09-30 12:32:45 -07:00
..
plugins Merge branch 'netcontrol-acld-verbs' of https://github.com/LBL-gov/zeek 2020-08-12 19:43:14 +00:00
__load__.zeek GH-379: move catch-and-release and unified2 scripts to policy/ 2019-06-05 13:33:45 -07:00
cluster.zeek Remove ineffective &default in netcontrol cluster event handler args 2020-04-16 15:40:27 -07:00
drop.zeek Support for log filter policy hooks 2020-09-30 12:32:45 -07:00
main.zeek Support for log filter policy hooks 2020-09-30 12:32:45 -07:00
non-cluster.zeek Add warning for ineffective &default arguments in handlers 2020-04-09 22:51:01 -07:00
plugin.zeek GH-379: move catch-and-release and unified2 scripts to policy/ 2019-06-05 13:33:45 -07:00
README More bro-to-zeek renaming in scripts and other files 2019-05-16 02:36:41 -05:00
shunt.zeek Support for log filter policy hooks 2020-09-30 12:32:45 -07:00
types.zeek More bro-to-zeek renaming in scripts and other files 2019-05-16 02:36:41 -05:00

The NetControl framework provides a way for Zeek to interact with networking
hard- and software, e.g. for dropping and shunting IP addresses/connections,
etc.