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