Install¶

This guide is for installing nmeta2dpae on Ubuntu OS.

Pre-Work¶

Ensure packages are up-to-date¶

sudo apt-get update
sudo apt-get upgrade

Install Python pip¶

sudo apt-get install python-pip

Install git¶

Install git and git-flow for software version control:

sudo apt-get install git git-flow

Install Packages Required by nmeta¶

Install coloredlogs¶

Install coloredlogs to improve readability of terminal logs by colour-coding:

sudo pip install coloredlogs

Install dpkt Python Packet Library¶

Install dpkt for parsing packets:

sudo pip install dpkt

Install scapy¶

sudo pip install scapy

Install pytest¶

Pytest is used to run unit tests:

sudo apt-get install python-pytest

Install YAML¶

Install Python YAML (“YAML Ain’t Markup Language”) for parsing config and policy files:

sudo apt-get install python-yaml

Install simplejson¶

sudo pip install simplejson

Install mock¶

sudo pip install -U mock

Install MongoDB¶

MongoDB is the database used by nmeta2. Install MongoDB as per their instructions :

Import the MongoDB public GPG Key:

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv EA312927

Create a list file for MongoDB:

echo "deb http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.2.list

Reload local package database:

sudo apt-get update

Install MongoDB:

sudo apt-get install -y mongodb-org

Add pymongo for a Python API into MongoDB:

sudo apt-get install build-essential python-dev
sudo pip install pymongo

Turn on smallfiles to cope with small file system size:

sudo vi /etc/mongod.conf

Add this to the storage section of the config:

mmapv1:
  smallFiles: true

Start MongoDB (if required) with:

sudo service mongod start

Install nmeta2dpae¶

Clone nmeta2dpae

cd
git clone https://github.com/mattjhayes/nmeta2dpae.git

Aliases¶

Aliases can be used to make it easier to run common commands. To add the aliases, edit the .bash_aliases file in your home directory:

cd
sudo vi .bash_aliases

Paste in the following:

# Run nmeta2dpae:
alias nm2="sudo python ~/nmeta2dpae/nmeta2dpae/nmeta2dpae.py"
#
# Run tests on nmeta2dpae:
alias nm2t="cd ~/nmeta2dpae/test/; py.test"

Re-read the Aliases¶

Read the aliases file in so that new command is available for use:

. ~/.bashrc

Edit Config¶

Edit the config file ~/nmeta2dpae/nmeta2dpae/config/config.yaml and update values as appropriate. You should check:

URL for nmeta2 under key nmeta_controller_address
Which interfaces should sniff under key sniff_if_names
MongoDB settings under keys mongo_addr and mongo_port

Create Custom Classifiers¶

Custom classifiers can be installed into the ~/nmeta2dpae/nmeta2dpae/classifiers directory. They operate per packet and are passed a flow class object that has variables and methods that are in the context of the current packet and the flow that it belongs to. Check out flow.py for more information. Custom classifiers are called by declaring them in main_policy.yaml in nmeta2 on the controller.

Run nmeta2dpae¶

nm2