external/bsd/bind/dist/doc/arm/man.rndc.conf.html
author sborrill <sborrill@NetBSD.org>
Mon, 20 Feb 2017 16:27:13 +0000
branchnetbsd-7-0
changeset 276014 55cdc09183be
parent 275995 010a3e1bc942
child 276037 16ff5934603e
permissions -rw-r--r--
Pull up following revision(s) (requested by snj in ticket #1363): doc/3RDPARTY: patch external/bsd/bind/Makefile.inc: up to 1.25 via patch external/bsd/bind/dist/CHANGES: up to 1.25 external/bsd/bind/dist/README: up to 1.13 external/bsd/bind/dist/bin/named/query.c: up to 1.23 external/bsd/bind/dist/bin/tests/system/dname/ans3/ans.pl: up to 1.1.1.1 external/bsd/bind/dist/bin/tests/system/dname/ns1/root.db: up to 1.1.1.3 external/bsd/bind/dist/bin/tests/system/dname/tests.sh: up to 1.1.1.5 external/bsd/bind/dist/config.guess: up to 1.2 external/bsd/bind/dist/config.sub: up to 1.2 external/bsd/bind/dist/contrib/dnsperf-2.1.0.0-1/config.guess: up to 1.2 external/bsd/bind/dist/contrib/dnsperf-2.1.0.0-1/config.sub: up to 1.2 external/bsd/bind/dist/contrib/idn/idnkit-1.0-src/config.guess: up to 1.2 external/bsd/bind/dist/contrib/idn/idnkit-1.0-src/config.sub: up to 1.2 external/bsd/bind/dist/contrib/nslint-3.0a2/config.guess: up to 1.2 external/bsd/bind/dist/contrib/nslint-3.0a2/config.sub: up to 1.2 external/bsd/bind/dist/doc/arm/Bv9ARM.ch01.html: up to 1.1.1.23 external/bsd/bind/dist/doc/arm/Bv9ARM.ch02.html: up to 1.1.1.20 external/bsd/bind/dist/doc/arm/Bv9ARM.ch03.html: up to 1.1.1.25 external/bsd/bind/dist/doc/arm/Bv9ARM.ch04.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.ch05.html: up to 1.1.1.26 external/bsd/bind/dist/doc/arm/Bv9ARM.ch06.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.ch07.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.ch08.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.ch09.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.ch10.html: up to 1.1.1.22 external/bsd/bind/dist/doc/arm/Bv9ARM.ch11.html: up to 1.1.1.11 external/bsd/bind/dist/doc/arm/Bv9ARM.ch12.html: up to 1.1.1.11 external/bsd/bind/dist/doc/arm/Bv9ARM.ch13.html: up to 1.1.1.11 external/bsd/bind/dist/doc/arm/Bv9ARM.html: up to 1.13 external/bsd/bind/dist/doc/arm/Bv9ARM.pdf: up to 1.18 external/bsd/bind/dist/doc/arm/man.arpaname.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.ddns-confgen.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.delv.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dig.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-checkds.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-coverage.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-dsfromkey.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-importkey.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-keyfromlabel.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-keygen.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-revoke.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-settime.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-signzone.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.dnssec-verify.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.genrandom.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.host.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.isc-hmac-fixup.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.lwresd.html: up to 1.1.1.5 external/bsd/bind/dist/doc/arm/man.named-checkconf.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.named-checkzone.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.named-journalprint.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.named-rrchecker.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.named.conf.html: up to 1.1.1.5 external/bsd/bind/dist/doc/arm/man.named.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.nsec3hash.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.nsupdate.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.rndc-confgen.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.rndc.conf.html: up to 1.13 external/bsd/bind/dist/doc/arm/man.rndc.html: up to 1.13 external/bsd/bind/dist/doc/arm/notes.html: up to 1.1.1.11 external/bsd/bind/dist/doc/arm/notes.pdf: up to 1.1.1.11 external/bsd/bind/dist/doc/arm/notes.xml: up to 1.1.1.11 external/bsd/bind/dist/lib/dns/api: up to 1.13 external/bsd/bind/dist/lib/dns/message.c: up to 1.22 external/bsd/bind/dist/lib/dns/rdataset.c: up to 1.9 external/bsd/bind/dist/lib/dns/resolver.c: up to 1.29 external/bsd/bind/dist/srcid: up to 1.19 external/bsd/bind/dist/unit/atf-src/admin/config.guess: up to 1.2 external/bsd/bind/dist/unit/atf-src/admin/config.sub: up to 1.2 external/bsd/bind/dist/version: up to 1.23 external/bsd/bind/include/isc/platform.h: up to 1.22 via patch Update BIND to 9.10.4-P6, fixing CVE-2017-3135.

<!--
 - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2000-2003 Internet Software Consortium.
 - 
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 - 
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>rndc.conf</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
<link rel="prev" href="man.rndc.html" title="rndc">
<link rel="next" href="man.rndc-confgen.html" title="rndc-confgen">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center"><code class="filename">rndc.conf</code></th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="man.rndc.html">Prev</a> </td>
<th width="60%" align="center">Manual pages</th>
<td width="20%" align="right"> <a accesskey="n" href="man.rndc-confgen.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="refentry">
<a name="man.rndc.conf"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p><code class="filename">rndc.conf</code> &#8212; rndc configuration file</p>
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">rndc.conf</code> </p></div>
</div>
<div class="refsection">
<a name="id-1.14.24.7"></a><h2>DESCRIPTION</h2>
<p><code class="filename">rndc.conf</code> is the configuration file
      for <span class="command"><strong>rndc</strong></span>, the BIND 9 name server control
      utility.  This file has a similar structure and syntax to
      <code class="filename">named.conf</code>.  Statements are enclosed
      in braces and terminated with a semi-colon.  Clauses in
      the statements are also semi-colon terminated.  The usual
      comment styles are supported:
    </p>
<p>
      C style: /* */
    </p>
<p>
      C++ style: // to end of line
    </p>
<p>
      Unix style: # to end of line
    </p>
<p><code class="filename">rndc.conf</code> is much simpler than
      <code class="filename">named.conf</code>.  The file uses three
      statements: an options statement, a server statement
      and a key statement.
    </p>
<p>
      The <code class="option">options</code> statement contains five clauses.
      The <code class="option">default-server</code> 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
      <span class="command"><strong>rndc</strong></span>.  The <code class="option">default-key</code>
      clause is followed by the name of a key which is identified by
      a <code class="option">key</code> statement.  If no
      <code class="option">keyid</code> is provided on the rndc command line,
      and no <code class="option">key</code> clause is found in a matching
      <code class="option">server</code> statement, this default key will be
      used to authenticate the server's commands and responses.  The
      <code class="option">default-port</code> clause is followed by the port
      to connect to on the remote name server.  If no
      <code class="option">port</code> option is provided on the rndc command
      line, and no <code class="option">port</code> clause is found in a
      matching <code class="option">server</code> statement, this default port
      will be used to connect.
      The <code class="option">default-source-address</code> and
      <code class="option">default-source-address-v6</code> clauses which
      can be used to set the IPv4 and IPv6 source addresses
      respectively.
    </p>
<p>
      After the <code class="option">server</code> keyword, the server
      statement includes a string which is the hostname or address
      for a name server.  The statement has three possible clauses:
      <code class="option">key</code>, <code class="option">port</code> and
      <code class="option">addresses</code>. 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 <code class="option">addresses</code>
      clause is supplied these addresses will be used instead of
      the server name.  Each address can take an optional port.
      If an <code class="option">source-address</code> or <code class="option">source-address-v6</code>
      of supplied then these will be used to specify the IPv4 and IPv6
      source addresses respectively.
    </p>
<p>
      The <code class="option">key</code> statement begins with an identifying
      string, the name of the key.  The statement has two clauses.
      <code class="option">algorithm</code> identifies the authentication algorithm
      for <span class="command"><strong>rndc</strong></span> to use; currently only HMAC-MD5
      (for compatibility), HMAC-SHA1, HMAC-SHA224, HMAC-SHA256
      (default), HMAC-SHA384 and HMAC-SHA512 are
      supported.  This is followed by a secret clause which contains
      the base-64 encoding of the algorithm's authentication 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 <span class="command"><strong>rndc-confgen</strong></span>
      can
      be used to generate a random key, or the
      <span class="command"><strong>mmencode</strong></span> program, also known as
      <span class="command"><strong>mimencode</strong></span>, can be used to generate a
      base-64
      string from known input.  <span class="command"><strong>mmencode</strong></span> 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="refsection">
<a name="id-1.14.24.8"></a><h2>EXAMPLE</h2>
<pre class="programlisting">
      options {
        default-server  localhost;
        default-key     samplekey;
      };
</pre>
<p>
    </p>
<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.24.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.24.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.10.4-P6</p>
</body>
</html>