man.rndc.conf.html revision 8dcec3cf256105c620d02d5c84c9ccbfe495ca8d
0N/A<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
0N/A<!--
0N/A - Copyright (C) 2000-2016 Internet Systems Consortium, Inc. ("ISC")
0N/A -
0N/A - This Source Code Form is subject to the terms of the Mozilla Public
0N/A - License, v. 2.0. If a copy of the MPL was not distributed with this
0N/A - file, You can obtain one at http://mozilla.org/MPL/2.0/.
0N/A-->
0N/A<html lang="en">
0N/A<head>
0N/A<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
0N/A<title>rndc.conf</title>
0N/A<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
0N/A<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
0N/A<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
0N/A<link rel="prev" href="man.rndc.html" title="rndc">
0N/A<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
0N/A</head>
0N/A<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0N/A<div class="navheader">
0N/A<table width="100%" summary="Navigation header">
0N/A<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
0N/A<tr>
0N/A<td width="20%" align="left">
0N/A<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
0N/A<th width="60%" align="center">Manual pages</th>
0N/A<td width="20%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
0N/A</td>
0N/A</tr>
0N/A</table>
0N/A<hr>
0N/A</div>
0N/A<div class="refentry">
0N/A<a name="man.rndc.conf"></a><div class="titlepage"></div>
0N/A
0N/A
0N/A
0N/A
0N/A
0N/A <div class="refnamediv">
0N/A<h2>Name</h2>
0N/A<p>
0N/A <code class="filename">rndc.conf</code>
0N/A &#8212; rndc configuration file
0N/A </p>
0N/A</div>
0N/A
0N/A
0N/A
0N/A <div class="refsynopsisdiv">
0N/A<h2>Synopsis</h2>
0N/A <div class="cmdsynopsis"><p>
0N/A <code class="command">rndc.conf</code>
0N/A </p></div>
0N/A </div>
0N/A
0N/A <div class="refsection">
0N/A<a name="id-1.14.28.7"></a><h2>DESCRIPTION</h2>
0N/A
0N/A <p><code class="filename">rndc.conf</code> is the configuration file
0N/A for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control
0N/A utility. This file has a similar structure and syntax to
0N/A <code class="filename">named.conf</code>. Statements are enclosed
0N/A in braces and terminated with a semi-colon. Clauses in
0N/A the statements are also semi-colon terminated. The usual
0N/A comment styles are supported:
0N/A </p>
0N/A <p>
0N/A C style: /* */
0N/A </p>
0N/A <p>
0N/A C++ style: // to end of line
0N/A </p>
0N/A <p>
0N/A Unix style: # to end of line
0N/A </p>
0N/A <p><code class="filename">rndc.conf</code> is much simpler than
0N/A <code class="filename">named.conf</code>. The file uses three
0N/A statements: an options statement, a server statement
0N/A and a key statement.
0N/A </p>
0N/A <p>
0N/A The <code class="option">options</code> statement contains five clauses.
0N/A The <code class="option">default-server</code> clause is followed by the
0N/A name or address of a name server. This host will be used when
0N/A no name server is given as an argument to
0N/A <span class="command"><strong>rndc</strong></span>. The <code class="option">default-key</code>
0N/A clause is followed by the name of a key which is identified by
0N/A a <code class="option">key</code> statement. If no
0N/A <code class="option">keyid</code> is provided on the rndc command line,
0N/A and no <code class="option">key</code> clause is found in a matching
0N/A <code class="option">server</code> statement, this default key will be
0N/A used to authenticate the server's commands and responses. The
0N/A <code class="option">default-port</code> clause is followed by the port
0N/A to connect to on the remote name server. If no
0N/A <code class="option">port</code> option is provided on the rndc command
0N/A line, and no <code class="option">port</code> clause is found in a
0N/A matching <code class="option">server</code> statement, this default port
0N/A will be used to connect.
0N/A The <code class="option">default-source-address</code> and
0N/A <code class="option">default-source-address-v6</code> clauses which
0N/A can be used to set the IPv4 and IPv6 source addresses
0N/A respectively.
0N/A </p>
0N/A <p>
0N/A After the <code class="option">server</code> keyword, the server
0N/A statement includes a string which is the hostname or address
0N/A for a name server. The statement has three possible clauses:
0N/A <code class="option">key</code>, <code class="option">port</code> and
0N/A <code class="option">addresses</code>. The key name must match the
0N/A name of a key statement in the file. The port number
0N/A specifies the port to connect to. If an <code class="option">addresses</code>
0N/A clause is supplied these addresses will be used instead of
0N/A the server name. Each address can take an optional port.
0N/A If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
0N/A of supplied then these will be used to specify the IPv4 and IPv6
0N/A source addresses respectively.
0N/A </p>
0N/A <p>
0N/A The <code class="option">key</code> statement begins with an identifying
0N/A string, the name of the key. The statement has two clauses.
0N/A <code class="option">algorithm</code> identifies the authentication algorithm
0N/A for <span class="command"><strong>rndc</strong></span> to use; currently only HMAC-MD5
0N/A (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
0N/A (default), HMAC-SHA384 and HMAC-SHA512 are
0N/A supported. This is followed by a secret clause which contains
0N/A the base-64 encoding of the algorithm's authentication key. The
0N/A base-64 string is enclosed in double quotes.
0N/A </p>
0N/A <p>
0N/A There are two common ways to generate the base-64 string for the
0N/A secret. The BIND 9 program <span class="command"><strong>rndc-confgen</strong></span>
0N/A can
0N/A be used to generate a random key, or the
0N/A <span class="command"><strong>mmencode</strong></span> program, also known as
0N/A <span class="command"><strong>mimencode</strong></span>, can be used to generate a
0N/A base-64
0N/A string from known input. <span class="command"><strong>mmencode</strong></span> does
0N/A not
0N/A ship with BIND 9 but is available on many systems. See the
0N/A EXAMPLE section for sample command lines for each.
0N/A </p>
0N/A </div>
0N/A
0N/A <div class="refsection">
0N/A<a name="id-1.14.28.8"></a><h2>EXAMPLE</h2>
0N/A
0N/A
0N/A <pre class="programlisting">
0N/A options {
0N/A default-server localhost;
0N/A default-key samplekey;
0N/A };
0N/A</pre>
0N/A<p>
0N/A </p>
0N/A <pre class="programlisting">
server localhost {
key samplekey;
};
</pre>
<p>
</p>
<pre class="programlisting">
server testserver {
key testkey;
addresses { localhost port 5353; };
};
</pre>
<p>
</p>
<pre class="programlisting">
key samplekey {
algorithm hmac-sha256;
secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
};
</pre>
<p>
</p>
<pre class="programlisting">
key testkey {
algorithm hmac-sha256;
secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
};
</pre>
<p>
</p>
<p>
In the above example, <span class="command"><strong>rndc</strong></span> 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-SHA256 algorithm and its secret clause contains the
base-64 encoding of the HMAC-SHA256 secret enclosed in double quotes.
</p>
<p>
If <span class="command"><strong>rndc -s testserver</strong></span> is used then <span class="command"><strong>rndc</strong></span> will
connect to server on localhost port 5353 using the key testkey.
</p>
<p>
To generate a random secret with <span class="command"><strong>rndc-confgen</strong></span>:
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
<p>
A complete <code class="filename">rndc.conf</code> file, including
the
randomly generated key, will be written to the standard
output. Commented-out <code class="option">key</code> and
<code class="option">controls</code> statements for
<code class="filename">named.conf</code> are also printed.
</p>
<p>
To generate a base-64 secret with <span class="command"><strong>mmencode</strong></span>:
</p>
<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
</p>
</div>
<div class="refsection">
<a name="id-1.14.28.9"></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 <code class="filename">rndc.conf</code>
file, using the controls statement in <code class="filename">named.conf</code>.
See the sections on the <code class="option">controls</code> statement in the
BIND 9 Administrator Reference Manual for details.
</p>
</div>
<div class="refsection">
<a name="id-1.14.28.10"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">rndc-confgen</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">mmencode</span>(1)
</span>,
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="man.rndc.html">Prev</a>�</td>
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
<td width="40%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">rndc</span>�</td>
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
<td width="40%" align="right" valign="top">�<span class="application">rndc-confgen</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.1rc2</p>
</body>
</html>