man.rndc.conf.html revision 5091a6fed939d70cc5ae90a8ddecf2a829cdbaba
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews<!--
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
71cef386fae61275b03e203825680b39fedaa8c6Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
bef75d63d74f58abc0f834ed271526672777ba29Automatic Updater -
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - Permission to use, copy, modify, and/or distribute this software for any
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - purpose with or without fee is hereby granted, provided that the above
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User - copyright notice and this permission notice appear in all copies.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater -
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User - PERFORMANCE OF THIS SOFTWARE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt-->
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User<!-- $Id$ -->
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<html>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<head>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<title>rndc.conf</title>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<link rel="prev" href="man.rndc.html" title="rndc">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User</head>
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<div class="navheader">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<table width="100%" summary="Navigation header">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<tr>
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User<td width="20%" align="left">
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<th width="60%" align="center">Manual pages</th>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</td>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</tr>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</table>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<hr>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refentry" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="man.rndc.conf"></a><div class="titlepage"></div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refnamediv">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<h2>Name</h2>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<p><code class="filename">rndc.conf</code> &#8212; rndc configuration file</p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsynopsisdiv">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<h2>Synopsis</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater</div>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<div class="refsect1" lang="en">
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<a name="id2625982"></a><h2>DESCRIPTION</h2>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><code class="filename">rndc.conf</code> is the configuration file
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User utility. This file has a similar structure and syntax to
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="filename">named.conf</code>. Statements are enclosed
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User in braces and terminated with a semi-colon. Clauses in
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User the statements are also semi-colon terminated. The usual
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User comment styles are supported:
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User<p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User C style: /* */
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater C++ style: // to end of line
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User Unix style: # to end of line
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p><code class="filename">rndc.conf</code> is much simpler than
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User <code class="filename">named.conf</code>. The file uses three
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User statements: an options statement, a server statement
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User and a key statement.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The <code class="option">options</code> statement contains five clauses.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater The <code class="option">default-server</code> clause is followed by the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User name or address of a name server. This host will be used when
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User no name server is given as an argument to
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User clause is followed by the name of a key which is identified by
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User a <code class="option">key</code> statement. If no
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <code class="option">keyid</code> is provided on the rndc command line,
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater and no <code class="option">key</code> clause is found in a matching
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <code class="option">server</code> statement, this default key will be
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater used to authenticate the server's commands and responses. The
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">default-port</code> clause is followed by the port
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User to connect to on the remote name server. If no
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <code class="option">port</code> option is provided on the rndc command
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User line, and no <code class="option">port</code> clause is found in a
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User matching <code class="option">server</code> statement, this default port
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater will be used to connect.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User The <code class="option">default-source-address</code> and
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">default-source-address-v6</code> clauses which
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater can be used to set the IPv4 and IPv6 source addresses
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User respectively.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User After the <code class="option">server</code> keyword, the server
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User statement includes a string which is the hostname or address
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater for a name server. The statement has three possible clauses:
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">key</code>, <code class="option">port</code> and
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User <code class="option">addresses</code>. The key name must match the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User name of a key statement in the file. The port number
7e71f05d8643aca84914437c900cb716444507e4Tinderbox User specifies the port to connect to. If an <code class="option">addresses</code>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User clause is supplied these addresses will be used instead of
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User the server name. Each address can take an optional port.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater of supplied then these will be used to specify the IPv4 and IPv6
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater source addresses respectively.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User </p>
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User<p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater The <code class="option">key</code> statement begins with an identifying
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater string, the name of the key. The statement has two clauses.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater <code class="option">algorithm</code> identifies the authentication algorithm
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater (default), HMAC-SHA384 and HMAC-SHA512 are
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt supported. This is followed by a secret clause which contains
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User the base-64 encoding of the algorithm's authentication key. The
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User base-64 string is enclosed in double quotes.
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User </p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater<p>
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater There are two common ways to generate the base-64 string for the
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt can
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater be used to generate a random key, or the
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <span><strong class="command">mmencode</strong></span> program, also known as
1e9517ea2156b990be21f44676d3370318eacf17Tinderbox User <span><strong class="command">mimencode</strong></span>, can be used to generate a
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater base-64
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater string from known input. <span><strong class="command">mmencode</strong></span> does
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater not
c313914d0e66b20969215e519bbf2ab4ecf39512Tinderbox User ship with BIND 9 but is available on many systems. See the
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater EXAMPLE section for sample command lines for each.
fc2381b901eb162810f54a11cc512b95f55a60dfAutomatic Updater </p>
</div>
<div class="refsect1" lang="en">
<a name="id2664384"></a><h2>EXAMPLE</h2>
<pre class="programlisting">
options {
default-server localhost;
default-key samplekey;
};
</pre>
<p>
</p>
<pre class="programlisting">
server localhost {
key samplekey;
};
</pre>
<p>
</p>
<pre class="programlisting">
server testserver {
key testkey;
addresses { localhost port 5353; };
};
</pre>
<p>
</p>
<pre class="programlisting">
key samplekey {
algorithm hmac-sha256;
secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
};
</pre>
<p>
</p>
<pre class="programlisting">
key testkey {
algorithm hmac-sha256;
secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
};
</pre>
<p>
</p>
<p>
In the above example, <span><strong class="command">rndc</strong></span> will by
default use
the server at localhost (127.0.0.1) and the key called samplekey.
Commands to the localhost server will use the samplekey key, which
must also be defined in the server's configuration file with the
same name and secret. The key statement indicates that samplekey
uses the HMAC-SHA256 algorithm and its secret clause contains the
base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
</p>
<p>
If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will
connect to server on localhost port 5353 using the key testkey.
</p>
<p>
To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>:
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
<p>
A complete <code class="filename">rndc.conf</code> file, including
the
randomly generated key, will be written to the standard
output. Commented-out <code class="option">key</code> and
<code class="option">controls</code> statements for
<code class="filename">named.conf</code> are also printed.
</p>
<p>
To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>:
</p>
<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2664505"></a><h2>NAME SERVER CONFIGURATION</h2>
<p>
The name server must be configured to accept rndc connections and
to recognize the key specified in the <code class="filename">rndc.conf</code>
file, using the controls statement in <code class="filename">named.conf</code>.
See the sections on the <code class="option">controls</code> statement in the
BIND 9 Administrator Reference Manual for details.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2664531"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2664569"></a><h2>AUTHOR</h2>
<p><span class="corpauthor">Internet Systems Consortium</span>
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">rndc</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">rndc-confgen</span>
</td>
</tr>
</table>
</div>
<p style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>