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