]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - usr.sbin/tcpdump/tcpdump/tcpdump.1
Reintegrate head revisions r273096-r277147
[FreeBSD/FreeBSD.git] / usr.sbin / tcpdump / tcpdump / tcpdump.1
1 .\" $FreeBSD$
2 .\"     $NetBSD: tcpdump.8,v 1.9 2003/03/31 00:18:17 perry Exp $
3 .\"
4 .\" Copyright (c) 1987, 1988, 1989, 1990, 1991, 1992, 1994, 1995, 1996, 1997
5 .\"     The Regents of the University of California.  All rights reserved.
6 .\" All rights reserved.
7 .\"
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that: (1) source code distributions
10 .\" retain the above copyright notice and this paragraph in its entirety, (2)
11 .\" distributions including binary code include the above copyright notice and
12 .\" this paragraph in its entirety in the documentation or other materials
13 .\" provided with the distribution, and (3) all advertising materials mentioning
14 .\" features or use of this software display the following acknowledgement:
15 .\" ``This product includes software developed by the University of California,
16 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
17 .\" the University nor the names of its contributors may be used to endorse
18 .\" or promote products derived from this software without specific prior
19 .\" written permission.
20 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
21 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
22 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
23 .\"
24 .TH TCPDUMP 1  "11 July 2014"
25 .SH NAME
26 tcpdump \- dump traffic on a network
27 .SH SYNOPSIS
28 .na
29 .B tcpdump
30 [
31 .B \-AbdDefhHIJKlLnNOpqRStuUvxX#
32 ] [
33 .B \-B
34 .I buffer_size
35 ]
36 .br
37 .ti +8
38 [
39 .B \-c
40 .I count
41 ]
42 .br
43 .ti +8
44 [
45 .B \-C
46 .I file_size
47 ] [
48 .B \-G
49 .I rotate_seconds
50 ] [
51 .B \-F
52 .I file
53 ]
54 .br
55 .ti +8
56 [
57 .B \-i
58 .I interface
59 ]
60 [
61 .B \-j
62 .I tstamp_type
63 ]
64 [
65 .B \-m
66 .I module
67 ]
68 [
69 .B \-M
70 .I secret
71 ]
72 .br
73 .ti +8
74 [
75 .B \-\-number
76 ]
77 [
78 .B \-Q
79 .I in|out|inout
80 ]
81 .ti +8
82 [
83 .B \-r
84 .I file
85 ]
86 [
87 .B \-V
88 .I file
89 ]
90 [
91 .B \-s
92 .I snaplen
93 ]
94 [
95 .B \-T
96 .I type
97 ]
98 [
99 .B \-w
100 .I file
101 ]
102 .br
103 .ti +8
104 [
105 .B \-W
106 .I filecount
107 ]
108 .br
109 .ti +8
110 [
111 .B \-E
112 .I spi@ipaddr algo:secret,...
113 ]
114 .br
115 .ti +8
116 [
117 .B \-y
118 .I datalinktype
119 ]
120 [
121 .B \-z
122 .I postrotate-command
123 ]
124 [
125 .B \-Z
126 .I user
127 ]
128 .ti +8
129 [
130 .BI \-\-time\-stamp\-precision= tstamp_precision
131 ]
132 [
133 .B \-\-version
134 ]
135 .ti +8
136 [
137 .I expression
138 ]
139 .br
140 .ad
141 .SH DESCRIPTION
142 .LP
143 \fITcpdump\fP prints out a description of the contents of packets on a
144 network interface that match the boolean \fIexpression\fP.  It can also
145 be run with the
146 .B \-w
147 flag, which causes it to save the packet data to a file for later
148 analysis, and/or with the
149 .B \-r
150 flag, which causes it to read from a saved packet file rather than to
151 read packets from a network interface.  It can also be run with the
152 .B \-V
153 flag, which causes it to read a list of saved packet files. In all cases,
154 only packets that match
155 .I expression
156 will be processed by
157 .IR tcpdump .
158 .LP
159 .I Tcpdump
160 will, if not run with the
161 .B \-c
162 flag, continue capturing packets until it is interrupted by a SIGINT
163 signal (generated, for example, by typing your interrupt character,
164 typically control-C) or a SIGTERM signal (typically generated with the
165 .BR kill (1)
166 command); if run with the
167 .B \-c
168 flag, it will capture packets until it is interrupted by a SIGINT or
169 SIGTERM signal or the specified number of packets have been processed.
170 .LP
171 When
172 .I tcpdump
173 finishes capturing packets, it will report counts of:
174 .IP
175 packets ``captured'' (this is the number of packets that
176 .I tcpdump
177 has received and processed);
178 .IP
179 packets ``received by filter'' (the meaning of this depends on the OS on
180 which you're running
181 .IR tcpdump ,
182 and possibly on the way the OS was configured - if a filter was
183 specified on the command line, on some OSes it counts packets regardless
184 of whether they were matched by the filter expression and, even if they
185 were matched by the filter expression, regardless of whether
186 .I tcpdump
187 has read and processed them yet, on other OSes it counts only packets that were
188 matched by the filter expression regardless of whether
189 .I tcpdump
190 has read and processed them yet, and on other OSes it counts only
191 packets that were matched by the filter expression and were processed by
192 .IR tcpdump );
193 .IP
194 packets ``dropped by kernel'' (this is the number of packets that were
195 dropped, due to a lack of buffer space, by the packet capture mechanism
196 in the OS on which
197 .I tcpdump
198 is running, if the OS reports that information to applications; if not,
199 it will be reported as 0).
200 .LP
201 On platforms that support the SIGINFO signal, such as most BSDs
202 (including Mac OS X) and Digital/Tru64 UNIX, it will report those counts
203 when it receives a SIGINFO signal (generated, for example, by typing
204 your ``status'' character, typically control-T, although on some
205 platforms, such as Mac OS X, the ``status'' character is not set by
206 default, so you must set it with
207 .BR stty (1)
208 in order to use it) and will continue capturing packets.
209 .LP
210 Reading packets from a network interface may require that you have
211 special privileges; see the
212 .B pcap (3PCAP)
213 man page for details.  Reading a saved packet file doesn't require
214 special privileges.
215 .SH OPTIONS
216 .TP
217 .B \-A
218 Print each packet (minus its link level header) in ASCII.  Handy for
219 capturing web pages.
220 .TP
221 .B \-b
222 Print the AS number in BGP packets in ASDOT notation rather than ASPLAIN
223 notation.
224 .TP
225 .BI \-B " buffer_size"
226 .PD 0
227 .TP
228 .BI \-\-buffer\-size= buffer_size
229 .PD
230 Set the operating system capture buffer size to \fIbuffer_size\fP, in
231 units of KiB (1024 bytes).
232 .TP
233 .BI \-c " count"
234 Exit after receiving \fIcount\fP packets.
235 .TP
236 .BI \-C " file_size"
237 Before writing a raw packet to a savefile, check whether the file is
238 currently larger than \fIfile_size\fP and, if so, close the current
239 savefile and open a new one.  Savefiles after the first savefile will
240 have the name specified with the
241 .B \-w
242 flag, with a number after it, starting at 1 and continuing upward.
243 The units of \fIfile_size\fP are millions of bytes (1,000,000 bytes,
244 not 1,048,576 bytes).
245 .TP
246 .B \-d
247 Dump the compiled packet-matching code in a human readable form to
248 standard output and stop.
249 .TP
250 .B \-dd
251 Dump packet-matching code as a
252 .B C
253 program fragment.
254 .TP
255 .B \-ddd
256 Dump packet-matching code as decimal numbers (preceded with a count).
257 .TP
258 .B \-D
259 .PD 0
260 .TP
261 .B \-\-list\-interfaces
262 .PD
263 Print the list of the network interfaces available on the system and on
264 which
265 .I tcpdump
266 can capture packets.  For each network interface, a number and an
267 interface name, possibly followed by a text description of the
268 interface, is printed.  The interface name or the number can be supplied
269 to the
270 .B \-i
271 flag to specify an interface on which to capture.
272 .IP
273 This can be useful on systems that don't have a command to list them
274 (e.g., Windows systems, or UNIX systems lacking
275 .BR "ifconfig \-a" );
276 the number can be useful on Windows 2000 and later systems, where the
277 interface name is a somewhat complex string.
278 .IP
279 The
280 .B \-D
281 flag will not be supported if
282 .I tcpdump
283 was built with an older version of
284 .I libpcap
285 that lacks the
286 .B pcap_findalldevs()
287 function.
288 .TP
289 .B \-e
290 Print the link-level header on each dump line.  This can be used, for
291 example, to print MAC layer addresses for protocols such as Ethernet and
292 IEEE 802.11.
293 .TP
294 .B \-E
295 Use \fIspi@ipaddr algo:secret\fP for decrypting IPsec ESP packets that
296 are addressed to \fIaddr\fP and contain Security Parameter Index value
297 \fIspi\fP. This combination may be repeated with comma or newline separation.
298 .IP
299 Note that setting the secret for IPv4 ESP packets is supported at this time.
300 .IP
301 Algorithms may be
302 \fBdes-cbc\fP,
303 \fB3des-cbc\fP,
304 \fBblowfish-cbc\fP,
305 \fBrc3-cbc\fP,
306 \fBcast128-cbc\fP, or
307 \fBnone\fP.
308 The default is \fBdes-cbc\fP.
309 The ability to decrypt packets is only present if \fItcpdump\fP was compiled
310 with cryptography enabled.
311 .IP
312 \fIsecret\fP is the ASCII text for ESP secret key.
313 If preceded by 0x, then a hex value will be read.
314 .IP
315 The option assumes RFC2406 ESP, not RFC1827 ESP.
316 The option is only for debugging purposes, and
317 the use of this option with a true `secret' key is discouraged.
318 By presenting IPsec secret key onto command line
319 you make it visible to others, via
320 .IR ps (1)
321 and other occasions.
322 .IP
323 In addition to the above syntax, the syntax \fIfile name\fP may be used
324 to have tcpdump read the provided file in. The file is opened upon
325 receiving the first ESP packet, so any special permissions that tcpdump
326 may have been given should already have been given up.
327 .TP
328 .B \-f
329 Print `foreign' IPv4 addresses numerically rather than symbolically
330 (this option is intended to get around serious brain damage in
331 Sun's NIS server \(em usually it hangs forever translating non-local
332 internet numbers).
333 .IP
334 The test for `foreign' IPv4 addresses is done using the IPv4 address and
335 netmask of the interface on which capture is being done.  If that
336 address or netmask are not available, available, either because the
337 interface on which capture is being done has no address or netmask or
338 because the capture is being done on the Linux "any" interface, which
339 can capture on more than one interface, this option will not work
340 correctly.
341 .TP
342 .BI \-F " file"
343 Use \fIfile\fP as input for the filter expression.
344 An additional expression given on the command line is ignored.
345 .TP
346 .BI \-G " rotate_seconds"
347 If specified, rotates the dump file specified with the
348 .B \-w
349 option every \fIrotate_seconds\fP seconds.
350 Savefiles will have the name specified by
351 .B \-w
352 which should include a time format as defined by
353 .BR strftime (3).
354 If no time format is specified, each new file will overwrite the previous.
355 .IP
356 If used in conjunction with the
357 .B \-C
358 option, filenames will take the form of `\fIfile\fP<count>'.
359 .TP
360 .B \-h
361 .PD 0
362 .TP
363 .B \-\-help
364 .PD
365 Print the tcpdump and libpcap version strings, print a usage message,
366 and exit.
367 .TP
368 .B \-\-version
369 .PD
370 Print the tcpdump and libpcap version strings and exit.
371 .TP
372 .B \-H
373 Attempt to detect 802.11s draft mesh headers.
374 .TP
375 .BI \-i " interface"
376 .PD 0
377 .TP
378 .BI \-\-interface= interface
379 .PD
380 Listen on \fIinterface\fP.
381 If unspecified, \fItcpdump\fP searches the system interface list for the
382 lowest numbered, configured up interface (excluding loopback), which may turn
383 out to be, for example, ``eth0''.
384 .IP
385 On Linux systems with 2.2 or later kernels, an
386 .I interface
387 argument of ``any'' can be used to capture packets from all interfaces.
388 Note that captures on the ``any'' device will not be done in promiscuous
389 mode.
390 .IP
391 If the
392 .B \-D
393 flag is supported, an interface number as printed by that flag can be
394 used as the
395 .I interface
396 argument.
397 .TP
398 .B \-I
399 .PD 0
400 .TP
401 .B \-\-monitor\-mode
402 .PD
403 Put the interface in "monitor mode"; this is supported only on IEEE
404 802.11 Wi-Fi interfaces, and supported only on some operating systems.
405 .IP
406 Note that in monitor mode the adapter might disassociate from the
407 network with which it's associated, so that you will not be able to use
408 any wireless networks with that adapter.  This could prevent accessing
409 files on a network server, or resolving host names or network addresses,
410 if you are capturing in monitor mode and are not connected to another
411 network with another adapter.
412 .IP
413 This flag will affect the output of the
414 .B \-L
415 flag.  If
416 .B \-I
417 isn't specified, only those link-layer types available when not in
418 monitor mode will be shown; if
419 .B \-I
420 is specified, only those link-layer types available when in monitor mode
421 will be shown.
422 .TP
423 .BI \-j " tstamp_type"
424 .PD 0
425 .TP
426 .BI \-\-time\-stamp\-type= tstamp_type
427 .PD
428 Set the time stamp type for the capture to \fItstamp_type\fP.  The names
429 to use for the time stamp types are given in
430 .BR pcap-tstamp (7);
431 not all the types listed there will necessarily be valid for any given
432 interface.
433 .TP
434 .B \-J
435 .PD 0
436 .TP
437 .B \-\-list\-time\-stamp\-types
438 .PD
439 List the supported time stamp types for the interface and exit.  If the
440 time stamp type cannot be set for the interface, no time stamp types are
441 listed.
442 .TP
443 .BI \-\-time\-stamp\-precision= tstamp_precision
444 When capturing, set the time stamp precision for the capture to
445 \fItstamp_precision\fP.  Note that availability of high precision time
446 stamps (nanoseconds) and their actual accuracy is platform and hardware
447 dependent.  Also note that when writing captures made with nanosecond
448 accuracy to a savefile, the time stamps are written with nanosecond
449 resolution, and the file is written with a different magic number, to
450 indicate that the time stamps are in seconds and nanoseconds; not all
451 programs that read pcap savefiles will be able to read those captures.
452 .LP
453 When reading a savefile, convert time stamps to the precision specified
454 by \fItimestamp_precision\fP, and display them with that resolution.  If
455 the precision specified is less than the precision of time stamps in the
456 file, the conversion will lose precision.
457 .LP
458 The supported values for \fItimestamp_precision\fP are \fBmicro\fP for
459 microsecond resolution and \fBnano\fP for nanosecond resolution.  The
460 default is microsecond resolution.
461 .TP
462 .B \-K
463 .PD 0
464 .TP
465 .B \-\-dont\-verify\-checksums
466 .PD
467 Don't attempt to verify IP, TCP, or UDP checksums.  This is useful for
468 interfaces that perform some or all of those checksum calculation in
469 hardware; otherwise, all outgoing TCP checksums will be flagged as bad.
470 .TP
471 .B \-l
472 Make stdout line buffered.
473 Useful if you want to see the data
474 while capturing it.
475 E.g.,
476 .IP
477 .RS
478 .RS
479 .nf
480 \fBtcpdump \-l | tee dat\fP
481 .fi
482 .RE
483 .RE
484 .IP
485 or
486 .IP
487 .RS
488 .RS
489 .nf
490 \fBtcpdump \-l > dat & tail \-f dat\fP
491 .fi
492 .RE
493 .RE
494 .IP
495 Note that on Windows,``line buffered'' means ``unbuffered'', so that
496 WinDump will write each character individually if
497 .B \-l
498 is specified.
499 .IP
500 .B \-U
501 is similar to
502 .B \-l
503 in its behavior, but it will cause output to be ``packet-buffered'', so
504 that the output is written to stdout at the end of each packet rather
505 than at the end of each line; this is buffered on all platforms,
506 including Windows.
507 .TP
508 .B \-L
509 .PD 0
510 .TP
511 .B \-\-list\-data\-link\-types
512 .PD
513 List the known data link types for the interface, in the specified mode,
514 and exit.  The list of known data link types may be dependent on the
515 specified mode; for example, on some platforms, a Wi-Fi interface might
516 support one set of data link types when not in monitor mode (for
517 example, it might support only fake Ethernet headers, or might support
518 802.11 headers but not support 802.11 headers with radio information)
519 and another set of data link types when in monitor mode (for example, it
520 might support 802.11 headers, or 802.11 headers with radio information,
521 only in monitor mode).
522 .TP
523 .BI \-m " module"
524 Load SMI MIB module definitions from file \fImodule\fR.
525 This option
526 can be used several times to load several MIB modules into \fItcpdump\fP.
527 .TP
528 .BI \-M " secret"
529 Use \fIsecret\fP as a shared secret for validating the digests found in
530 TCP segments with the TCP-MD5 option (RFC 2385), if present.
531 .TP
532 .B \-n
533 Don't convert addresses (i.e., host addresses, port numbers, etc.) to names.
534 .TP
535 .B \-N
536 Don't print domain name qualification of host names.
537 E.g.,
538 if you give this flag then \fItcpdump\fP will print ``nic''
539 instead of ``nic.ddn.mil''.
540 .TP
541 .B \-#
542 .PD 0
543 .TP
544 .B \-\-number
545 .PD
546 Print an optional packet number at the beginning of the line.
547 .TP
548 .B \-O
549 .PD 0
550 .TP
551 .B \-\-no\-optimize
552 .PD
553 Do not run the packet-matching code optimizer.
554 This is useful only
555 if you suspect a bug in the optimizer.
556 .TP
557 .B \-p
558 .PD 0
559 .TP
560 .B \-\-no\-promiscuous\-mode
561 .PD
562 \fIDon't\fP put the interface
563 into promiscuous mode.
564 Note that the interface might be in promiscuous
565 mode for some other reason; hence, `-p' cannot be used as an abbreviation for
566 `ether host {local-hw-addr} or ether broadcast'.
567 .TP
568 .BI \-Q " direction"
569 .PD 0
570 .TP
571 .BI \-\-direction= direction
572 .PD
573 Choose send/receive direction \fIdirection\fR for which packets should be
574 captured. Possible values are `in', `out' and `inout'. Not available
575 on all platforms.
576 .TP
577 .B \-q
578 Quick (quiet?) output.
579 Print less protocol information so output
580 lines are shorter.
581 .TP
582 .B \-R
583 Assume ESP/AH packets to be based on old specification (RFC1825 to RFC1829).
584 If specified, \fItcpdump\fP will not print replay prevention field.
585 Since there is no protocol version field in ESP/AH specification,
586 \fItcpdump\fP cannot deduce the version of ESP/AH protocol.
587 .TP
588 .BI \-r " file"
589 Read packets from \fIfile\fR (which was created with the
590 .B \-w
591 option or by other tools that write pcap or pcap-ng files).
592 Standard input is used if \fIfile\fR is ``-''.
593 .TP
594 .B \-S
595 .PD 0
596 .TP
597 .B \-\-absolute\-tcp\-sequence\-numbers
598 .PD
599 Print absolute, rather than relative, TCP sequence numbers.
600 .TP
601 .BI \-s " snaplen"
602 .PD 0
603 .TP
604 .BI \-\-snapshot\-length= snaplen
605 .PD
606 Snarf \fIsnaplen\fP bytes of data from each packet rather than the
607 default of 65535 bytes.
608 Packets truncated because of a limited snapshot
609 are indicated in the output with ``[|\fIproto\fP]'', where \fIproto\fP
610 is the name of the protocol level at which the truncation has occurred.
611 Note that taking larger snapshots both increases
612 the amount of time it takes to process packets and, effectively,
613 decreases the amount of packet buffering.
614 This may cause packets to be
615 lost.
616 You should limit \fIsnaplen\fP to the smallest number that will
617 capture the protocol information you're interested in.
618 Setting
619 \fIsnaplen\fP to 0 sets it to the default of 65535,
620 for backwards compatibility with recent older versions of
621 .IR tcpdump .
622 .TP
623 .BI \-T " type"
624 Force packets selected by "\fIexpression\fP" to be interpreted the
625 specified \fItype\fR.
626 Currently known types are
627 \fBaodv\fR (Ad-hoc On-demand Distance Vector protocol),
628 \fBcarp\fR (Common Address Redundancy Protocol),
629 \fBcnfp\fR (Cisco NetFlow protocol),
630 \fBlmp\fR (Link Management Protocol),
631 \fBpgm\fR (Pragmatic General Multicast),
632 \fBpgm_zmtp1\fR (ZMTP/1.0 inside PGM/EPGM),
633 \fBradius\fR (RADIUS),
634 \fBrpc\fR (Remote Procedure Call),
635 \fBrtp\fR (Real-Time Applications protocol),
636 \fBrtcp\fR (Real-Time Applications control protocol),
637 \fBsnmp\fR (Simple Network Management Protocol),
638 \fBtftp\fR (Trivial File Transfer Protocol),
639 \fBvat\fR (Visual Audio Tool),
640 \fBwb\fR (distributed White Board),
641 \fBzmtp1\fR (ZeroMQ Message Transport Protocol 1.0)
642 and
643 \fBvxlan\fR (Virtual eXtensible Local Area Network).
644 .IP
645 Note that the \fBpgm\fR type above affects UDP interpretation only, the native
646 PGM is always recognised as IP protocol 113 regardless. UDP-encapsulated PGM is
647 often called "EPGM" or "PGM/UDP".
648 .IP
649 Note that the \fBpgm_zmtp1\fR type above affects interpretation of both native
650 PGM and UDP at once. During the native PGM decoding the application data of an
651 ODATA/RDATA packet would be decoded as a ZeroMQ datagram with ZMTP/1.0 frames.
652 During the UDP decoding in addition to that any UDP packet would be treated as
653 an encapsulated PGM packet.
654 .TP
655 .B \-t
656 \fIDon't\fP print a timestamp on each dump line.
657 .TP
658 .B \-tt
659 Print an unformatted timestamp on each dump line.
660 .TP
661 .B \-ttt
662 Print a delta (micro-second resolution) between current and previous line
663 on each dump line.
664 .TP
665 .B \-tttt
666 Print a timestamp in default format proceeded by date on each dump line.
667 .TP
668 .B \-ttttt
669 Print a delta (micro-second resolution) between current and first line
670 on each dump line.
671 .TP
672 .B \-u
673 Print undecoded NFS handles.
674 .TP
675 .B \-U
676 .PD 0
677 .TP
678 .B \-\-packet\-buffered
679 .PD
680 If the
681 .B \-w
682 option is not specified, make the printed packet output
683 ``packet-buffered''; i.e., as the description of the contents of each
684 packet is printed, it will be written to the standard output, rather
685 than, when not writing to a terminal, being written only when the output
686 buffer fills.
687 .IP
688 If the
689 .B \-w
690 option is specified, make the saved raw packet output
691 ``packet-buffered''; i.e., as each packet is saved, it will be written
692 to the output file, rather than being written only when the output
693 buffer fills.
694 .IP
695 The
696 .B \-U
697 flag will not be supported if
698 .I tcpdump
699 was built with an older version of
700 .I libpcap
701 that lacks the
702 .B pcap_dump_flush()
703 function.
704 .TP
705 .B \-v
706 When parsing and printing, produce (slightly more) verbose output.
707 For example, the time to live,
708 identification, total length and options in an IP packet are printed.
709 Also enables additional packet integrity checks such as verifying the
710 IP and ICMP header checksum.
711 .IP
712 When writing to a file with the
713 .B \-w
714 option, report, every 10 seconds, the number of packets captured.
715 .TP
716 .B \-vv
717 Even more verbose output.
718 For example, additional fields are
719 printed from NFS reply packets, and SMB packets are fully decoded.
720 .TP
721 .B \-vvv
722 Even more verbose output.
723 For example,
724 telnet \fBSB\fP ... \fBSE\fP options
725 are printed in full.
726 With
727 .B \-X
728 Telnet options are printed in hex as well.
729 .TP
730 .BI \-V " file"
731 Read a list of filenames from \fIfile\fR. Standard input is used
732 if \fIfile\fR is ``-''.
733 .TP
734 .BI \-w " file"
735 Write the raw packets to \fIfile\fR rather than parsing and printing
736 them out.
737 They can later be printed with the \-r option.
738 Standard output is used if \fIfile\fR is ``-''.
739 .IP
740 This output will be buffered if written to a file or pipe, so a program
741 reading from the file or pipe may not see packets for an arbitrary
742 amount of time after they are received.  Use the
743 .B \-U
744 flag to cause packets to be written as soon as they are received.
745 .IP
746 The MIME type \fIapplication/vnd.tcpdump.pcap\fP has been registered
747 with IANA for \fIpcap\fP files. The filename extension \fI.pcap\fP
748 appears to be the most commonly used along with \fI.cap\fP and
749 \fI.dmp\fP. \fITcpdump\fP itself doesn't check the extension when
750 reading capture files and doesn't add an extension when writing them
751 (it uses magic numbers in the file header instead). However, many
752 operating systems and applications will use the extension if it is
753 present and adding one (e.g. .pcap) is recommended.
754 .IP
755 See
756 .BR pcap-savefile (5)
757 for a description of the file format.
758 .TP
759 .B \-W
760 Used in conjunction with the
761 .B \-C
762 option, this will limit the number
763 of files created to the specified number, and begin overwriting files
764 from the beginning, thus creating a 'rotating' buffer.
765 In addition, it will name
766 the files with enough leading 0s to support the maximum number of
767 files, allowing them to sort correctly.
768 .IP
769 Used in conjunction with the
770 .B \-G
771 option, this will limit the number of rotated dump files that get
772 created, exiting with status 0 when reaching the limit. If used with
773 .B \-C
774 as well, the behavior will result in cyclical files per timeslice.
775 .TP
776 .B \-x
777 When parsing and printing,
778 in addition to printing the headers of each packet, print the data of
779 each packet (minus its link level header) in hex.
780 The smaller of the entire packet or
781 .I snaplen
782 bytes will be printed.  Note that this is the entire link-layer
783 packet, so for link layers that pad (e.g. Ethernet), the padding bytes
784 will also be printed when the higher layer packet is shorter than the
785 required padding.
786 .TP
787 .B \-xx
788 When parsing and printing,
789 in addition to printing the headers of each packet, print the data of
790 each packet,
791 .I including
792 its link level header, in hex.
793 .TP
794 .B \-X
795 When parsing and printing,
796 in addition to printing the headers of each packet, print the data of
797 each packet (minus its link level header) in hex and ASCII.
798 This is very handy for analysing new protocols.
799 .TP
800 .B \-XX
801 When parsing and printing,
802 in addition to printing the headers of each packet, print the data of
803 each packet,
804 .I including
805 its link level header, in hex and ASCII.
806 .TP
807 .BI \-y " datalinktype"
808 .PD 0
809 .TP
810 .BI \-\-linktype= datalinktype
811 .PD
812 Set the data link type to use while capturing packets to \fIdatalinktype\fP.
813 .TP
814 .BI \-z " postrotate-command"
815 Used in conjunction with the
816 .B -C
817 or
818 .B -G
819 options, this will make
820 .I tcpdump
821 run "
822 .I postrotate-command file
823 " where
824 .I file
825 is the savefile being closed after each rotation. For example, specifying
826 .B \-z gzip
827 or
828 .B \-z bzip2
829 will compress each savefile using gzip or bzip2.
830 .IP
831 Note that tcpdump will run the command in parallel to the capture, using
832 the lowest priority so that this doesn't disturb the capture process.
833 .IP
834 And in case you would like to use a command that itself takes flags or
835 different arguments, you can always write a shell script that will take the
836 savefile name as the only argument, make the flags & arguments arrangements
837 and execute the command that you want.
838 .TP
839 .BI \-Z " user"
840 .PD 0
841 .TP
842 .BI \-\-relinquish\-privileges= user
843 .PD
844 If
845 .I tcpdump
846 is running as root, after opening the capture device or input savefile,
847 but before opening any savefiles for output, change the user ID to
848 .I user
849 and the group ID to the primary group of
850 .IR user .
851 .IP
852 This behavior can also be enabled by default at compile time.
853 .IP "\fI expression\fP"
854 .RS
855 selects which packets will be dumped.
856 If no \fIexpression\fP
857 is given, all packets on the net will be dumped.
858 Otherwise,
859 only packets for which \fIexpression\fP is `true' will be dumped.
860 .LP
861 For the \fIexpression\fP syntax, see
862 .BR pcap-filter (7).
863 .LP
864 The \fIexpression\fP argument can be passed to \fItcpdump\fP as either a single
865 Shell argument, or as multiple Shell arguments, whichever is more convenient.
866 Generally, if the expression contains Shell metacharacters, such as
867 backslashes used to escape protocol names, it is easier to pass it as
868 a single, quoted argument rather than to escape the Shell
869 metacharacters.
870 Multiple arguments are concatenated with spaces before being parsed.
871 .SH EXAMPLES
872 .LP
873 To print all packets arriving at or departing from \fIsundown\fP:
874 .RS
875 .nf
876 \fBtcpdump host sundown\fP
877 .fi
878 .RE
879 .LP
880 To print traffic between \fIhelios\fR and either \fIhot\fR or \fIace\fR:
881 .RS
882 .nf
883 \fBtcpdump host helios and \\( hot or ace \\)\fP
884 .fi
885 .RE
886 .LP
887 To print all IP packets between \fIace\fR and any host except \fIhelios\fR:
888 .RS
889 .nf
890 \fBtcpdump ip host ace and not helios\fP
891 .fi
892 .RE
893 .LP
894 To print all traffic between local hosts and hosts at Berkeley:
895 .RS
896 .nf
897 .B
898 tcpdump net ucb-ether
899 .fi
900 .RE
901 .LP
902 To print all ftp traffic through internet gateway \fIsnup\fP:
903 (note that the expression is quoted to prevent the shell from
904 (mis-)interpreting the parentheses):
905 .RS
906 .nf
907 .B
908 tcpdump 'gateway snup and (port ftp or ftp-data)'
909 .fi
910 .RE
911 .LP
912 To print traffic neither sourced from nor destined for local hosts
913 (if you gateway to one other net, this stuff should never make it
914 onto your local net).
915 .RS
916 .nf
917 .B
918 tcpdump ip and not net \fIlocalnet\fP
919 .fi
920 .RE
921 .LP
922 To print the start and end packets (the SYN and FIN packets) of each
923 TCP conversation that involves a non-local host.
924 .RS
925 .nf
926 .B
927 tcpdump 'tcp[tcpflags] & (tcp-syn|tcp-fin) != 0 and not src and dst net \fIlocalnet\fP'
928 .fi
929 .RE
930 .LP
931 To print all IPv4 HTTP packets to and from port 80, i.e. print only
932 packets that contain data, not, for example, SYN and FIN packets and
933 ACK-only packets.  (IPv6 is left as an exercise for the reader.)
934 .RS
935 .nf
936 .B
937 tcpdump 'tcp port 80 and (((ip[2:2] - ((ip[0]&0xf)<<2)) - ((tcp[12]&0xf0)>>2)) != 0)'
938 .fi
939 .RE
940 .LP
941 To print IP packets longer than 576 bytes sent through gateway \fIsnup\fP:
942 .RS
943 .nf
944 .B
945 tcpdump 'gateway snup and ip[2:2] > 576'
946 .fi
947 .RE
948 .LP
949 To print IP broadcast or multicast packets that were
950 .I not
951 sent via Ethernet broadcast or multicast:
952 .RS
953 .nf
954 .B
955 tcpdump 'ether[0] & 1 = 0 and ip[16] >= 224'
956 .fi
957 .RE
958 .LP
959 To print all ICMP packets that are not echo requests/replies (i.e., not
960 ping packets):
961 .RS
962 .nf
963 .B
964 tcpdump 'icmp[icmptype] != icmp-echo and icmp[icmptype] != icmp-echoreply'
965 .fi
966 .RE
967 .SH OUTPUT FORMAT
968 .LP
969 The output of \fItcpdump\fP is protocol dependent.
970 The following
971 gives a brief description and examples of most of the formats.
972 .de HD
973 .sp 1.5
974 .B
975 ..
976 .HD
977 Link Level Headers
978 .LP
979 If the '-e' option is given, the link level header is printed out.
980 On Ethernets, the source and destination addresses, protocol,
981 and packet length are printed.
982 .LP
983 On FDDI networks, the  '-e' option causes \fItcpdump\fP to print
984 the `frame control' field,  the source and destination addresses,
985 and the packet length.
986 (The `frame control' field governs the
987 interpretation of the rest of the packet.
988 Normal packets (such
989 as those containing IP datagrams) are `async' packets, with a priority
990 value between 0 and 7; for example, `\fBasync4\fR'.
991 Such packets
992 are assumed to contain an 802.2 Logical Link Control (LLC) packet;
993 the LLC header is printed if it is \fInot\fR an ISO datagram or a
994 so-called SNAP packet.
995 .LP
996 On Token Ring networks, the '-e' option causes \fItcpdump\fP to print
997 the `access control' and `frame control' fields, the source and
998 destination addresses, and the packet length.
999 As on FDDI networks,
1000 packets are assumed to contain an LLC packet.
1001 Regardless of whether
1002 the '-e' option is specified or not, the source routing information is
1003 printed for source-routed packets.
1004 .LP
1005 On 802.11 networks, the '-e' option causes \fItcpdump\fP to print
1006 the `frame control' fields, all of the addresses in the 802.11 header,
1007 and the packet length.
1008 As on FDDI networks,
1009 packets are assumed to contain an LLC packet.
1010 .LP
1011 \fI(N.B.: The following description assumes familiarity with
1012 the SLIP compression algorithm described in RFC-1144.)\fP
1013 .LP
1014 On SLIP links, a direction indicator (``I'' for inbound, ``O'' for outbound),
1015 packet type, and compression information are printed out.
1016 The packet type is printed first.
1017 The three types are \fIip\fP, \fIutcp\fP, and \fIctcp\fP.
1018 No further link information is printed for \fIip\fR packets.
1019 For TCP packets, the connection identifier is printed following the type.
1020 If the packet is compressed, its encoded header is printed out.
1021 The special cases are printed out as
1022 \fB*S+\fIn\fR and \fB*SA+\fIn\fR, where \fIn\fR is the amount by which
1023 the sequence number (or sequence number and ack) has changed.
1024 If it is not a special case,
1025 zero or more changes are printed.
1026 A change is indicated by U (urgent pointer), W (window), A (ack),
1027 S (sequence number), and I (packet ID), followed by a delta (+n or -n),
1028 or a new value (=n).
1029 Finally, the amount of data in the packet and compressed header length
1030 are printed.
1031 .LP
1032 For example, the following line shows an outbound compressed TCP packet,
1033 with an implicit connection identifier; the ack has changed by 6,
1034 the sequence number by 49, and the packet ID by 6; there are 3 bytes of
1035 data and 6 bytes of compressed header:
1036 .RS
1037 .nf
1038 \fBO ctcp * A+6 S+49 I+6 3 (6)\fP
1039 .fi
1040 .RE
1041 .HD
1042 ARP/RARP Packets
1043 .LP
1044 Arp/rarp output shows the type of request and its arguments.
1045 The
1046 format is intended to be self explanatory.
1047 Here is a short sample taken from the start of an `rlogin' from
1048 host \fIrtsg\fP to host \fIcsam\fP:
1049 .RS
1050 .nf
1051 .sp .5
1052 \f(CWarp who-has csam tell rtsg
1053 arp reply csam is-at CSAM\fR
1054 .sp .5
1055 .fi
1056 .RE
1057 The first line says that rtsg sent an arp packet asking
1058 for the Ethernet address of internet host csam.
1059 Csam
1060 replies with its Ethernet address (in this example, Ethernet addresses
1061 are in caps and internet addresses in lower case).
1062 .LP
1063 This would look less redundant if we had done \fItcpdump \-n\fP:
1064 .RS
1065 .nf
1066 .sp .5
1067 \f(CWarp who-has 128.3.254.6 tell 128.3.254.68
1068 arp reply 128.3.254.6 is-at 02:07:01:00:01:c4\fP
1069 .fi
1070 .RE
1071 .LP
1072 If we had done \fItcpdump \-e\fP, the fact that the first packet is
1073 broadcast and the second is point-to-point would be visible:
1074 .RS
1075 .nf
1076 .sp .5
1077 \f(CWRTSG Broadcast 0806  64: arp who-has csam tell rtsg
1078 CSAM RTSG 0806  64: arp reply csam is-at CSAM\fR
1079 .sp .5
1080 .fi
1081 .RE
1082 For the first packet this says the Ethernet source address is RTSG, the
1083 destination is the Ethernet broadcast address, the type field
1084 contained hex 0806 (type ETHER_ARP) and the total length was 64 bytes.
1085 .HD
1086 TCP Packets
1087 .LP
1088 \fI(N.B.:The following description assumes familiarity with
1089 the TCP protocol described in RFC-793.
1090 If you are not familiar
1091 with the protocol, neither this description nor \fItcpdump\fP will
1092 be of much use to you.)\fP
1093 .LP
1094 The general format of a tcp protocol line is:
1095 .RS
1096 .nf
1097 .sp .5
1098 \fIsrc > dst: flags data-seqno ack window urgent options\fP
1099 .sp .5
1100 .fi
1101 .RE
1102 \fISrc\fP and \fIdst\fP are the source and destination IP
1103 addresses and ports.
1104 \fIFlags\fP are some combination of S (SYN),
1105 F (FIN), P (PUSH), R (RST), U (URG), W (ECN CWR), E (ECN-Echo) or
1106 `.' (ACK), or `none' if no flags are set.
1107 \fIData-seqno\fP describes the portion of sequence space covered
1108 by the data in this packet (see example below).
1109 \fIAck\fP is sequence number of the next data expected the other
1110 direction on this connection.
1111 \fIWindow\fP is the number of bytes of receive buffer space available
1112 the other direction on this connection.
1113 \fIUrg\fP indicates there is `urgent' data in the packet.
1114 \fIOptions\fP are tcp options enclosed in angle brackets (e.g., <mss 1024>).
1115 .LP
1116 \fISrc, dst\fP and \fIflags\fP are always present.
1117 The other fields
1118 depend on the contents of the packet's tcp protocol header and
1119 are output only if appropriate.
1120 .LP
1121 Here is the opening portion of an rlogin from host \fIrtsg\fP to
1122 host \fIcsam\fP.
1123 .RS
1124 .nf
1125 .sp .5
1126 \s-2\f(CWrtsg.1023 > csam.login: S 768512:768512(0) win 4096 <mss 1024>
1127 csam.login > rtsg.1023: S 947648:947648(0) ack 768513 win 4096 <mss 1024>
1128 rtsg.1023 > csam.login: . ack 1 win 4096
1129 rtsg.1023 > csam.login: P 1:2(1) ack 1 win 4096
1130 csam.login > rtsg.1023: . ack 2 win 4096
1131 rtsg.1023 > csam.login: P 2:21(19) ack 1 win 4096
1132 csam.login > rtsg.1023: P 1:2(1) ack 21 win 4077
1133 csam.login > rtsg.1023: P 2:3(1) ack 21 win 4077 urg 1
1134 csam.login > rtsg.1023: P 3:4(1) ack 21 win 4077 urg 1\fR\s+2
1135 .sp .5
1136 .fi
1137 .RE
1138 The first line says that tcp port 1023 on rtsg sent a packet
1139 to port \fIlogin\fP
1140 on csam.
1141 The \fBS\fP indicates that the \fISYN\fP flag was set.
1142 The packet sequence number was 768512 and it contained no data.
1143 (The notation is `first:last(nbytes)' which means `sequence
1144 numbers \fIfirst\fP
1145 up to but not including \fIlast\fP which is \fInbytes\fP bytes of user data'.)
1146 There was no piggy-backed ack, the available receive window was 4096
1147 bytes and there was a max-segment-size option requesting an mss of
1148 1024 bytes.
1149 .LP
1150 Csam replies with a similar packet except it includes a piggy-backed
1151 ack for rtsg's SYN.
1152 Rtsg then acks csam's SYN.
1153 The `.' means the ACK flag was set.
1154 The packet contained no data so there is no data sequence number.
1155 Note that the ack sequence
1156 number is a small integer (1).
1157 The first time \fItcpdump\fP sees a
1158 tcp `conversation', it prints the sequence number from the packet.
1159 On subsequent packets of the conversation, the difference between
1160 the current packet's sequence number and this initial sequence number
1161 is printed.
1162 This means that sequence numbers after the
1163 first can be interpreted
1164 as relative byte positions in the conversation's data stream (with the
1165 first data byte each direction being `1').
1166 `-S' will override this
1167 feature, causing the original sequence numbers to be output.
1168 .LP
1169 On the 6th line, rtsg sends csam 19 bytes of data (bytes 2 through 20
1170 in the rtsg \(-> csam side of the conversation).
1171 The PUSH flag is set in the packet.
1172 On the 7th line, csam says it's received data sent by rtsg up to
1173 but not including byte 21.
1174 Most of this data is apparently sitting in the
1175 socket buffer since csam's receive window has gotten 19 bytes smaller.
1176 Csam also sends one byte of data to rtsg in this packet.
1177 On the 8th and 9th lines,
1178 csam sends two bytes of urgent, pushed data to rtsg.
1179 .LP
1180 If the snapshot was small enough that \fItcpdump\fP didn't capture
1181 the full TCP header, it interprets as much of the header as it can
1182 and then reports ``[|\fItcp\fP]'' to indicate the remainder could not
1183 be interpreted.
1184 If the header contains a bogus option (one with a length
1185 that's either too small or beyond the end of the header), \fItcpdump\fP
1186 reports it as ``[\fIbad opt\fP]'' and does not interpret any further
1187 options (since it's impossible to tell where they start).
1188 If the header
1189 length indicates options are present but the IP datagram length is not
1190 long enough for the options to actually be there, \fItcpdump\fP reports
1191 it as ``[\fIbad hdr length\fP]''.
1192 .HD
1193 .B Capturing TCP packets with particular flag combinations (SYN-ACK, URG-ACK, etc.)
1194 .PP
1195 There are 8 bits in the control bits section of the TCP header:
1196 .IP
1197 .I CWR | ECE | URG | ACK | PSH | RST | SYN | FIN
1198 .PP
1199 Let's assume that we want to watch packets used in establishing
1200 a TCP connection.
1201 Recall that TCP uses a 3-way handshake protocol
1202 when it initializes a new connection; the connection sequence with
1203 regard to the TCP control bits is
1204 .PP
1205 .RS
1206 1) Caller sends SYN
1207 .RE
1208 .RS
1209 2) Recipient responds with SYN, ACK
1210 .RE
1211 .RS
1212 3) Caller sends ACK
1213 .RE
1214 .PP
1215 Now we're interested in capturing packets that have only the
1216 SYN bit set (Step 1).
1217 Note that we don't want packets from step 2
1218 (SYN-ACK), just a plain initial SYN.
1219 What we need is a correct filter
1220 expression for \fItcpdump\fP.
1221 .PP
1222 Recall the structure of a TCP header without options:
1223 .PP
1224 .nf
1225  0                            15                              31
1226 -----------------------------------------------------------------
1227 |          source port          |       destination port        |
1228 -----------------------------------------------------------------
1229 |                        sequence number                        |
1230 -----------------------------------------------------------------
1231 |                     acknowledgment number                     |
1232 -----------------------------------------------------------------
1233 |  HL   | rsvd  |C|E|U|A|P|R|S|F|        window size            |
1234 -----------------------------------------------------------------
1235 |         TCP checksum          |       urgent pointer          |
1236 -----------------------------------------------------------------
1237 .fi
1238 .PP
1239 A TCP header usually holds 20 octets of data, unless options are
1240 present.
1241 The first line of the graph contains octets 0 - 3, the
1242 second line shows octets 4 - 7 etc.
1243 .PP
1244 Starting to count with 0, the relevant TCP control bits are contained
1245 in octet 13:
1246 .PP
1247 .nf
1248  0             7|             15|             23|             31
1249 ----------------|---------------|---------------|----------------
1250 |  HL   | rsvd  |C|E|U|A|P|R|S|F|        window size            |
1251 ----------------|---------------|---------------|----------------
1252 |               |  13th octet   |               |               |
1253 .fi
1254 .PP
1255 Let's have a closer look at octet no. 13:
1256 .PP
1257 .nf
1258                 |               |
1259                 |---------------|
1260                 |C|E|U|A|P|R|S|F|
1261                 |---------------|
1262                 |7   5   3     0|
1263 .fi
1264 .PP
1265 These are the TCP control bits we are interested
1266 in.
1267 We have numbered the bits in this octet from 0 to 7, right to
1268 left, so the PSH bit is bit number 3, while the URG bit is number 5.
1269 .PP
1270 Recall that we want to capture packets with only SYN set.
1271 Let's see what happens to octet 13 if a TCP datagram arrives
1272 with the SYN bit set in its header:
1273 .PP
1274 .nf
1275                 |C|E|U|A|P|R|S|F|
1276                 |---------------|
1277                 |0 0 0 0 0 0 1 0|
1278                 |---------------|
1279                 |7 6 5 4 3 2 1 0|
1280 .fi
1281 .PP
1282 Looking at the
1283 control bits section we see that only bit number 1 (SYN) is set.
1284 .PP
1285 Assuming that octet number 13 is an 8-bit unsigned integer in
1286 network byte order, the binary value of this octet is
1287 .IP
1288 00000010
1289 .PP
1290 and its decimal representation is
1291 .PP
1292 .nf
1293    7     6     5     4     3     2     1     0
1294 0*2 + 0*2 + 0*2 + 0*2 + 0*2 + 0*2 + 1*2 + 0*2  =  2
1295 .fi
1296 .PP
1297 We're almost done, because now we know that if only SYN is set,
1298 the value of the 13th octet in the TCP header, when interpreted
1299 as a 8-bit unsigned integer in network byte order, must be exactly 2.
1300 .PP
1301 This relationship can be expressed as
1302 .RS
1303 .B
1304 tcp[13] == 2
1305 .RE
1306 .PP
1307 We can use this expression as the filter for \fItcpdump\fP in order
1308 to watch packets which have only SYN set:
1309 .RS
1310 .B
1311 tcpdump -i xl0 tcp[13] == 2
1312 .RE
1313 .PP
1314 The expression says "let the 13th octet of a TCP datagram have
1315 the decimal value 2", which is exactly what we want.
1316 .PP
1317 Now, let's assume that we need to capture SYN packets, but we
1318 don't care if ACK or any other TCP control bit is set at the
1319 same time.
1320 Let's see what happens to octet 13 when a TCP datagram
1321 with SYN-ACK set arrives:
1322 .PP
1323 .nf
1324      |C|E|U|A|P|R|S|F|
1325      |---------------|
1326      |0 0 0 1 0 0 1 0|
1327      |---------------|
1328      |7 6 5 4 3 2 1 0|
1329 .fi
1330 .PP
1331 Now bits 1 and 4 are set in the 13th octet.
1332 The binary value of
1333 octet 13 is
1334 .IP
1335      00010010
1336 .PP
1337 which translates to decimal
1338 .PP
1339 .nf
1340    7     6     5     4     3     2     1     0
1341 0*2 + 0*2 + 0*2 + 1*2 + 0*2 + 0*2 + 1*2 + 0*2   = 18
1342 .fi
1343 .PP
1344 Now we can't just use 'tcp[13] == 18' in the \fItcpdump\fP filter
1345 expression, because that would select only those packets that have
1346 SYN-ACK set, but not those with only SYN set.
1347 Remember that we don't care
1348 if ACK or any other control bit is set as long as SYN is set.
1349 .PP
1350 In order to achieve our goal, we need to logically AND the
1351 binary value of octet 13 with some other value to preserve
1352 the SYN bit.
1353 We know that we want SYN to be set in any case,
1354 so we'll logically AND the value in the 13th octet with
1355 the binary value of a SYN:
1356 .PP
1357 .nf
1358
1359           00010010 SYN-ACK              00000010 SYN
1360      AND  00000010 (we want SYN)   AND  00000010 (we want SYN)
1361           --------                      --------
1362      =    00000010                 =    00000010
1363 .fi
1364 .PP
1365 We see that this AND operation delivers the same result
1366 regardless whether ACK or another TCP control bit is set.
1367 The decimal representation of the AND value as well as
1368 the result of this operation is 2 (binary 00000010),
1369 so we know that for packets with SYN set the following
1370 relation must hold true:
1371 .IP
1372 ( ( value of octet 13 ) AND ( 2 ) ) == ( 2 )
1373 .PP
1374 This points us to the \fItcpdump\fP filter expression
1375 .RS
1376 .B
1377      tcpdump -i xl0 'tcp[13] & 2 == 2'
1378 .RE
1379 .PP
1380 Some offsets and field values may be expressed as names
1381 rather than as numeric values. For example tcp[13] may
1382 be replaced with tcp[tcpflags]. The following TCP flag
1383 field values are also available: tcp-fin, tcp-syn, tcp-rst,
1384 tcp-push, tcp-act, tcp-urg.
1385 .PP
1386 This can be demonstrated as:
1387 .RS
1388 .B
1389      tcpdump -i xl0 'tcp[tcpflags] & tcp-push != 0'
1390 .RE
1391 .PP
1392 Note that you should use single quotes or a backslash
1393 in the expression to hide the AND ('&') special character
1394 from the shell.
1395 .HD
1396 .B
1397 UDP Packets
1398 .LP
1399 UDP format is illustrated by this rwho packet:
1400 .RS
1401 .nf
1402 .sp .5
1403 \f(CWactinide.who > broadcast.who: udp 84\fP
1404 .sp .5
1405 .fi
1406 .RE
1407 This says that port \fIwho\fP on host \fIactinide\fP sent a udp
1408 datagram to port \fIwho\fP on host \fIbroadcast\fP, the Internet
1409 broadcast address.
1410 The packet contained 84 bytes of user data.
1411 .LP
1412 Some UDP services are recognized (from the source or destination
1413 port number) and the higher level protocol information printed.
1414 In particular, Domain Name service requests (RFC-1034/1035) and Sun
1415 RPC calls (RFC-1050) to NFS.
1416 .HD
1417 UDP Name Server Requests
1418 .LP
1419 \fI(N.B.:The following description assumes familiarity with
1420 the Domain Service protocol described in RFC-1035.
1421 If you are not familiar
1422 with the protocol, the following description will appear to be written
1423 in greek.)\fP
1424 .LP
1425 Name server requests are formatted as
1426 .RS
1427 .nf
1428 .sp .5
1429 \fIsrc > dst: id op? flags qtype qclass name (len)\fP
1430 .sp .5
1431 \f(CWh2opolo.1538 > helios.domain: 3+ A? ucbvax.berkeley.edu. (37)\fR
1432 .sp .5
1433 .fi
1434 .RE
1435 Host \fIh2opolo\fP asked the domain server on \fIhelios\fP for an
1436 address record (qtype=A) associated with the name \fIucbvax.berkeley.edu.\fP
1437 The query id was `3'.
1438 The `+' indicates the \fIrecursion desired\fP flag
1439 was set.
1440 The query length was 37 bytes, not including the UDP and
1441 IP protocol headers.
1442 The query operation was the normal one, \fIQuery\fP,
1443 so the op field was omitted.
1444 If the op had been anything else, it would
1445 have been printed between the `3' and the `+'.
1446 Similarly, the qclass was the normal one,
1447 \fIC_IN\fP, and omitted.
1448 Any other qclass would have been printed
1449 immediately after the `A'.
1450 .LP
1451 A few anomalies are checked and may result in extra fields enclosed in
1452 square brackets:  If a query contains an answer, authority records or
1453 additional records section,
1454 .IR ancount ,
1455 .IR nscount ,
1456 or
1457 .I arcount
1458 are printed as `[\fIn\fPa]', `[\fIn\fPn]' or  `[\fIn\fPau]' where \fIn\fP
1459 is the appropriate count.
1460 If any of the response bits are set (AA, RA or rcode) or any of the
1461 `must be zero' bits are set in bytes two and three, `[b2&3=\fIx\fP]'
1462 is printed, where \fIx\fP is the hex value of header bytes two and three.
1463 .HD
1464 UDP Name Server Responses
1465 .LP
1466 Name server responses are formatted as
1467 .RS
1468 .nf
1469 .sp .5
1470 \fIsrc > dst:  id op rcode flags a/n/au type class data (len)\fP
1471 .sp .5
1472 \f(CWhelios.domain > h2opolo.1538: 3 3/3/7 A 128.32.137.3 (273)
1473 helios.domain > h2opolo.1537: 2 NXDomain* 0/1/0 (97)\fR
1474 .sp .5
1475 .fi
1476 .RE
1477 In the first example, \fIhelios\fP responds to query id 3 from \fIh2opolo\fP
1478 with 3 answer records, 3 name server records and 7 additional records.
1479 The first answer record is type A (address) and its data is internet
1480 address 128.32.137.3.
1481 The total size of the response was 273 bytes,
1482 excluding UDP and IP headers.
1483 The op (Query) and response code
1484 (NoError) were omitted, as was the class (C_IN) of the A record.
1485 .LP
1486 In the second example, \fIhelios\fP responds to query 2 with a
1487 response code of non-existent domain (NXDomain) with no answers,
1488 one name server and no authority records.
1489 The `*' indicates that
1490 the \fIauthoritative answer\fP bit was set.
1491 Since there were no
1492 answers, no type, class or data were printed.
1493 .LP
1494 Other flag characters that might appear are `\-' (recursion available,
1495 RA, \fInot\fP set) and `|' (truncated message, TC, set).
1496 If the
1497 `question' section doesn't contain exactly one entry, `[\fIn\fPq]'
1498 is printed.
1499 .HD
1500 SMB/CIFS decoding
1501 .LP
1502 \fItcpdump\fP now includes fairly extensive SMB/CIFS/NBT decoding for data
1503 on UDP/137, UDP/138 and TCP/139.
1504 Some primitive decoding of IPX and
1505 NetBEUI SMB data is also done.
1506 .LP
1507 By default a fairly minimal decode is done, with a much more detailed
1508 decode done if -v is used.
1509 Be warned that with -v a single SMB packet
1510 may take up a page or more, so only use -v if you really want all the
1511 gory details.
1512 .LP
1513 For information on SMB packet formats and what all the fields mean see
1514 www.cifs.org or the pub/samba/specs/ directory on your favorite
1515 samba.org mirror site.
1516 The SMB patches were written by Andrew Tridgell
1517 (tridge@samba.org).
1518 .HD
1519 NFS Requests and Replies
1520 .LP
1521 Sun NFS (Network File System) requests and replies are printed as:
1522 .RS
1523 .nf
1524 .sp .5
1525 \fIsrc.sport > dst.nfs: NFS request xid xid len op args\fP
1526 \fIsrc.nfs > dst.dport: NFS reply xid xid reply stat len op results\fP
1527 .sp .5
1528 \f(CW
1529 sushi.1023 > wrl.nfs: NFS request xid 26377
1530         112 readlink fh 21,24/10.73165
1531 wrl.nfs > sushi.1023: NFS reply xid 26377
1532         reply ok 40 readlink "../var"
1533 sushi.1022 > wrl.nfs: NFS request xid 8219
1534         144 lookup fh 9,74/4096.6878 "xcolors"
1535 wrl.nfs > sushi.1022: NFS reply xid 8219
1536         reply ok 128 lookup fh 9,74/4134.3150
1537 \fR
1538 .sp .5
1539 .fi
1540 .RE
1541 In the first line, host \fIsushi\fP sends a transaction with id \fI26377\fP
1542 to \fIwrl\fP.
1543 The request was 112 bytes,
1544 excluding the UDP and IP headers.
1545 The operation was a \fIreadlink\fP
1546 (read symbolic link) on file handle (\fIfh\fP) 21,24/10.731657119.
1547 (If one is lucky, as in this case, the file handle can be interpreted
1548 as a major,minor device number pair, followed by the inode number and
1549 generation number.) In the second line, \fIwrl\fP replies `ok' with
1550 the same transaction id and the contents of the link.
1551 .LP
1552 In the third line, \fIsushi\fP asks (using a new transaction id) \fIwrl\fP
1553 to lookup the name `\fIxcolors\fP' in directory file 9,74/4096.6878. In
1554 the fourth line, \fIwrl\fP sends a reply with the respective transaction id.
1555 .LP
1556 Note that the data printed
1557 depends on the operation type.
1558 The format is intended to be self
1559 explanatory if read in conjunction with
1560 an NFS protocol spec.
1561 Also note that older versions of tcpdump printed NFS packets in a
1562 slightly different format: the transaction id (xid) would be printed
1563 instead of the non-NFS port number of the packet.
1564 .LP
1565 If the \-v (verbose) flag is given, additional information is printed.
1566 For example:
1567 .RS
1568 .nf
1569 .sp .5
1570 \f(CW
1571 sushi.1023 > wrl.nfs: NFS request xid 79658
1572         148 read fh 21,11/12.195 8192 bytes @ 24576
1573 wrl.nfs > sushi.1023: NFS reply xid 79658
1574         reply ok 1472 read REG 100664 ids 417/0 sz 29388
1575 \fP
1576 .sp .5
1577 .fi
1578 .RE
1579 (\-v also prints the IP header TTL, ID, length, and fragmentation fields,
1580 which have been omitted from this example.)  In the first line,
1581 \fIsushi\fP asks \fIwrl\fP to read 8192 bytes from file 21,11/12.195,
1582 at byte offset 24576.
1583 \fIWrl\fP replies `ok'; the packet shown on the
1584 second line is the first fragment of the reply, and hence is only 1472
1585 bytes long (the other bytes will follow in subsequent fragments, but
1586 these fragments do not have NFS or even UDP headers and so might not be
1587 printed, depending on the filter expression used).
1588 Because the \-v flag
1589 is given, some of the file attributes (which are returned in addition
1590 to the file data) are printed: the file type (``REG'', for regular file),
1591 the file mode (in octal), the uid and gid, and the file size.
1592 .LP
1593 If the \-v flag is given more than once, even more details are printed.
1594 .LP
1595 Note that NFS requests are very large and much of the detail won't be printed
1596 unless \fIsnaplen\fP is increased.
1597 Try using `\fB\-s 192\fP' to watch
1598 NFS traffic.
1599 .LP
1600 NFS reply packets do not explicitly identify the RPC operation.
1601 Instead,
1602 \fItcpdump\fP keeps track of ``recent'' requests, and matches them to the
1603 replies using the transaction ID.
1604 If a reply does not closely follow the
1605 corresponding request, it might not be parsable.
1606 .HD
1607 AFS Requests and Replies
1608 .LP
1609 Transarc AFS (Andrew File System) requests and replies are printed
1610 as:
1611 .HD
1612 .RS
1613 .nf
1614 .sp .5
1615 \fIsrc.sport > dst.dport: rx packet-type\fP
1616 \fIsrc.sport > dst.dport: rx packet-type service call call-name args\fP
1617 \fIsrc.sport > dst.dport: rx packet-type service reply call-name args\fP
1618 .sp .5
1619 \f(CW
1620 elvis.7001 > pike.afsfs:
1621         rx data fs call rename old fid 536876964/1/1 ".newsrc.new"
1622         new fid 536876964/1/1 ".newsrc"
1623 pike.afsfs > elvis.7001: rx data fs reply rename
1624 \fR
1625 .sp .5
1626 .fi
1627 .RE
1628 In the first line, host elvis sends a RX packet to pike.
1629 This was
1630 a RX data packet to the fs (fileserver) service, and is the start of
1631 an RPC call.
1632 The RPC call was a rename, with the old directory file id
1633 of 536876964/1/1 and an old filename of `.newsrc.new', and a new directory
1634 file id of 536876964/1/1 and a new filename of `.newsrc'.
1635 The host pike
1636 responds with a RPC reply to the rename call (which was successful, because
1637 it was a data packet and not an abort packet).
1638 .LP
1639 In general, all AFS RPCs are decoded at least by RPC call name.
1640 Most
1641 AFS RPCs have at least some of the arguments decoded (generally only
1642 the `interesting' arguments, for some definition of interesting).
1643 .LP
1644 The format is intended to be self-describing, but it will probably
1645 not be useful to people who are not familiar with the workings of
1646 AFS and RX.
1647 .LP
1648 If the -v (verbose) flag is given twice, acknowledgement packets and
1649 additional header information is printed, such as the RX call ID,
1650 call number, sequence number, serial number, and the RX packet flags.
1651 .LP
1652 If the -v flag is given twice, additional information is printed,
1653 such as the RX call ID, serial number, and the RX packet flags.
1654 The MTU negotiation information is also printed from RX ack packets.
1655 .LP
1656 If the -v flag is given three times, the security index and service id
1657 are printed.
1658 .LP
1659 Error codes are printed for abort packets, with the exception of Ubik
1660 beacon packets (because abort packets are used to signify a yes vote
1661 for the Ubik protocol).
1662 .LP
1663 Note that AFS requests are very large and many of the arguments won't
1664 be printed unless \fIsnaplen\fP is increased.
1665 Try using `\fB-s 256\fP'
1666 to watch AFS traffic.
1667 .LP
1668 AFS reply packets do not explicitly identify the RPC operation.
1669 Instead,
1670 \fItcpdump\fP keeps track of ``recent'' requests, and matches them to the
1671 replies using the call number and service ID.
1672 If a reply does not closely
1673 follow the
1674 corresponding request, it might not be parsable.
1675
1676 .HD
1677 KIP AppleTalk (DDP in UDP)
1678 .LP
1679 AppleTalk DDP packets encapsulated in UDP datagrams are de-encapsulated
1680 and dumped as DDP packets (i.e., all the UDP header information is
1681 discarded).
1682 The file
1683 .I /etc/atalk.names
1684 is used to translate AppleTalk net and node numbers to names.
1685 Lines in this file have the form
1686 .RS
1687 .nf
1688 .sp .5
1689 \fInumber       name\fP
1690
1691 \f(CW1.254              ether
1692 16.1            icsd-net
1693 1.254.110       ace\fR
1694 .sp .5
1695 .fi
1696 .RE
1697 The first two lines give the names of AppleTalk networks.
1698 The third
1699 line gives the name of a particular host (a host is distinguished
1700 from a net by the 3rd octet in the number \-
1701 a net number \fImust\fP have two octets and a host number \fImust\fP
1702 have three octets.)  The number and name should be separated by
1703 whitespace (blanks or tabs).
1704 The
1705 .I /etc/atalk.names
1706 file may contain blank lines or comment lines (lines starting with
1707 a `#').
1708 .LP
1709 AppleTalk addresses are printed in the form
1710 .RS
1711 .nf
1712 .sp .5
1713 \fInet.host.port\fP
1714
1715 \f(CW144.1.209.2 > icsd-net.112.220
1716 office.2 > icsd-net.112.220
1717 jssmag.149.235 > icsd-net.2\fR
1718 .sp .5
1719 .fi
1720 .RE
1721 (If the
1722 .I /etc/atalk.names
1723 doesn't exist or doesn't contain an entry for some AppleTalk
1724 host/net number, addresses are printed in numeric form.)
1725 In the first example, NBP (DDP port 2) on net 144.1 node 209
1726 is sending to whatever is listening on port 220 of net icsd node 112.
1727 The second line is the same except the full name of the source node
1728 is known (`office').
1729 The third line is a send from port 235 on
1730 net jssmag node 149 to broadcast on the icsd-net NBP port (note that
1731 the broadcast address (255) is indicated by a net name with no host
1732 number \- for this reason it's a good idea to keep node names and
1733 net names distinct in /etc/atalk.names).
1734 .LP
1735 NBP (name binding protocol) and ATP (AppleTalk transaction protocol)
1736 packets have their contents interpreted.
1737 Other protocols just dump
1738 the protocol name (or number if no name is registered for the
1739 protocol) and packet size.
1740
1741 \fBNBP packets\fP are formatted like the following examples:
1742 .RS
1743 .nf
1744 .sp .5
1745 \s-2\f(CWicsd-net.112.220 > jssmag.2: nbp-lkup 190: "=:LaserWriter@*"
1746 jssmag.209.2 > icsd-net.112.220: nbp-reply 190: "RM1140:LaserWriter@*" 250
1747 techpit.2 > icsd-net.112.220: nbp-reply 190: "techpit:LaserWriter@*" 186\fR\s+2
1748 .sp .5
1749 .fi
1750 .RE
1751 The first line is a name lookup request for laserwriters sent by net icsd host
1752 112 and broadcast on net jssmag.
1753 The nbp id for the lookup is 190.
1754 The second line shows a reply for this request (note that it has the
1755 same id) from host jssmag.209 saying that it has a laserwriter
1756 resource named "RM1140" registered on port 250.
1757 The third line is
1758 another reply to the same request saying host techpit has laserwriter
1759 "techpit" registered on port 186.
1760
1761 \fBATP packet\fP formatting is demonstrated by the following example:
1762 .RS
1763 .nf
1764 .sp .5
1765 \s-2\f(CWjssmag.209.165 > helios.132: atp-req  12266<0-7> 0xae030001
1766 helios.132 > jssmag.209.165: atp-resp 12266:0 (512) 0xae040000
1767 helios.132 > jssmag.209.165: atp-resp 12266:1 (512) 0xae040000
1768 helios.132 > jssmag.209.165: atp-resp 12266:2 (512) 0xae040000
1769 helios.132 > jssmag.209.165: atp-resp 12266:3 (512) 0xae040000
1770 helios.132 > jssmag.209.165: atp-resp 12266:4 (512) 0xae040000
1771 helios.132 > jssmag.209.165: atp-resp 12266:5 (512) 0xae040000
1772 helios.132 > jssmag.209.165: atp-resp 12266:6 (512) 0xae040000
1773 helios.132 > jssmag.209.165: atp-resp*12266:7 (512) 0xae040000
1774 jssmag.209.165 > helios.132: atp-req  12266<3,5> 0xae030001
1775 helios.132 > jssmag.209.165: atp-resp 12266:3 (512) 0xae040000
1776 helios.132 > jssmag.209.165: atp-resp 12266:5 (512) 0xae040000
1777 jssmag.209.165 > helios.132: atp-rel  12266<0-7> 0xae030001
1778 jssmag.209.133 > helios.132: atp-req* 12267<0-7> 0xae030002\fR\s+2
1779 .sp .5
1780 .fi
1781 .RE
1782 Jssmag.209 initiates transaction id 12266 with host helios by requesting
1783 up to 8 packets (the `<0-7>').
1784 The hex number at the end of the line
1785 is the value of the `userdata' field in the request.
1786 .LP
1787 Helios responds with 8 512-byte packets.
1788 The `:digit' following the
1789 transaction id gives the packet sequence number in the transaction
1790 and the number in parens is the amount of data in the packet,
1791 excluding the atp header.
1792 The `*' on packet 7 indicates that the
1793 EOM bit was set.
1794 .LP
1795 Jssmag.209 then requests that packets 3 & 5 be retransmitted.
1796 Helios
1797 resends them then jssmag.209 releases the transaction.
1798 Finally,
1799 jssmag.209 initiates the next request.
1800 The `*' on the request
1801 indicates that XO (`exactly once') was \fInot\fP set.
1802
1803 .HD
1804 IP Fragmentation
1805 .LP
1806 Fragmented Internet datagrams are printed as
1807 .RS
1808 .nf
1809 .sp .5
1810 \fB(frag \fIid\fB:\fIsize\fB@\fIoffset\fB+)\fR
1811 \fB(frag \fIid\fB:\fIsize\fB@\fIoffset\fB)\fR
1812 .sp .5
1813 .fi
1814 .RE
1815 (The first form indicates there are more fragments.
1816 The second
1817 indicates this is the last fragment.)
1818 .LP
1819 \fIId\fP is the fragment id.
1820 \fISize\fP is the fragment
1821 size (in bytes) excluding the IP header.
1822 \fIOffset\fP is this
1823 fragment's offset (in bytes) in the original datagram.
1824 .LP
1825 The fragment information is output for each fragment.
1826 The first
1827 fragment contains the higher level protocol header and the frag
1828 info is printed after the protocol info.
1829 Fragments
1830 after the first contain no higher level protocol header and the
1831 frag info is printed after the source and destination addresses.
1832 For example, here is part of an ftp from arizona.edu to lbl-rtsg.arpa
1833 over a CSNET connection that doesn't appear to handle 576 byte datagrams:
1834 .RS
1835 .nf
1836 .sp .5
1837 \s-2\f(CWarizona.ftp-data > rtsg.1170: . 1024:1332(308) ack 1 win 4096 (frag 595a:328@0+)
1838 arizona > rtsg: (frag 595a:204@328)
1839 rtsg.1170 > arizona.ftp-data: . ack 1536 win 2560\fP\s+2
1840 .sp .5
1841 .fi
1842 .RE
1843 There are a couple of things to note here:  First, addresses in the
1844 2nd line don't include port numbers.
1845 This is because the TCP
1846 protocol information is all in the first fragment and we have no idea
1847 what the port or sequence numbers are when we print the later fragments.
1848 Second, the tcp sequence information in the first line is printed as if there
1849 were 308 bytes of user data when, in fact, there are 512 bytes (308 in
1850 the first frag and 204 in the second).
1851 If you are looking for holes
1852 in the sequence space or trying to match up acks
1853 with packets, this can fool you.
1854 .LP
1855 A packet with the IP \fIdon't fragment\fP flag is marked with a
1856 trailing \fB(DF)\fP.
1857 .HD
1858 Timestamps
1859 .LP
1860 By default, all output lines are preceded by a timestamp.
1861 The timestamp
1862 is the current clock time in the form
1863 .RS
1864 .nf
1865 \fIhh:mm:ss.frac\fP
1866 .fi
1867 .RE
1868 and is as accurate as the kernel's clock.
1869 The timestamp reflects the time the kernel first saw the packet.
1870 No attempt
1871 is made to account for the time lag between when the
1872 Ethernet interface removed the packet from the wire and when the kernel
1873 serviced the `new packet' interrupt.
1874 .SH "SEE ALSO"
1875 stty(1), pcap(3PCAP), bpf(4), nit(4P), pcap-savefile(5),
1876 pcap-filter(7), pcap-tstamp(7)
1877 .LP
1878 .RS
1879 .I http://www.iana.org/assignments/media-types/application/vnd.tcpdump.pcap
1880 .RE
1881 .LP
1882 .SH AUTHORS
1883 The original authors are:
1884 .LP
1885 Van Jacobson,
1886 Craig Leres and
1887 Steven McCanne, all of the
1888 Lawrence Berkeley National Laboratory, University of California, Berkeley, CA.
1889 .LP
1890 It is currently being maintained by tcpdump.org.
1891 .LP
1892 The current version is available via http:
1893 .LP
1894 .RS
1895 .I http://www.tcpdump.org/
1896 .RE
1897 .LP
1898 The original distribution is available via anonymous ftp:
1899 .LP
1900 .RS
1901 .I ftp://ftp.ee.lbl.gov/old/tcpdump.tar.Z
1902 .RE
1903 .LP
1904 IPv6/IPsec support is added by WIDE/KAME project.
1905 This program uses Eric Young's SSLeay library, under specific configurations.
1906 .SH BUGS
1907 Please send problems, bugs, questions, desirable enhancements, patches
1908 etc. to:
1909 .LP
1910 .RS
1911 tcpdump-workers@lists.tcpdump.org
1912 .RE
1913 .LP
1914 NIT doesn't let you watch your own outbound traffic, BPF will.
1915 We recommend that you use the latter.
1916 .LP
1917 On Linux systems with 2.0[.x] kernels:
1918 .IP
1919 packets on the loopback device will be seen twice;
1920 .IP
1921 packet filtering cannot be done in the kernel, so that all packets must
1922 be copied from the kernel in order to be filtered in user mode;
1923 .IP
1924 all of a packet, not just the part that's within the snapshot length,
1925 will be copied from the kernel (the 2.0[.x] packet capture mechanism, if
1926 asked to copy only part of a packet to userland, will not report the
1927 true length of the packet; this would cause most IP packets to get an
1928 error from
1929 .BR tcpdump );
1930 .IP
1931 capturing on some PPP devices won't work correctly.
1932 .LP
1933 We recommend that you upgrade to a 2.2 or later kernel.
1934 .LP
1935 Some attempt should be made to reassemble IP fragments or, at least
1936 to compute the right length for the higher level protocol.
1937 .LP
1938 Name server inverse queries are not dumped correctly: the (empty)
1939 question section is printed rather than real query in the answer
1940 section.
1941 Some believe that inverse queries are themselves a bug and
1942 prefer to fix the program generating them rather than \fItcpdump\fP.
1943 .LP
1944 A packet trace that crosses a daylight savings time change will give
1945 skewed time stamps (the time change is ignored).
1946 .LP
1947 Filter expressions on fields other than those in Token Ring headers will
1948 not correctly handle source-routed Token Ring packets.
1949 .LP
1950 Filter expressions on fields other than those in 802.11 headers will not
1951 correctly handle 802.11 data packets with both To DS and From DS set.
1952 .LP
1953 .BR "ip6 proto"
1954 should chase header chain, but at this moment it does not.
1955 .BR "ip6 protochain"
1956 is supplied for this behavior.
1957 .LP
1958 Arithmetic expression against transport layer headers, like \fBtcp[0]\fP,
1959 does not work against IPv6 packets.
1960 It only looks at IPv4 packets.