mirror of
https://github.com/zeek/zeek.git
synced 2025-10-04 23:58:20 +00:00

This reflects the `spicy-plugin` code as of `d8c296b81cc2a11`. In addition to moving the code into Zeek's source tree, this comes with a couple small functional changes: - `spicyz` no longer tries to infer if it's running from the build directory. Instead `ZEEK_SPICY_LIBRARY` can be set to a custom location. `zeek-set-path.sh` does that now. - ZEEK_CONFIG can be set to change what `spicyz -z` print out. This is primarily for backwards compatibility. Some further notes on specifics: - We raise the minimum Spicy version to 1.8 (i.e., current `main` branch). - Renamed the `compiler/` subdirectory to `spicyz` to avoid include-path conflicts with the Spicy headers. - In `cmake/`, the corresponding PR brings a new/extended version of `FindZeek`, which Spicy analyzer packages need. We also now install some of the files that the Spicy plugin used to bring for testing, so that existing packages keep working. - For now, this all remains backwards compatible with the current `zkg` analyzer templates so that they work with both external and integrated Spicy support. Later, once we don't need to support any external Spicy plugin versions anymore, we can clean up the templates as well. - All the plugin's tests have moved into the standard test suite. They are skipped if configure with `--disable-spicy`. This holds off on adapting the new code further to Zeek's coding conventions, so that it remains easier to maintain it in parallel to the (now legacy) external plugin. We'll make a pass over the formatting for (presumable) Zeek 6.1.
48 lines
1.3 KiB
Text
48 lines
1.3 KiB
Text
# @TEST-REQUIRES: have-spicy
|
|
#
|
|
# @TEST-EXEC: spicyz -d -o foo.hlto foo.spicy foo.evt
|
|
# @TEST-EXEC: zeek -r ${TRACES}/ssh/single-conn.trace foo.hlto %INPUT Spicy::enable_print=T >output
|
|
# @TEST-EXEC: btest-diff output
|
|
|
|
# @TEST-START-FILE foo.spicy
|
|
module foo;
|
|
import zeek;
|
|
|
|
public type X = unit {
|
|
xs: bytes &eod {
|
|
local y = zeek::protocol_handle_get_or_create("spicy_Y");
|
|
local z = zeek::protocol_handle_get_or_create("spicy_Z");
|
|
|
|
zeek::protocol_data_in(zeek::is_orig(), b"only Y", y);
|
|
zeek::protocol_data_in(zeek::is_orig(), b"both Y and Z");
|
|
|
|
zeek::protocol_handle_close(z);
|
|
zeek::protocol_data_in(zeek::is_orig(), b"only Y after removal of Z");
|
|
|
|
zeek::protocol_handle_close(y);
|
|
zeek::protocol_data_in(zeek::is_orig(), b"goes nowhere");
|
|
}
|
|
};
|
|
|
|
public type Y = unit {
|
|
ys: bytes &eod &chunked { print "ys=%s" % $$; }
|
|
};
|
|
|
|
public type Z = unit {
|
|
zs: bytes &eod &chunked { print "zs=%s" % $$; }
|
|
};
|
|
# @TEST-END-FILE
|
|
|
|
# @TEST-START-FILE foo.evt
|
|
# Analyzer instantiated from Zeek based on the traffic.
|
|
protocol analyzer spicy::X over TCP:
|
|
parse originator with foo::X,
|
|
port 22/tcp,
|
|
replaces SSH;
|
|
|
|
# Analyzers which will only be instantiated explicitly by us.
|
|
protocol analyzer spicy::Y over TCP:
|
|
parse originator with foo::Y;
|
|
protocol analyzer spicy::Z over TCP:
|
|
parse originator with foo::Z;
|
|
# @TEST-END-FILE
|