flowtop.8

   1 .\" netsniff-ng - the packet sniffing beast
   2 .\" Copyright 2013 Daniel Borkmann.
   3 .\" Subject to the GPL, version 2.
   4 .TH FLOWTOP 8 "03 March 2013" "Linux" "netsniff-ng toolkit"
   5 .SH NAME
   6 flowtop \- top-like netfilter TCP/UDP/SCTP/DCCP/ICMP(v6) flow tracking
   7 .PP
   8 .SH SYNOPSIS
   9 .PP
  10 \fBflowtop\fR { [\fIoptions\fR] }
  11 .PP
  12 .SH DESCRIPTION
  13 .PP
  14 flowtop is a top-like connection tracking tool that can run on an end host or
  15 small home router. It is able to present TCP, UDP/UDP-lite, SCTP, DCCP, and
  16 ICMP(v6) flows that have been collected by the kernel's netfilter connection
  17 tracking framework, thus no packet capturing in user space needs to be done.
  18 .PP
  19 flowtop is able to give you a quick overview of current connections on your
  20 local system, e.g. for debugging purposes or to answer questions like:
  21 .PP
  22     * If you access website X, what other connections are being opened in
  23       the background that I'm not aware of?
  24     * What connections are active that pass one's router?
  25     * I have this proprietary binary Y, to where does it connect?
  26     * To which countries am I sending data?
  27     * Are there any suspicious background connections on my machine?
  28     * How many active connections does binary Y have?
  29 .PP
  30 The following information will be presented in flowtop's output:
  31 .PP
  32     * Application name and PID when run on local machine
  33     * Reverse DNS for source and destination
  34     * Geo-location information (country, city)
  35     * Used protocols (IPv4, IPv6, TCP, UDP, SCTP, ICMP, ...)
  36     * Flow port's service name heuristic
  37     * Transport protocol state machine information
  38 .PP
  39 In order for flowtop to work, netfilter must be active and running
  40 on your machine, thus kernel-side connection tracking is active.
  41 .PP
  42 flowtop's intention is just to get a quick look over your active connections.
  43 If you want logging support, have a look at netfilter's conntrack(8) tools
  44 instead.
  45 .PP
  46 .SH OPTIONS
  47 .PP
  48 .SS -4, --ipv4
  49 Display IPv4 flows. That is the default when flowtop is started without
  50 any arguments.
  51 .PP
  52 .SS -6, --ipv6
  53 Display IPv6 flows. That is the default when flowtop is started without
  54 any arguments.
  55 .PP
  56 .SS -T, --tcp
  57 Display TCP flows. That is the default when flowtop is started without
  58 any arguments.
  59 .PP
  60 .SS -U, --udp
  61 Display UDP and UDP-lite flows.
  62 .PP
  63 .SS -D, --dccp
  64 Display DCCP flows.
  65 .PP
  66 .SS -I, --icmp
  67 Display ICMP version 4 and version 6 flows.
  68 .PP
  69 .SS -S, --sctp
  70 Display SCTP flows.
  71 .PP
  72 .SS -s, --show-src
  73 Also show source information of the flow, not only destination information.
  74 .PP
  75 .SS -u, --update
  76 The built-in database update mechanism will be invoked to get Maxmind's
  77 latest database. To configure search locations for databases, the file
  78 /etc/netsniff-ng/geoip.conf contains possible addresses. Thus, to save
  79 bandwidth or for mirroring Maxmind's databases (to bypass their traffic
  80 limit policy), different hosts or IP addresses can be placed into geoip.conf,
  81 separated by a newline.
  82 .PP
  83 .SS -v, --version
  84 Show version information and exit.
  85 .PP
  86 .SS -h, --help
  87 Show user help and exit.
  88 .PP
  89 .SH USAGE EXAMPLE
  90 .PP
  91 .SS flowtop
  92 Default ncurses output for flowtop that tracks IPv4, IPv6 flows for TCP.
  93 .PP
  94 .SS flowtop -46UTDISs
  95 This example enables the maximum display options for flowtop.
  96 .PP
  97 .SH CONFIG FILES
  98 .PP
  99 Files under /etc/netsniff-ng/ can be modified to extend flowtop's
 100 service resolution and lookup information.
 101 .PP
 102     * tcp.conf - TCP port/services map
 103     * udp.conf - UDP port/services map
 104     * geoip.conf - GeoIP database mirrors
 105 .PP
 106 .SH BUGS
 107 With a fairly high rate of connection tracking updates, flowtop can become
 108 unresponsive for short periods of time while scrolling. The right fix would
 109 be to replace flowtop's connection management backend with a better design
 110 with respect to the locking approach. This is still on the "todo" list.
 111 .PP
 112 .SH LEGAL
 113 flowtop is licensed under the GNU GPL version 2.0.
 114 .PP
 115 .SH HISTORY
 116 .B flowtop
 117 was originally written for the netsniff-ng toolkit by Daniel Borkmann. It
 118 is currently maintained by Tobias Klauser <tklauser@distanz.ch> and Daniel
 119 Borkmann <dborkma@tik.ee.ethz.ch>.
 120 .PP
 121 .SH SEE ALSO
 122 .BR netsniff-ng (8),
 123 .BR trafgen (8),
 124 .BR mausezahn (8),
 125 .BR ifpps (8),
 126 .BR bpfc (8),
 127 .BR astraceroute (8),
 128 .BR curvetun (8)
 129 .PP
 130 .SH AUTHOR
 131 Manpage was written by Daniel Borkmann.
 132 .PP
 133 .SH COLOPHON
 134 This page is part of the Linux netsniff-ng toolkit project. A description of the project,
 135 and information about reporting bugs, can be found at http://netsniff-ng.org/.