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