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.8 2006/06/29 13:02:31 marka Exp $
  17 .\"
  18 .hy 0
  19 .ad l
  20 .\"     Title: rndc\-confgen
  21 .\"    Author:
  22 .\" Generator: DocBook XSL Stylesheets v1.70.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 .TP 3n
  60 \-a
  61 Do automatic
  62 \fBrndc\fR
  63 configuration. This creates a file
  64 \fIrndc.key\fR
  65 in
  66 \fI/etc\fR
  67 (or whatever
  68 \fIsysconfdir\fR
  69 was specified as when
  70 BIND
  71 was built) that is read by both
  72 \fBrndc\fR
  73 and
  74 \fBnamed\fR
  75 on startup. The
  76 \fIrndc.key\fR
  77 file defines a default command channel and authentication key allowing
  78 \fBrndc\fR
  79 to communicate with
  80 \fBnamed\fR
  81 on the local host with no further configuration.
  82 .sp
  83 Running
  84 \fBrndc\-confgen \-a\fR
  85 allows BIND 9 and
  86 \fBrndc\fR
  87 to be used as drop\-in replacements for BIND 8 and
  88 \fBndc\fR, with no changes to the existing BIND 8
  89 \fInamed.conf\fR
  90 file.
  91 .sp
  92 If a more elaborate configuration than that generated by
  93 \fBrndc\-confgen \-a\fR
  94 is required, for example if rndc is to be used remotely, you should run
  95 \fBrndc\-confgen\fR
  96 without the
  97 \fB\-a\fR
  98 option and set up a
  99 \fIrndc.conf\fR
 100 and
 101 \fInamed.conf\fR
 102 as directed.
 103 .TP 3n
 104 \-b \fIkeysize\fR
 105 Specifies the size of the authentication key in bits. Must be between 1 and 512 bits; the default is 128.
 106 .TP 3n
 107 \-c \fIkeyfile\fR
 108 Used with the
 109 \fB\-a\fR
 110 option to specify an alternate location for
 111 \fIrndc.key\fR.
 112 .TP 3n
 113 \-h
 114 Prints a short summary of the options and arguments to
 115 \fBrndc\-confgen\fR.
 116 .TP 3n
 117 \-k \fIkeyname\fR
 118 Specifies the key name of the rndc authentication key. This must be a valid domain name. The default is
 119 \fBrndc\-key\fR.
 120 .TP 3n
 121 \-p \fIport\fR
 122 Specifies the command channel port where
 123 \fBnamed\fR
 124 listens for connections from
 125 \fBrndc\fR. The default is 953.
 126 .TP 3n
 127 \-r \fIrandomfile\fR
 128 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 129 \fI/dev/random\fR
 130 or equivalent device, the default source of randomness is keyboard input.
 131 \fIrandomdev\fR
 132 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 133 \fIkeyboard\fR
 134 indicates that keyboard input should be used.
 135 .TP 3n
 136 \-s \fIaddress\fR
 137 Specifies the IP address where
 138 \fBnamed\fR
 139 listens for command channel connections from
 140 \fBrndc\fR. The default is the loopback address 127.0.0.1.
 141 .TP 3n
 142 \-t \fIchrootdir\fR
 143 Used with the
 144 \fB\-a\fR
 145 option to specify a directory where
 146 \fBnamed\fR
 147 will run chrooted. An additional copy of the
 148 \fIrndc.key\fR
 149 will be written relative to this directory so that it will be found by the chrooted
 150 \fBnamed\fR.
 151 .TP 3n
 152 \-u \fIuser\fR
 153 Used with the
 154 \fB\-a\fR
 155 option to set the owner of the
 156 \fIrndc.key\fR
 157 file generated. If
 158 \fB\-t\fR
 159 is also specified only the file in the chroot area has its owner changed.
 160 .SH "EXAMPLES"
 161 .PP
 162 To allow
 163 \fBrndc\fR
 164 to be used with no manual configuration, run
 165 .PP
 166 \fBrndc\-confgen \-a\fR
 167 .PP
 168 To print a sample
 169 \fIrndc.conf\fR
 170 file and corresponding
 171 \fBcontrols\fR
 172 and
 173 \fBkey\fR
 174 statements to be manually inserted into
 175 \fInamed.conf\fR, run
 176 .PP
 177 \fBrndc\-confgen\fR
 178 .SH "SEE ALSO"
 179 .PP
 180 \fBrndc\fR(8),
 181 \fBrndc.conf\fR(5),
 182 \fBnamed\fR(8),
 183 BIND 9 Administrator Reference Manual.
 184 .SH "AUTHOR"
 185 .PP
 186 Internet Systems Consortium
 187 .SH "COPYRIGHT"
 188 Copyright \(co 2004, 2005 Internet Systems Consortium, Inc. ("ISC")