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