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