![]() 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. |
||
---|---|---|
.github/workflows | ||
auxil | ||
ci | ||
cmake@ac0529be3d | ||
doc@40e049c138 | ||
docker | ||
man | ||
scripts | ||
src | ||
testing | ||
.cirrus.yml | ||
.clang-format | ||
.clang-tidy | ||
.cmake-format.json | ||
.dockerignore | ||
.git-blame-ignore-revs | ||
.gitattributes | ||
.gitignore | ||
.gitmodules | ||
.pre-commit-config.yaml | ||
.style.yapf | ||
.update-changes.cfg | ||
CHANGES | ||
CMakeLists.txt | ||
configure | ||
COPYING | ||
COPYING-3rdparty | ||
INSTALL | ||
Makefile | ||
NEWS | ||
README | ||
README.md | ||
VERSION | ||
zeek-config.h.in | ||
zeek-config.in | ||
zeek-path-dev.bat.in | ||
zeek-path-dev.in | ||
zeek-version.h.in | ||
zkg-config.in |
The Zeek Network Security Monitor
A powerful framework for network traffic analysis and security monitoring.
Key Features — Documentation — Getting Started — Development — License
Follow us on Twitter at @zeekurity.
Key Features
-
In-depth Analysis Zeek ships with analyzers for many protocols, enabling high-level semantic analysis at the application layer.
-
Adaptable and Flexible Zeek's domain-specific scripting language enables site-specific monitoring policies and means that it is not restricted to any particular detection approach.
-
Efficient Zeek targets high-performance networks and is used operationally at a variety of large sites.
-
Highly Stateful Zeek keeps extensive application-layer state about the network it monitors and provides a high-level archive of a network's activity.
Getting Started
The best place to find information about getting started with Zeek is our web site www.zeek.org, specifically the documentation section there. On the web site you can also find downloads for stable releases, tutorials on getting Zeek set up, and many other useful resources.
You can find release notes in NEWS, and a complete record of all changes in CHANGES.
To work with the most recent code from the development branch of Zeek, clone the master git repository:
git clone --recursive https://github.com/zeek/zeek
With all dependencies in place, build and install:
./configure && make && sudo make install
Write your first Zeek script:
# File "hello.zeek"
event zeek_init()
{
print "Hello World!";
}
And run it:
zeek hello.zeek
For learning more about the Zeek scripting language, try.zeek.org is a great resource.
Development
Zeek is developed on GitHub by its community. We welcome contributions. Working on an open source project like Zeek can be an incredibly rewarding experience and, packet by packet, makes the Internet a little safer. Today, as a result of countless contributions, Zeek is used operationally around the world by major companies and educational and scientific institutions alike for securing their cyber infrastructure.
If you're interested in getting involved, we collect feature requests and issues on GitHub here and you might find these to be a good place to get started. More information on Zeek's development can be found here, and information about its community and mailing lists (which are fairly active) can be found here.
License
Zeek comes with a BSD license, allowing for free use with virtually no restrictions. You can find it here.
Tooling
We use the following tooling to help discover issues to fix, amongst a number of others.
- Clang-Tidy
- Coverity
- PVS-Studio - static analyzer for C, C++, C#, and Java code.