flowtop.8

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