misc: Add a readme to describe the project purpose a bit
1 file changed
tree: a542c020a5f19a5d12d27b8b0274c5a567cc1f79
  1. contrib/
  2. debian/
  3. include/
  4. src/
  5. .gitignore
  6. AUTHORS
  7. configure.ac
  8. COPYING
  9. git-version-gen
  10. Makefile.am
  11. README.md
  12. TODO
README.md

osmo-pcap consists out of the osmo-pcap-client to cpature 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.

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.

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.