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