rndc.conf.docbook revision b2f07642fd712c8fda81a116bcdde229ab291f33
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "—">]>
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - Copyright (C) 2000, 2001 Internet Software Consortium.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Permission to use, copy, modify, and/or distribute this software for any
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - purpose with or without fee is hereby granted, provided that the above
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - copyright notice and this permission notice appear in all copies.
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8a66318e41ed14c5a88130e8c362610e8faa2121Mark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
6ea1b817e31b89a627e146fe69e23ea0a64c89ecBob Halley - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: rndc.conf.docbook,v 1.17 2007/06/18 23:47:25 tbox Exp $ -->
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentryinfo>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><filename>rndc.conf</filename></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><filename>rndc.conf</filename></refname>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews <refpurpose>rndc configuration file</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><filename>rndc.conf</filename> is the configuration file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for <command>rndc</command>, the BIND 9 name server control
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein utility. This file has a similar structure and syntax to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>named.conf</filename>. Statements are enclosed
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in braces and terminated with a semi-colon. Clauses in
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the statements are also semi-colon terminated. The usual
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein comment styles are supported:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein C style: /* */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein C++ style: // to end of line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Unix style: # to end of line
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <para><filename>rndc.conf</filename> is much simpler than
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>named.conf</filename>. The file uses three
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statements: an options statement, a server statement
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and a key statement.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>options</option> statement contains five clauses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>default-server</option> clause is followed by the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name or address of a name server. This host will be used when
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein no name server is given as an argument to
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>rndc</command>. The <option>default-key</option>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clause is followed by the name of a key which is identified by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>keyid</option> is provided on the rndc command line,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and no <option>key</option> clause is found in a matching
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>server</option> statement, this default key will be
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein used to authenticate the server's commands and responses. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>default-port</option> clause is followed by the port
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to connect to on the remote name server. If no
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>port</option> option is provided on the rndc command
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein line, and no <option>port</option> clause is found in a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein matching <option>server</option> statement, this default port
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will be used to connect.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>default-source-address-v6</option> clauses which
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein can be used to set the IPv4 and IPv6 source addresses
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein respectively.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein After the <option>server</option> keyword, the server
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein statement includes a string which is the hostname or address
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for a name server. The statement has three possible clauses:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>addresses</option>. The key name must match the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name of a key statement in the file. The port number
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein specifies the port to connect to. If an <option>addresses</option>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein clause is supplied these addresses will be used instead of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the server name. Each address can take an optional port.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If an <option>source-address</option> or <option>source-address-v6</option>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein of supplied then these will be used to specify the IPv4 and IPv6
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein source addresses respectively.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <option>key</option> statement begins with an identifying
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein string, the name of the key. The statement has two clauses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <option>algorithm</option> identifies the authentication algorithm
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein for <command>rndc</command> to use; currently only HMAC-MD5
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein (default), HMAC-SHA384 and HMAC-SHA512 are
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein supported. This is followed by a secret clause which contains
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the base-64 encoding of the algorithm's authentication key. The
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 string is enclosed in double quotes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein There are two common ways to generate the base-64 string for the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret. The BIND 9 program <command>rndc-confgen</command>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein be used to generate a random key, or the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>mmencode</command> program, also known as
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>mimencode</command>, can be used to generate a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein string from known input. <command>mmencode</command> does
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein ship with BIND 9 but is available on many systems. See the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein EXAMPLE section for sample command lines for each.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default-server localhost;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default-key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server localhost {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server testserver {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein addresses { localhost port 5353; };
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key samplekey {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm hmac-sha256;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein</programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm hmac-sha256;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </programlisting>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein In the above example, <command>rndc</command> will by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein 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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein must also be defined in the server's configuration file with the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein same name and secret. The key statement indicates that samplekey
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein uses the HMAC-SHA256 algorithm and its secret clause contains the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein If <command>rndc -s testserver</command> is used then <command>rndc</command> will
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein connect to server on localhost port 5353 using the key testkey.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To generate a random secret with <command>rndc-confgen</command>:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein A complete <filename>rndc.conf</filename> file, including
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein randomly generated key, will be written to the standard
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>named.conf</filename> are also printed.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein To generate a base-64 secret with <command>mmencode</command>:
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews <para><userinput>echo "known plaintext for a secret" | mmencode</userinput>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The name server must be configured to accept rndc connections and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein to recognize the key specified in the <filename>rndc.conf</filename>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein file, using the controls statement in <filename>named.conf</filename>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein See the sections on the <option>controls</option> statement in the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein BIND 9 Administrator Reference Manual for details.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citerefentry>
f051d76c87e055c6ea3879e0c97a76609df915ccMark Andrews <refentrytitle>mmencode</refentrytitle><manvolnum>1</manvolnum>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </citerefentry>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <citetitle>BIND 9 Administrator Reference Manual</citetitle>.