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