pfSense-pkg-zeek

Zeek Network Security Monitor package for pfSense router/firewall

Compatibility

This package has been tested on pfSense 2.4.5-RELEASE (amd64). Maybe it might not work with older versions of pfSense.

Installation

Download the generated package through pfSense-pkg-zeek

Copy the package from your local machine to your firewall

You’ll need to enable ssh access to your pfSense firewall as it’s not enabled by default. To do this, login to pfsense and browse to System > Advanced, then scroll down to the SSH section and check ‘Enable Secure Shell’.

By default, pfSense disables upstream pkg repositories (for good reason). So we need to re-enable them albeit, temporarily. There are two files you’ll need to edit.

/usr/local/etc/pkg/repos/FreeBSD.conf
/usr/local/share/pfSense/pkg/repos/pfSense-repo.conf

Make it look like:

FreeBSD: { enabled: yes }

As this package depends on zeek, we need to update the pkg cache and get on with installing zeek.

pkg update && pkg install -y zeek

Finally, copy the package to your firewall temporary folder.

scp ~/Downloads/pfSense-pkg-zeek-0.1.1.txz root@firewall-ip-address:/tmp/

Install the package on the firewall via pkg add command

pkg add pfSense-pkg-zeek-0.1.1.txz

Now, you can access the interface by login to pfSense and browse to Services > Zeek NSM

Note : After installing the package, the service does not start automatically, all you need is to enable the zeek instance on an interface from pfsense GUI to get the service started.

Contribution

• Having an issue? or looking for support? Open an issue and we will get you the help you need.
• Got a new feature or a bug fix? Fork the repo, make your changes, and submit a pull request.
• See the Setting up a Development Environment page for instructions on how to set up your own development environment and generate packages.

Support this project

If you find this project useful, please star the repo to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you 😄

License (Apache 2.0)

Copyright (c) 2019 Prosper Doko All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.