source: networking/netutils/wireshark.xml@ 13927bc

10.0 10.1 11.0 11.1 11.2 7.10 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 krejzi/svn lazarus nosym perl-modules plabs/python-mods qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 13927bc was 13927bc, checked in by Fernando de Oliveira <fernando@…>, 9 years ago

Typo.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@12123 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.6 KB
Line 
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 "ceb4b2bac5607d948e00bd950461be1c">
10 <!ENTITY wireshark-size "26 MB">
11 <!ENTITY wireshark-buildsize "926 MB">
12 <!ENTITY wireshark-time "6.0 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 &lfs74_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 you need <application>Gtk+</application> or
85 <application>Qt4</application> installed, otherwise, you will need to pass
86 <option>--disable-wireshark</option> to the
87 <command>configure</command> command.</para>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref linkend="libpcap"/> (required to capture data)
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink>,
97 <ulink url="http://www.maxmind.com/app/c">GeoIP</ulink>,
98 <xref linkend="gnutls"/>,
99 <xref linkend="libgcrypt"/>,
100 <xref linkend="lua"/>,
101 <xref linkend="mitkrb"/>,
102 <xref linkend="openssl"/>,
103 <xref linkend="pcre"/>, and
104 <ulink url="http://www.portaudio.com/download.html">PortAudio</ulink>
105 </para>
106
107 <bridgehead renderas="sect4">Optional (to build the GUI front-end)</bridgehead>
108 <para role="optional">
109 <xref linkend="gtk2"/>,
110 <xref linkend="gtk3"/>, or
111 <xref linkend="qt4"/>
112 </para>
113
114 <para condition="html" role="usernotes">User Notes:
115 <ulink url="&blfs-wiki;/wireshark"/></para>
116
117 </sect2>
118
119 <sect2 role="kernel" id="wireshark-kernel">
120 <title>Kernel Configuration</title>
121
122 <para>The kernel must have the Packet protocol enabled for
123 <application>Wireshark</application> to capture live packets from the
124 network.</para>
125
126<screen><literal>Networking support: Y
127 Networking options:
128 Packet: sockets monitoring interface: M or Y</literal></screen>
129
130 <para>If built as a module, the name is
131 <filename>af_packet.ko</filename>.</para>
132
133 <indexterm zone="wireshark wireshark-kernel">
134 <primary sortas="d-Capturing-network-packets">Capturing network
135 packets</primary>
136 </indexterm>
137
138 </sect2>
139
140 <sect2 role="installation">
141 <title>Installation of Wireshark</title>
142
143 <para>Optionally, fix the description of the program in the title.
144 The first change overwrites the default "SVN Unknown" in the title
145 and the secong overwrites a utility script that resets the version
146 to "unknown".</para>
147
148<screen><userinput>cat > svnversion.h &lt;&lt; "EOF"
149#define SVNVERSION "BLFS"
150#define SVNPATH "source"
151EOF
152
153cat > make-version.pl &lt;&lt; "EOF"
154#!/usr/bin/perl
155EOF</userinput></screen>
156
157 <para><application>Wireshark</application> is a very large and complex
158 application. These instructions provide additional security measures to
159 ensure that only trusted users are allowed to view network traffic. First,
160 set up a system group for wireshark. As the <systemitem
161 class="username">root</systemitem> user:</para>
162
163<screen role="root"><userinput>groupadd -g 62 wireshark</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 &amp;&amp;
169make</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 &amp;&amp;
176
177install -v -m755 -d /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
178install -v -m755 -d /usr/share/pixmaps/wireshark &amp;&amp;
179
180install -v -m644 README{,.linux} doc/README.* doc/*.{pod,txt} \
181 /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
182
183pushd /usr/share/doc/wireshark-&wireshark-version; &amp;&amp;
184 for FILENAME in ../../wireshark/*.html; do
185 ln -s -v -f $FILENAME .
186 done &amp;&amp;
187popd &amp;&amp;
188
189install -v -m644 -D wireshark.desktop \
190 /usr/share/applications/wireshark.desktop &amp;&amp;
191
192install -v -m644 -D image/wsicon48.png \
193 /usr/share/pixmaps/wireshark.png &amp;&amp;
194
195install -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>&lt;Downloaded_Files&gt;</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} &amp;&amp;
209chmod -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 &lt;username&gt;</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>--disable-wireshark</option>: This option is required if you
223 have <application>GTK+</application> installed but do not want to build
224 the GUI.</para>
225
226 <para><option>--with-gtk3=yes</option>: This option is required if you want
227 to use <application>GTK+</application>3 instead of 2, for the GUI.</para>
228
229 <para><option>--with-qt=yes</option>: This option is required if you want to
230 use <application>Qt</application> instead of
231 <application>GTK+</application>, for the GUI.</para>
232
233 <para><option>--with-ssl</option>: This option is required if you
234 are linking Kerberos libraries into the build so that the
235 <application>OpenSSL</application>
236 <filename class='libraryfile'>libcrypto</filename> library is found.</para>
237
238 </sect2>
239
240 <sect2 role="configuration">
241 <title>Configuring Wireshark</title>
242
243 <sect3 id="wireshark-config">
244 <title>Config Files</title>
245
246 <para><filename>/etc/wireshark.conf</filename> and
247 <filename>~/.wireshark/*</filename></para>
248
249 <indexterm zone="wireshark wireshark-config">
250 <primary sortas="e-AA.wireshark-star">~/.wireshark/*</primary>
251 </indexterm>
252
253 <indexterm zone="wireshark wireshark-config">
254 <primary sortas="e-etc-wireshark.conf">/etc/wireshark.conf</primary>
255 </indexterm>
256
257 </sect3>
258
259 <sect3>
260 <title>Configuration Information</title>
261
262 <para>Though the default configuration parameters are very sane,
263 reference the configuration section of the
264 <ulink url="http://www.wireshark.org/docs/wsug_html/">Wireshark User's
265 Guide</ulink> for configuration information. Most of
266 <application>Wireshark</application>'s configuration can be accomplished
267 using the menu options of the <command>wireshark</command>
268 graphical interface.</para>
269
270 <note>
271 <para>If you want to look at packets, make sure you don't filter
272 them out with <xref linkend="iptables"/>. If you want to exclude
273 certain classes of packets, it is more efficient to do it with
274 <application>iptables</application> than it is with
275 <application>Wireshark</application>.</para>
276 </note>
277
278 </sect3>
279
280 </sect2>
281
282 <sect2 role="content">
283 <title>Contents</title>
284
285 <segmentedlist>
286 <segtitle>Installed Programs</segtitle>
287 <segtitle>Installed Libraries</segtitle>
288 <segtitle>Installed Directories</segtitle>
289
290 <seglistitem>
291 <seg>capinfos, dftest, dumpcap, editcap, mergecap, randpkt, rawshark,
292 reordercap, text2pcap, tshark, and wireshark</seg>
293 <seg>libwireshark.so, libwiretap.so, libwsutil.so, and
294 numerous plugin modules</seg>
295 <seg>/usr/lib/wireshark, /usr/share/doc/wireshark-&wireshark-version;,
296 /usr/share/pixmaps/wireshark, and /usr/share/wireshark</seg>
297 </seglistitem>
298 </segmentedlist>
299
300 <variablelist>
301 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
302 <?dbfo list-presentation="list"?>
303 <?dbhtml list-presentation="table"?>
304
305 <varlistentry id="capinfos">
306 <term><command>capinfos</command></term>
307 <listitem>
308 <para>reads a saved capture file and returns any or all of several
309 statistics about that file. It is able to detect and read any capture
310 supported by the <application>Wireshark</application> package.</para>
311 <indexterm zone="wireshark capinfos">
312 <primary sortas="b-capinfos">capinfos</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="dftest">
318 <term><command>dftest</command></term>
319 <listitem>
320 <para>is a display-filter-compiler test program.</para>
321 <indexterm zone="wireshark dftest">
322 <primary sortas="b-dftest">dftest</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="dumpcap">
328 <term><command>dumpcap</command></term>
329 <listitem>
330 <para>is a network traffic dump tool. It lets you capture packet data
331 from a live network and write the packets to a file.</para>
332 <indexterm zone="wireshark dumpcap">
333 <primary sortas="b-dumpcap">dumpcap</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="editcap">
339 <term><command>editcap</command></term>
340 <listitem>
341 <para>edits and/or translates the format of capture files. It knows
342 how to read <application>libpcap</application> capture files,
343 including those of <command>tcpdump</command>,
344 <application>Wireshark</application> and other tools that write
345 captures in that format.</para>
346 <indexterm zone="wireshark editcap">
347 <primary sortas="b-editcap">editcap</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="mergecap">
353 <term><command>mergecap</command></term>
354 <listitem>
355 <para>combines multiple saved capture files into a single output
356 file.</para>
357 <indexterm zone="wireshark mergecap">
358 <primary sortas="b-mergecap">mergecap</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="randpkt">
364 <term><command>randpkt</command></term>
365 <listitem>
366 <para>creates random-packet capture files.</para>
367 <indexterm zone="wireshark randpkt">
368 <primary sortas="b-randpkt">randpkt</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="rawshark">
374 <term><command>rawshark</command></term>
375 <listitem>
376 <para>dump and analyze raw libpcap data.</para>
377 <indexterm zone="wireshark rawshark">
378 <primary sortas="b-rawshark">rawshark</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="reordercap">
384 <term><command>reordercap</command></term>
385 <listitem>
386 <para>reorder timestamps of input file frames into output file.</para>
387 <indexterm zone="wireshark reordercap">
388 <primary sortas="b-reordercap">reordercap</primary>
389 </indexterm>
390 </listitem>
391 </varlistentry>
392
393 <varlistentry id="text2pcap">
394 <term><command>text2pcap</command></term>
395 <listitem>
396 <para>reads in an ASCII hex dump and writes the
397 data described into a <application>libpcap</application>-style
398 capture file.</para>
399 <indexterm zone="wireshark text2pcap">
400 <primary sortas="b-text2pcap">text2pcap</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="tshark">
406 <term><command>tshark</command></term>
407 <listitem>
408 <para>is a TTY-mode network protocol analyzer. It lets you capture
409 packet data from a live network or read packets from a
410 previously saved capture file.</para>
411 <indexterm zone="wireshark tshark">
412 <primary sortas="b-tshark">tshark</primary>
413 </indexterm>
414 </listitem>
415 </varlistentry>
416
417 <varlistentry id="wireshark-prog">
418 <term><command>wireshark</command></term>
419 <listitem>
420 <para>is a GUI network protocol analyzer. It lets you interactively
421 browse packet data from a live network or from a previously
422 saved capture file.</para>
423 <indexterm zone="wireshark wireshark-prog">
424 <primary sortas="b-wireshark">wireshark</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 <varlistentry id="libwireshark">
430 <term><filename class='libraryfile'>libwireshark.so</filename></term>
431 <listitem>
432 <para>contains functions used by the
433 <application>Wireshark</application> programs to perform filtering and
434 packet capturing.</para>
435 <indexterm zone="wireshark libwireshark">
436 <primary sortas="c-libwireshark">libwireshark.so</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="libwiretap">
442 <term><filename class='libraryfile'>libwiretap.so</filename></term>
443 <listitem>
444 <para>is a library being developed as a future replacement for
445 <filename class='libraryfile'>libpcap</filename>, the current
446 standard Unix library for packet capturing. For more information,
447 see the <filename>README</filename> file in the source
448 <filename class='directory'>wiretap</filename> directory.</para>
449 <indexterm zone="wireshark libwiretap">
450 <primary sortas="c-libwiretap">libwiretap.so</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 </variablelist>
456
457 </sect2>
458
459</sect1>
Note: See TracBrowser for help on using the repository browser.