man.rndc.conf.html revision 04bbadfbcb8a755cb208c4034073a3c0eb96b9aa
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<!--
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - Copyright (C) 2000-2003 Internet Software Consortium.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly -
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - Permission to use, copy, modify, and/or distribute this software for any
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - purpose with or without fee is hereby granted, provided that the above
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - copyright notice and this permission notice appear in all copies.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly -
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly - PERFORMANCE OF THIS SOFTWARE.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly-->
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<!-- $Id$ -->
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<html>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<head>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<title>rndc.conf</title>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<link rel="prev" href="man.rndc.html" title="rndc">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</head>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="navheader">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<table width="100%" summary="Navigation header">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<tr>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<td width="20%" align="left">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<th width="60%" align="center">Manual pages</th>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</td>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</tr>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</table>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<hr>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</div>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="refentry" lang="en">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<a name="man.rndc.conf"></a><div class="titlepage"></div>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="refnamediv">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<h2>Name</h2>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p><code class="filename">rndc.conf</code> &#8212; rndc configuration file</p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</div>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="refsynopsisdiv">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<h2>Synopsis</h2>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly</div>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<div class="refsect1" lang="en">
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<a name="id2616973"></a><h2>DESCRIPTION</h2>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p><code class="filename">rndc.conf</code> is the configuration file
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly utility. This file has a similar structure and syntax to
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="filename">named.conf</code>. Statements are enclosed
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly in braces and terminated with a semi-colon. Clauses in
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly the statements are also semi-colon terminated. The usual
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly comment styles are supported:
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly </p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly C style: /* */
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly </p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly C++ style: // to end of line
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly </p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly Unix style: # to end of line
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly </p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p><code class="filename">rndc.conf</code> is much simpler than
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="filename">named.conf</code>. The file uses three
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly statements: an options statement, a server statement
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly and a key statement.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly </p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly<p>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly The <code class="option">options</code> statement contains five clauses.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly The <code class="option">default-server</code> clause is followed by the
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly name or address of a name server. This host will be used when
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly no name server is given as an argument to
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly clause is followed by the name of a key which is identified by
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly a <code class="option">key</code> statement. If no
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="option">keyid</code> is provided on the rndc command line,
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly and no <code class="option">key</code> clause is found in a matching
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="option">server</code> statement, this default key will be
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly used to authenticate the server's commands and responses. The
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="option">default-port</code> clause is followed by the port
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly to connect to on the remote name server. If no
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="option">port</code> option is provided on the rndc command
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly line, and no <code class="option">port</code> clause is found in a
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly matching <code class="option">server</code> statement, this default port
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly will be used to connect.
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly The <code class="option">default-source-address</code> and
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly <code class="option">default-source-address-v6</code> clauses which
6e89f0a006cdbb50151504b3107096e365136687Jenny Han Donnelly can be used to set the IPv4 and IPv6 source addresses
respectively.
</p>
<p>
After the <code class="option">server</code> keyword, the server
statement includes a string which is the hostname or address
for a name server. The statement has three possible clauses:
<code class="option">key</code>, <code class="option">port</code> and
<code class="option">addresses</code>. The key name must match the
name of a key statement in the file. The port number
specifies the port to connect to. If an <code class="option">addresses</code>
clause is supplied these addresses will be used instead of
the server name. Each address can take an optional port.
If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
of supplied then these will be used to specify the IPv4 and IPv6
source addresses respectively.
</p>
<p>
The <code class="option">key</code> statement begins with an identifying
string, the name of the key. The statement has two clauses.
<code class="option">algorithm</code> identifies the authentication algorithm
for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
(for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
(default), HMAC-SHA384 and HMAC-SHA512 are
supported. This is followed by a secret clause which contains
the base-64 encoding of the algorithm's authentication key. The
base-64 string is enclosed in double quotes.
</p>
<p>
There are two common ways to generate the base-64 string for the
secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
can
be used to generate a random key, or the
<span><strong class="command">mmencode</strong></span> program, also known as
<span><strong class="command">mimencode</strong></span>, can be used to generate a
base-64
string from known input. <span><strong class="command">mmencode</strong></span> does
not
ship with BIND 9 but is available on many systems. See the
EXAMPLE section for sample command lines for each.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2645885"></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="id2649420"></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="id2649446"></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="id2649484"></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.ch10.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>
</body>
</html>