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

   1 <!--
   2  - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2001, 2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id: rndc-confgen.html,v 1.3.2.5.2.13 2006/06/29 13:02:31 marka Exp $ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>rndc-confgen</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.70.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="id2482688"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <div class="cmdsynopsis"><p><code class="command">rndc-confgen</code>  [<code class="option">-a</code>] [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>] [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-p <em class="replaceable"><code>port</code></em></code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s <em class="replaceable"><code>address</code></em></code>] [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>] [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]</p></div>
  33 </div>
  34 <div class="refsect1" lang="en">
  35 <a name="id2549476"></a><h2>DESCRIPTION</h2>
  36 <p>
  37         <span><strong class="command">rndc-confgen</strong></span> generates configuration files
  38         for <span><strong class="command">rndc</strong></span>.  It can be used as a
  39         convenient alternative to writing the
  40         <code class="filename">rndc.conf</code> file
  41         and the corresponding <span><strong class="command">controls</strong></span>
  42         and <span><strong class="command">key</strong></span>
  43         statements in <code class="filename">named.conf</code> by hand.
  44         Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
  45         option to set up a <code class="filename">rndc.key</code> file and
  46         avoid the need for a <code class="filename">rndc.conf</code> file
  47         and a <span><strong class="command">controls</strong></span> statement altogether.
  48     </p>
  49 </div>
  50 <div class="refsect1" lang="en">
  51 <a name="id2549522"></a><h2>OPTIONS</h2>
  52 <div class="variablelist"><dl>
  53 <dt><span class="term">-a</span></dt>
  54 <dd>
  55 <p>
  56               Do automatic <span><strong class="command">rndc</strong></span> configuration.
  57               This creates a file <code class="filename">rndc.key</code>
  58               in <code class="filename">/etc</code> (or whatever
  59               <code class="varname">sysconfdir</code>
  60               was specified as when <acronym class="acronym">BIND</acronym> was built)
  61               that is read by both <span><strong class="command">rndc</strong></span>
  62               and <span><strong class="command">named</strong></span> on startup.  The
  63               <code class="filename">rndc.key</code> file defines a default
  64               command channel and authentication key allowing
  65               <span><strong class="command">rndc</strong></span> to communicate with
  66               <span><strong class="command">named</strong></span> on the local host
  67               with no further configuration.
  68           </p>
  69 <p>
  70               Running <span><strong class="command">rndc-confgen -a</strong></span> allows
  71               BIND 9 and <span><strong class="command">rndc</strong></span> to be used as drop-in
  72               replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
  73               with no changes to the existing BIND 8
  74               <code class="filename">named.conf</code> file.
  75           </p>
  76 <p>
  77               If a more elaborate configuration than that
  78               generated by <span><strong class="command">rndc-confgen -a</strong></span>
  79               is required, for example if rndc is to be used remotely,
  80               you should run <span><strong class="command">rndc-confgen</strong></span> without the
  81               <span><strong class="command">-a</strong></span> option and set up a
  82               <code class="filename">rndc.conf</code> and
  83               <code class="filename">named.conf</code>
  84               as directed.
  85           </p>
  86 </dd>
  87 <dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
  88 <dd><p>
  89                Specifies the size of the authentication key in bits.
  90                Must be between 1 and 512 bits; the default is 128.
  91           </p></dd>
  92 <dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
  93 <dd><p>
  94                Used with the <span><strong class="command">-a</strong></span> option to specify
  95                an alternate location for <code class="filename">rndc.key</code>.
  96           </p></dd>
  97 <dt><span class="term">-h</span></dt>
  98 <dd><p>
  99                Prints a short summary of the options and arguments to
 100                <span><strong class="command">rndc-confgen</strong></span>.
 101           </p></dd>
 102 <dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
 103 <dd><p>
 104                Specifies the key name of the rndc authentication key.
 105                This must be a valid domain name.
 106                The default is <code class="constant">rndc-key</code>.
 107           </p></dd>
 108 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
 109 <dd><p>
 110                Specifies the command channel port where <span><strong class="command">named</strong></span>
 111                listens for connections from <span><strong class="command">rndc</strong></span>.
 112                The default is 953.
 113           </p></dd>
 114 <dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
 115 <dd><p>
 116                Specifies a source of random data for generating the
 117                authorization.  If the operating
 118                system does not provide a <code class="filename">/dev/random</code>
 119                or equivalent device, the default source of randomness
 120                is keyboard input.  <code class="filename">randomdev</code> specifies
 121                the name of a character device or file containing random
 122                data to be used instead of the default.  The special value
 123                <code class="filename">keyboard</code> indicates that keyboard
 124                input should be used.
 125           </p></dd>
 126 <dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
 127 <dd><p>
 128                Specifies the IP address where <span><strong class="command">named</strong></span>
 129                listens for command channel connections from
 130                <span><strong class="command">rndc</strong></span>.  The default is the loopback
 131                address 127.0.0.1.
 132           </p></dd>
 133 <dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
 134 <dd><p>
 135                Used with the <span><strong class="command">-a</strong></span> option to specify
 136                a directory where <span><strong class="command">named</strong></span> will run
 137                chrooted.  An additional copy of the <code class="filename">rndc.key</code>
 138                will be written relative to this directory so that
 139                it will be found by the chrooted <span><strong class="command">named</strong></span>.
 140           </p></dd>
 141 <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
 142 <dd><p>
 143                Used with the <span><strong class="command">-a</strong></span> option to set the owner
 144                of the <code class="filename">rndc.key</code> file generated.  If
 145                <span><strong class="command">-t</strong></span> is also specified only the file in
 146                the chroot area has its owner changed.
 147           </p></dd>
 148 </dl></div>
 149 </div>
 150 <div class="refsect1" lang="en">
 151 <a name="id2549972"></a><h2>EXAMPLES</h2>
 152 <p>
 153         To allow <span><strong class="command">rndc</strong></span> to be used with
 154         no manual configuration, run
 155     </p>
 156 <p>
 157         <strong class="userinput"><code>rndc-confgen -a</code></strong>
 158     </p>
 159 <p>
 160         To print a sample <code class="filename">rndc.conf</code> file and
 161         corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
 162         statements to be manually inserted into <code class="filename">named.conf</code>,
 163         run
 164     </p>
 165 <p>
 166         <strong class="userinput"><code>rndc-confgen</code></strong>
 167     </p>
 168 </div>
 169 <div class="refsect1" lang="en">
 170 <a name="id2550016"></a><h2>SEE ALSO</h2>
 171 <p>
 172       <span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
 173       <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
 174       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 175       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 176     </p>
 177 </div>
 178 <div class="refsect1" lang="en">
 179 <a name="id2550058"></a><h2>AUTHOR</h2>
 180 <p>
 181         <span class="corpauthor">Internet Systems Consortium</span>
 182     </p>
 183 </div>
 184 </div></body>
 185 </html>