nemea-pycommon

Common Python modules and methods of the NEMEA system.


Keywords
liberouter, nemea
License
BSD-3-Clause
Install
pip install nemea-pycommon==1.7.0

Documentation

Nemea Framework

This repository contains base libraries for a Nemea system. The Nemea system is a modular system that consists of independent modules for network traffic analysis and anomaly detection.

The framework consists of:

  • libtrap -- communication interface for messages transfer between Nemea modules
  • UniRec -- flexible and efficient data format of flow-records
  • common -- usefull common functions and data structures
  • pytrap -- python wrapper for libtrap and UniRec that allows development of nemea modules in python
  • pycommon -- python common modules and methods, there is currently a support of alerts creation in the IDEA format that can be stored into MongoDB or sent to the Warden incident sharing system

Dependencies

To be able to compile Nemea Framework on GNU/Linux distributions, you will need to have installed on your system the following depencies which were needed on Ubuntu 20.04 LTS:

make autoreconf libtool libxml2-dev

Installation

This repository is usually used as a git submodule of https://github.com/CESNET/Nemea However, it can be installed independently using:

./bootstrap.sh
./configure
make
sudo make install

For information about configuration options see:

./configure --help

Python parts must be installed separately when needed. It can be done using:

cd pytrap; sudo python3 setup.py install

and

cd pycommon; sudo python3 setup.py install

Project status:

License: BSD license

Travis CI build: Build Status

Coverity Scan: Coverity Scan Build Status

CodeCov: codecov.io

Ohloh: Ohloh Project Status