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