README.md
1Ipsumdump
2=========
3
4 `ipsumdump` reads IP packets from the network (using libpcap, or
5packet sockets on Linux), or from a tcpdump(1) save file, and writes
6an ASCII summary of the packet data to the standard output. Comments
7on the first couple lines describe the summary’s contents; for
8example:
9
10 !IPSummaryDump 1.3
11 !creator "ipsumdump -i wvlan0"
12 !host no.lcdf.org
13 !runtime 996022410.322317 (Tue Jul 24 17:53:30 2001)
14 !data ip_src ip_dst
15 63.250.213.167 192.150.187.106
16 63.250.213.167 192.150.187.106
17 // ...
18
19 Two other programs are included. `ipaggcreate` processes traces and
20counts various properties of packet aggregates, making it easy to
21answer questions such as “What is the distribution of packets per
22TCP/UDP flow in this trace?” or “How long does it take to encounter
2310000 different IP addresses in this trace?” `ipaggmanip` takes
24aggregate files produced by `ipaggcreate` and manipulates them in
25various ways.
26
27 If you are building from a source repository (git), you will need
28to generate configure scripts. (This is not necessary if you
29downloaded a tarball.) Run `./bootstrap.sh` from the top directory.
30
31 Thereafter installation is standard. Run `./configure`, supplying
32any options, then `make install`. Documentation is supplied in manual
33page format; after `make install`, try `man ipsumdump`. (Before
34installation, try `pod2man ipsumdump.pod | nroff -man | less`.) Run
35`ipsumdump --help` to see what options are available.
36
37
38About Click
39-----------
40
41 `ipsumdump` is built from the Click modular router, an extensible
42system for processing packets. Click routers consist of C++ components
43called elements. While some elements run only in a Linux kernel, most can
44run either in the kernel or in user space, and there are user-level
45elements for reading packets from libpcap or from tcpdump files.
46
47 The `ipsumdump` program just builds up a simple Click configuration and
48runs it, as if by the `click` user-level driver. However, you don't need to
49install Click to run ipsumdump; the `libclick` directory contains all the
50relevant parts of Click, bundled into a library.
51
52 If you’re curious, try running `ipsumdump --config` with some other
53options to see the Click configuration ipsumdump would run. Only three
54source files had to be written from scratch: src/ipsumdump.cc,
55src/toipsumdump.cc, and src/toipsumdump.hh. The rest came from Click
56itself.
57
58 This is, I think, a pleasant way to write a packet processor!
59
60 The Click source distribution: https://github.com/kohler/click/
61
62
63Authors
64-------
65
66Eddie Kohler
67Harvard University
68(UCLA and ICIR/International Computer Science Institute)
69kohler@seas.harvard.edu
70
71Copyright (c) 2001-2003 International Computer Science Institute
72Copyright (c) 2004-2011 Regents of the University of California
73Copyright (c) 2008 Meraki, Inc.
74Copyright (c) 2001-2014 Eddie Kohler
75
76 The anonymization algorithm was borrowed from tcpdpriv by Greg Minshall.
77
78 Thanks to Vern Paxson and Lee Breslau for comments and suggestions.
79
80
81License
82-------
83
84 `ipsumdump` is available under the Click license, a BSD-like license. See
85the file `libclick*/LICENSE` for full license terms.
86