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