contrib/bind-9.3/bin/rndc/rndc-confgen.8

   1 .\" Copyright (C) 2004, 2005 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.3.2.5.2.7 2005/10/13 02:33:50 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\" ** You probably do not want to edit this file directly **
  21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
  22 .\" Instead of manually editing it, you probably should edit the DocBook XML
  23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
  24 .TH "RNDC\-CONFGEN" "8" "Aug 27, 2001" "BIND9" "BIND9"
  25 .\" disable hyphenation
  26 .nh
  27 .\" disable justification (adjust text to left margin only)
  28 .ad l
  29 .SH "NAME"
  30 rndc\-confgen \- rndc key generation tool
  31 .SH "SYNOPSIS"
  32 .HP 13
  33 \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]
  34 .SH "DESCRIPTION"
  35 .PP
  36 \fBrndc\-confgen\fR
  37 generates configuration files for
  38 \fBrndc\fR. It can be used as a convenient alternative to writing the
  39 \fIrndc.conf\fR
  40 file and the corresponding
  41 \fBcontrols\fR
  42 and
  43 \fBkey\fR
  44 statements in
  45 \fInamed.conf\fR
  46 by hand. Alternatively, it can be run with the
  47 \fB\-a\fR
  48 option to set up a
  49 \fIrndc.key\fR
  50 file and avoid the need for a
  51 \fIrndc.conf\fR
  52 file and a
  53 \fBcontrols\fR
  54 statement altogether.
  55 .SH "OPTIONS"
  56 .TP
  57 \-a
  58 Do automatic
  59 \fBrndc\fR
  60 configuration. This creates a file
  61 \fIrndc.key\fR
  62 in
  63 \fI/etc\fR
  64 (or whatever
  65 \fIsysconfdir\fR
  66 was specified as when
  67 BIND
  68 was built) that is read by both
  69 \fBrndc\fR
  70 and
  71 \fBnamed\fR
  72 on startup. The
  73 \fIrndc.key\fR
  74 file defines a default command channel and authentication key allowing
  75 \fBrndc\fR
  76 to communicate with
  77 \fBnamed\fR
  78 on the local host with no further configuration.
  79 .sp
  80 Running
  81 \fBrndc\-confgen \-a\fR
  82 allows BIND 9 and
  83 \fBrndc\fR
  84 to be used as drop\-in replacements for BIND 8 and
  85 \fBndc\fR, with no changes to the existing BIND 8
  86 \fInamed.conf\fR
  87 file.
  88 .sp
  89 If a more elaborate configuration than that generated by
  90 \fBrndc\-confgen \-a\fR
  91 is required, for example if rndc is to be used remotely, you should run
  92 \fBrndc\-confgen\fR
  93 without the
  94 \fB\-a\fR
  95 option and set up a
  96 \fIrndc.conf\fR
  97 and
  98 \fInamed.conf\fR
  99 as directed.
 100 .TP
 101 \-b \fIkeysize\fR
 102 Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is 128.
 103 .TP
 104 \-c \fIkeyfile\fR
 105 Used with the
 106 \fB\-a\fR
 107 option to specify an alternate location for
 108 \fIrndc.key\fR.
 109 .TP
 110 \-h
 111 Prints a short summary of the options and arguments to
 112 \fBrndc\-confgen\fR.
 113 .TP
 114 \-k \fIkeyname\fR
 115 Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is
 116 \fBrndc\-key\fR.
 117 .TP
 118 \-p \fIport\fR
 119 Specifies the command channel port where
 120 \fBnamed\fR
 121 listens for connections from
 122 \fBrndc\fR. The default is 953.
 123 .TP
 124 \-r \fIrandomfile\fR
 125 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 126 \fI/dev/random\fR
 127 or equivalent device, the default source of randomness is keyboard input.
 128 \fIrandomdev\fR
 129 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 130 \fIkeyboard\fR
 131 indicates that keyboard input should be used.
 132 .TP
 133 \-s \fIaddress\fR
 134 Specifies the IP address where
 135 \fBnamed\fR
 136 listens for command channel connections from
 137 \fBrndc\fR. The default is the loopback address 127.0.0.1.
 138 .TP
 139 \-t \fIchrootdir\fR
 140 Used with the
 141 \fB\-a\fR
 142 option to specify a directory where
 143 \fBnamed\fR
 144 will run chrooted. An additional copy of the
 145 \fIrndc.key\fR
 146 will be written relative to this directory so that it will be found by the chrooted
 147 \fBnamed\fR.
 148 .TP
 149 \-u \fIuser\fR
 150 Used with the
 151 \fB\-a\fR
 152 option to set the owner of the
 153 \fIrndc.key\fR
 154 file generated. If
 155 \fB\-t\fR
 156 is also specified only the file in the chroot area has its owner changed.
 157 .SH "EXAMPLES"
 158 .PP
 159 To allow
 160 \fBrndc\fR
 161 to be used with no manual configuration, run
 162 .PP
 163 \fBrndc\-confgen \-a\fR
 164 .PP
 165 To print a sample
 166 \fIrndc.conf\fR
 167 file and corresponding
 168 \fBcontrols\fR
 169 and
 170 \fBkey\fR
 171 statements to be manually inserted into
 172 \fInamed.conf\fR, run
 173 .PP
 174 \fBrndc\-confgen\fR
 175 .SH "SEE ALSO"
 176 .PP
 177 \fBrndc\fR(8),
 178 \fBrndc.conf\fR(5),
 179 \fBnamed\fR(8),
 180 BIND 9 Administrator Reference Manual.
 181 .SH "AUTHOR"
 182 .PP
 183 Internet Systems Consortium