bin/tools/nsec3hash.docbook

	nsec3hash.docbook revision 19c7b1a0293498a3e36692c59646ed6e15ffc8d0
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews<!--
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - Copyright (C) 2009, 2014, 2015  Internet Systems Consortium, Inc. ("ISC")
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews -
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - Permission to use, copy, modify, and/or distribute this software for any
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - purpose with or without fee is hereby granted, provided that the above
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - copyright notice and this permission notice appear in all copies.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews -
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews - PERFORMANCE OF THIS SOFTWARE.
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews-->
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews<!-- Converted by db4-upgrade version 1.0 -->
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.nsec3hash">
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  <info>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <date>2009-03-02</date>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  </info>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  <refentryinfo>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <corpname>ISC</corpname>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  </refentryinfo>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  <refmeta>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <refentrytitle><application>nsec3hash</application></refentrytitle>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <manvolnum>8</manvolnum>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <refmiscinfo>BIND9</refmiscinfo>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  </refmeta>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  <refnamediv>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <refname><application>nsec3hash</application></refname>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <refpurpose>generate NSEC3 hash</refpurpose>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  </refnamediv>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews  <docinfo>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews    <copyright>
5c526acb82c882e41b655c31f5fa4425c87b671cMark Andrews      <year>2009</year>
      <year>2014</year>
      <year>2015</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
  </docinfo>

  <refsynopsisdiv>
    <cmdsynopsis sepchar=" ">
      <command>nsec3hash</command>
      <arg choice="req" rep="norepeat"><replaceable class="parameter">salt</replaceable></arg>
      <arg choice="req" rep="norepeat"><replaceable class="parameter">algorithm</replaceable></arg>
      <arg choice="req" rep="norepeat"><replaceable class="parameter">iterations</replaceable></arg>
      <arg choice="req" rep="norepeat"><replaceable class="parameter">domain</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection><info><title>DESCRIPTION</title></info>

    <para>
      <command>nsec3hash</command> generates an NSEC3 hash based on
      a set of NSEC3 parameters.  This can be used to check the validity
      of NSEC3 records in a signed zone.
    </para>
  </refsection>

  <refsection><info><title>ARGUMENTS</title></info>

    <variablelist>
      <varlistentry>
        <term>salt</term>
        <listitem>
          <para>
            The salt provided to the hash algorithm.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>algorithm</term>
        <listitem>
          <para>
            A number indicating the hash algorithm.  Currently the
            only supported hash algorithm for NSEC3 is SHA-1, which is
            indicated by the number 1; consequently "1" is the only
            useful value for this argument.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>iterations</term>
        <listitem>
          <para>
            The number of additional times the hash should be performed.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>domain</term>
        <listitem>
          <para>
            The domain name to be hashed.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsection>

  <refsection><info><title>SEE ALSO</title></info>

    <para>
      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
      <citetitle>RFC 5155</citetitle>.
    </para>
  </refsection>

</refentry>