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