contrib/bind9/bin/tools/nsec3hash.docbook

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