6c2a76b3e2ccd32c35814b6e0f54da00190749d7Evan Hunt - Copyright (C) 2001, 2003-2005, 2007, 2009, 2013-2016 Internet Systems Consortium, Inc. ("ISC")
5affecff6e148a8e124d03f5dbac0da11e30dcc5Tinderbox User - This Source Code Form is subject to the terms of the Mozilla Public
19558a04decde0e7261d489d92d04ad88104217bTinderbox User - License, v. 2.0. If a copy of the MPL was not distributed with this
2fee8782a6fd57d86a67949092ab9197111af390Evan Hunt - file, You can obtain one at http://mozilla.org/MPL/2.0/.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<!-- Converted by db4-upgrade version 1.0 -->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<refentry xmlns:db="http://docbook.org/ns/docbook" version="5.0" xml:id="man.rndc-confgen">
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refentryinfo>
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </refentryinfo>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refentrytitle><application>rndc-confgen</application></refentrytitle>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refnamediv>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refname><application>rndc-confgen</application></refname>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <refpurpose>rndc key generation tool</refpurpose>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User </refnamediv>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt </copyright>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refsynopsisdiv>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-a</option></arg>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <arg choice="opt" rep="norepeat"><option>-A <replaceable class="parameter">algorithm</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-b <replaceable class="parameter">keysize</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-c <replaceable class="parameter">keyfile</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-h</option></arg>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-p <replaceable class="parameter">port</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt <arg choice="opt" rep="norepeat"><option>-s <replaceable class="parameter">address</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-t <replaceable class="parameter">chrootdir</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <arg choice="opt" rep="norepeat"><option>-u <replaceable class="parameter">user</replaceable></option></arg>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </cmdsynopsis>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </refsynopsisdiv>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <refsection><info><title>DESCRIPTION</title></info>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews generates configuration files
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews for <command>rndc</command>. It can be used as a
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater convenient alternative to writing the
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews and the corresponding <command>controls</command>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews statements in <filename>named.conf</filename> by hand.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews Alternatively, it can be run with the <command>-a</command>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews option to set up a <filename>rndc.key</filename> file and
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews avoid the need for a <filename>rndc.conf</filename> file
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews and a <command>controls</command> statement altogether.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </refsection>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refsection><info><title>OPTIONS</title></info>
b91d11bfcc30b96f2c80f3a76d12e3dcc8597a68Mark Andrews <variablelist>
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrews <varlistentry>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews Do automatic <command>rndc</command> configuration.
e76dfff967cfbe00f4d1540434832e4499a9cd83Tinderbox User was specified as when <acronym>BIND</acronym> was
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <filename>rndc.key</filename> file defines a default
549c517e2ecad52bb1d32f08920e29d4e8cda71eTinderbox User command channel and authentication key allowing
3bd8b5a8fb126e45c67ff53b68183c889cc27918Tinderbox User with no further configuration.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Running <command>rndc-confgen -a</command> allows
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews BIND 9 and <command>rndc</command> to be used as
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews replacements for BIND 8 and <command>ndc</command>,
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User with no changes to the existing BIND 8
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt If a more elaborate configuration than that
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews generated by <command>rndc-confgen -a</command>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User is required, for example if rndc is to be used remotely,
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews you should run <command>rndc-confgen</command> without
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt </varlistentry>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <varlistentry>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <term>-A <replaceable class="parameter">algorithm</replaceable></term>
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt Specifies the algorithm to use for the TSIG key. Available
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-md5 or
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews if MD5 was disabled hmac-sha256.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </varlistentry>
fec6e13f2d1e69fe1c2b8fac36f732f124cf5398Mark Andrews <varlistentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <term>-b <replaceable class="parameter">keysize</replaceable></term>
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont Specifies the size of the authentication key in bits.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews Must be between 1 and 512 bits; the default is the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </varlistentry>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <varlistentry>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews <term>-c <replaceable class="parameter">keyfile</replaceable></term>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Used with the <command>-a</command> option to specify
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews an alternate location for <filename>rndc.key</filename>.
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews </varlistentry>
549c517e2ecad52bb1d32f08920e29d4e8cda71eTinderbox User <varlistentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews Prints a short summary of the options and arguments to
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </varlistentry>
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <varlistentry>
e813f036c8251b6d9d2a72fa84f80c2c9d2795afMark Andrews <term>-k <replaceable class="parameter">keyname</replaceable></term>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User Specifies the key name of the rndc authentication key.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater This must be a valid domain name.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User The default is <constant>rndc-key</constant>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews </varlistentry>
fa0326cc2cf428f67575b6ba3b97b528a31b0010Tinderbox User <varlistentry>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <term>-p <replaceable class="parameter">port</replaceable></term>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews Specifies the command channel port where <command>named</command>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User listens for connections from <command>rndc</command>.
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater The default is 953.
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt </varlistentry>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <varlistentry>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <term>-r <replaceable class="parameter">randomfile</replaceable></term>
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt Specifies a source of random data for generating the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews authorization. If the operating
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User system does not provide a <filename>/dev/random</filename>
dd65eb1efb40b1c47d57963192bfc54873b219beAutomatic Updater or equivalent device, the default source of randomness
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User is keyboard input. <filename>randomdev</filename>
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt the name of a character device or file containing random
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews data to be used instead of the default. The special value
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <filename>keyboard</filename> indicates that keyboard
133e6d43fa82e80d3798be4de00f4540f485ec6cAutomatic Updater input should be used.
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt </varlistentry>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <varlistentry>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson <term>-s <replaceable class="parameter">address</replaceable></term>
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt Specifies the IP address where <command>named</command>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews listens for command channel connections from
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <command>rndc</command>. The default is the loopback
5f7586ddbd3edd11272cdd30ed613d936129328bTinderbox User address 127.0.0.1.
30370d905e9be3be7d9b947fd432bacecbb13bb9Evan Hunt </varlistentry>
015055b6e23f5c08f6a5b34726f90b62597e9e45Tinderbox User <varlistentry>
361967ea970ea8f0ef8875e769505ecdac74bfb0Tinderbox User <term>-t <replaceable class="parameter">chrootdir</replaceable></term>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews Used with the <command>-a</command> option to specify
5affecff6e148a8e124d03f5dbac0da11e30dcc5Tinderbox User a directory where <command>named</command> will run
34d1f3b65324f8fcf358fa2f47891441d4b1d2f0Tinderbox User chrooted. An additional copy of the <filename>rndc.key</filename>
1fce11b1d3f2d461d261156b8cdc64ab864f06a9Tinderbox User will be written relative to this directory so that
fab54780409846f7c71f6026d665f18c77c649efTinderbox User it will be found by the chrooted <command>named</command>.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </varlistentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <varlistentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <term>-u <replaceable class="parameter">user</replaceable></term>
8927a982bde7e4b665966b55f0fa57c5cf21b9d8Mark Andrews Used with the <command>-a</command> option to set the
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews of the <filename>rndc.key</filename> file generated.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <command>-t</command> is also specified only the file
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews the chroot area has its owner changed.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </varlistentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </variablelist>
361967ea970ea8f0ef8875e769505ecdac74bfb0Tinderbox User </refsection>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refsection><info><title>EXAMPLES</title></info>
cdf1c3d486ec082ef6c92297d22d54a67cca0c90Tinderbox User To allow <command>rndc</command> to be used with
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews no manual configuration, run
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews To print a sample <filename>rndc.conf</filename> file and
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews corresponding <command>controls</command> and <command>key</command>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews statements to be manually inserted into <filename>named.conf</filename>,
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </refsection>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refsection><info><title>SEE ALSO</title></info>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </citerefentry>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <citerefentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refentrytitle>rndc.conf</refentrytitle><manvolnum>5</manvolnum>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </citerefentry>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <citerefentry>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
a2c370ca12bb0360ff7e969474ead3f788c65fffTinderbox User </citerefentry>,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
7d638dd31ecb633aaefca994b60b70c58b5def03Tinderbox User </refsection>