man.rndc-confgen.html revision 2fa992d017c027173a47c834db88bef10df453c0
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - Copyright (C) 2000-2003 Internet Software Consortium.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - Permission to use, copy, modify, and/or distribute this software for any
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - purpose with or without fee is hereby granted, provided that the above
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - copyright notice and this permission notice appear in all copies.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington - PERFORMANCE OF THIS SOFTWARE.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<table width="100%" summary="Navigation header">
7de0b02ea333f0df1acdce59cfb943fd3c37e940Phill Cunnington<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<th width="60%" align="center">Manual pages</th>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<a name="man.rndc-confgen"></a><div class="titlepage"></div>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<p><span class="application">rndc-confgen</span> — rndc key generation tool</p>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<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>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<a name="id2662726"></a><h2>DESCRIPTION</h2>
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington<p><span><strong class="command">rndc-confgen</strong></span>
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington generates configuration files
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington for <span><strong class="command">rndc</strong></span>. It can be used as a
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington convenient alternative to writing the
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington <code class="filename">rndc.conf</code> file
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington and the corresponding <span><strong class="command">controls</strong></span>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington and <span><strong class="command">key</strong></span>
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington statements in <code class="filename">named.conf</code> by hand.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington option to set up a <code class="filename">rndc.key</code> file and
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington avoid the need for a <code class="filename">rndc.conf</code> file
c289b3af72dda73e53e6886c920c198b779ebf37Rich Riley and a <span><strong class="command">controls</strong></span> statement altogether.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington Do automatic <span><strong class="command">rndc</strong></span> configuration.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington This creates a file <code class="filename">rndc.key</code>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington in <code class="filename">/etc</code> (or whatever
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington was specified as when <acronym class="acronym">BIND</acronym> was
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington that is read by both <span><strong class="command">rndc</strong></span>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington and <span><strong class="command">named</strong></span> on startup. The
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington <code class="filename">rndc.key</code> file defines a default
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington command channel and authentication key allowing
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington <span><strong class="command">rndc</strong></span> to communicate with
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington <span><strong class="command">named</strong></span> on the local host
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington with no further configuration.
feb6036520c1ae40dab32694a6162ba0af6bf8e8Phill Cunnington Running <span><strong class="command">rndc-confgen -a</strong></span> allows
feb6036520c1ae40dab32694a6162ba0af6bf8e8Phill Cunnington BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
7de0b02ea333f0df1acdce59cfb943fd3c37e940Phill Cunnington replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
7de0b02ea333f0df1acdce59cfb943fd3c37e940Phill Cunnington with no changes to the existing BIND 8
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington <code class="filename">named.conf</code> file.
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington If a more elaborate configuration than that
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington generated by <span><strong class="command">rndc-confgen -a</strong></span>
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington is required, for example if rndc is to be used remotely,
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington you should run <span><strong class="command">rndc-confgen</strong></span> without
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington <span><strong class="command">-a</strong></span> option and set up a
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington <code class="filename">rndc.conf</code> and
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
2dffe047d982828750ee6d5e2bda32caee3de522Phill Cunnington Specifies the algorithm to use for the TSIG key. Available
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington hmac-sha384 and hmac-sha512. The default is hmac-md5.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington Specifies the size of the authentication key in bits.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington Must be between 1 and 512 bits; the default is the
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington Used with the <span><strong class="command">-a</strong></span> option to specify
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington an alternate location for <code class="filename">rndc.key</code>.
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington Prints a short summary of the options and arguments to
bb788488efdd119f14e88ccc5a3cf302e743bcc4Phill Cunnington <span><strong class="command">rndc-confgen</strong></span>.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Specifies the key name of the rndc authentication key.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington This must be a valid domain name.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington The default is <code class="constant">rndc-key</code>.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Specifies the command channel port where <span><strong class="command">named</strong></span>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington listens for connections from <span><strong class="command">rndc</strong></span>.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington The default is 953.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Specifies a source of random data for generating the
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington authorization. If the operating
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington system does not provide a <code class="filename">/dev/random</code>
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington or equivalent device, the default source of randomness
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington is keyboard input. <code class="filename">randomdev</code>
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington the name of a character device or file containing random
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington data to be used instead of the default. The special value
732503600dd72c03d01e43a8a199f43150f8e056Phill Cunnington <code class="filename">keyboard</code> indicates that keyboard
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington input should be used.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Specifies the IP address where <span><strong class="command">named</strong></span>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington listens for command channel connections from
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington <span><strong class="command">rndc</strong></span>. The default is the loopback
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington address 127.0.0.1.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Used with the <span><strong class="command">-a</strong></span> option to specify
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington a directory where <span><strong class="command">named</strong></span> will run
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington chrooted. An additional copy of the <code class="filename">rndc.key</code>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington will be written relative to this directory so that
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington it will be found by the chrooted <span><strong class="command">named</strong></span>.
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
a093731116a8c24d49b903df7602cf586e499b45Phill Cunnington Used with the <span><strong class="command">-a</strong></span> option to set the
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington of the <code class="filename">rndc.key</code> file generated.
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington <span><strong class="command">-t</strong></span> is also specified only the file
a6bf4d9e39eae70c6b74d0d91d35704662c84ff7Phill Cunnington the chroot area has its owner changed.