1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY ethereal-download-http "http://www.ethereal.com/distribution/ethereal-ðereal-version;.tar.bz2">
|
---|
8 | <!ENTITY ethereal-download-ftp "ftp://ftp.ethereal.com/pub/ethereal/all-versions/ethereal-ðereal-version;.tar.bz2">
|
---|
9 | <!ENTITY ethereal-md5sum "f9905b9d347acdc05af664a7553f7f76">
|
---|
10 | <!ENTITY ethereal-size "8.8 MB">
|
---|
11 | <!ENTITY ethereal-buildsize "331 MB">
|
---|
12 | <!ENTITY ethereal-time "5.4 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="ethereal" xreflabel="Ethereal-ðereal-version;">
|
---|
16 | <?dbhtml filename="ethereal.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Ethereal-ðereal-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="ethereal">
|
---|
26 | <primary sortas="a-Ethereal">Ethereal</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Ethereal</title>
|
---|
31 |
|
---|
32 | <para>The <application>Ethereal</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>Ethereal</application> provides both a graphical and 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 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
42 | <itemizedlist spacing="compact">
|
---|
43 | <listitem>
|
---|
44 | <para>Download (HTTP): <ulink url="ðereal-download-http;"/></para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>Download (FTP): <ulink url="ðereal-download-ftp;"/></para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>Download MD5 sum: ðereal-md5sum;</para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>Download size: ðereal-size;</para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>Estimated disk space required: ðereal-buildsize;</para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>Estimated build time: ðereal-time;</para>
|
---|
60 | </listitem>
|
---|
61 | </itemizedlist>
|
---|
62 |
|
---|
63 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
64 | <itemizedlist spacing="compact">
|
---|
65 | <listitem>
|
---|
66 | <para>Additional Documentation: <ulink
|
---|
67 | url="http://www.ethereal.com/docs/"/></para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <para>From this page you can download many different docs in a variety
|
---|
72 | of formats.</para>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Ethereal dependencies</bridgehead>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
77 | <para role="required"><xref linkend="GLib"/> or <xref linkend="glib2"/>
|
---|
78 | (to build the TTY-mode front-end only)</para>
|
---|
79 |
|
---|
80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
81 | <para role="recommended"><xref linkend="libpcap"/>
|
---|
82 | (required to capture data)</para>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
85 | <para role="optional"><xref linkend="pkgconfig"/>,
|
---|
86 | <xref linkend="GTK"/> or <xref linkend="gtk2"/>
|
---|
87 | (to build the GUI front-end),
|
---|
88 | <xref linkend="openssl"/>,
|
---|
89 | <xref linkend="heimdal"/> or <xref linkend="mitkrb"/>,
|
---|
90 | <xref linkend="python"/>,
|
---|
91 | <xref linkend="pcre"/>,
|
---|
92 | <ulink url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
|
---|
93 | (which needs <ulink
|
---|
94 | url="http://www.gnupg.org/download/index.html#libgpg-error">libgpg-error</ulink>
|
---|
95 | then <ulink
|
---|
96 | url="http://www.gnupg.org/download/index.html#libgcrypt">libgcrypt</ulink>),
|
---|
97 | <ulink url="http://www.net-snmp.org/">Net-SNMP</ulink>,
|
---|
98 | <ulink url="http://www.gnu.org/software/adns/adns.html">adns</ulink>, and
|
---|
99 | <ulink url="http://www.lua.org/">Lua</ulink></para>
|
---|
100 |
|
---|
101 | <!-- Though configure looks for all these, and the developers I'm
|
---|
102 | sure use them, the doc sources are not included in the release
|
---|
103 | tarball (they are in SVN, though)
|
---|
104 | <bridgehead renderas="sect4">Optional (to build additional
|
---|
105 | documentation)</bridgehead>
|
---|
106 | <para role="optional"><xref linkend="doxygen"/>,
|
---|
107 | <xref linkend="libxml"/>,
|
---|
108 | <xref linkend="libxslt"/>, and
|
---|
109 | <xref linkend="fop"/></para>
|
---|
110 | -->
|
---|
111 |
|
---|
112 | <para condition="html" role="usernotes">User Notes:
|
---|
113 | <ulink url="&blfs-wiki;/ethereal"/></para>
|
---|
114 |
|
---|
115 | </sect2>
|
---|
116 |
|
---|
117 | <sect2 role="kernel" id="ethereal-kernel">
|
---|
118 | <title>Kernel Configuration</title>
|
---|
119 |
|
---|
120 | <para>The kernel must have the Packet protocol enabled for
|
---|
121 | <application>Ethereal</application> to capture live packets from the
|
---|
122 | network. Enable the Packet protocol by choosing <quote>Y</quote> in the
|
---|
123 | <quote>Networking</quote> – <quote>Packet socket</quote>
|
---|
124 | configuration parameter. Alternatively, build the
|
---|
125 | <filename>af_packet.ko</filename> module by choosing <quote>M</quote> in
|
---|
126 | this parameter.</para>
|
---|
127 |
|
---|
128 | <indexterm zone="ethereal ethereal-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 Ethereal</title>
|
---|
137 |
|
---|
138 | <para>Install <application>Ethereal</application> by running the following
|
---|
139 | commands:</para>
|
---|
140 |
|
---|
141 | <screen><userinput>./configure --prefix=/usr \
|
---|
142 | --sysconfdir=/etc \
|
---|
143 | --enable-threads &&
|
---|
144 | make</userinput></screen>
|
---|
145 |
|
---|
146 | <para>This package does not come with a test suite.</para>
|
---|
147 |
|
---|
148 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
149 |
|
---|
150 | <screen role="root"><userinput>make install &&
|
---|
151 | install -v -m644 FAQ README{,.linux} doc/README.* doc/*.{pod,txt} \
|
---|
152 | /usr/share/ethereal &&
|
---|
153 | install -v -m644 -D ethereal.desktop \
|
---|
154 | /usr/share/applications/ethereal.desktop &&
|
---|
155 | install -v -m644 -D image/elogo3d48x48.png \
|
---|
156 | /usr/share/pixmaps/ethereal.png &&
|
---|
157 | install -v -m755 -d /usr/share/pixmaps/ethereal &&
|
---|
158 | install -v -m644 image/*.{png,ico,xpm,bmp} \
|
---|
159 | /usr/share/pixmaps/ethereal</userinput></screen>
|
---|
160 |
|
---|
161 | <para>If you downloaded any of the documentation files from the page
|
---|
162 | listed in the 'Additional Downloads', install them by issuing the following
|
---|
163 | commands as the <systemitem class="username">root</systemitem> user:</para>
|
---|
164 |
|
---|
165 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/ethereal-ðereal-version; &&
|
---|
166 | install -v -m644 <replaceable><Downloaded_Files></replaceable> /usr/share/doc/ethereal-ðereal-version;</userinput></screen>
|
---|
167 |
|
---|
168 | </sect2>
|
---|
169 |
|
---|
170 | <sect2 role="commands">
|
---|
171 | <title>Command Explanations</title>
|
---|
172 |
|
---|
173 | <para><parameter>--enable-threads</parameter>: This parameter enables the
|
---|
174 | use of threads in <command>ethereal</command>.</para>
|
---|
175 |
|
---|
176 | <para><option>--with-ssl</option>: This parameter enables the use of the
|
---|
177 | <application>OpenSSL</application>
|
---|
178 | <filename class='libraryfile'>libcrypto</filename> library.</para>
|
---|
179 |
|
---|
180 | </sect2>
|
---|
181 |
|
---|
182 | <sect2 role="configuration">
|
---|
183 | <title>Configuring Ethereal</title>
|
---|
184 |
|
---|
185 | <sect3 id="ethereal-config">
|
---|
186 | <title>Config Files</title>
|
---|
187 |
|
---|
188 | <para><filename>/etc/ethereal.conf</filename> and
|
---|
189 | <filename>~/.ethereal/preferences</filename></para>
|
---|
190 |
|
---|
191 | <indexterm zone="ethereal ethereal-config">
|
---|
192 | <primary sortas="e-AA.ethereal-preferences">~/.ethereal/preferences</primary>
|
---|
193 | </indexterm>
|
---|
194 |
|
---|
195 | <indexterm zone="ethereal ethereal-config">
|
---|
196 | <primary sortas="e-etc-ethereal.conf">/etc/ethereal.conf</primary>
|
---|
197 | </indexterm>
|
---|
198 |
|
---|
199 | </sect3>
|
---|
200 |
|
---|
201 | <sect3>
|
---|
202 | <title>Configuration Information</title>
|
---|
203 |
|
---|
204 | <para>Though the default configuration parameters are very sane,
|
---|
205 | reference the configuration section of the
|
---|
206 | <ulink url="http://www.ethereal.com/docs/user-guide/">Ethereal User's
|
---|
207 | Guide</ulink> for configuration information. Most of
|
---|
208 | <application>Ethereal</application>'s configuration can be accomplished
|
---|
209 | using the menu options of the <command>ethereal</command>
|
---|
210 | graphical interface.</para>
|
---|
211 |
|
---|
212 | <note>
|
---|
213 | <para>If you want to look at packets, make sure you don't filter
|
---|
214 | them out with <xref linkend="iptables"/>. If you want to exclude
|
---|
215 | certain classes of packets, it is more efficient to do it with
|
---|
216 | <application>iptables</application> than
|
---|
217 | <application>Ethereal</application>.</para>
|
---|
218 | </note>
|
---|
219 |
|
---|
220 | </sect3>
|
---|
221 |
|
---|
222 | </sect2>
|
---|
223 |
|
---|
224 | <sect2 role="content">
|
---|
225 | <title>Contents</title>
|
---|
226 |
|
---|
227 | <segmentedlist>
|
---|
228 | <segtitle>Installed Programs</segtitle>
|
---|
229 | <segtitle>Installed Libraries</segtitle>
|
---|
230 | <segtitle>Installed Directories</segtitle>
|
---|
231 |
|
---|
232 | <seglistitem>
|
---|
233 | <seg>capinfos, dftest, editcap, ethereal, idl2eth, mergecap, randpkt,
|
---|
234 | tethereal and text2pcap</seg>
|
---|
235 | <seg>libethereal.so, libwiretap.so and numerous dissector plugin
|
---|
236 | modules</seg>
|
---|
237 | <seg>/usr/lib/ethereal, /usr/share/ethereal and
|
---|
238 | /usr/share/pixmaps/ethereal</seg>
|
---|
239 | </seglistitem>
|
---|
240 | </segmentedlist>
|
---|
241 |
|
---|
242 | <variablelist>
|
---|
243 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
244 | <?dbfo list-presentation="list"?>
|
---|
245 | <?dbhtml list-presentation="table"?>
|
---|
246 |
|
---|
247 | <varlistentry id="capinfos">
|
---|
248 | <term><command>capinfos</command></term>
|
---|
249 | <listitem>
|
---|
250 | <para>reads a saved capture file and returns any or all of several
|
---|
251 | statistics about that file. It is able to detect and read any capture
|
---|
252 | supported by the <application>Ethereal</application> package.</para>
|
---|
253 | <indexterm zone="ethereal capinfos">
|
---|
254 | <primary sortas="b-capinfos">capinfos</primary>
|
---|
255 | </indexterm>
|
---|
256 | </listitem>
|
---|
257 | </varlistentry>
|
---|
258 |
|
---|
259 | <varlistentry id="dftest">
|
---|
260 | <term><command>dftest</command></term>
|
---|
261 | <listitem>
|
---|
262 | <para>is a display-filter-compiler test program.</para>
|
---|
263 | <indexterm zone="ethereal dftest">
|
---|
264 | <primary sortas="b-dftest">dftest</primary>
|
---|
265 | </indexterm>
|
---|
266 | </listitem>
|
---|
267 | </varlistentry>
|
---|
268 |
|
---|
269 | <varlistentry id="editcap">
|
---|
270 | <term><command>editcap</command></term>
|
---|
271 | <listitem>
|
---|
272 | <para>edits and/or translates the format of capture files. It knows
|
---|
273 | how to read <application>libpcap</application> capture files,
|
---|
274 | including those of <command>tcpdump</command>,
|
---|
275 | <application>Ethereal</application> and other tools that write
|
---|
276 | captures in that format.</para>
|
---|
277 | <indexterm zone="ethereal editcap">
|
---|
278 | <primary sortas="b-editcap">editcap</primary>
|
---|
279 | </indexterm>
|
---|
280 | </listitem>
|
---|
281 | </varlistentry>
|
---|
282 |
|
---|
283 | <varlistentry id="ethereal-prog">
|
---|
284 | <term><command>ethereal</command></term>
|
---|
285 | <listitem>
|
---|
286 | <para>is a GUI network protocol analyzer. It lets you interactively
|
---|
287 | browse packet data from a live network or from a previously
|
---|
288 | saved capture file.</para>
|
---|
289 | <indexterm zone="ethereal ethereal-prog">
|
---|
290 | <primary sortas="b-ethereal">ethereal</primary>
|
---|
291 | </indexterm>
|
---|
292 | </listitem>
|
---|
293 | </varlistentry>
|
---|
294 |
|
---|
295 | <varlistentry id="idl2eth">
|
---|
296 | <term><command>idl2eth</command></term>
|
---|
297 | <listitem>
|
---|
298 | <para>takes a user specified CORBA
|
---|
299 | IDL file and generates <quote>C</quote> source code that
|
---|
300 | can be used to create an <application>Ethereal</application>
|
---|
301 | plugin.</para>
|
---|
302 | <indexterm zone="ethereal idl2eth">
|
---|
303 | <primary sortas="b-idl2eth">idl2eth</primary>
|
---|
304 | </indexterm>
|
---|
305 | </listitem>
|
---|
306 | </varlistentry>
|
---|
307 |
|
---|
308 | <varlistentry id="mergecap">
|
---|
309 | <term><command>mergecap</command></term>
|
---|
310 | <listitem>
|
---|
311 | <para>combines multiple saved capture files into a single output
|
---|
312 | file.</para>
|
---|
313 | <indexterm zone="ethereal mergecap">
|
---|
314 | <primary sortas="b-mergecap">mergecap</primary>
|
---|
315 | </indexterm>
|
---|
316 | </listitem>
|
---|
317 | </varlistentry>
|
---|
318 |
|
---|
319 | <varlistentry id="randpkt">
|
---|
320 | <term><command>randpkt</command></term>
|
---|
321 | <listitem>
|
---|
322 | <para>creates random-packet capture files.</para>
|
---|
323 | <indexterm zone="ethereal randpkt">
|
---|
324 | <primary sortas="b-randpkt">randpkt</primary>
|
---|
325 | </indexterm>
|
---|
326 | </listitem>
|
---|
327 | </varlistentry>
|
---|
328 |
|
---|
329 | <varlistentry id="tethereal">
|
---|
330 | <term><command>tethereal</command></term>
|
---|
331 | <listitem>
|
---|
332 | <para>is a TTY-mode network protocol analyzer. It lets you capture
|
---|
333 | packet data from a live network or read packets from a
|
---|
334 | previously saved capture file.</para>
|
---|
335 | <indexterm zone="ethereal tethereal">
|
---|
336 | <primary sortas="b-tethereal">tethereal</primary>
|
---|
337 | </indexterm>
|
---|
338 | </listitem>
|
---|
339 | </varlistentry>
|
---|
340 |
|
---|
341 | <varlistentry id="text2pcap">
|
---|
342 | <term><command>text2pcap</command></term>
|
---|
343 | <listitem>
|
---|
344 | <para>reads in an ASCII hex dump and writes the
|
---|
345 | data described into a <application>libpcap</application>-style
|
---|
346 | capture file.</para>
|
---|
347 | <indexterm zone="ethereal text2pcap">
|
---|
348 | <primary sortas="b-text2pcap">text2pcap</primary>
|
---|
349 | </indexterm>
|
---|
350 | </listitem>
|
---|
351 | </varlistentry>
|
---|
352 |
|
---|
353 | <varlistentry id="libethereal">
|
---|
354 | <term><filename class='libraryfile'>libethereal.so</filename></term>
|
---|
355 | <listitem>
|
---|
356 | <para>contains functions used by the
|
---|
357 | <application>Ethereal</application> programs to perform filtering and
|
---|
358 | packet capturing.</para>
|
---|
359 | <indexterm zone="ethereal libethereal">
|
---|
360 | <primary sortas="c-libethereal">libethereal.so</primary>
|
---|
361 | </indexterm>
|
---|
362 | </listitem>
|
---|
363 | </varlistentry>
|
---|
364 |
|
---|
365 | <varlistentry id="libwiretap">
|
---|
366 | <term><filename class='libraryfile'>libwiretap.so</filename></term>
|
---|
367 | <listitem>
|
---|
368 | <para>is a library being developed as a future replacement for
|
---|
369 | <filename class='libraryfile'>libpcap</filename>, the current
|
---|
370 | standard Unix library for packet capturing. For more information,
|
---|
371 | see the <filename>README</filename> file in the source
|
---|
372 | <filename class='directory'>wiretap</filename> directory.</para>
|
---|
373 | <indexterm zone="ethereal libwiretap">
|
---|
374 | <primary sortas="c-libwiretap">libwiretap.so</primary>
|
---|
375 | </indexterm>
|
---|
376 | </listitem>
|
---|
377 | </varlistentry>
|
---|
378 |
|
---|
379 | </variablelist>
|
---|
380 |
|
---|
381 | </sect2>
|
---|
382 |
|
---|
383 | </sect1>
|
---|