No description
Find a file
Arne Welzel b77f5fa14c Add gulrak/filesystem to auxil, expose via zeek::filesystem
This adds https://github.com/gulrak/filesystem as a submodule into auxil
as a compiler-independent std::filesystem replacement.

The ghc::filesystem namespace is exposed as zeek::filesystem in util.h.

In the build directory, we add 3rdparty/ghc as a symlink to auxil in
order to support building from the build tree.

    <build_dir>/src/3rdparty/ghc -> /path/to/zeek/src/auxil/filesystem/include/ghc

In the installation tree, the headers are installed into include/zeek/3rdparty:

    <install_dir>/include/zeek/3rdparty/ghc

Note, this differs from how we approached rapidjson which isn't included
using a zeek/3rdparty and instead requires an additional include path of
the following form for external plugins to find and use it.

    <install_dir>/include/zeek/3rdparty/rapidjson/include/

We diverge from this approach. Placing ghc directly into 3rdparty appears
nicer and avoids changing external components (DynamicPlugin.cmake / spicyc)
2022-07-04 13:32:18 +02:00
.github/workflows Provide zeek-client by default 2022-06-21 18:17:51 -07:00
auxil Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
ci Add helpers for syncing commit files with external testsuites 2022-06-28 13:20:14 -07:00
cmake@cebdc410ea Bump cmake submodule for run-clang-tidy fix [skip ci] [nomail] 2022-06-27 09:27:50 -07:00
doc@bdb22dd2ce Merge branch 'update' of https://github.com/leres/zeek 2022-07-04 10:24:34 +01:00
docker Include spicy in build. 2022-05-16 09:07:11 +02:00
man Add documentation for GH-1829 2021-11-16 13:51:29 +00:00
scripts GH-2229: Fix some typos in weak-keys.zeek 2022-06-30 15:12:10 -07:00
src Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
testing Merge branch 'topic/christian/management-default-instance' 2022-07-01 11:11:46 -07:00
.cirrus.yml Remove deprecated --enable-mobile-ipv6 configure argument 2022-06-30 17:42:18 +00:00
.clang-format Add pre-commit config. 2021-11-09 07:20:18 +01:00
.clang-tidy Change over to whitelisting clang-tidy options instead of blacklisting 2019-08-12 13:59:17 -07:00
.dockerignore Add .dockerignore to suppress btest artifacts 2021-09-24 17:04:26 -07:00
.git-blame-ignore-revs GH-1781: Add .git-blame-ignore-revs file 2021-11-02 16:06:36 -07:00
.gitattributes GH-1497: Support CRLF line-endings in Zeek scripts and signature files 2021-04-08 20:32:30 -07:00
.gitignore Added --include-plugins configure argument 2021-06-10 10:39:13 -07:00
.gitmodules Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
.lgtm.yml Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
.pre-commit-config.yaml Format Python scripts with yapf. 2021-11-24 23:13:24 +01:00
.style.yapf Format Python scripts with yapf. 2021-11-24 23:13:24 +01:00
.update-changes.cfg Add script to update external test repo commit pointers 2019-04-05 17:09:01 -07:00
CHANGES Merge branch 'update' of https://github.com/leres/zeek 2022-07-04 10:24:34 +01:00
CMakeLists.txt Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
configure Remove deprecated --enable-mobile-ipv6 configure argument 2022-06-30 17:42:18 +00:00
COPYING Update COPYING to 2021 2021-01-07 09:56:59 +00:00
COPYING.3rdparty Add gulrak/filesystem to auxil, expose via zeek::filesystem 2022-07-04 13:32:18 +02:00
INSTALL Update documentation to include "Book of Zeek" revisions 2021-02-01 15:54:36 -08:00
Makefile Keep make dist from deleting all paths containing 'build' [skip ci] 2022-06-03 22:36:19 +00:00
NEWS Merge branch 'update' of https://github.com/leres/zeek 2022-07-04 10:24:34 +01:00
README Fix hello world script in the readme. 2019-07-31 14:43:18 -04:00
README.md Fix logo/website link in README [skip ci] 2021-01-20 11:04:17 -08:00
VERSION Merge branch 'update' of https://github.com/leres/zeek 2022-07-04 10:24:34 +01:00
zeek-config.h.in Merge remote-tracking branch 'origin/master' into topic/johanna/tls12-decryption 2022-01-05 10:27:55 +00:00
zeek-config.in Remove other general deprecations 2022-06-30 19:17:13 +00:00
zeek-path-dev.in Switch to more accurate source and binary references in cmake 2021-06-23 10:26:17 +00:00
zeek-wrapper.in Format shell scripts with shfmt. 2021-11-24 23:13:02 +01:00
zkg-config.in Add bin_dir setting for default zkg config file 2021-03-24 15:53:10 -07:00

Zeek Logo

The Zeek Network Security Monitor

A powerful framework for network traffic analysis and security monitoring.

Key FeaturesDocumentationGetting StartedDevelopmentLicense

Follow us on Twitter at @zeekurity.

Coverage Status

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.