No description
Find a file
Arne Welzel f0b9c59adb Add experimental JavaScript support when libnode is available
zeek.on('zeek_init', () => {
        console.log('Hello, Zeek!');
    });

For interaction with external systems and HTTP APIs, JavaScript and the
Node.js ecosystem beat Zeek script. Make it more easily accessible by
including ZeekJS with Zeek directly.

When a recent enough libnode version is found on the build system, ZeekJS is
added as a builtin plugin. This behavior can be disabled via
``--disable-javascript``. Linux distributions providing such a package are
Ubuntu (22.10) and Debian (testing/bookworm) as libnode-dev.
Fedora provides it as nodejs-devel.

This plugin takes over loading of .js or .cjs files. When no such files
are provided to Zeek, Node and the V8 engine are not initialized and
should not get into the way.

This should be considered experimental.
2023-04-14 11:26:41 +02:00
.github/workflows github: No more docker workflow 2023-02-01 08:52:05 +01:00
auxil Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
ci Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
cmake@f258c75659 Redesign subdir-libs and plugin scaffolding 2023-04-13 22:23:46 +02:00
doc@a9e2358470 Update doc submodule [nomail] [skip ci] 2023-04-14 00:37:16 +00:00
docker Configure apt to retry a few times on Docker image builder tasks 2023-02-27 14:29:56 -07:00
man Add documentation for GH-1829 2021-11-16 13:51:29 +00:00
scripts logging/Manager: Fix crash for rotation format function not returning 2023-04-13 09:23:51 +02:00
src Revert "Type: Add TypeManager->TypeList() and use for ListVal()" 2023-04-14 09:49:05 +02:00
testing Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
.cirrus.yml Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
.clang-format Add pre-commit config. 2021-11-09 07:20:18 +01:00
.clang-tidy Disable annoying bugprone-easily-swappable-parameters clang-tidy check [skip ci] 2022-10-07 16:15:47 -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 Cirrus configuration for Windows builds 2022-11-09 18:16:13 +02:00
.gitmodules Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +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 remote-tracking branch 'origin/topic/awelzel/revert-type-manager-intro' 2023-04-14 10:33:01 +02:00
CMakeLists.txt Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
configure Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
COPYING Update COPYING to 2023 2023-01-03 12:10:03 -07:00
COPYING-3rdparty Rename COPYING.3rdparty to COPYING-3rdparty 2023-01-03 12:10:03 -07:00
INSTALL Update documentation to include "Book of Zeek" revisions 2021-02-01 15:54:36 -08:00
Makefile Add zeek -V/--build-info 2023-02-13 12:23:29 +01:00
NEWS Add experimental JavaScript support when libnode is available 2023-04-14 11:26:41 +02:00
README Add tooling section to README 2023-01-27 13:03:52 -07:00
README.md Add build status, slack, and discourse badges to readme 2023-02-27 15:25:36 -07:00
VERSION Merge remote-tracking branch 'origin/topic/awelzel/revert-type-manager-intro' 2023-04-14 10:33:01 +02:00
zeek-config.h.in Add configure option for preallocating PortVal objects 2023-03-15 10:12:32 -07:00
zeek-config.in Provide infrastructure to migrate legacy analyzers to Spicy. 2023-02-01 11:33:48 +01:00
zeek-path-dev.in Compile Zeek with MSVC 2022-11-09 18:15:30 +02:00
zeek-version.h.in zeek-config: Move ZEEK_VERSION* out of zeek-config.h 2023-02-22 16:48:39 +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 Build Status

Slack Discourse

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.