man.rndc-confgen.html revision a8a5c3eb62ea3256fd015fffd12a8a7552331df9
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Copyright (C) 2000-2003 Internet Software Consortium.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - Permission to use, copy, modify, and/or distribute this software for any
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - purpose with or without fee is hereby granted, provided that the above
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - copyright notice and this permission notice appear in all copies.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi - PERFORMANCE OF THIS SOFTWARE.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<!-- $Id$ -->
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<a name="man.rndc-confgen"></a><div class="titlepage"></div>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</code>] [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></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>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><span><strong class="command">rndc-confgen</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi generates configuration files
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi for <span><strong class="command">rndc</strong></span>. It can be used as a
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi convenient alternative to writing the
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi and the corresponding <span><strong class="command">controls</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi statements in <code class="filename">named.conf</code> by hand.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi option to set up a <code class="filename">rndc.key</code> file and
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi avoid the need for a <code class="filename">rndc.conf</code> file
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi and a <span><strong class="command">controls</strong></span> statement altogether.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Do automatic <span><strong class="command">rndc</strong></span> configuration.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi This creates a file <code class="filename">rndc.key</code>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi was specified as when <acronym class="acronym">BIND</acronym> was
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi that is read by both <span><strong class="command">rndc</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi and <span><strong class="command">named</strong></span> on startup. The
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <code class="filename">rndc.key</code> file defines a default
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi command channel and authentication key allowing
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">rndc</strong></span> to communicate with
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">named</strong></span> on the local host
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi with no further configuration.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Running <span><strong class="command">rndc-confgen -a</strong></span> allows
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi with no changes to the existing BIND 8
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi If a more elaborate configuration than that
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi generated by <span><strong class="command">rndc-confgen -a</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi is required, for example if rndc is to be used remotely,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi you should run <span><strong class="command">rndc-confgen</strong></span> without
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">-a</strong></span> option and set up a
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi as directed.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies the algorithm to use for the TSIG key. Available
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi hmac-sha384 and hmac-sha512. The default is hmac-md5.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies the size of the authentication key in bits.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Must be between 1 and 512 bits; the default is the
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Used with the <span><strong class="command">-a</strong></span> option to specify
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi an alternate location for <code class="filename">rndc.key</code>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Prints a short summary of the options and arguments to
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">rndc-confgen</strong></span>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies the key name of the rndc authentication key.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi This must be a valid domain name.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi The default is <code class="constant">rndc-key</code>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies the command channel port where <span><strong class="command">named</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi listens for connections from <span><strong class="command">rndc</strong></span>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi The default is 953.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies a source of random data for generating the
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi authorization. If the operating
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi system does not provide a <code class="filename">/dev/random</code>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi or equivalent device, the default source of randomness
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi is keyboard input. <code class="filename">randomdev</code>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi the name of a character device or file containing random
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi data to be used instead of the default. The special value
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <code class="filename">keyboard</code> indicates that keyboard
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi input should be used.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Specifies the IP address where <span><strong class="command">named</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi listens for command channel connections from
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">rndc</strong></span>. The default is the loopback
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi address 127.0.0.1.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Used with the <span><strong class="command">-a</strong></span> option to specify
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi a directory where <span><strong class="command">named</strong></span> will run
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi chrooted. An additional copy of the <code class="filename">rndc.key</code>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi will be written relative to this directory so that
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi it will be found by the chrooted <span><strong class="command">named</strong></span>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi Used with the <span><strong class="command">-a</strong></span> option to set the
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi of the <code class="filename">rndc.key</code> file generated.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span><strong class="command">-t</strong></span> is also specified only the file
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi the chroot area has its owner changed.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi To allow <span><strong class="command">rndc</strong></span> to be used with
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi no manual configuration, run
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi To print a sample <code class="filename">rndc.conf</code> file and
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi statements to be manually inserted into <code class="filename">named.conf</code>,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><strong class="userinput"><code>rndc-confgen</code></strong>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<p><span class="corpauthor">Internet Systems Consortium</span>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
7aec1d6e253b21f9e9b7ef68b4d81ab9859b51fecindi<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>