man.rndc-confgen.html revision d6fa26d0adaec6c910115be34fe7a5a5f402c14f
689023771c563d8660e45d439a207e06e96de28fMark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Copyright (C) 2000-2015 Internet Systems Consortium, Inc. ("ISC")
689023771c563d8660e45d439a207e06e96de28fMark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
689023771c563d8660e45d439a207e06e96de28fMark Andrews - License, v. 2.0. If a copy of the MPL was not distributed with this
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - file, You can obtain one at http://mozilla.org/MPL/2.0/.
689023771c563d8660e45d439a207e06e96de28fMark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
689023771c563d8660e45d439a207e06e96de28fMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
689023771c563d8660e45d439a207e06e96de28fMark Andrews<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
689023771c563d8660e45d439a207e06e96de28fMark Andrews<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
79cf9524b15ca65f55fd6913e6cf01b5581c588aAutomatic Updater<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<table width="100%" summary="Navigation header">
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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater<a name="man.rndc-confgen"></a><div class="titlepage"></div>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob 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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="command"><strong>rndc-confgen</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generates configuration files
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for <span class="command"><strong>rndc</strong></span>. It can be used as a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein convenient alternative to writing the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and the corresponding <span class="command"><strong>controls</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and <span class="command"><strong>key</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statements in <code class="filename">named.conf</code> by hand.
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater Alternatively, it can be run with the <span class="command"><strong>-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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and a <span class="command"><strong>controls</strong></span> statement altogether.
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater<a name="id-1.14.29.8"></a><h2>OPTIONS</h2>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<div class="variablelist"><dl class="variablelist">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Do automatic <span class="command"><strong>rndc</strong></span> configuration.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This creates a file <code class="filename">rndc.key</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in <code class="filename">/etc</code> (or whatever
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater was specified as when <acronym class="acronym">BIND</acronym> was
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein that is read by both <span class="command"><strong>rndc</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and <span class="command"><strong>named</strong></span> on startup. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="filename">rndc.key</code> file defines a default
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein command channel and authentication key allowing
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>rndc</strong></span> to communicate with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>named</strong></span> on the local host
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein with no further configuration.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
00124ad0406365d39f4b2d1011ef6a76706e9df0Mark Andrews replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
3b4098640dd85040270f39b9a5ee5e22de99d3d6Mark Andrews with no changes to the existing BIND 8
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If a more elaborate configuration than that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generated by <span class="command"><strong>rndc-confgen -a</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein is required, for example if rndc is to be used remotely,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein you should run <span class="command"><strong>rndc-confgen</strong></span> without
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>-a</strong></span> option and set up a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein as directed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the algorithm to use for the TSIG key. Available
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hmac-sha384 and hmac-sha512. The default is hmac-md5 or
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein if MD5 was disabled hmac-sha256.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater Specifies the size of the authentication key in bits.
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater Must be between 1 and 512 bits; the default is the
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater Used with the <span class="command"><strong>-a</strong></span> option to specify
d060d8669f5558690e7faf4a1c12fe5c02a7c60dAutomatic Updater an alternate location for <code class="filename">rndc.key</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>rndc-confgen</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the key name of the rndc authentication key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein This must be a valid domain name.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The default is <code class="constant">rndc-key</code>.
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the command channel port where <span class="command"><strong>named</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein listens for connections from <span class="command"><strong>rndc</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The default is 953.
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies a source of random data for generating the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authorization. If the operating
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein system does not provide a <code class="filename">/dev/random</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or equivalent device, the default source of randomness
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews is keyboard input. <code class="filename">randomdev</code>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the name of a character device or file containing random
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein data to be used instead of the default. The special value
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="filename">keyboard</code> indicates that keyboard
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein input should be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the IP address where <span class="command"><strong>named</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein listens for command channel connections from
4f6469885c3d66367e3f8fb94e1f3c66115990b0Mark Andrews <span class="command"><strong>rndc</strong></span>. The default is the loopback
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein address 127.0.0.1.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Used with the <span class="command"><strong>-a</strong></span> option to specify
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a directory where <span class="command"><strong>named</strong></span> will run
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein chrooted. An additional copy of the <code class="filename">rndc.key</code>
65ad89971ee9973074cd11c207af92bf5440df01Automatic Updater will be written relative to this directory so that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein it will be found by the chrooted <span class="command"><strong>named</strong></span>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Used with the <span class="command"><strong>-a</strong></span> option to set the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of the <code class="filename">rndc.key</code> file generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="command"><strong>-t</strong></span> is also specified only the file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the chroot area has its owner changed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To allow <span class="command"><strong>rndc</strong></span> to be used with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein no manual configuration, run
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
4a71c59d2bf32585c5dd18f4630d5f10e56a1ab3Automatic Updater To print a sample <code class="filename">rndc.conf</code> file and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statements to be manually inserted into <code class="filename">named.conf</code>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><strong class="userinput"><code>rndc-confgen</code></strong>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
517ae3de96aaf870049c52f1224e38a85fe7f21aAutomatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right" valign="top">�<span class="application">ddns-confgen</span>
47012ae6dbf18a2503d7b33c1c9583dc38625cb7Mark Andrews<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0rc1</p>