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