contrib/bind9/bin/tools/nsec3hash.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2009  Internet Systems Consortium, Inc. ("ISC")
   6  -
   7  - Permission to use, copy, modify, and/or distribute this software for any
   8  - purpose with or without fee is hereby granted, provided that the above
   9  - copyright notice and this permission notice appear in all copies.
  10  -
  11  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  12  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  13  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  14  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  15  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  16  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  17  - PERFORMANCE OF THIS SOFTWARE.
  18 -->
  19
  20 <!-- $Id: nsec3hash.docbook,v 1.3 2009/03/02 23:47:43 tbox Exp $ -->
  21 <refentry id="man.nsec3hash">
  22   <refentryinfo>
  23     <date>Feb 18, 2009</date>
  24   </refentryinfo>
  25
  26   <refmeta>
  27     <refentrytitle><application>nsec3hash</application></refentrytitle>
  28     <manvolnum>8</manvolnum>
  29     <refmiscinfo>BIND9</refmiscinfo>
  30   </refmeta>
  31
  32   <refnamediv>
  33     <refname><application>nsec3hash</application></refname>
  34     <refpurpose>generate NSEC3 hash</refpurpose>
  35   </refnamediv>
  36
  37   <docinfo>
  38     <copyright>
  39       <year>2009</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42   </docinfo>
  43
  44   <refsynopsisdiv>
  45     <cmdsynopsis>
  46       <command>nsec3hash</command>
  47       <arg choice="req"><replaceable class="parameter">salt</replaceable></arg>
  48       <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg>
  49       <arg choice="req"><replaceable class="parameter">iterations</replaceable></arg>
  50       <arg choice="req"><replaceable class="parameter">domain</replaceable></arg>
  51     </cmdsynopsis>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>DESCRIPTION</title>
  56     <para>
  57       <command>nsec3hash</command> generates an NSEC3 hash based on
  58       a set of NSEC3 parameters.  This can be used to check the validity
  59       of NSEC3 records in a signed zone.
  60     </para>
  61   </refsect1>
  62
  63   <refsect1>
  64     <title>ARGUMENTS</title>
  65     <variablelist>
  66       <varlistentry>
  67         <term>salt</term>
  68         <listitem>
  69           <para>
  70             The salt provided to the hash algorithm.
  71           </para>
  72         </listitem>
  73       </varlistentry>
  74
  75       <varlistentry>
  76         <term>algorithm</term>
  77         <listitem>
  78           <para>
  79             A number indicating the hash algorithm.  Currently the
  80             only supported hash algorithm for NSEC3 is SHA-1, which is
  81             indicated by the number 1; consequently "1" is the only
  82             useful value for this argument.
  83           </para>
  84         </listitem>
  85       </varlistentry>
  86
  87       <varlistentry>
  88         <term>iterations</term>
  89         <listitem>
  90           <para>
  91             The number of additional times the hash should be performed.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry>
  97         <term>domain</term>
  98         <listitem>
  99           <para>
 100             The domain name to be hashed.
 101           </para>
 102         </listitem>
 103       </varlistentry>
 104     </variablelist>
 105   </refsect1>
 106
 107   <refsect1>
 108     <title>SEE ALSO</title>
 109     <para>
 110       <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 111       <citetitle>RFC 5155</citetitle>.
 112     </para>
 113   </refsect1>
 114
 115   <refsect1>
 116     <title>AUTHOR</title>
 117     <para><corpauthor>Internet Systems Consortium</corpauthor>
 118     </para>
 119   </refsect1>
 120
 121 </refentry><!--
 122  - Local variables:
 123  - mode: sgml
 124  - End:
 125 -->