1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY wireshark-download-http "http://www.wireshark.org/download/src/all-versions/wireshark-&wireshark-version;.tar.bz2">
|
---|
8 | <!ENTITY wireshark-download-ftp " ">
|
---|
9 | <!ENTITY wireshark-md5sum "d8915cf7555e2bbb699020a8736631e7">
|
---|
10 | <!ENTITY wireshark-size "26 MB">
|
---|
11 | <!ENTITY wireshark-buildsize "1.1 GB">
|
---|
12 | <!ENTITY wireshark-time "6.6 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="wireshark" xreflabel="Wireshark-&wireshark-version;">
|
---|
16 | <?dbhtml filename="wireshark.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Wireshark-&wireshark-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="wireshark">
|
---|
26 | <primary sortas="a-Wireshark">Wireshark</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Wireshark</title>
|
---|
31 |
|
---|
32 | <para>The <application>Wireshark</application> package contains a network
|
---|
33 | protocol analyzer, also known as a <quote>sniffer</quote>. This is useful
|
---|
34 | for analyzing data captured <quote>off the wire</quote> from a live network
|
---|
35 | connection, or data read from a capture file.
|
---|
36 | <application>Wireshark</application> provides both a graphical and a TTY-mode
|
---|
37 | front-end for examining captured network packets from over 500 protocols,
|
---|
38 | as well as the capability to read capture files from many other popular
|
---|
39 | network analyzers.</para>
|
---|
40 |
|
---|
41 | &lfs73_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>Download (HTTP): <ulink url="&wireshark-download-http;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download (FTP): <ulink url="&wireshark-download-ftp;"/></para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download MD5 sum: &wireshark-md5sum;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Download size: &wireshark-size;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated disk space required: &wireshark-buildsize;</para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Estimated build time: &wireshark-time;</para>
|
---|
62 | </listitem>
|
---|
63 | </itemizedlist>
|
---|
64 |
|
---|
65 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
66 | <itemizedlist spacing="compact">
|
---|
67 | <listitem>
|
---|
68 | <para>Additional Documentation:
|
---|
69 | <ulink url="http://www.wireshark.org/download/docs/"/>
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <para>From this page you can download many different docs in a variety
|
---|
75 | of formats.</para>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect3">Wireshark dependencies</bridgehead>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
80 | <para role="required">
|
---|
81 | <xref linkend="glib2"/> (to build the TTY-mode front-end only)
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | <para>Note that if you don't have <application>Gtk+</application>
|
---|
85 | installed, you will need to pass <option>--disable-wireshark</option>
|
---|
86 | to the <command>configure</command> command.</para>
|
---|
87 |
|
---|
88 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
89 | <para role="recommended">
|
---|
90 | <xref linkend="libpcap"/> (required to capture data)
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
94 | <para role="optional">
|
---|
95 | <xref linkend="pkgconfig"/>,
|
---|
96 | <xref linkend="gtk2"/> or <xref linkend="gtk3"/> (to build the GUI front-end),
|
---|
97 | <xref linkend="openssl"/>,
|
---|
98 | <xref linkend="mitkrb"/>,
|
---|
99 | <xref linkend="python2"/>,
|
---|
100 | <xref linkend="pcre"/>,
|
---|
101 | <xref linkend="gnutls"/>,
|
---|
102 | <ulink url="http://www.portaudio.com/download.html">PortAudio</ulink>,
|
---|
103 | <ulink url="http://www.maxmind.com/app/c">GeoIP</ulink>,
|
---|
104 | <!-- <ulink url="http://www.net-snmp.org/">Net-SNMP</ulink>, -->
|
---|
105 | <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink>, and
|
---|
106 | <xref linkend="lua"/>
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <para condition="html" role="usernotes">User Notes:
|
---|
110 | <ulink url="&blfs-wiki;/wireshark"/></para>
|
---|
111 |
|
---|
112 | </sect2>
|
---|
113 |
|
---|
114 | <sect2 role="kernel" id="wireshark-kernel">
|
---|
115 | <title>Kernel Configuration</title>
|
---|
116 |
|
---|
117 | <para>The kernel must have the Packet protocol enabled for
|
---|
118 | <application>Wireshark</application> to capture live packets from the
|
---|
119 | network.</para>
|
---|
120 |
|
---|
121 | <screen><literal>Networking support: Y
|
---|
122 | Networking options:
|
---|
123 | Packet: sockets monitoring interface: M or Y</literal></screen>
|
---|
124 |
|
---|
125 | <para>If built as a module, the name is
|
---|
126 | <filename>af_packet.ko</filename>.</para>
|
---|
127 |
|
---|
128 | <indexterm zone="wireshark wireshark-kernel">
|
---|
129 | <primary sortas="d-Capturing-network-packets">Capturing network
|
---|
130 | packets</primary>
|
---|
131 | </indexterm>
|
---|
132 |
|
---|
133 | </sect2>
|
---|
134 |
|
---|
135 | <sect2 role="installation">
|
---|
136 | <title>Installation of Wireshark</title>
|
---|
137 |
|
---|
138 | <para>Optionally, fix the description of the program in the title.
|
---|
139 | The first change overwrites the default "SVN Unknown" in the title
|
---|
140 | and the secong overwrites a utility script that resets the version
|
---|
141 | to "unknown".</para>
|
---|
142 |
|
---|
143 | <screen><userinput>cat > svnversion.h << "EOF"
|
---|
144 | #define SVNVERSION "BLFS"
|
---|
145 | #define SVNPATH "source"
|
---|
146 | EOF
|
---|
147 |
|
---|
148 | cat > make-version.pl << "EOF"
|
---|
149 | #!/usr/bin/perl
|
---|
150 | EOF</userinput></screen>
|
---|
151 |
|
---|
152 | <para><application>Wireshark</application> is a very large and complex
|
---|
153 | application. These instructions provide additional security measures to
|
---|
154 | ensure that only trusted users are allowed to view network traffic. First,
|
---|
155 | set up a system group for wireshark. As the <systemitem
|
---|
156 | class="username">root</systemitem> user:</para>
|
---|
157 |
|
---|
158 | <screen role="root"><userinput>groupadd -g 62 wireshark</userinput></screen>
|
---|
159 |
|
---|
160 | <para>There is one issues that prevents the build from completing
|
---|
161 | when generating the man pages. Fix it up with:</para>
|
---|
162 |
|
---|
163 | <screen><userinput>sed -i '/=item/s/$/\n\n=back/' doc/reordercap.pod</userinput></screen>
|
---|
164 |
|
---|
165 | <para>Continue to install <application>Wireshark</application> by running
|
---|
166 | the following commands:</para>
|
---|
167 |
|
---|
168 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
169 | make</userinput></screen>
|
---|
170 |
|
---|
171 | <para>This package does not come with a test suite.</para>
|
---|
172 |
|
---|
173 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
174 |
|
---|
175 | <screen role="root"><userinput>make install &&
|
---|
176 |
|
---|
177 | install -v -m755 -d /usr/share/doc/wireshark-&wireshark-version; &&
|
---|
178 | install -v -m755 -d /usr/share/pixmaps/wireshark &&
|
---|
179 |
|
---|
180 | install -v -m644 README{,.linux} doc/README.* doc/*.{pod,txt} \
|
---|
181 | /usr/share/doc/wireshark-&wireshark-version; &&
|
---|
182 |
|
---|
183 | pushd /usr/share/doc/wireshark-&wireshark-version; &&
|
---|
184 | for FILENAME in ../../wireshark/*.html; do
|
---|
185 | ln -s -v $FILENAME .
|
---|
186 | done &&
|
---|
187 | popd &&
|
---|
188 |
|
---|
189 | install -v -m644 -D wireshark.desktop \
|
---|
190 | /usr/share/applications/wireshark.desktop &&
|
---|
191 |
|
---|
192 | install -v -m644 -D image/wsicon48.png \
|
---|
193 | /usr/share/pixmaps/wireshark.png &&
|
---|
194 |
|
---|
195 | install -v -m644 image/*.{png,ico,xpm,bmp} \
|
---|
196 | /usr/share/pixmaps/wireshark</userinput></screen>
|
---|
197 |
|
---|
198 | <para>If you downloaded any of the documentation files from the page
|
---|
199 | listed in the 'Additional Downloads', install them by issuing the following
|
---|
200 | commands as the <systemitem class="username">root</systemitem> user:</para>
|
---|
201 |
|
---|
202 | <screen role="root"><userinput>install -v -m644 <replaceable><Downloaded_Files></replaceable> /usr/share/doc/wireshark-&wireshark-version;</userinput></screen>
|
---|
203 |
|
---|
204 | <para>Now, set ownership and permissions of sensitive applications to
|
---|
205 | only allow authorized users. As the <systemitem
|
---|
206 | class="username">root</systemitem> user:</para>
|
---|
207 |
|
---|
208 | <screen role="root"><userinput>chown -v root:wireshark /usr/bin/{tshark,dumpcap} &&
|
---|
209 | chmod -v 6550 /usr/bin/{tshark,dumpcap}</userinput></screen>
|
---|
210 |
|
---|
211 | <para>Finally, add any users to the wireshark group with <userinput>usermod -a -G
|
---|
212 | wireshark <username></userinput>.</para>
|
---|
213 |
|
---|
214 | </sect2>
|
---|
215 |
|
---|
216 | <sect2 role="commands">
|
---|
217 | <title>Command Explanations</title>
|
---|
218 |
|
---|
219 | <para><parameter>--enable-threads</parameter>: This parameter enables the
|
---|
220 | use of threads in <command>wireshark</command>.</para>
|
---|
221 |
|
---|
222 | <para><option>--with-ssl</option>: This parameter is required if you
|
---|
223 | are linking Kerberos libraries into the build so that the
|
---|
224 | <application>OpenSSL</application>
|
---|
225 | <filename class='libraryfile'>libcrypto</filename> library is found.</para>
|
---|
226 |
|
---|
227 | <para><option>--with-python</option>: This parameter is required if you
|
---|
228 | want Python bindings built.</para>
|
---|
229 |
|
---|
230 | </sect2>
|
---|
231 |
|
---|
232 | <sect2 role="configuration">
|
---|
233 | <title>Configuring Wireshark</title>
|
---|
234 |
|
---|
235 | <sect3 id="wireshark-config">
|
---|
236 | <title>Config Files</title>
|
---|
237 |
|
---|
238 | <para><filename>/etc/wireshark.conf</filename> and
|
---|
239 | <filename>~/.wireshark/*</filename></para>
|
---|
240 |
|
---|
241 | <indexterm zone="wireshark wireshark-config">
|
---|
242 | <primary sortas="e-AA.wireshark-star">~/.wireshark/*</primary>
|
---|
243 | </indexterm>
|
---|
244 |
|
---|
245 | <indexterm zone="wireshark wireshark-config">
|
---|
246 | <primary sortas="e-etc-wireshark.conf">/etc/wireshark.conf</primary>
|
---|
247 | </indexterm>
|
---|
248 |
|
---|
249 | </sect3>
|
---|
250 |
|
---|
251 | <sect3>
|
---|
252 | <title>Configuration Information</title>
|
---|
253 |
|
---|
254 | <para>Though the default configuration parameters are very sane,
|
---|
255 | reference the configuration section of the
|
---|
256 | <ulink url="http://www.wireshark.org/docs/wsug_html/">Wireshark User's
|
---|
257 | Guide</ulink> for configuration information. Most of
|
---|
258 | <application>Wireshark</application>'s configuration can be accomplished
|
---|
259 | using the menu options of the <command>wireshark</command>
|
---|
260 | graphical interface.</para>
|
---|
261 |
|
---|
262 | <note>
|
---|
263 | <para>If you want to look at packets, make sure you don't filter
|
---|
264 | them out with <xref linkend="iptables"/>. If you want to exclude
|
---|
265 | certain classes of packets, it is more efficient to do it with
|
---|
266 | <application>iptables</application> than it is with
|
---|
267 | <application>Wireshark</application>.</para>
|
---|
268 | </note>
|
---|
269 |
|
---|
270 | </sect3>
|
---|
271 |
|
---|
272 | </sect2>
|
---|
273 |
|
---|
274 | <sect2 role="content">
|
---|
275 | <title>Contents</title>
|
---|
276 |
|
---|
277 | <segmentedlist>
|
---|
278 | <segtitle>Installed Programs</segtitle>
|
---|
279 | <segtitle>Installed Libraries</segtitle>
|
---|
280 | <segtitle>Installed Directories</segtitle>
|
---|
281 |
|
---|
282 | <seglistitem>
|
---|
283 | <seg>capinfos, dftest, dumpcap, editcap, idl2wrs, mergecap, randpkt,
|
---|
284 | rawshark, text2pcap, tshark, and wireshark</seg>
|
---|
285 | <seg>libwireshark.so, libwiretap.so, libwsutil.so, and
|
---|
286 | numerous plugin modules</seg>
|
---|
287 | <seg>/usr/lib/wireshark, /usr/share/doc/wireshark-&wireshark-version;,
|
---|
288 | /usr/share/pixmaps/wireshark, and /usr/share/wireshark</seg>
|
---|
289 | </seglistitem>
|
---|
290 | </segmentedlist>
|
---|
291 |
|
---|
292 | <variablelist>
|
---|
293 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
294 | <?dbfo list-presentation="list"?>
|
---|
295 | <?dbhtml list-presentation="table"?>
|
---|
296 |
|
---|
297 | <varlistentry id="capinfos">
|
---|
298 | <term><command>capinfos</command></term>
|
---|
299 | <listitem>
|
---|
300 | <para>reads a saved capture file and returns any or all of several
|
---|
301 | statistics about that file. It is able to detect and read any capture
|
---|
302 | supported by the <application>Wireshark</application> package.</para>
|
---|
303 | <indexterm zone="wireshark capinfos">
|
---|
304 | <primary sortas="b-capinfos">capinfos</primary>
|
---|
305 | </indexterm>
|
---|
306 | </listitem>
|
---|
307 | </varlistentry>
|
---|
308 |
|
---|
309 | <varlistentry id="dftest">
|
---|
310 | <term><command>dftest</command></term>
|
---|
311 | <listitem>
|
---|
312 | <para>is a display-filter-compiler test program.</para>
|
---|
313 | <indexterm zone="wireshark dftest">
|
---|
314 | <primary sortas="b-dftest">dftest</primary>
|
---|
315 | </indexterm>
|
---|
316 | </listitem>
|
---|
317 | </varlistentry>
|
---|
318 |
|
---|
319 | <varlistentry id="dumpcap">
|
---|
320 | <term><command>dumpcap</command></term>
|
---|
321 | <listitem>
|
---|
322 | <para>is a network traffic dump tool. It lets you capture packet data
|
---|
323 | from a live network and write the packets to a file.</para>
|
---|
324 | <indexterm zone="wireshark dumpcap">
|
---|
325 | <primary sortas="b-dumpcap">dumpcap</primary>
|
---|
326 | </indexterm>
|
---|
327 | </listitem>
|
---|
328 | </varlistentry>
|
---|
329 |
|
---|
330 | <varlistentry id="editcap">
|
---|
331 | <term><command>editcap</command></term>
|
---|
332 | <listitem>
|
---|
333 | <para>edits and/or translates the format of capture files. It knows
|
---|
334 | how to read <application>libpcap</application> capture files,
|
---|
335 | including those of <command>tcpdump</command>,
|
---|
336 | <application>Wireshark</application> and other tools that write
|
---|
337 | captures in that format.</para>
|
---|
338 | <indexterm zone="wireshark editcap">
|
---|
339 | <primary sortas="b-editcap">editcap</primary>
|
---|
340 | </indexterm>
|
---|
341 | </listitem>
|
---|
342 | </varlistentry>
|
---|
343 |
|
---|
344 | <varlistentry id="idl2wrs">
|
---|
345 | <term><command>idl2wrs</command></term>
|
---|
346 | <listitem>
|
---|
347 | <para>takes a user specified CORBA
|
---|
348 | IDL file and generates <quote>C</quote> source code that
|
---|
349 | can be used to create an <application>Wireshark</application>
|
---|
350 | plugin.</para>
|
---|
351 | <indexterm zone="wireshark idl2wrs">
|
---|
352 | <primary sortas="b-idl2wrs">idl2wrs</primary>
|
---|
353 | </indexterm>
|
---|
354 | </listitem>
|
---|
355 | </varlistentry>
|
---|
356 |
|
---|
357 | <varlistentry id="mergecap">
|
---|
358 | <term><command>mergecap</command></term>
|
---|
359 | <listitem>
|
---|
360 | <para>combines multiple saved capture files into a single output
|
---|
361 | file.</para>
|
---|
362 | <indexterm zone="wireshark mergecap">
|
---|
363 | <primary sortas="b-mergecap">mergecap</primary>
|
---|
364 | </indexterm>
|
---|
365 | </listitem>
|
---|
366 | </varlistentry>
|
---|
367 |
|
---|
368 | <varlistentry id="randpkt">
|
---|
369 | <term><command>randpkt</command></term>
|
---|
370 | <listitem>
|
---|
371 | <para>creates random-packet capture files.</para>
|
---|
372 | <indexterm zone="wireshark randpkt">
|
---|
373 | <primary sortas="b-randpkt">randpkt</primary>
|
---|
374 | </indexterm>
|
---|
375 | </listitem>
|
---|
376 | </varlistentry>
|
---|
377 |
|
---|
378 | <varlistentry id="rawshark">
|
---|
379 | <term><command>rawshark</command></term>
|
---|
380 | <listitem>
|
---|
381 | <para>dump and analyze raw libpcap data.</para>
|
---|
382 | <indexterm zone="wireshark rawshark">
|
---|
383 | <primary sortas="b-rawshark">rawshark</primary>
|
---|
384 | </indexterm>
|
---|
385 | </listitem>
|
---|
386 | </varlistentry>
|
---|
387 |
|
---|
388 | <varlistentry id="text2pcap">
|
---|
389 | <term><command>text2pcap</command></term>
|
---|
390 | <listitem>
|
---|
391 | <para>reads in an ASCII hex dump and writes the
|
---|
392 | data described into a <application>libpcap</application>-style
|
---|
393 | capture file.</para>
|
---|
394 | <indexterm zone="wireshark text2pcap">
|
---|
395 | <primary sortas="b-text2pcap">text2pcap</primary>
|
---|
396 | </indexterm>
|
---|
397 | </listitem>
|
---|
398 | </varlistentry>
|
---|
399 |
|
---|
400 | <varlistentry id="tshark">
|
---|
401 | <term><command>tshark</command></term>
|
---|
402 | <listitem>
|
---|
403 | <para>is a TTY-mode network protocol analyzer. It lets you capture
|
---|
404 | packet data from a live network or read packets from a
|
---|
405 | previously saved capture file.</para>
|
---|
406 | <indexterm zone="wireshark tshark">
|
---|
407 | <primary sortas="b-tshark">tshark</primary>
|
---|
408 | </indexterm>
|
---|
409 | </listitem>
|
---|
410 | </varlistentry>
|
---|
411 |
|
---|
412 | <varlistentry id="wireshark-prog">
|
---|
413 | <term><command>wireshark</command></term>
|
---|
414 | <listitem>
|
---|
415 | <para>is a GUI network protocol analyzer. It lets you interactively
|
---|
416 | browse packet data from a live network or from a previously
|
---|
417 | saved capture file.</para>
|
---|
418 | <indexterm zone="wireshark wireshark-prog">
|
---|
419 | <primary sortas="b-wireshark">wireshark</primary>
|
---|
420 | </indexterm>
|
---|
421 | </listitem>
|
---|
422 | </varlistentry>
|
---|
423 |
|
---|
424 | <varlistentry id="libwireshark">
|
---|
425 | <term><filename class='libraryfile'>libwireshark.so</filename></term>
|
---|
426 | <listitem>
|
---|
427 | <para>contains functions used by the
|
---|
428 | <application>Wireshark</application> programs to perform filtering and
|
---|
429 | packet capturing.</para>
|
---|
430 | <indexterm zone="wireshark libwireshark">
|
---|
431 | <primary sortas="c-libwireshark">libwireshark.so</primary>
|
---|
432 | </indexterm>
|
---|
433 | </listitem>
|
---|
434 | </varlistentry>
|
---|
435 |
|
---|
436 | <varlistentry id="libwiretap">
|
---|
437 | <term><filename class='libraryfile'>libwiretap.so</filename></term>
|
---|
438 | <listitem>
|
---|
439 | <para>is a library being developed as a future replacement for
|
---|
440 | <filename class='libraryfile'>libpcap</filename>, the current
|
---|
441 | standard Unix library for packet capturing. For more information,
|
---|
442 | see the <filename>README</filename> file in the source
|
---|
443 | <filename class='directory'>wiretap</filename> directory.</para>
|
---|
444 | <indexterm zone="wireshark libwiretap">
|
---|
445 | <primary sortas="c-libwiretap">libwiretap.so</primary>
|
---|
446 | </indexterm>
|
---|
447 | </listitem>
|
---|
448 | </varlistentry>
|
---|
449 |
|
---|
450 | </variablelist>
|
---|
451 |
|
---|
452 | </sect2>
|
---|
453 |
|
---|
454 | </sect1>
|
---|