contrib/bind9/doc/arm/man.rndc-confgen.html

   1 <!--
   2  - Copyright (C) 2004-2010 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000-2003 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or 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: man.rndc-confgen.html,v 1.102.14.21.2.1 2010/02/25 12:16:49 tbox 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.71.1">
  23 <link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
  24 <link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
  25 <link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
  26 </head>
  27 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  28 <div class="navheader">
  29 <table width="100%" summary="Navigation header">
  30 <tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
  31 <tr>
  32 <td width="20%" align="left">
  33 <a accesskey="p" href="man.rndc.conf.html">Prev</a> </td>
  34 <th width="60%" align="center">Manual pages</th>
  35 <td width="20%" align="right"> </td>
  36 </tr>
  37 </table>
  38 <hr>
  39 </div>
  40 <div class="refentry" lang="en">
  41 <a name="man.rndc-confgen"></a><div class="titlepage"></div>
  42 <div class="refnamediv">
  43 <h2>Name</h2>
  44 <p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
  45 </div>
  46 <div class="refsynopsisdiv">
  47 <h2>Synopsis</h2>
  48 <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>
  49 </div>
  50 <div class="refsect1" lang="en">
  51 <a name="id2633104"></a><h2>DESCRIPTION</h2>
  52 <p><span><strong class="command">rndc-confgen</strong></span>
  53       generates configuration files
  54       for <span><strong class="command">rndc</strong></span>.  It can be used as a
  55       convenient alternative to writing the
  56       <code class="filename">rndc.conf</code> file
  57       and the corresponding <span><strong class="command">controls</strong></span>
  58       and <span><strong class="command">key</strong></span>
  59       statements in <code class="filename">named.conf</code> by hand.
  60       Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
  61       option to set up a <code class="filename">rndc.key</code> file and
  62       avoid the need for a <code class="filename">rndc.conf</code> file
  63       and a <span><strong class="command">controls</strong></span> statement altogether.
  64     </p>
  65 </div>
  66 <div class="refsect1" lang="en">
  67 <a name="id2633170"></a><h2>OPTIONS</h2>
  68 <div class="variablelist"><dl>
  69 <dt><span class="term">-a</span></dt>
  70 <dd>
  71 <p>
  72             Do automatic <span><strong class="command">rndc</strong></span> configuration.
  73             This creates a file <code class="filename">rndc.key</code>
  74             in <code class="filename">/etc</code> (or whatever
  75             <code class="varname">sysconfdir</code>
  76             was specified as when <acronym class="acronym">BIND</acronym> was
  77             built)
  78             that is read by both <span><strong class="command">rndc</strong></span>
  79             and <span><strong class="command">named</strong></span> on startup.  The
  80             <code class="filename">rndc.key</code> file defines a default
  81             command channel and authentication key allowing
  82             <span><strong class="command">rndc</strong></span> to communicate with
  83             <span><strong class="command">named</strong></span> on the local host
  84             with no further configuration.
  85           </p>
  86 <p>
  87             Running <span><strong class="command">rndc-confgen -a</strong></span> allows
  88             BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
  89             drop-in
  90             replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
  91             with no changes to the existing BIND 8
  92             <code class="filename">named.conf</code> file.
  93           </p>
  94 <p>
  95             If a more elaborate configuration than that
  96             generated by <span><strong class="command">rndc-confgen -a</strong></span>
  97             is required, for example if rndc is to be used remotely,
  98             you should run <span><strong class="command">rndc-confgen</strong></span> without
  99             the
 100             <span><strong class="command">-a</strong></span> option and set up a
 101             <code class="filename">rndc.conf</code> and
 102             <code class="filename">named.conf</code>
 103             as directed.
 104           </p>
 105 </dd>
 106 <dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
 107 <dd><p>
 108             Specifies the size of the authentication key in bits.
 109             Must be between 1 and 512 bits; the default is 128.
 110           </p></dd>
 111 <dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
 112 <dd><p>
 113             Used with the <span><strong class="command">-a</strong></span> option to specify
 114             an alternate location for <code class="filename">rndc.key</code>.
 115           </p></dd>
 116 <dt><span class="term">-h</span></dt>
 117 <dd><p>
 118             Prints a short summary of the options and arguments to
 119             <span><strong class="command">rndc-confgen</strong></span>.
 120           </p></dd>
 121 <dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
 122 <dd><p>
 123             Specifies the key name of the rndc authentication key.
 124             This must be a valid domain name.
 125             The default is <code class="constant">rndc-key</code>.
 126           </p></dd>
 127 <dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
 128 <dd><p>
 129             Specifies the command channel port where <span><strong class="command">named</strong></span>
 130             listens for connections from <span><strong class="command">rndc</strong></span>.
 131             The default is 953.
 132           </p></dd>
 133 <dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
 134 <dd><p>
 135             Specifies a source of random data for generating the
 136             authorization.  If the operating
 137             system does not provide a <code class="filename">/dev/random</code>
 138             or equivalent device, the default source of randomness
 139             is keyboard input.  <code class="filename">randomdev</code>
 140             specifies
 141             the name of a character device or file containing random
 142             data to be used instead of the default.  The special value
 143             <code class="filename">keyboard</code> indicates that keyboard
 144             input should be used.
 145           </p></dd>
 146 <dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
 147 <dd><p>
 148             Specifies the IP address where <span><strong class="command">named</strong></span>
 149             listens for command channel connections from
 150             <span><strong class="command">rndc</strong></span>.  The default is the loopback
 151             address 127.0.0.1.
 152           </p></dd>
 153 <dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
 154 <dd><p>
 155             Used with the <span><strong class="command">-a</strong></span> option to specify
 156             a directory where <span><strong class="command">named</strong></span> will run
 157             chrooted.  An additional copy of the <code class="filename">rndc.key</code>
 158             will be written relative to this directory so that
 159             it will be found by the chrooted <span><strong class="command">named</strong></span>.
 160           </p></dd>
 161 <dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
 162 <dd><p>
 163             Used with the <span><strong class="command">-a</strong></span> option to set the
 164             owner
 165             of the <code class="filename">rndc.key</code> file generated.
 166             If
 167             <span><strong class="command">-t</strong></span> is also specified only the file
 168             in
 169             the chroot area has its owner changed.
 170           </p></dd>
 171 </dl></div>
 172 </div>
 173 <div class="refsect1" lang="en">
 174 <a name="id2634989"></a><h2>EXAMPLES</h2>
 175 <p>
 176       To allow <span><strong class="command">rndc</strong></span> to be used with
 177       no manual configuration, run
 178     </p>
 179 <p><strong class="userinput"><code>rndc-confgen -a</code></strong>
 180     </p>
 181 <p>
 182       To print a sample <code class="filename">rndc.conf</code> file and
 183       corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
 184       statements to be manually inserted into <code class="filename">named.conf</code>,
 185       run
 186     </p>
 187 <p><strong class="userinput"><code>rndc-confgen</code></strong>
 188     </p>
 189 </div>
 190 <div class="refsect1" lang="en">
 191 <a name="id2635046"></a><h2>SEE ALSO</h2>
 192 <p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
 193       <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
 194       <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
 195       <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
 196     </p>
 197 </div>
 198 <div class="refsect1" lang="en">
 199 <a name="id2635084"></a><h2>AUTHOR</h2>
 200 <p><span class="corpauthor">Internet Systems Consortium</span>
 201     </p>
 202 </div>
 203 </div>
 204 <div class="navfooter">
 205 <hr>
 206 <table width="100%" summary="Navigation footer">
 207 <tr>
 208 <td width="40%" align="left">
 209 <a accesskey="p" href="man.rndc.conf.html">Prev</a> </td>
 210 <td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
 211 <td width="40%" align="right"> </td>
 212 </tr>
 213 <tr>
 214 <td width="40%" align="left" valign="top">
 215 <code class="filename">rndc.conf</code> </td>
 216 <td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
 217 <td width="40%" align="right" valign="top"> </td>
 218 </tr>
 219 </table>
 220 </div>
 221 </body>
 222 </html>