man.rndc-confgen.html revision 14a656f94b1fd0ababd84a772228dfa52276ba15
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<!--
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd - Copyright (C) 2000-2003 Internet Software Consortium.
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd -
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd - Permission to use, copy, modify, and/or distribute this software for any
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - purpose with or without fee is hereby granted, provided that the above
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - copyright notice and this permission notice appear in all copies.
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin -
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2e545ce2450a9953665f701bb05350f0d3f26275nd - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen - PERFORMANCE OF THIS SOFTWARE.
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen-->
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<html>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<head>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<title>rndc-confgen</title>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link rel="prev" href="man.rndc.conf.html" title="rndc.conf">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<link rel="next" href="man.ddns-confgen.html" title="ddns-confgen">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</head>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<div class="navheader">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<table width="100%" summary="Navigation header">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<tr><th colspan="3" align="center"><span class="application">rndc-confgen</span></th></tr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<tr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<td width="20%" align="left">
f2dddcb17c7d7e94cc69563d3c99f9d035224ecctrawick<a accesskey="p" href="man.rndc.conf.html">Prev</a>�</td>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<th width="60%" align="center">Manual pages</th>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<td width="20%" align="right">�<a accesskey="n" href="man.ddns-confgen.html">Next</a>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</td>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</tr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</table>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<hr>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</div>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<div class="refentry">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<a name="man.rndc-confgen"></a><div class="titlepage"></div>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin <div class="refnamediv">
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<h2>Name</h2>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin<p>
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh <span class="application">rndc-confgen</span>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin &#8212; rndc key generation tool
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin </p>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin</div>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin
727872d18412fc021f03969b8641810d8896820bhumbedooh
0d0ba3a410038e179b695446bb149cce6264e0abnd
727872d18412fc021f03969b8641810d8896820bhumbedooh <div class="refsynopsisdiv">
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh<h2>Synopsis</h2>
0d0ba3a410038e179b695446bb149cce6264e0abnd <div class="cmdsynopsis"><p>
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh <code class="command">rndc-confgen</code>
727872d18412fc021f03969b8641810d8896820bhumbedooh [<code class="option">-a</code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh [<code class="option">-h</code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
727872d18412fc021f03969b8641810d8896820bhumbedooh [<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
0d0ba3a410038e179b695446bb149cce6264e0abnd [<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
30471a4650391f57975f60bbb6e4a90be7b284bfhumbedooh </p></div>
205f749042ed530040a4f0080dbcb47ceae8a374rjung </div>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen
0d0ba3a410038e179b695446bb149cce6264e0abnd <div class="refsection">
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd<a name="id-1.14.25.7"></a><h2>DESCRIPTION</h2>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd <p><span class="command"><strong>rndc-confgen</strong></span>
109b93ded5941c5c5fdbc05a2a16286ed4f7e5c8minfrin generates configuration files
for <span class="command"><strong>rndc</strong></span>. It can be used as a
convenient alternative to writing the
<code class="filename">rndc.conf</code> file
and the corresponding <span class="command"><strong>controls</strong></span>
and <span class="command"><strong>key</strong></span>
statements in <code class="filename">named.conf</code> by hand.
Alternatively, it can be run with the <span class="command"><strong>-a</strong></span>
option to set up a <code class="filename">rndc.key</code> file and
avoid the need for a <code class="filename">rndc.conf</code> file
and a <span class="command"><strong>controls</strong></span> statement altogether.
</p>
</div>
<div class="refsection">
<a name="id-1.14.25.8"></a><h2>OPTIONS</h2>
<div class="variablelist"><dl class="variablelist">
<dt><span class="term">-a</span></dt>
<dd>
<p>
Do automatic <span class="command"><strong>rndc</strong></span> configuration.
This creates a file <code class="filename">rndc.key</code>
in <code class="filename">/etc</code> (or whatever
<code class="varname">sysconfdir</code>
was specified as when <acronym class="acronym">BIND</acronym> was
built)
that is read by both <span class="command"><strong>rndc</strong></span>
and <span class="command"><strong>named</strong></span> on startup. The
<code class="filename">rndc.key</code> file defines a default
command channel and authentication key allowing
<span class="command"><strong>rndc</strong></span> to communicate with
<span class="command"><strong>named</strong></span> on the local host
with no further configuration.
</p>
<p>
Running <span class="command"><strong>rndc-confgen -a</strong></span> allows
BIND 9 and <span class="command"><strong>rndc</strong></span> to be used as
drop-in
replacements for BIND 8 and <span class="command"><strong>ndc</strong></span>,
with no changes to the existing BIND 8
<code class="filename">named.conf</code> file.
</p>
<p>
If a more elaborate configuration than that
generated by <span class="command"><strong>rndc-confgen -a</strong></span>
is required, for example if rndc is to be used remotely,
you should run <span class="command"><strong>rndc-confgen</strong></span> without
the
<span class="command"><strong>-a</strong></span> option and set up a
<code class="filename">rndc.conf</code> and
<code class="filename">named.conf</code>
as directed.
</p>
</dd>
<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
<dd>
<p>
Specifies the algorithm to use for the TSIG key. Available
choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
hmac-sha384 and hmac-sha512. The default is hmac-md5.
</p>
</dd>
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
<dd>
<p>
Specifies the size of the authentication key in bits.
Must be between 1 and 512 bits; the default is the
hash size.
</p>
</dd>
<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
<dd>
<p>
Used with the <span class="command"><strong>-a</strong></span> option to specify
an alternate location for <code class="filename">rndc.key</code>.
</p>
</dd>
<dt><span class="term">-h</span></dt>
<dd>
<p>
Prints a short summary of the options and arguments to
<span class="command"><strong>rndc-confgen</strong></span>.
</p>
</dd>
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
<dd>
<p>
Specifies the key name of the rndc authentication key.
This must be a valid domain name.
The default is <code class="constant">rndc-key</code>.
</p>
</dd>
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
<dd>
<p>
Specifies the command channel port where <span class="command"><strong>named</strong></span>
listens for connections from <span class="command"><strong>rndc</strong></span>.
The default is 953.
</p>
</dd>
<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
<dd>
<p>
Specifies a source of random data for generating the
authorization. If the operating
system does not provide a <code class="filename">/dev/random</code>
or equivalent device, the default source of randomness
is keyboard input. <code class="filename">randomdev</code>
specifies
the name of a character device or file containing random
data to be used instead of the default. The special value
<code class="filename">keyboard</code> indicates that keyboard
input should be used.
</p>
</dd>
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
<dd>
<p>
Specifies the IP address where <span class="command"><strong>named</strong></span>
listens for command channel connections from
<span class="command"><strong>rndc</strong></span>. The default is the loopback
address 127.0.0.1.
</p>
</dd>
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
<dd>
<p>
Used with the <span class="command"><strong>-a</strong></span> option to specify
a directory where <span class="command"><strong>named</strong></span> will run
chrooted. An additional copy of the <code class="filename">rndc.key</code>
will be written relative to this directory so that
it will be found by the chrooted <span class="command"><strong>named</strong></span>.
</p>
</dd>
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
<dd>
<p>
Used with the <span class="command"><strong>-a</strong></span> option to set the
owner
of the <code class="filename">rndc.key</code> file generated.
If
<span class="command"><strong>-t</strong></span> is also specified only the file
in
the chroot area has its owner changed.
</p>
</dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.14.25.9"></a><h2>EXAMPLES</h2>
<p>
To allow <span class="command"><strong>rndc</strong></span> to be used with
no manual configuration, run
</p>
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
</p>
<p>
To print a sample <code class="filename">rndc.conf</code> file and
corresponding <span class="command"><strong>controls</strong></span> and <span class="command"><strong>key</strong></span>
statements to be manually inserted into <code class="filename">named.conf</code>,
run
</p>
<p><strong class="userinput"><code>rndc-confgen</code></strong>
</p>
</div>
<div class="refsection">
<a name="id-1.14.25.10"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry">
<span class="refentrytitle">rndc</span>(8)
</span>,
<span class="citerefentry">
<span class="refentrytitle">rndc.conf</span>(5)
</span>,
<span class="citerefentry">
<span class="refentrytitle">named</span>(8)
</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.conf.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.ddns-confgen.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<code class="filename">rndc.conf</code>�</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">ddns-confgen</span>
</td>
</tr>
</table>
</div>
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.0pre-alpha</p>
</body>
</html>