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