rndc-confgen.docbook revision 704e6c8876907aac0bf7380effca8bca400d4acd
bec154197d3d640b0d5b416cd5218ea58dca5d3aTinderbox User - Copyright (C) 2001, 2003-2005, 2007, 2009, 2013-2016 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - This Source Code Form is subject to the terms of the Mozilla Public
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - 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/.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- Converted by db4-upgrade version 1.0 -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc-confgen">
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>rndc-confgen</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>rndc-confgen</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>rndc key generation tool</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-a</option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">algorithm</replaceable></option></arg>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">keyfile</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-h</option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">address</replaceable></option></arg>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">chrootdir</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </cmdsynopsis>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User </refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsection><info><title>DESCRIPTION</title></info>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User generates configuration files
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User for <command>rndc</command>. It can be used as a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein convenient alternative to writing the
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User and the corresponding <command>controls</command>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User statements in <filename>named.conf</filename> by hand.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Alternatively, it can be run with the <command>-a</command>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User option to set up a <filename>rndc.key</filename> file and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein avoid the need for a <filename>rndc.conf</filename> file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and a <command>controls</command> statement altogether.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User <refsection><info><title>OPTIONS</title></info>
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User <variablelist>
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Do automatic <command>rndc</command> configuration.
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User This creates a file <filename>rndc.key</filename>
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User was specified as when <acronym>BIND</acronym> was
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>rndc.key</filename> file defines a default
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User command channel and authentication key allowing
7be2f6d5df28b207e3e385c555eb4f740150528dTinderbox User with no further configuration.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Running <command>rndc-confgen -a</command> allows
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater BIND 9 and <command>rndc</command> to be used as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein replacements for BIND 8 and <command>ndc</command>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein with no changes to the existing BIND 8
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If a more elaborate configuration than that
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews generated by <command>rndc-confgen -a</command>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews is required, for example if rndc is to be used remotely,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein you should run <command>rndc-confgen</command> without
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews as directed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-A <replaceable class="parameter">algorithm</replaceable></term>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews 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.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-b <replaceable class="parameter">keysize</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the size of the authentication key in bits.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Must be between 1 and 512 bits; the default is the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-c <replaceable class="parameter">keyfile</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Used with the <command>-a</command> option to specify
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein an alternate location for <filename>rndc.key</filename>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Prints a short summary of the options and arguments to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-k <replaceable class="parameter">keyname</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the key name of the rndc authentication key.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews This must be a valid domain name.
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews </varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <varlistentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <term>-p <replaceable class="parameter">port</replaceable></term>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews Specifies the command channel port where <command>named</command>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews listens for connections from <command>rndc</command>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The default is 953.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-r <replaceable class="parameter">randomfile</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies a source of random data for generating the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authorization. If the operating
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein system does not provide a <filename>/dev/random</filename>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein or equivalent device, the default source of randomness
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater is keyboard input. <filename>randomdev</filename>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater the name of a character device or file containing random
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater data to be used instead of the default. The special value
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater <filename>keyboard</filename> indicates that keyboard
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater input should be used.
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater </varlistentry>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater <varlistentry>
afb33f777af856f8c3382604a7a8ffdfe2b512c5Automatic Updater <term>-s <replaceable class="parameter">address</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the IP address where <command>named</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein listens for command channel connections from
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>rndc</command>. The default is the loopback
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein address 127.0.0.1.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-t <replaceable class="parameter">chrootdir</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Used with the <command>-a</command> option to specify
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein a directory where <command>named</command> will run
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein chrooted. An additional copy of the <filename>rndc.key</filename>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will be written relative to this directory so that
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein it will be found by the chrooted <command>named</command>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-u <replaceable class="parameter">user</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Used with the <command>-a</command> option to set the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of the <filename>rndc.key</filename> file generated.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>-t</command> is also specified only the file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the chroot area has its owner changed.
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </varlistentry>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </variablelist>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews </refsection>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews <refsection><info><title>EXAMPLES</title></info>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews To allow <command>rndc</command> to be used with
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein no manual configuration, run
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews To print a sample <filename>rndc.conf</filename> file and
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews corresponding <command>controls</command> and <command>key</command>
ceeb18e6907a10547859faa340ecad83bedae90cMark Andrews statements to be manually inserted into <filename>named.conf</filename>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsection>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsection><info><title>SEE ALSO</title></info>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User </citerefentry>,
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
3a32ac2a720653083c7a22cb654b86c398f6d4c8Tinderbox User </refsection>