external/bsd/bind/dist/bin/confgen/rndc-confgen.8

   1 .\"     $NetBSD: rndc-confgen.8,v 1.6 2014/12/10 04:37:51 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2009, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2001, 2003 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: rndc\-confgen
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: March 14, 2013
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "RNDC\-CONFGEN" "8" "March 14, 2013" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 rndc\-confgen \- rndc key generation tool
  36 .SH "SYNOPSIS"
  37 .HP 13
  38 \fBrndc\-confgen\fR [\fB\-a\fR] [\fB\-A\ \fR\fB\fIalgorithm\fR\fR] [\fB\-b\ \fR\fB\fIkeysize\fR\fR] [\fB\-c\ \fR\fB\fIkeyfile\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\fB\-s\ \fR\fB\fIaddress\fR\fR] [\fB\-t\ \fR\fB\fIchrootdir\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR]
  39 .SH "DESCRIPTION"
  40 .PP
  41 \fBrndc\-confgen\fR
  42 generates configuration files for
  43 \fBrndc\fR. It can be used as a convenient alternative to writing the
  44 \fIrndc.conf\fR
  45 file and the corresponding
  46 \fBcontrols\fR
  47 and
  48 \fBkey\fR
  49 statements in
  50 \fInamed.conf\fR
  51 by hand. Alternatively, it can be run with the
  52 \fB\-a\fR
  53 option to set up a
  54 \fIrndc.key\fR
  55 file and avoid the need for a
  56 \fIrndc.conf\fR
  57 file and a
  58 \fBcontrols\fR
  59 statement altogether.
  60 .SH "OPTIONS"
  61 .PP
  62 \-a
  63 .RS 4
  64 Do automatic
  65 \fBrndc\fR
  66 configuration. This creates a file
  67 \fIrndc.key\fR
  68 in
  69 \fI/etc\fR
  70 (or whatever
  71 \fIsysconfdir\fR
  72 was specified as when
  73 BIND
  74 was built) that is read by both
  75 \fBrndc\fR
  76 and
  77 \fBnamed\fR
  78 on startup. The
  79 \fIrndc.key\fR
  80 file defines a default command channel and authentication key allowing
  81 \fBrndc\fR
  82 to communicate with
  83 \fBnamed\fR
  84 on the local host with no further configuration.
  85 .sp
  86 Running
  87 \fBrndc\-confgen \-a\fR
  88 allows BIND 9 and
  89 \fBrndc\fR
  90 to be used as drop\-in replacements for BIND 8 and
  91 \fBndc\fR, with no changes to the existing BIND 8
  92 \fInamed.conf\fR
  93 file.
  94 .sp
  95 If a more elaborate configuration than that generated by
  96 \fBrndc\-confgen \-a\fR
  97 is required, for example if rndc is to be used remotely, you should run
  98 \fBrndc\-confgen\fR
  99 without the
 100 \fB\-a\fR
 101 option and set up a
 102 \fIrndc.conf\fR
 103 and
 104 \fInamed.conf\fR
 105 as directed.
 106 .RE
 107 .PP
 108 \-A \fIalgorithm\fR
 109 .RS 4
 110 Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-md5.
 111 .RE
 112 .PP
 113 \-b \fIkeysize\fR
 114 .RS 4
 115 Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is the hash size.
 116 .RE
 117 .PP
 118 \-c \fIkeyfile\fR
 119 .RS 4
 120 Used with the
 121 \fB\-a\fR
 122 option to specify an alternate location for
 123 \fIrndc.key\fR.
 124 .RE
 125 .PP
 126 \-h
 127 .RS 4
 128 Prints a short summary of the options and arguments to
 129 \fBrndc\-confgen\fR.
 130 .RE
 131 .PP
 132 \-k \fIkeyname\fR
 133 .RS 4
 134 Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is
 135 \fBrndc\-key\fR.
 136 .RE
 137 .PP
 138 \-p \fIport\fR
 139 .RS 4
 140 Specifies the command channel port where
 141 \fBnamed\fR
 142 listens for connections from
 143 \fBrndc\fR. The default is 953.
 144 .RE
 145 .PP
 146 \-r \fIrandomfile\fR
 147 .RS 4
 148 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 149 \fI/dev/random\fR
 150 or equivalent device, the default source of randomness is keyboard input.
 151 \fIrandomdev\fR
 152 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 153 \fIkeyboard\fR
 154 indicates that keyboard input should be used.
 155 .RE
 156 .PP
 157 \-s \fIaddress\fR
 158 .RS 4
 159 Specifies the IP address where
 160 \fBnamed\fR
 161 listens for command channel connections from
 162 \fBrndc\fR. The default is the loopback address 127.0.0.1.
 163 .RE
 164 .PP
 165 \-t \fIchrootdir\fR
 166 .RS 4
 167 Used with the
 168 \fB\-a\fR
 169 option to specify a directory where
 170 \fBnamed\fR
 171 will run chrooted. An additional copy of the
 172 \fIrndc.key\fR
 173 will be written relative to this directory so that it will be found by the chrooted
 174 \fBnamed\fR.
 175 .RE
 176 .PP
 177 \-u \fIuser\fR
 178 .RS 4
 179 Used with the
 180 \fB\-a\fR
 181 option to set the owner of the
 182 \fIrndc.key\fR
 183 file generated. If
 184 \fB\-t\fR
 185 is also specified only the file in the chroot area has its owner changed.
 186 .RE
 187 .SH "EXAMPLES"
 188 .PP
 189 To allow
 190 \fBrndc\fR
 191 to be used with no manual configuration, run
 192 .PP
 193 \fBrndc\-confgen \-a\fR
 194 .PP
 195 To print a sample
 196 \fIrndc.conf\fR
 197 file and corresponding
 198 \fBcontrols\fR
 199 and
 200 \fBkey\fR
 201 statements to be manually inserted into
 202 \fInamed.conf\fR, run
 203 .PP
 204 \fBrndc\-confgen\fR
 205 .SH "SEE ALSO"
 206 .PP
 207 \fBrndc\fR(8),
 208 \fBrndc.conf\fR(5),
 209 \fBnamed\fR(8),
 210 BIND 9 Administrator Reference Manual.
 211 .SH "AUTHOR"
 212 .PP
 213 Internet Systems Consortium
 214 .SH "COPYRIGHT"
 215 Copyright \(co 2004, 2005, 2007, 2009, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
 216 .br
 217 Copyright \(co 2001, 2003 Internet Software Consortium.
 218 .br