man.rndc.conf.html revision 395c95214142142854509945adf3293c0270e1c5
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<!--
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Copyright (C) 2000-2003 Internet Software Consortium.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore -
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - Permission to use, copy, modify, and/or distribute this software for any
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - purpose with or without fee is hereby granted, provided that the above
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - copyright notice and this permission notice appear in all copies.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore -
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore - PERFORMANCE OF THIS SOFTWARE.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore-->
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<!-- $Id$ -->
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<html>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<head>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<title>rndc.conf</title>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<link rel="prev" href="man.rndc.html" title="rndc">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</head>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="navheader">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<table width="100%" summary="Navigation header">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<tr>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<td width="20%" align="left">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<th width="60%" align="center">Manual pages</th>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</td>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</tr>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</table>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<hr>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</div>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="refentry" lang="en">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<a name="man.rndc.conf"></a><div class="titlepage"></div>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="refnamediv">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<h2>Name</h2>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p><code class="filename">rndc.conf</code> &#8212; rndc configuration file</p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</div>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="refsynopsisdiv">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<h2>Synopsis</h2>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore</div>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<div class="refsect1" lang="en">
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<a name="id2623313"></a><h2>DESCRIPTION</h2>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p><code class="filename">rndc.conf</code> is the configuration file
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore utility. This file has a similar structure and syntax to
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <code class="filename">named.conf</code>. Statements are enclosed
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore in braces and terminated with a semi-colon. Clauses in
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe the statements are also semi-colon terminated. The usual
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe comment styles are supported:
7014882c6a3672fd0e5d60200af8643ae53c5928Richard Lowe </p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore C style: /* */
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore C++ style: // to end of line
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore Unix style: # to end of line
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p><code class="filename">rndc.conf</code> is much simpler than
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <code class="filename">named.conf</code>. The file uses three
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore statements: an options statement, a server statement
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore and a key statement.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore </p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore<p>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore The <code class="option">options</code> statement contains five clauses.
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore The <code class="option">default-server</code> clause is followed by the
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore name or address of a name server. This host will be used when
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore no name server is given as an argument to
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <span><strong class="command">rndc</strong></span>. The <code class="option">default-key</code>
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore clause is followed by the name of a key which is identified by
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore a <code class="option">key</code> statement. If no
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <code class="option">keyid</code> is provided on the rndc command line,
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore and no <code class="option">key</code> clause is found in a matching
f6929ecef713a1395a17d75418eb6d6f8f2c68fdGarrett D'Amore <code class="option">server</code> statement, this default key will be
used to authenticate the server's commands and responses. The
<code class="option">default-port</code> clause is followed by the port
to connect to on the remote name server. If no
<code class="option">port</code> option is provided on the rndc command
line, and no <code class="option">port</code> clause is found in a
matching <code class="option">server</code> statement, this default port
will be used to connect.
The <code class="option">default-source-address</code> and
<code class="option">default-source-address-v6</code> clauses which
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="id2662806"></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="id2663201"></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="id2663226"></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="id2663265"></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>