/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

  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. <!-- $Id: nsec3hash.docbook,v 1.3 2009/03/02 23:47:43 tbox Exp $ -->
  20. <refentry id="man.nsec3hash">
  21. <refentryinfo>
  22. <date>Feb 18, 2009</date>
  23. </refentryinfo>
  24. <refmeta>
  25. <refentrytitle><application>nsec3hash</application></refentrytitle>
  26. <manvolnum>8</manvolnum>
  27. <refmiscinfo>BIND9</refmiscinfo>
  28. </refmeta>
  29. <refnamediv>
  30. <refname><application>nsec3hash</application></refname>
  31. <refpurpose>generate NSEC3 hash</refpurpose>
  32. </refnamediv>
  33. <docinfo>
  34. <copyright>
  35. <year>2009</year>
  36. <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  37. </copyright>
  38. </docinfo>
  39. <refsynopsisdiv>
  40. <cmdsynopsis>
  41. <command>nsec3hash</command>
  42. <arg choice="req"><replaceable class="parameter">salt</replaceable></arg>
  43. <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg>
  44. <arg choice="req"><replaceable class="parameter">iterations</replaceable></arg>
  45. <arg choice="req"><replaceable class="parameter">domain</replaceable></arg>
  46. </cmdsynopsis>
  47. </refsynopsisdiv>
  48. <refsect1>
  49. <title>DESCRIPTION</title>
  50. <para>
  51. <command>nsec3hash</command> generates an NSEC3 hash based on
  52. a set of NSEC3 parameters. This can be used to check the validity
  53. of NSEC3 records in a signed zone.
  54. </para>
  55. </refsect1>
  56. <refsect1>
  57. <title>ARGUMENTS</title>
  58. <variablelist>
  59. <varlistentry>
  60. <term>salt</term>
  61. <listitem>
  62. <para>
  63. The salt provided to the hash algorithm.
  64. </para>
  65. </listitem>
  66. </varlistentry>
  67. <varlistentry>
  68. <term>algorithm</term>
  69. <listitem>
  70. <para>
  71. A number indicating the hash algorithm. Currently the
  72. only supported hash algorithm for NSEC3 is SHA-1, which is
  73. indicated by the number 1; consequently "1" is the only
  74. useful value for this argument.
  75. </para>
  76. </listitem>
  77. </varlistentry>
  78. <varlistentry>
  79. <term>iterations</term>
  80. <listitem>
  81. <para>
  82. The number of additional times the hash should be performed.
  83. </para>
  84. </listitem>
  85. </varlistentry>
  86. <varlistentry>
  87. <term>domain</term>
  88. <listitem>
  89. <para>
  90. The domain name to be hashed.
  91. </para>
  92. </listitem>
  93. </varlistentry>
  94. </variablelist>
  95. </refsect1>
  96. <refsect1>
  97. <title>SEE ALSO</title>
  98. <para>
  99. <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
  100. <citetitle>RFC 5155</citetitle>.
  101. </para>
  102. </refsect1>
  103. <refsect1>
  104. <title>AUTHOR</title>
  105. <para><corpauthor>Internet Systems Consortium</corpauthor>
  106. </para>
  107. </refsect1>
  108. </refentry><!--
  109. - Local variables:
  110. - mode: sgml
  111. - End:
  112. -->