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