rndc-confgen.html revision 156d095d8693524541cb77e2cf952abab95479a1
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<!--
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe -
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - Permission to use, copy, modify, and/or distribute this software for any
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - purpose with or without fee is hereby granted, provided that the above
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - copyright notice and this permission notice appear in all copies.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe -
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov - PERFORMANCE OF THIS SOFTWARE.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov-->
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<!-- $Id: rndc-confgen.html,v 1.5 2009/06/12 01:12:50 tbox Exp $ -->
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<html>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<head>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<title>rndc-confgen</title>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</head>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<a name="man.rndc-confgen"></a><div class="titlepage"></div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="refnamediv">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<h2>Name</h2>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<p><span class="application">rndc-confgen</span> &#8212; rndc key generation tool</p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="refsynopsisdiv">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<h2>Synopsis</h2>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="cmdsynopsis"><p><code class="command">rndc-confgen</code> [<code class="option">-a</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>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="refsect1" lang="en">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<a name="id2543410"></a><h2>DESCRIPTION</h2>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<p><span><strong class="command">rndc-confgen</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov generates configuration files
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov for <span><strong class="command">rndc</strong></span>. It can be used as a
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov convenient alternative to writing the
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="filename">rndc.conf</code> file
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov and the corresponding <span><strong class="command">controls</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov and <span><strong class="command">key</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov statements in <code class="filename">named.conf</code> by hand.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Alternatively, it can be run with the <span><strong class="command">-a</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov option to set up a <code class="filename">rndc.key</code> file and
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov avoid the need for a <code class="filename">rndc.conf</code> file
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov and a <span><strong class="command">controls</strong></span> statement altogether.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</div>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="refsect1" lang="en">
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<a name="id2543454"></a><h2>OPTIONS</h2>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<div class="variablelist"><dl>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dt><span class="term">-a</span></dt>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dd>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Do automatic <span><strong class="command">rndc</strong></span> configuration.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov This creates a file <code class="filename">rndc.key</code>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov in <code class="filename">/etc</code> (or whatever
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="varname">sysconfdir</code>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov was specified as when <acronym class="acronym">BIND</acronym> was
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov built)
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov that is read by both <span><strong class="command">rndc</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov and <span><strong class="command">named</strong></span> on startup. The
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="filename">rndc.key</code> file defines a default
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov command channel and authentication key allowing
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <span><strong class="command">rndc</strong></span> to communicate with
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <span><strong class="command">named</strong></span> on the local host
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov with no further configuration.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Running <span><strong class="command">rndc-confgen -a</strong></span> allows
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov BIND 9 and <span><strong class="command">rndc</strong></span> to be used as
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov drop-in
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov replacements for BIND 8 and <span><strong class="command">ndc</strong></span>,
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov with no changes to the existing BIND 8
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="filename">named.conf</code> file.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov If a more elaborate configuration than that
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov generated by <span><strong class="command">rndc-confgen -a</strong></span>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov is required, for example if rndc is to be used remotely,
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov you should run <span><strong class="command">rndc-confgen</strong></span> without
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov the
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <span><strong class="command">-a</strong></span> option and set up a
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="filename">rndc.conf</code> and
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <code class="filename">named.conf</code>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov as directed.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov</dd>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dd><p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Specifies the size of the authentication key in bits.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Must be between 1 and 512 bits; the default is 128.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p></dd>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dd><p>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov Used with the <span><strong class="command">-a</strong></span> option to specify
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov an alternate location for <code class="filename">rndc.key</code>.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p></dd>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<dt><span class="term">-h</span></dt>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<dd><p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Prints a short summary of the options and arguments to
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov <span><strong class="command">rndc-confgen</strong></span>.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p></dd>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov<dd><p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Specifies the key name of the rndc authentication key.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov This must be a valid domain name.
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe The default is <code class="constant">rndc-key</code>.
a9478106a12424322498e53cf7cd75bd8a4d6004Yuri Pankov </p></dd>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe<dd><p>
c10c16dec587a0662068f6e2991c29ed3a9db943Richard Lowe Specifies the command channel port where <span><strong class="command">named</strong></span>
listens for connections from <span><strong class="command">rndc</strong></span>.
The default is 953.
</p></dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
<dd><p>
Specifies a source of random data for generating the
authorization. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
is keyboard input. <code class="filename">randomdev</code>
specifies
the name of a character device or file containing random
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
</p></dd>
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
<dd><p>
Specifies the IP address where <span><strong class="command">named</strong></span>
listens for command channel connections from
<span><strong class="command">rndc</strong></span>. The default is the loopback
address 127.0.0.1.
</p></dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
<dd><p>
Used with the <span><strong class="command">-a</strong></span> option to specify
a directory where <span><strong class="command">named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
it will be found by the chrooted <span><strong class="command">named</strong></span>.
</p></dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd><p>
Used with the <span><strong class="command">-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
<span><strong class="command">-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id2543768"></a><h2>EXAMPLES</h2>
<p>
To allow <span><strong class="command">rndc</strong></span> to be used with
no manual configuration, run
</p>
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
<p>
To print a sample <code class="filename">rndc.conf</code> file and
corresponding <span><strong class="command">controls</strong></span> and <span><strong class="command">key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543810"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">rndc.conf</span>(5)</span>,
<span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543848"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div></body>
</html>