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