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