No description
Find a file
Christian Kreibich d1d218b5cc Install zkg as part of the Zeek distribution.
- Add auxil/package-manager submodule as an optional build
  source. When the submodule is present, zkg gets installed into the
  Zeek installation's bin directory, its config file into etc/zkg, and
  its state into var/lib/zkg. Like zeekctl, zkg finds its own module
  independently of any PYTHONPATH. Installation via pip remains
  supported. You can skip zkg explicitly via --disable-zkg. See the
  NEWS update for details.

- Establish a "zeek/python" subdirectory under libdir as the common place
  for Python modules in the Zeek distribution. This now separates out
  the Broker Python bindings, ZeekControl, and zkg's Python module.

- Add configure flags to allow customizing this Python folder, in
  three ways: --python-dir, --python-prefix, and --python-home. These
  differ in the logic they automatically add to the path, and build on
  the logic already used in Broker.

- Include a (comented-out) @load for zkg's packages folder in
  local.zeek.

- Bump zeekctl to move to this new location.

- Bump doc to include installation instructions

- Update NEWS accordingly.
2020-12-11 18:43:47 -08:00
.github/workflows Fix generate-docs Action to stage autogenerated script-reference files 2020-09-10 11:54:51 -07:00
auxil Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
ci Merge remote-tracking branch 'origin/topic/jsiwek/python2-eol' 2020-11-26 18:17:54 +00:00
cmake@40251ae850 Update submodule(s) [nomail] 2020-12-04 11:18:44 -08:00
doc@2d1cba368f Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
man Rename all BRO-prefixed environment variables 2019-05-22 00:12:31 -05:00
scripts Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
src Merge remote-tracking branch 'origin/topic/neverlord/caf-migration' 2020-12-10 14:14:38 -08:00
testing GH-1321: Prevent compounding of connection_status_update event timers 2020-12-08 11:20:02 -08:00
.cirrus.yml Fix cirrus config for static broker test. 2020-12-03 19:09:54 +00:00
.clang-tidy Change over to whitelisting clang-tidy options instead of blacklisting 2019-08-12 13:59:17 -07:00
.gitattributes Make github identify our Flex source correctly. 2019-08-23 14:27:06 -04:00
.gitignore Update .gitignore to ignore pyenv .python-version 2020-11-21 22:50:44 -05:00
.gitmodules Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08: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/neverlord/caf-migration' 2020-12-10 14:14:38 -08:00
CMakeLists.txt Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
configure Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
COPYING Update license year for 2018 2018-11-01 13:54:07 -05:00
COPYING.3rdparty Switch one's complement checksum implementation 2020-09-24 09:41:15 -07:00
INSTALL Make INSTALL a symlink to doc/install/install.rst 2015-03-13 15:45:20 -05:00
Makefile Rename aux/ to auxil/ 2020-06-04 15:18:44 -07:00
NEWS Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08:00
README Fix hello world script in the readme. 2019-07-31 14:43:18 -04:00
README.md Add coveralls badge to README.md 2020-10-23 19:58:02 +00:00
VERSION Merge remote-tracking branch 'origin/topic/neverlord/caf-migration' 2020-12-10 14:14:38 -08:00
zeek-config.h.in Move file_analysis code to zeek namespaces 2020-08-20 15:55:17 -07:00
zeek-config.in Improve support for custom libdir locations 2020-11-19 23:27:10 -08:00
zeek-path-dev.in Rename all BRO-prefixed environment variables 2019-05-22 00:12:31 -05:00
zeek-wrapper.in Merge remote-tracking branch 'origin/topic/robin/631-deprecation-v2' 2020-01-30 19:19:56 -08:00
zkg-config.in Install zkg as part of the Zeek distribution. 2020-12-11 18:43:47 -08: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.