Documentation for the Object Identifiers User Accessible Table.

svn path=/trunk/; revision=33368
This commit is contained in:
Graeme Lunt 2010-06-29 09:41:53 +00:00
parent 3123ecf3e4
commit 98f57f0da0
1 changed files with 42 additions and 0 deletions

View File

@ -1059,6 +1059,11 @@ standard libpcap format.
K12 Protocols (k12_protos) (<xref linkend="ChK12ProtocolsSection"/>)
</para>
</listitem>
<listitem>
<para>
Object Identifier Names and Associated Syntaxes (<xref linkend="ChObjectIdentifiers"/>)
</para>
</listitem>
<listitem>
<para>
PRES Users Context List (pres_context_list) (<xref linkend="ChPresContextList"/>)
@ -1341,6 +1346,43 @@ standard libpcap format.
</variablelist>
</section>
<section id="ChObjectIdentifiers"><title>Object Identifiers</title>
<para>
Many protocols that use ASN.1 use Object Identifiers (OIDs) to uniquely identify certain pieces of information. In many cases, they are used in an extension mechanism so that new object identifiers (and associated values) may be defined without needing to change the base standard.
</para>
<para>
Whilst Wireshark has knowledge about many of the OIDs and the syntax of their associated values, the extensibility means that other values may be encountered.
</para>
<para>
Wireshark uses this table to allow the user to define the name and syntax of Object Identifiers that Wireshark does not know about (for example, a privately defined X.400 extension). It also allows the user to override the name and syntax of Object Identifiers that Wireshark does know about (e.g. changing the name "id-at-countryName" to just "c").
</para>
<para>
This table is handled by an <xref linkend="ChUserTable"/> with the following fields.
</para>
<variablelist>
<varlistentry><term><command>OID</command></term>
<listitem>
<para>
The string representation of the Object Identifier e.g. "2.5.4.6".
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>Name</command></term>
<listitem>
<para>
The name that should be displayed by Wireshark when the Object Identifier is dissected e.g. ("c");
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>Syntax</command></term>
<listitem>
<para>
The syntax of the value associated with the Object Identifier. This must be one of the syntaxes that Wireshark already knows about (e.g. "PrintableString").
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section id="ChPresContextList"><title>PRES Users Context List</title>
<para>