external/bsd/bind/dist/bin/tools/isc-hmac-fixup.8

   1 .\"     $NetBSD: isc-hmac-fixup.8,v 1.6 2014/12/10 04:37:54 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\"
   5 .\" Permission to use, copy, modify, and/or distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15 .\" PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" Id
  18 .\"
  19 .hy 0
  20 .ad l
  21 .\"     Title: isc\-hmac\-fixup
  22 .\"    Author:
  23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  24 .\"      Date: April 28, 2013
  25 .\"    Manual: BIND9
  26 .\"    Source: BIND9
  27 .\"
  28 .TH "ISC\-HMAC\-FIXUP" "8" "April 28, 2013" "BIND9" "BIND9"
  29 .\" disable hyphenation
  30 .nh
  31 .\" disable justification (adjust text to left margin only)
  32 .ad l
  33 .SH "NAME"
  34 isc\-hmac\-fixup \- fixes HMAC keys generated by older versions of BIND
  35 .SH "SYNOPSIS"
  36 .HP 15
  37 \fBisc\-hmac\-fixup\fR {\fIalgorithm\fR} {\fIsecret\fR}
  38 .SH "DESCRIPTION"
  39 .PP
  40 Versions of BIND 9 up to and including BIND 9.6 had a bug causing HMAC\-SHA* TSIG keys which were longer than the digest length of the hash algorithm (i.e., SHA1 keys longer than 160 bits, SHA256 keys longer than 256 bits, etc) to be used incorrectly, generating a message authentication code that was incompatible with other DNS implementations.
  41 .PP
  42 This bug has been fixed in BIND 9.7. However, the fix may cause incompatibility between older and newer versions of BIND, when using long keys.
  43 \fBisc\-hmac\-fixup\fR
  44 modifies those keys to restore compatibility.
  45 .PP
  46 To modify a key, run
  47 \fBisc\-hmac\-fixup\fR
  48 and specify the key's algorithm and secret on the command line. If the secret is longer than the digest length of the algorithm (64 bytes for SHA1 through SHA256, or 128 bytes for SHA384 and SHA512), then a new secret will be generated consisting of a hash digest of the old secret. (If the secret did not require conversion, then it will be printed without modification.)
  49 .SH "SECURITY CONSIDERATIONS"
  50 .PP
  51 Secrets that have been converted by
  52 \fBisc\-hmac\-fixup\fR
  53 are shortened, but as this is how the HMAC protocol works in operation anyway, it does not affect security. RFC 2104 notes, "Keys longer than [the digest length] are acceptable but the extra length would not significantly increase the function strength."
  54 .SH "SEE ALSO"
  55 .PP
  56 BIND 9 Administrator Reference Manual,
  57 RFC 2104.
  58 .SH "AUTHOR"
  59 .PP
  60 Internet Systems Consortium
  61 .SH "COPYRIGHT"
  62 Copyright \(co 2010, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
  63 .br