da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin [<!ENTITY mdash "&#8212;">]>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin<refentry id="man.rndc.conf">

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <refentryinfo>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <date>June 30, 2000</date>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </refentryinfo>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <refmeta>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <refentrytitle><filename>rndc.conf</filename></refentrytitle>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <manvolnum>5</manvolnum>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <refmiscinfo>BIND9</refmiscinfo>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz </refmeta>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <refnamediv>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <refname><filename>rndc.conf</filename></refname>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <refpurpose>rndc configuration file</refpurpose>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </refnamediv>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <docinfo>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <copyright>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <year>2004</year>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <year>2005</year>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <year>2007</year>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <holder>Internet Systems Consortium, Inc. ("ISC")</holder>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </copyright>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <copyright>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <year>2000</year>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <year>2001</year>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <holder>Internet Software Consortium.</holder>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </copyright>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </docinfo>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <refsynopsisdiv>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <cmdsynopsis>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz <command>rndc.conf</command>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz </cmdsynopsis>

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz </refsynopsisdiv>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <refsect1>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <title>DESCRIPTION</title>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <para><filename>rndc.conf</filename> is the configuration file

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin for <command>rndc</command>, the BIND 9 name server control

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin utility. This file has a similar structure and syntax to

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <filename>named.conf</filename>. Statements are enclosed

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin in braces and terminated with a semi-colon. Clauses in

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin the statements are also semi-colon terminated. The usual

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin comment styles are supported:

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin C style: /* */

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin C++ style: // to end of line

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin Unix style: # to end of line

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin </para>

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin <para><filename>rndc.conf</filename> is much simpler than

7c2fbfb345896881c631598ee3852ce9ce33fb07April Chin <filename>named.conf</filename>. The file uses three

34f9b3eef6fdadbda0a846aa4d68691ac40eace5Roland Mainz statements: an options statement, a server statement

da2e3ebdc1edfbc5028edf1354e7dd2fa69a7968chin and a key statement.

</para>

<para>

The <option>options</option> statement contains five clauses.

The <option>default-server</option> clause is followed by the

name or address of a name server. This host will be used when

no name server is given as an argument to

<command>rndc</command>. The <option>default-key</option>

clause is followed by the name of a key which is identified by

a <option>key</option> statement. If no

<option>keyid</option> is provided on the rndc command line,

and no <option>key</option> clause is found in a matching

<option>server</option> statement, this default key will be

used to authenticate the server's commands and responses. The

<option>default-port</option> clause is followed by the port

to connect to on the remote name server. If no

<option>port</option> option is provided on the rndc command

line, and no <option>port</option> clause is found in a

matching <option>server</option> statement, this default port

will be used to connect.

The <option>default-source-address</option> and

<option>default-source-address-v6</option> clauses which

can be used to set the IPv4 and IPv6 source addresses

respectively.

</para>

<para>

After the <option>server</option> keyword, the server

statement includes a string which is the hostname or address

for a name server. The statement has three possible clauses:

<option>key</option>, <option>port</option> and

<option>addresses</option>. 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 <option>addresses</option>

clause is supplied these addresses will be used instead of

the server name. Each address can take an optional port.

If an <option>source-address</option> or <option>source-address-v6</option>

of supplied then these will be used to specify the IPv4 and IPv6

source addresses respectively.

</para>

<para>

The <option>key</option> statement begins with an identifying

string, the name of the key. The statement has two clauses.

<option>algorithm</option> identifies the encryption algorithm

for <command>rndc</command> to use; currently only HMAC-MD5

is

supported. This is followed by a secret clause which contains

the base-64 encoding of the algorithm's encryption key. The

base-64 string is enclosed in double quotes.

</para>

<para>

There are two common ways to generate the base-64 string for the

secret. The BIND 9 program <command>rndc-confgen</command>

can

be used to generate a random key, or the

<command>mmencode</command> program, also known as

<command>mimencode</command>, can be used to generate a

base-64

string from known input. <command>mmencode</command> does

not

ship with BIND 9 but is available on many systems. See the

EXAMPLE section for sample command lines for each.

</para>

</refsect1>

<refsect1>

<title>EXAMPLE</title>

<para><programlisting>

options {

default-server localhost;

default-key samplekey;

};

</programlisting>

</para>

<para><programlisting>

server localhost {

key samplekey;

};

</programlisting>

</para>

<para><programlisting>

server testserver {

key testkey;

addresses { localhost port 5353; };

};

</programlisting>

</para>

<para><programlisting>

key samplekey {

algorithm hmac-md5;

secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";

};

</programlisting>

</para>

<para><programlisting>

key testkey {

algorithm hmac-md5;

secret "R3HI8P6BKw9ZwXwN3VZKuQ==";

};

</programlisting>

</para>

<para>

In the above example, <command>rndc</command> 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-MD5 algorithm and its secret clause contains the

base-64 encoding of the HMAC-MD5 secret enclosed in double quotes.

</para>

<para>

If <command>rndc -s testserver</command> is used then <command>rndc</command> will

connect to server on localhost port 5353 using the key testkey.

</para>

<para>

To generate a random secret with <command>rndc-confgen</command>:

</para>

<para><userinput>rndc-confgen</userinput>

</para>

<para>

A complete <filename>rndc.conf</filename> file, including

the

randomly generated key, will be written to the standard

output. Commented-out <option>key</option> and

<option>controls</option> statements for

<filename>named.conf</filename> are also printed.

</para>

<para>

To generate a base-64 secret with <command>mmencode</command>:

</para>

<para><userinput>echo "known plaintext for a secret" | mmencode</userinput>

</para>

</refsect1>

<refsect1>

<title>NAME SERVER CONFIGURATION</title>

<para>

The name server must be configured to accept rndc connections and

to recognize the key specified in the <filename>rndc.conf</filename>

file, using the controls statement in <filename>named.conf</filename>.

See the sections on the <option>controls</option> statement in the

BIND 9 Administrator Reference Manual for details.

</para>

</refsect1>

<refsect1>

<title>SEE ALSO</title>

<para><citerefentry>

<refentrytitle>rndc</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>rndc-confgen</refentrytitle><manvolnum>8</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>mmencode</refentrytitle><manvolnum>1</manvolnum>

</citerefentry>,

<citetitle>BIND 9 Administrator Reference Manual</citetitle>.

</para>

</refsect1>

<refsect1>

<title>AUTHOR</title>

<para><corpauthor>Internet Systems Consortium</corpauthor>

</para>

</refsect1>

</refentry><!--