Add sections for SMI and GeoIP. Sort the UAT sections.

svn path=/trunk/; revision=26582
This commit is contained in:
Gerald Combs 2008-10-27 18:55:27 +00:00
parent 749f4359eb
commit 2c964392a7
1 changed files with 198 additions and 122 deletions

View File

@ -1027,6 +1027,11 @@ standard libpcap format.
Display Filter Macros (dfilter_macros) (<xref linkend="ChDisplayFilterMacrosSection"/>)
</para>
</listitem>
<listitem>
<para>
GeoIP Database Paths (geoip_db_paths) (<xref linkend="ChGeoIPDbPaths"/>)
</para>
</listitem>
<listitem>
<para>
K12 Protocols (k12_protos) (<xref linkend="ChK12ProtocolsSection"/>)
@ -1034,7 +1039,17 @@ standard libpcap format.
</listitem>
<listitem>
<para>
User DLTs Table (user_dlts) (<xref linkend="ChUserDLTsSection"/>)
SCCP Users Table (sccp_users) (<xref linkend="ChSccpUsers"/>)
</para>
</listitem>
<listitem>
<para>
SMI Modules (smi_modules) (<xref linkend="ChSNMPSMIModules"/>)
</para>
</listitem>
<listitem>
<para>
SMI Paths (smi_paths) (<xref linkend="ChSNMPSMIPaths"/>)
</para>
</listitem>
<listitem>
@ -1044,7 +1059,7 @@ standard libpcap format.
</listitem>
<listitem>
<para>
SCCP Users Table (sccp_users) (<xref linkend="ChSccpUsers"/>)
User DLTs Table (user_dlts) (<xref linkend="ChUserDLTsSection"/>)
</para>
</listitem>
</itemizedlist>
@ -1194,6 +1209,31 @@ standard libpcap format.
</section>
<section id="ChGeoIPDbPaths"><title>GeoIP Database Paths</title>
<para>
If your copy of Wireshark supports <ulink url="http://www.maxmind.com/">MaxMind's</ulink> GeoIP library, you can use their databases to match IP addresses to countries, cites, autonomous system numbers, ISPs, and other bits of information. Some databases are <ulink url="http://www.maxmind.com/download/geoip/database/">available at no cost</ulink>, while others require a licensing fee. See <ulink url="http://www.maxmind.com/app/ip-location">the MaxMind web site</ulink> for more information.
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>path</command></term>
<listitem>
<para>
This specifies a directory containing GeoIP data files. Any files
beginning with <filename>Geo</filename> and ending with
<filename>.dat</filename> will be automatically loaded. A total of 8
files can be loaded.
</para>
<para>
The locations for your data files are up to you, but <filename class='directory'>/usr/share/GeoIP</filename> (Linux), <filename class='directory'>C:\GeoIP</filename> (Windows), <filename class='directory'>C:\Program Files\Wireshark\GeoIP</filename> (Windows) might be good choices.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChK12ProtocolsSection"><title>Tektronix K12xx/15 RF5 protocols Table</title>
<para>
The Tektronix K12xx/15 rf5 file format uses helper files (*.stk) to identify the various protocols that are
@ -1225,6 +1265,149 @@ standard libpcap format.
</section>
<section id="ChSccpUsers"><title>SCCP users Table</title>
<para>
Wireshark uses this table to map specific protocols to a certain DPC/SSN combination for SCCP.
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>ni</command></term>
<listitem>
<para>
An Integer representing the network indicator for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>called_pc</command></term>
<listitem>
<para>
An range of integers representing the dpcs for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>called_ssn</command></term>
<listitem>
<para>
An range of integers representing the ssns for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>user</command></term>
<listitem>
<para>
The protocol that is carried over this association
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChSNMPSMIModules"><title>SMI (MIB and PIB) Modules</title>
<para>
If your copy of Wireshark supports libSMI, you can specify a list of MIB
and PIB modules here. The COPS and SNMP dissectors can use them to resolve
OIDs.
</para>
<variablelist>
<varlistentry><term><command>name</command></term>
<listitem>
<para>
The name of the module, e.g. <database>IF-MIB</database>.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChSNMPSMIPaths"><title>SMI (MIB and PIB) Paths</title>
<para>
If your copy of Wireshark supports libSMI, you can specify one or more
paths to MIB and PIB modules here.
</para>
<variablelist>
<varlistentry><term><command>name</command></term>
<listitem>
<para>
A module directory, e.g. <filename
class='directory'>/usr/local/snmp/mibs</filename>. Wireshark
automatically uses the standard SMI path for your system, so you
usually don't have to add anything here.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChSNMPUsersSection"><title>SNMP users Table</title>
<para>
Wireshark uses this table to verify authentication and to decrypt encrypted SNMPv3 packets.
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>engine_id</command></term>
<listitem>
<para>
If given this entry will be used only for packets whose engine id is this.
This field takes an hexadecimal string in the form 0102030405.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>userName</command></term>
<listitem>
<para>
This is the userName. When a single user has more than one password
for different SNMP-engines the first entry to match both is taken, if you
need a catch all engine-id (empty) that entry should be the last one.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>auth_model</command></term>
<listitem>
<para>
Which auth model to use (either "MD5" or "SHA1").
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>authPassword</command></term>
<listitem>
<para>
The authentication password. Use '\xDD' for unprintable characters.
An hexadecimal password must be entered as a sequence of '\xDD' characters.
For example the hex password 010203040506 must be entered as '\x01\x02\x03\x04\x05\x06'.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>priv_proto</command></term>
<listitem>
<para>
Which encryption algorithm to use (either "DES" or "AES").
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>privPassword</command></term>
<listitem>
<para>
The privacy password. Use '\xDD' for unprintable characters.
An hexadecimal password must be entered as a sequence of '\xDD' characters.
For example the hex password 010203040506 must be entered as '\x01\x02\x03\x04\x05\x06'.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChUserDLTsSection"><title>User DLTs protocol table</title>
<para>
When a pcap file uses one of the user DLTs (147 to 162) wireshark uses this table to know which protocol(s) to use for each user DLT.
@ -1280,113 +1463,6 @@ standard libpcap format.
</section>
<section id="ChSNMPUsersSection"><title>SNMP users Table</title>
<para>
Wireshark uses this table to verify authentication and to decrypt encrypted SNMPv3 packets.
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>engine_id</command></term>
<listitem>
<para>
If given this entry will be used only for packets whose engine id is this.
This field takes an hexadecimal string in the form 0102030405.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>userName</command></term>
<listitem>
<para>
This is the userName. When a single user has more than one password
for different SNMP-engines the first entry to match both is taken, if you
need a catch all engine-id (empty) that entry should be the last one.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>auth_model</command></term>
<listitem>
<para>
Which auth model to use (either "MD5" or "SHA1").
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>authPassword</command></term>
<listitem>
<para>
The authentication password. Use '\xDD' for unprintable characters.
An hexadecimal password must be entered as a sequence of '\xDD' characters.
For example the hex password 010203040506 must be entered as '\x01\x02\x03\x04\x05\x06'.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>priv_proto</command></term>
<listitem>
<para>
Which encryption algorithm to use (either "DES" or "AES").
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>privPassword</command></term>
<listitem>
<para>
The privacy password. Use '\xDD' for unprintable characters.
An hexadecimal password must be entered as a sequence of '\xDD' characters.
For example the hex password 010203040506 must be entered as '\x01\x02\x03\x04\x05\x06'.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChSccpUsers"><title>SCCP users Table</title>
<para>
Wireshark uses this table to map specific protocols to a certain DPC/SSN combination for SCCP.
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>ni</command></term>
<listitem>
<para>
An Integer representing the network indicator for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>called_pc</command></term>
<listitem>
<para>
An range of integers representing the dpcs for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>called_ssn</command></term>
<listitem>
<para>
An range of integers representing the ssns for which this association is valid.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>user</command></term>
<listitem>
<para>
The protocol that is carried over this association
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
<!-- End of WSUG Chapter Customizing -->