FlowMon - TCP Input Filter Plugin

Introduction

This site is a homepage of FlowMon TCP Input Filter Plugin.

The FlowMon TCP Input Filter Plugin allows to gather additional information about TCP protocol. Currently, it adds the length of SYN packet and TCP window size set in this packet.

The plugin is tested with FlowMon 3.5.x.

Downloads

Version 1.0.0, release date: November 29, 2013 flowmon-input-syn-1.0.0.tar.gz

Doxygen documentation

Doxygen generated code documentation is available here.

Documentation

Requirements

The plugin was tested on CentOS 5, Scientific Linux 6 and OpenSuse 12.1

Compilation requires FlowMon development headers to be installed. The configure script checks for the header files and required utilities.

Install

To compile and install the plugin, follow these steps:

$ tar -xpzf flowmon-input-tcp-*.tar.gz
$ cd flowmon-input-tcp-*
$ ./configure
$ make && make install

Alternatively, on RPM-based systems it is possible to build RPM package and install it using package manager. Use following command to build the RPM package:

$ make rpm

The resulting rpm and srpm packages are located in RPMBUILD/RPMS and RPMBUIL/SRPMS directories

Usage

The plugin must be loaded to flowmonexp using -X option. Running flowmonexp with -l option shows help for all available plugins. The TCP input filter export plugin is called input-tcp.

$ flowmonexp -X /path/to/flowmon-input-tcp.so -l
$ flowmonexp -I pcap:device=eth0 -X /path/to/flowmon-input-syn.so -J input-tcp

Using the above mentioned settings the exporter will read traffic from eth0 interface and load the TCP input filter plugin to add information about SYN packet length and TCP window size.

Notes

It is easy to add new information from TCP protocol headers.

BSD License

Copyright (C) 2013 Masaryk University, Institute of Computer Science
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in
   the documentation and/or other materials provided with the
   distribution.
3. Neither the name of the Masaryk University nor the names of its
   contributors may be used to endorse or promote products derived
   from this software without specific prior written permission.

This software is provided ``as is'', and any express or implied
warranties, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose are disclaimed.
In no event shall the company or contributors be liable for any
direct, indirect, incidental, special, exemplary, or consequential
damages (including, but not limited to, procurement of substitute
goods or services; loss of use, data, or profits; or business
interruption) however caused and on any theory of liability, whether
in contract, strict liability, or tort (including negligence or
otherwise) arising in any way out of the use of this software, even
if advised of the possibility of such damage.

Licence conditions in accordance with § 11 of Act No. 130/2002 Coll.

This software is the result of the scientific and research activities at Masaryk University. The owner of the result is Masaryk University, a public university, ID: 00216224. Masaryk University allows other companies and individuals to use this software free of charge and without territorial restrictions under the terms of the BSD licence (http://opensource.org/licenses/BSD-3-Clause). This permission is granted for unlimited time.

This software is not subject to special information treatment according to Act No. 412/2005 Coll., as amended. In case that a person who will use the software under this licence offer violates the licence terms, the permission to use the software terminates.

Licenční podmínky v souladu s § 11 zákona č. 130/2002 Sb.

Tento software je výsledkem vědecko-výzkumných aktivit na Masarykově univerzitě. Vlastníkem výsledku je Masarykova univerzita, veřejná vysoká škola, IČ: 00216224. Masarykova univerzita tímto umožňuje jiným právnickým a fyzickým osobám tento software bezplatně a bez územního omezení využívat podle podmínek BSD licence (http://opensource.org/licenses/BSD-3-Clause). Toto oprávnění se poskytuje na dobu neurčitou.

Tento software nepodléhá zvláštnímu režimu nakládání s informacemi dle zákona č. 412/2005 Sb., v platném znění. V případě, že osoba, která bude užívat software na základě této nabídky licence, poruší uvedené licenční podmínky, zaniká její oprávnění software využívat.