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