contrib/bind9/bin/rndc/rndc-confgen.8

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