/contrib/bind9/bin/tools/nsec3hash.docbook
https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 125 lines · 112 code · 13 blank · 0 comment · 0 complexity · 5f7970645cc25a50dc54aeee52a82026 MD5 · raw file
- <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
- [<!ENTITY mdash "—">]>
- <!--
- - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
- -
- - Permission to use, copy, modify, and/or distribute this software for any
- - purpose with or without fee is hereby granted, provided that the above
- - copyright notice and this permission notice appear in all copies.
- -
- - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
- - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
- - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
- - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- - PERFORMANCE OF THIS SOFTWARE.
- -->
- <!-- $Id: nsec3hash.docbook,v 1.3 2009/03/02 23:47:43 tbox Exp $ -->
- <refentry id="man.nsec3hash">
- <refentryinfo>
- <date>Feb 18, 2009</date>
- </refentryinfo>
- <refmeta>
- <refentrytitle><application>nsec3hash</application></refentrytitle>
- <manvolnum>8</manvolnum>
- <refmiscinfo>BIND9</refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname><application>nsec3hash</application></refname>
- <refpurpose>generate NSEC3 hash</refpurpose>
- </refnamediv>
- <docinfo>
- <copyright>
- <year>2009</year>
- <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
- </copyright>
- </docinfo>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>nsec3hash</command>
- <arg choice="req"><replaceable class="parameter">salt</replaceable></arg>
- <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg>
- <arg choice="req"><replaceable class="parameter">iterations</replaceable></arg>
- <arg choice="req"><replaceable class="parameter">domain</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>DESCRIPTION</title>
- <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>
- </refsect1>
- <refsect1>
- <title>ARGUMENTS</title>
- <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>
- </refsect1>
- <refsect1>
- <title>SEE ALSO</title>
- <para>
- <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
- <citetitle>RFC 5155</citetitle>.
- </para>
- </refsect1>
- <refsect1>
- <title>AUTHOR</title>
- <para><corpauthor>Internet Systems Consortium</corpauthor>
- </para>
- </refsect1>
- </refentry><!--
- - Local variables:
- - mode: sgml
- - End:
- -->