contrib/bind-9.2.4rc7/bin/rndc/rndc-confgen.8

   1 .\" Copyright (C) 2004  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.8 2004/06/03 05:21:14 marka Exp $
  17 .\"
  18 .TH "RNDC-CONFGEN" "8" "Aug 27, 2001" "BIND9" ""
  19 .SH NAME
  20 rndc-confgen \- rndc key generation tool
  21 .SH SYNOPSIS
  22 .sp
  23 \fBrndc-confgen\fR [ \fB-a\fR ]  [ \fB-b \fIkeysize\fB\fR ]  [ \fB-c \fIkeyfile\fB\fR ]  [ \fB-h\fR ]  [ \fB-k \fIkeyname\fB\fR ]  [ \fB-p \fIport\fB\fR ]  [ \fB-r \fIrandomfile\fB\fR ]  [ \fB-s \fIaddress\fB\fR ]  [ \fB-t \fIchrootdir\fB\fR ]  [ \fB-u \fIuser\fB\fR ]
  24 .SH "DESCRIPTION"
  25 .PP
  26 \fBrndc-confgen\fR generates configuration files
  27 for \fBrndc\fR. It can be used as a
  28 convenient alternative to writing the
  29 \fIrndc.conf\fR file
  30 and the corresponding \fBcontrols\fR
  31 and \fBkey\fR
  32 statements in \fInamed.conf\fR by hand.
  33 Alternatively, it can be run with the \fB-a\fR
  34 option to set up a \fIrndc.key\fR file and
  35 avoid the need for a \fIrndc.conf\fR file
  36 and a \fBcontrols\fR statement altogether.
  37 .SH "OPTIONS"
  38 .TP
  39 \fB-a\fR
  40 Do automatic \fBrndc\fR configuration.
  41 This creates a file \fIrndc.key\fR
  42 in \fI/etc\fR (or whatever
  43 sysconfdir
  44 was specified as when BIND was built)
  45 that is read by both \fBrndc\fR
  46 and \fBnamed\fR on startup. The
  47 \fIrndc.key\fR file defines a default
  48 command channel and authentication key allowing
  49 \fBrndc\fR to communicate with
  50 \fBnamed\fR with no further configuration.
  51
  52 Running \fBrndc-confgen -a\fR allows
  53 BIND 9 and \fBrndc\fR to be used as drop-in
  54 replacements for BIND 8 and \fBndc\fR,
  55 with no changes to the existing BIND 8
  56 \fInamed.conf\fR file.
  57 .TP
  58 \fB-b \fIkeysize\fB\fR
  59 Specifies the size of the authentication key in bits.
  60 Must be between 1 and 512 bits; the default is 128.
  61 .TP
  62 \fB-c \fIkeyfile\fB\fR
  63 Used with the \fB-a\fR option to specify
  64 an alternate location for \fIrndc.key\fR.
  65 .TP
  66 \fB-h\fR
  67 Prints a short summary of the options and arguments to
  68 \fBrndc-confgen\fR.
  69 .TP
  70 \fB-k \fIkeyname\fB\fR
  71 Specifies the key name of the rndc authentication key.
  72 This must be a valid domain name.
  73 The default is rndc-key.
  74 .TP
  75 \fB-p \fIport\fB\fR
  76 Specifies the command channel port where \fBnamed\fR
  77 listens for connections from \fBrndc\fR.
  78 The default is 953.
  79 .TP
  80 \fB-r \fIrandomfile\fB\fR
  81 Specifies a source of random data for generating the
  82 authorization. If the operating
  83 system does not provide a \fI/dev/random\fR
  84 or equivalent device, the default source of randomness
  85 is keyboard input. \fIrandomdev\fR specifies
  86 the name of a character device or file containing random
  87 data to be used instead of the default. The special value
  88 \fIkeyboard\fR indicates that keyboard
  89 input should be used.
  90 .TP
  91 \fB-s \fIaddress\fB\fR
  92 Specifies the IP address where \fBnamed\fR
  93 listens for command channel connections from
  94 \fBrndc\fR. The default is the loopback
  95 address 127.0.0.1.
  96 .TP
  97 \fB-t \fIchrootdir\fB\fR
  98 Used with the \fB-a\fR option to specify
  99 a directory where \fBnamed\fR will run
 100 chrooted. An additional copy of the \fIrndc.key\fR
 101 will be written relative to this directory so that
 102 it will be found by the chrooted \fBnamed\fR.
 103 .TP
 104 \fB-u \fIuser\fB\fR
 105 Used with the \fB-a\fR option to set the owner
 106 of the \fIrndc.key\fR file generated. If
 107 \fB-t\fR is also specified only the file in
 108 the chroot area has its owner changed.
 109 .SH "EXAMPLES"
 110 .PP
 111 To allow \fBrndc\fR to be used with
 112 no manual configuration, run
 113 .PP
 114 \fBrndc-confgen -a\fR
 115 .PP
 116 To print a sample \fIrndc.conf\fR file and
 117 corresponding \fBcontrols\fR and \fBkey\fR
 118 statements to be manually inserted into \fInamed.conf\fR,
 119 run
 120 .PP
 121 \fBrndc-confgen\fR
 122 .SH "SEE ALSO"
 123 .PP
 124 \fBrndc\fR(8),
 125 \fBrndc.conf\fR(5),
 126 \fBnamed\fR(8),
 127 \fIBIND 9 Administrator Reference Manual\fR.
 128 .SH "AUTHOR"
 129 .PP
 130 Internet Systems Consortium