rndc.conf.html revision 8de7014e56565605a51898a2a33a8b08fd3f1e57
148N/A<!--
148N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
148N/A -
148N/A - Permission to use, copy, modify, and distribute this software for any
148N/A - purpose with or without fee is hereby granted, provided that the above
148N/A - copyright notice and this permission notice appear in all copies.
148N/A -
148N/A - THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
148N/A - DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
148N/A - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
148N/A - INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
148N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
148N/A - FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
148N/A - NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
148N/A - WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
148N/A-->
148N/A<HTML
148N/A><HEAD
148N/A><TITLE
148N/A>rndc.conf</TITLE
148N/A><META
148N/ANAME="GENERATOR"
2899N/ACONTENT="Modular DocBook HTML Stylesheet Version 1.61
148N/A"></HEAD
148N/A><BODY
148N/ACLASS="REFENTRY"
148N/ABGCOLOR="#FFFFFF"
148N/ATEXT="#000000"
1552N/ALINK="#0000FF"
618N/AVLINK="#840084"
148N/AALINK="#0000FF"
148N/A><H1
844N/A><A
1552N/ANAME="AEN1"
148N/A><TT
1258N/ACLASS="FILENAME"
148N/A>rndc.conf</TT
2899N/A></A
2899N/A></H1
148N/A><DIV
148N/ACLASS="REFNAMEDIV"
148N/A><A
181N/ANAME="AEN9"
148N/A></A
181N/A><H2
148N/A>Name</H2
148N/A><TT
148N/ACLASS="FILENAME"
148N/A>rndc.conf</TT
148N/A>&nbsp;--&nbsp;rndc configuration file</DIV
148N/A><DIV
148N/ACLASS="REFSYNOPSISDIV"
148N/A><A
1200N/ANAME="AEN13"
1200N/A></A
148N/A><H2
148N/A>Synopsis</H2
148N/A><P
148N/A><B
148N/ACLASS="COMMAND"
148N/A>rndc.conf</B
148N/A> </P
690N/A></DIV
690N/A><DIV
148N/ACLASS="REFSECT1"
727N/A><A
727N/ANAME="AEN16"
727N/A></A
727N/A><H2
727N/A>DESCRIPTION</H2
727N/A><P
727N/A> <TT
727N/ACLASS="FILENAME"
727N/A>rndc.conf</TT
727N/A> is the configuration file
727N/A for <B
727N/ACLASS="COMMAND"
727N/A>rndc</B
727N/A>, the BIND 9 name server control
727N/A utility. This file has a similar structure and syntax to
727N/A <TT
727N/ACLASS="FILENAME"
148N/A>named.conf</TT
148N/A>. Statements are enclosed
148N/A in braces and terminated with a semi-colon. Clauses in
148N/A the statements are also semi-colon terminated. The usual
560N/A comment styles are supported:
727N/A </P
148N/A><P
181N/A> C style: /* */
148N/A </P
148N/A><P
148N/A> C++ style: // to end of line
148N/A </P
><P
> Unix style: # to end of line
</P
><P
> <TT
CLASS="FILENAME"
>rndc.conf</TT
> is much simpler than
<TT
CLASS="FILENAME"
>named.conf</TT
>. The file uses three
statements: an options statement, a server statement
and a key statement.
</P
><P
> The <TT
CLASS="OPTION"
>options</TT
> statement contains three clauses.
The <TT
CLASS="OPTION"
>default-server</TT
> 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
<B
CLASS="COMMAND"
>rndc</B
>. The <TT
CLASS="OPTION"
>default-key</TT
>
clause is followed by the name of a key which is identified by
a <TT
CLASS="OPTION"
>key</TT
> statement. If no
<TT
CLASS="OPTION"
>keyid</TT
> is provided on the rndc command line,
and no <TT
CLASS="OPTION"
>key</TT
> clause is found in a matching
<TT
CLASS="OPTION"
>server</TT
> statement, this default key will be
used to authenticate the server's commands and responses. The
<TT
CLASS="OPTION"
>default-port</TT
> clause is followed by the port
to connect to on the remote name server. If no
<TT
CLASS="OPTION"
>port</TT
> option is provided on the rndc command
line, and no <TT
CLASS="OPTION"
>port</TT
> clause is found in a
matching <TT
CLASS="OPTION"
>server</TT
> statement, this default port
will be used to connect.
</P
><P
> After the <TT
CLASS="OPTION"
>server</TT
> keyword, the server statement
includes a string which is the hostname or address for a name
server. The statement has two possible clauses:
<TT
CLASS="OPTION"
>key</TT
> and <TT
CLASS="OPTION"
>port</TT
>. The key name must
match the name of a key statement in the file. The port number
specifies the port to connect to.
</P
><P
> The <TT
CLASS="OPTION"
>key</TT
> statement begins with an identifying
string, the name of the key. The statement has two clauses.
<TT
CLASS="OPTION"
>algorithm</TT
> identifies the encryption algorithm
for <B
CLASS="COMMAND"
>rndc</B
> 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.
</P
><P
> There are two common ways to generate the base-64 string for the
secret. The BIND 9 program <B
CLASS="COMMAND"
>dnssec-keygen</B
> can
be used to generate a random key, or the
<B
CLASS="COMMAND"
>mmencode</B
> program, also known as
<B
CLASS="COMMAND"
>mimencode</B
>, can be used to generate a base-64
string from known input. <B
CLASS="COMMAND"
>mmencode</B
> does not
ship with BIND 9 but is available on many systems. See the
EXAMPLE section for sample command lines for each.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN54"
></A
><H2
>EXAMPLE</H2
><PRE
CLASS="PROGRAMLISTING"
> options {
default-server localhost;
default-key samplekey;
};
server localhost {
key samplekey;
};
key samplekey {
algorithm hmac-md5;
secret "c3Ryb25nIGVub3VnaCBmb3IgYSBtYW4gYnV0IG1hZGUgZm9yIGEgd29tYW4K";
};
</PRE
><P
> In the above example, <B
CLASS="COMMAND"
>rndc</B
> 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.
</P
><P
> To generate a random secret with <B
CLASS="COMMAND"
>dnssec-keygen</B
>:
</P
><P
> <TT
CLASS="USERINPUT"
><B
>$ dnssec-keygen -a hmac-md5 -b 128 -n user rndc</B
></TT
>
</P
><P
> The base-64 string will appear in two files,
<TT
CLASS="FILENAME"
>Krndc.+157.+{random}.key</TT
> and
<TT
CLASS="FILENAME"
>Krndc.+157.+{random}.private</TT
>. After
extracting the key to be placed in the
<TT
CLASS="FILENAME"
>rndc.conf</TT
> and
<TT
CLASS="FILENAME"
>named.conf</TT
> key statements, the
.key and .private files can be removed.
</P
><P
> To generate a random secret with <B
CLASS="COMMAND"
>mmencode</B
>:
</P
><P
> <TT
CLASS="USERINPUT"
><B
>$ echo "known plaintext for a secret" | mmencode</B
></TT
>
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN72"
></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 <TT
CLASS="FILENAME"
>rndc.conf</TT
>
file, using the controls statement in <TT
CLASS="FILENAME"
>named.conf</TT
>.
See the sections on the <TT
CLASS="OPTION"
>controls</TT
> statement in the
BIND 9 Administrator Reference Manual for details.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN78"
></A
><H2
>SEE ALSO</H2
><P
> <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>rndc</SPAN
>(8)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>dnssec-keygen</SPAN
>(8)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>mmencode</SPAN
>(1)</SPAN
>,
<I
CLASS="CITETITLE"
>BIND 9 Administrator Reference Manual</I
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN91"
></A
><H2
>AUTHOR</H2
><P
> Internet Software Consortium
</P
></DIV
></BODY
></HTML
>