Use pcap_setnonblock() on Linux.
[darkstat] / darkstat.8
1 .\"
2 .\" darkstat 3
3 .\" Copyright 2001-2009, Emil Mikulic.
4 .\"
5 .\" You may use, modify and redistribute this file under the terms of the
6 .\" GNU General Public License version 2. (see COPYING.GPL)
7 .\"
8 .TH darkstat 8 "September 2008" "darkstat 3"
9 .SH NAME
10 darkstat \- network statistics gatherer
11 .\"
12 .SH SYNOPSIS
13 .B darkstat
14 [
15 .BI \-i " interface"
16 ] [
17 .BI \-r " file"
18 ] [
19 .BI \-\-pppoe
20 ] [
21 .BI \-\-verbose
22 ] [
23 .BI \-\-no\-daemon
24 ] [
25 .BI \-\-no\-promisc
26 ] [
27 .BI \-\-no\-dns
28 ] [
29 .BI \-\-no\-macs
30 ] [
31 .BI \-\-no\-lastseen
32 ] [
33 .BI \-p " port"
34 ] [
35 .BI \-b " bindaddr"
36 ] [
37 .BI \-f " filter"
38 ] [
39 .BI \-l " network/netmask"
40 ] [
41 .BI \-\-chroot " dir"
42 ] [
43 .BI \-\-user " username"
44 ] [
45 .BI \-\-daylog " filename"
46 ] [
47 .BI \-\-import " filename"
48 ] [
49 .BI \-\-export " filename"
50 ] [
51 .BI \-\-pidfile " filename"
52 ] [
53 .BI \-\-hosts\-max " count"
54 ] [
55 .BI \-\-hosts\-keep " count"
56 ] [
57 .BI \-\-ports\-max " count"
58 ] [
59 .BI \-\-ports\-keep " count"
60 ] [
61 .BI \-\-highest\-port " port"
62 ] [
63 .BI \-\-hexdump
64 ]
65 .\"
66 .SH DESCRIPTION
67 .I darkstat
68 is a packet sniffer that runs as a background process on
69 a cable/DSL router, gathers all sorts of statistics about network usage,
70 and serves them over HTTP.
71
72 All settings are passed on the commandline.
73 .\"
74 .SH OPTIONS
75 .\"
76 .TP
77 .BI \-i " interface"
78 Capture traffic on the specified network interface.
79 This is the only mandatory commandline argument.
80 .\"
81 .TP
82 .BI \-r " file"
83 Instead of capturing live traffic, read it from a
84 .BR pcap (3)
85 capture file.
86 This is only useful for development and benchmarking.
87 The
88 .BI \-r
89 and
90 .BI \-i
91 arguments are mutually exclusive.
92 .\"
93 .TP
94 .BI \-\-pppoe
95 Don't use this.
96 .RS
97
98 Instead, capture on the tunnel interface that your PPPoE software
99 provides, for example \fBtun0\fR on \fIFreeBSD\fR, \fBpppoe0\fR on
100 \fIOpenBSD\fR or \fINetBSD\fR.
101
102 If you really must, you can capture on an Ethernet interface and pass
103 this argument to have \fIdarkstat\fR decode PPPoE frames and ignore
104 everything else.
105 Make sure you also specify your local address with the \fB\-l\fR
106 argument.
107 .RE
108 .\"
109 .TP
110 .BI \-\-verbose
111 Print debugging messages to the terminal.
112 .\"
113 .TP
114 .BI \-\-no\-daemon
115 Do not detach from the controlling terminal;
116 stay in the foreground.
117 .\"
118 .TP
119 .BI \-\-no\-promisc
120 Do not use promiscuous mode to capture.
121 Note that an interface may already be in promiscuous mode.
122 If this is a problem, use an appropriate
123 .BR bpf (4)
124 filter.
125 .\"
126 .TP
127 .BI \-\-no\-dns
128 Do not resolve IPs to host names.
129 This can significantly reduce memory footprint on small systems
130 as an extra process is created for DNS resolving.
131 .\"
132 .TP
133 .BI \-\-no\-macs
134 Do not display MAC addresses in the hosts table.
135 .\"
136 .TP
137 .BI \-\-no\-lastseen
138 Do not display the last seen time in the hosts table.
139 .\"
140 .TP
141 .BI \-p " port"
142 Bind the web interface to the specified port.
143 The default is 667.
144 .\"
145 .TP
146 .BI \-b " bindaddr"
147 Bind the web interface to the specified address.
148 The default is to listen on all interfaces.
149 .\"
150 .TP
151 .BI \-f " filter"
152 Use the specified filter expression when capturing traffic.
153 The filter syntax is beyond the scope of this manual page;
154 please refer to the
155 .BR tcpdump (1)
156 documentation.
157 .\"
158 .TP
159 .BI \-l " network/netmask"
160 Define a "local network" according to the network and netmask addresses.
161 All traffic entering or leaving this network will be graphed, as opposed
162 to the default behaviour of only graphing traffic to and from the local
163 host.
164 .RS
165
166 The rule is that if \fBip_addr & netmask == network\fR,
167 then that address is considered local.
168 See the usage example below.
169 .RE
170 .\"
171 .TP
172 .BI \-\-chroot " dir"
173 Force \fIdarkstat\fR to \fBchroot()\fR into the specified directory.
174 Without this argument, a default directory will be used, which is
175 determined at build time.
176 Usually \fI/var/empty\fR or \fI/var/lib/empty\fR.
177 .RS
178
179 For security reasons, this directory should be empty, and the user that
180 \fIdarkstat\fR is running as should not have write access to it.
181
182 However, if you wish to use \fB\-\-daylog\fR or \fB\-\-export\fR,
183 \fIdarkstat\fR will need write access to the chroot.
184 If you are uncomfortable with the security implications, don't
185 use any functionality that requires write access.
186 .RE
187 .\"
188 .TP
189 .BI \-\-user " username"
190 Force \fIdarkstat\fR to drop privileges to the \fBuid\fR and \fBgid\fR of
191 the specified user.
192 Without this argument, a default value will be used, which is set at
193 build time.
194 Usually \fBnobody\fR.
195 .RS
196
197 For security reasons, this should not be \fBroot\fR.
198 .RE
199 .\"
200 .TP
201 .BI \-\-daylog " filename"
202 .RS
203 Log daily traffic statistics into the named file, relative to the
204 chroot directory.
205 If you wish to use \fB\-\-daylog\fR, you must first specify a
206 \fB\-\-chroot\fR directory, and it must be writeable by the
207 \fIdarkstat\fR user.
208 A writeable chroot has security implications; if you are uncomfortable
209 with this, do not use the \fB\-\-daylog\fR functionality.
210
211 If the daylog argument is not specified, no logging is performed.
212
213 The daylog format is:
214
215 localtime|time_t|bytes_in|bytes_out|pkts_in|pkts_outs
216
217 Lines starting with a # are comments stating when logging started and
218 stopped.
219 .RE
220 .\"
221 .TP
222 .BI \-\-import " filename"
223 Upon starting, import a \fIdarkstat\fR database from the named file,
224 relative to the chroot directory.
225 If you wish to use \fB\-\-import\fR, you must first specify a
226 \fB\-\-chroot\fR directory.
227 If the import is unsuccessful, \fIdarkstat\fR will start with an empty
228 database.
229 .\"
230 .TP
231 .BI \-\-export " filename"
232 On shutdown, and upon receiving SIGUSR1, export the in-memory database
233 to the named file, relative to the chroot directory.
234 If you wish to use \fB\-\-export\fR, you must first specify a
235 \fB\-\-chroot\fR directory, and it must be writeable by the
236 \fIdarkstat\fR user.
237 A writeable chroot has security implications - if you are uncomfortable
238 with this, do not use the \fB\-\-export\fR functionality.
239 .\"
240 .TP
241 .BI \-\-pidfile " filename"
242 .RS
243 Creates a file containing the process ID of \fIdarkstat\fR.
244 This file will be unlinked upon clean shutdown.
245 As with all pidfiles, if \fIdarkstat\fR dies uncleanly, a stale pidfile
246 can be left over.
247
248 For example, start \fIdarkstat\fR with:
249 .IP
250 darkstat \-i fxp0 \-\-chroot /var/run/darkstat \-\-pidfile darkstat.pid
251 .PP
252 And stop with:
253 .IP
254 kill `cat /var/run/darkstat/darkstat.pid`
255 .PP
256 By default,
257 .BR kill (1)
258 will send SIGTERM, which will cause \fIdarkstat\fR to shut down cleanly.
259 .RE
260 .\"
261 .TP
262 .BI \-\-hosts\-max " count"
263 The maximum number of hosts that will be kept in the hosts table.
264 This is used to limit how much accounting data will be kept in memory.
265 The number of
266 .BI \-\-hosts\-max
267 must be greater than
268 .BI \-\-hosts\-keep
269 .\"
270 .TP
271 .BI \-\-hosts\-keep " count"
272 When the hosts table hits
273 .BI \-\-hosts\-max
274 and traffic is seen from a new host, we clean out the hosts table,
275 keeping only the top
276 .BI \-\-hosts\-keep
277 number of hosts, sorted by total traffic.
278 .\"
279 .TP
280 .BI \-\-ports\-max " count"
281 The maximum number of ports that will be tracked for each host.
282 This is used to limit how much accounting data will be kept in memory.
283 The number of
284 .BI \-\-ports\-max
285 must be greater than
286 .BI \-\-ports\-keep
287 .\"
288 .TP
289 .BI \-\-ports\-keep " count"
290 When a ports table fills up, this many ports are kept and the rest are
291 discarded.
292 .\"
293 .TP
294 .BI \-\-highest\-port " port"
295 Ports that are numerically higher than this will not appear in the
296 per-host ports tables, although their traffic will still be accounted
297 for.
298 This can be used to hide ephemeral ports.
299 By default, all ports are tracked.
300 .\"
301 .TP
302 .BI \-\-hexdump
303 Show hex dumps of received traffic.
304 This is only for debugging, and implies \-\-verbose and \-\-no\-daemon.
305 .\"
306 .\" --------------------------------------------------------------------
307 .SH USAGE EXAMPLES
308 To gather statistics on the
309 .I fxp0
310 interface:
311 .IP
312 darkstat \-i fxp0
313 .PP
314 .\"
315 We want to account for traffic on the Internet-facing interface,
316 but only serve web pages to our private local network where we have the
317 IP address 192.168.0.1:
318 .IP
319 darkstat \-i fxp0 \-b 192.168.0.1
320 .PP
321 .\"
322 We want to serve web pages on the standard HTTP port:
323 .IP
324 darkstat \-i fxp0 \-p 80
325 .PP
326 .\"
327 We are on Optus (cable) and don't want to account for the constant ARP
328 traffic we are receiving:
329 .IP
330 darkstat \-i fxp0 \-f "not arp"
331 .PP
332 .\"
333 We only want to account for SSH traffic:
334 .IP
335 darkstat \-i fxp0 \-f "port 22"
336 .PP
337 .\"
338 We don't want to account for network internal traffic:
339 .IP
340 darkstat \-i fxp0 \-f "not (src net 192.168.0 and dst net 192.168.0)"
341 .PP
342 .\"
343 (For a full reference on filter syntax, refer to the
344 .BR tcpdump (1)
345 manpage)
346 .PP
347 .\"
348 We have a network consisting of a gateway server (192.168.1.1) and a few
349 workstations (192.168.1.2, 192.168.1.3, etc.) and we want to graph all
350 traffic entering and leaving the local network, not just the gateway
351 server (which is running \fIdarkstat\fR):
352 .IP
353 darkstat \-i fxp0 \-l 192.168.1.0/255.255.255.0
354 .PP
355 .\"
356 We want to specify the local IP of the gateway manually because it
357 cannot be automatically detected, e.g. \fB\-\-pppoe\fR is in use.
358 Note the /32 netmask:
359 .IP
360 darkstat \-i fxp0 \-\-pppoe \-l 192.168.1.1/255.255.255.255
361 .\"
362 .SH SIGNALS
363 To shut
364 .I darkstat
365 down cleanly, send a SIGTERM or SIGINT signal to the
366 .I darkstat
367 parent process.
368 .PP
369 Sending the SIGUSR1 signal will cause \fIdarkstat\fR to empty out its
370 in-memory database.
371 If an \fB\-\-export\fR file was set, it will first save the database to
372 file.
373 .PP
374 .\"
375 .SH FREQUENTLY ASKED QUESTIONS
376 .SS How many bytes does each bar on the graph represent?
377 Hover your mouse cursor over a bar and you should get a tooltip
378 saying exactly how many bytes in and out the bar represents.
379 .\"
380 .SS Why aren't there labels / tics / a scale on the graphs?
381 Because implementing them is hard.
382 And doing so \fIcorrectly\fR, and in a way that works across all
383 browsers, looks pretty much impossible.
384
385 I might attempt it some day.
386 In the meantime, patches would be gladly accepted.
387 .\"
388 .SS Why are the graphs blank?  All the bars are zero.
389 The graphs only show traffic in/out of the local host, which is
390 determined by getting the IP address of the interface you're sniffing
391 on.
392
393 You can use the \fB\-l\fR argument to override the local address for
394 accounting purposes.
395 You can also use it to do accounting for a whole subnet by specifying
396 an appropriate netmask.
397 .\"
398 .SH SEE ALSO
399 .BR tcpdump (1)
400 .\"
401 .SH HISTORY
402 .I darkstat
403 was written in 2001, largely as a result of a certain Australian
404 cable Internet provider introducing a 3GB monthly traffic limit.
405 .\"
406 .SH AUTHORS
407 Emil Mikulic and others. (see the AUTHORS and THANKS files)
408 .\"
409 .SH WEBSITE
410 http://dmr.ath.cx/net/darkstat/