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