Tools for distributed pcap recording (osmo-pcap-server, osmo-pcap-client) https://osmocom.org/projects/osmo-pcap
Go to file
Vadim Yanitskiy 9f47bedf37 build: include README.md into the release tarball
Change-Id: I1fcd14371dd2576f45c9c0798fd5c3628b631e13
2024-01-26 23:36:41 +07:00
contrib Bump version: 0.4.1.9-7f4d-dirty → 0.4.2 2023-09-12 15:50:50 +02:00
debian Bump version: 0.4.1.9-7f4d-dirty → 0.4.2 2023-09-12 15:50:50 +02:00
doc Use uniform log format for default config files 2023-12-01 12:48:59 +01:00
include client: Add 'wqueue max-length <0-4294967295>' VTY command 2022-04-14 18:32:23 +02:00
src server: Call osmo_fd_unregister() before closing and changing bfd->fd 2023-03-14 11:50:02 +01:00
tests tests: $(BUILT_SOURCES) is not defined 2023-06-12 19:39:52 +07:00
.gitignore .gitignore: blacklist configure~ 2022-06-28 17:36:02 +02:00
.gitreview Add gitreview config 2017-08-22 12:34:59 +02:00
AUTHORS osmo-pcap: Start with the autoconf/automake skeleton for this project 2011-05-31 10:19:47 +02:00
COPYING osmo-pcap: Start with the autoconf/automake skeleton for this project 2011-05-31 10:19:47 +02:00
Makefile.am build: include README.md into the release tarball 2024-01-26 23:36:41 +07:00
README.md README.md: fix typo 2021-08-05 18:52:43 +02:00
TLS_TODO tls: Add initial ideas about TLS in the client/server 2016-09-08 15:48:02 +02:00
TODO misc: Update the todo with an obvious thing to do 2016-08-12 11:01:59 +02:00
configure.ac Bump version: 0.4.1.9-7f4d-dirty → 0.4.2 2023-09-12 15:50:50 +02:00
git-version-gen misc: Fix the version determination of git-version-gen 2012-11-06 08:48:33 +01:00
osmoappdesc.py Change default ports of client, server 2021-08-05 19:24:02 +02:00

README.md

osmo-pcap distributed network capture

osmo-pcap has been created to collect network traces at different nodes but store them centrally at a dedicated node for further analysis. This might be needed for auditing, resolving conflicts, post processing or debugging a distributed system.

The system consists out of the osmo-pcap-client to capture traffic at a host and osmo-pcap-server to receive the traffic, store and rotate the traffic at a centralized server. There is a shell script to compress and expire old traces.

osmo-pcap-client

The osmo-pcap-client is using libpcap and has a built-in detector for the GPRS-NS/BSSGP protocol to exclude user traffic. The client is known to work on 32/64 bit systems. It can be configured through the VTY and the minimal config includes the interface to monitor, the pcap filter to use and the server to send it to.

osmo-pcap-server

The osmo-pcap-server will listen for new TCP connections and then will receive the data from the client if it is coming from a known/good source IPv4/port. The server is configured to write one file per client and to change/rotate the file when the link encapsulation is changing. It can be configured to rotate the file a given time interval and/or if the filesize is over a threshold.

The osmo-pcap-server comes with a shell script to rotate and compress old traces. Currently the configuration parameters (age or amount based) need to be tuned in the script itself.

Installation and Configuration

There are Debian, Ubuntu, Raspbian packages available via the excellent openSUSE Build Service.

Please see the contrib/osmo-pcap-server.cfg and contrib/osmo-pcap-client.cfg file in the repository

Running tests

In order to run all tests, do the following:

$ ./configure --enable-external-tests $ make -j5 $ sudo setcap 'CAP_NET_RAW+eip CAP_NET_ADMIN+eip' src/osmo-pcap-client $ make check

Wishlist/TODO

  • Add non-blocking TLS (probably GNUtls) support between client and server.
  • Improve the clean-up script, maybe re-write in python with exteral configuration.
  • Add hooks to the server to have an application receive all packages

Author and License

osmo-pcap has been created by Holger Hans Peter Freyther (holger@freyther.de) and is licensed as AGPLv3+. The author appreciates failure or success reports of using the software.