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

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