man.rndc.conf.html revision 7f18387d4b5e85a430436570a5072e41d83fa246
c92c50783e4e93699f2a42643b8f200b9b719c87Automatic Updater - 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<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews<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>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox 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>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<p><code class="filename">rndc.conf</code> is the configuration file
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User for <span><strong class="command">rndc</strong></span>, the BIND 9 name server control
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User utility. This file has a similar structure and syntax to
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <code class="filename">named.conf</code>. Statements are enclosed
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in braces and terminated with a semi-colon. Clauses in
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User the statements are also semi-colon terminated. The usual
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User comment styles are supported:
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User C style: /* */
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein C++ style: // to end of line
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User Unix style: # to end of line
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User<p><code class="filename">rndc.conf</code> is much simpler than
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <code class="filename">named.conf</code>. The file uses three
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User statements: an options statement, a server statement
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein and a key statement.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">options</code> statement contains five clauses.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">default-server</code> clause is followed by the
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User name or address of a name server. This host will be used when
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User 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>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User clause is followed by the name of a key which is identified by
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User a <code class="option">key</code> statement. If no
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">keyid</code> is provided on the rndc command line,
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User and no <code class="option">key</code> clause is found in a matching
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <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
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein line, and no <code class="option">port</code> clause is found in a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein matching <code class="option">server</code> statement, this default port
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein will be used to connect.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The <code class="option">default-source-address</code> and
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <code class="option">default-source-address-v6</code> clauses which
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User can be used to set the IPv4 and IPv6 source addresses
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein respectively.
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User After the <code class="option">server</code> keyword, the server
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User statement includes a string which is the hostname or address
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User for a name server. The statement has three possible clauses:
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <code class="option">key</code>, <code class="option">port</code> and
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User <code class="option">addresses</code>. The key name must match the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein name of a key statement in the file. The port number
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User specifies the port to connect to. If an <code class="option">addresses</code>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User 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 <code class="option">source-address</code> or <code class="option">source-address-v6</code>
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User of supplied then these will be used to specify the IPv4 and IPv6
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User source addresses respectively.
6f64d4ab8e68f9b2333bcbfc755396d29a4a9d7cAutomatic Updater The <code class="option">key</code> statement begins with an identifying
6f64d4ab8e68f9b2333bcbfc755396d29a4a9d7cAutomatic Updater string, the name of the key. The statement has two clauses.
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User <code class="option">algorithm</code> identifies the authentication algorithm
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User for <span><strong class="command">rndc</strong></span> to use; currently only HMAC-MD5
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User (default), HMAC-SHA384 and HMAC-SHA512 are
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User supported. This is followed by a secret clause which contains
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User the base-64 encoding of the algorithm's authentication key. The
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User base-64 string is enclosed in double quotes.
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User There are two common ways to generate the base-64 string for the
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User secret. The BIND 9 program <span><strong class="command">rndc-confgen</strong></span>
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User be used to generate a random key, or the
6f64d4ab8e68f9b2333bcbfc755396d29a4a9d7cAutomatic Updater <span><strong class="command">mmencode</strong></span> program, also known as
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater <span><strong class="command">mimencode</strong></span>, can be used to generate a
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User string from known input. <span><strong class="command">mmencode</strong></span> does
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater ship with BIND 9 but is available on many systems. See the
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater EXAMPLE section for sample command lines for each.
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User default-server localhost;
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater default-key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server localhost {
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews key samplekey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein server testserver {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein addresses { localhost port 5353; };
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User key samplekey {
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein algorithm hmac-sha256;
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein secret "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein key testkey {
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User algorithm hmac-sha256;
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User secret "R3HI8P6BKw9ZwXwN3VZKuQ==";
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User In the above example, <span><strong class="command">rndc</strong></span> will by
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the server at localhost (127.0.0.1) and the key called samplekey.
ea94d370123a5892f6c47a97f21d1b28d44bb168Tinderbox User 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.
dba3c818ae00b10388d31703e86a28415db398acTinderbox User If <span><strong class="command">rndc -s testserver</strong></span> is used then <span><strong class="command">rndc</strong></span> will
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater connect to server on localhost port 5353 using the key testkey.
2895f101b5585a19015ac2c2c1e1812ac467fa12Automatic Updater To generate a random secret with <span><strong class="command">rndc-confgen</strong></span>:
44d0f0256fbdce130a18655023c3b06bacacbd61Automatic Updater<p><strong class="userinput"><code>rndc-confgen</code></strong>
dba3c818ae00b10388d31703e86a28415db398acTinderbox User A complete <code class="filename">rndc.conf</code> file, including
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein randomly generated key, will be written to the standard
dba3c818ae00b10388d31703e86a28415db398acTinderbox User output. Commented-out <code class="option">key</code> and
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <code class="option">controls</code> statements for
dba3c818ae00b10388d31703e86a28415db398acTinderbox User <code class="filename">named.conf</code> are also printed.
dba3c818ae00b10388d31703e86a28415db398acTinderbox User To generate a base-64 secret with <span><strong class="command">mmencode</strong></span>:
dba3c818ae00b10388d31703e86a28415db398acTinderbox User<p><strong class="userinput"><code>echo "known plaintext for a secret" | mmencode</code></strong>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<a name="id2663243"></a><h2>NAME SERVER CONFIGURATION</h2>
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater 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>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews file, using the controls statement in <code class="filename">named.conf</code>.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein See the sections on the <code class="option">controls</code> statement in the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein BIND 9 Administrator Reference Manual for details.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p><span class="citerefentry"><span class="refentrytitle">rndc</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">rndc-confgen</span>(8)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <span class="citerefentry"><span class="refentrytitle">mmencode</span>(1)</span>,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
dba3c818ae00b10388d31703e86a28415db398acTinderbox User<p><span class="corpauthor">Internet Systems Consortium</span>
dba3c818ae00b10388d31703e86a28415db398acTinderbox User<table width="100%" summary="Navigation footer">
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>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<td width="40%" align="right">�<a accesskey="n" href="man.rndc-confgen.html">Next</a>
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
c3dc968140ab7f04795acc7835e4e89ccb0c0a27Tinderbox User<td width="40%" align="right" valign="top">�<span class="application">rndc-confgen</span>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<p style="text-align: center;">BIND 9.11.0pre-alpha</p>