/contrib/bind9/bin/tools/isc-hmac-fixup.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) 2010  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: isc-hmac-fixup.docbook,v 1.2 2010/01/07 21:52:11 each Exp $ -->
 21<refentry id="man.isc-hmac-fixup">
 22  <refentryinfo>
 23    <date>January 5, 2010</date>
 24  </refentryinfo>
 25
 26  <refmeta>
 27    <refentrytitle><application>isc-hmac-fixup</application></refentrytitle>
 28    <manvolnum>1</manvolnum>
 29    <refmiscinfo>BIND9</refmiscinfo>
 30  </refmeta>
 31
 32  <refnamediv>
 33    <refname><application>isc-hmac-fixup</application></refname>
 34    <refpurpose>fixes HMAC keys generated by older versions of BIND</refpurpose>
 35  </refnamediv>
 36
 37  <docinfo>
 38    <copyright>
 39      <year>2010</year>
 40      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
 41    </copyright>
 42  </docinfo>
 43
 44  <refsynopsisdiv>
 45    <cmdsynopsis>
 46      <command>isc-hmac-fixup</command>
 47      <arg choice="req"><replaceable class="parameter">algorithm</replaceable></arg>
 48      <arg choice="req"><replaceable class="parameter">secret</replaceable></arg>
 49    </cmdsynopsis>
 50  </refsynopsisdiv>
 51
 52  <refsect1>
 53    <title>DESCRIPTION</title>
 54    <para>
 55      Versions of BIND 9 up to and including BIND 9.6 had a bug causing
 56      HMAC-SHA* TSIG keys which were longer than the digest length of the
 57      hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys
 58      longer than 256 bits, etc) to be used incorrectly, generating a
 59      message authentication code that was incompatible with other DNS
 60      implementations.
 61    </para>
 62    <para>
 63      This bug has been fixed in BIND 9.7.  However, the fix may
 64      cause incompatibility between older and newer versions of
 65      BIND, when using long keys.  <command>isc-hmac-fixup</command>
 66      modifies those keys to restore compatibility.
 67    </para>
 68    <para>
 69      To modify a key, run <command>isc-hmac-fixup</command> and
 70      specify the key's algorithm and secret on the command line.  If the
 71      secret is longer than the digest length of the algorithm (64 bytes
 72      for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a
 73      new secret will be generated consisting of a hash digest of the old
 74      secret.  (If the secret did not require conversion, then it will be
 75      printed without modification.)
 76    </para>
 77  </refsect1>
 78
 79  <refsect1>
 80    <title>SECURITY CONSIDERATIONS</title>
 81    <para>
 82      Secrets that have been converted by <command>isc-hmac-fixup</command>
 83      are shortened, but as this is how the HMAC protocol works in
 84      operation anyway, it does not affect security.  RFC 2104 notes,
 85      "Keys longer than [the digest length] are acceptable but the
 86      extra length would not significantly increase the function
 87      strength."
 88    </para>
 89  </refsect1>
 90
 91  <refsect1>
 92    <title>SEE ALSO</title>
 93    <para>
 94      <citetitle>BIND 9 Administrator Reference Manual</citetitle>,
 95      <citetitle>RFC 2104</citetitle>.
 96    </para>
 97  </refsect1>
 98
 99  <refsect1>
100    <title>AUTHOR</title>
101    <para><corpauthor>Internet Systems Consortium</corpauthor>
102    </para>
103  </refsect1>
104
105</refentry><!--
106 - Local variables:
107 - mode: sgml
108 - End:
109-->