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