2017-09-12 00:16:47 +00:00
|
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
|
|
|
|
<!--
|
2018-01-23 00:38:08 +00:00
|
|
|
|
- Copyright (C) 2000-2018 Internet Systems Consortium, Inc. ("ISC")
|
2017-09-12 00:16:47 +00:00
|
|
|
|
-
|
|
|
|
|
|
- This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
|
|
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
|
|
- file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
|
|
-->
|
|
|
|
|
|
<html lang="en">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
|
|
|
|
|
|
<title>rndc-confgen</title>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
|
2018-01-23 17:52:04 +00:00
|
|
|
|
<link rel="up" href="Bv9ARM.ch12.html" title="Manual pages">
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<link rel="prev" href="man.pkcs11-tokens.html" title="pkcs11-tokens">
|
|
|
|
|
|
<link rel="next" href="man.rndc.conf.html" title="rndc.conf">
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</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"><span class="application">rndc-confgen</span></th></tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="20%" align="left">
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<a accesskey="p" href="man.pkcs11-tokens.html">Prev</a><EFBFBD></td>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<th width="60%" align="center">Manual pages</th>
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<td width="20%" align="right"><EFBFBD><a accesskey="n" href="man.rndc.conf.html">Next</a>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="refentry">
|
|
|
|
|
|
<a name="man.rndc-confgen"></a><div class="titlepage"></div>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refnamediv">
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<h2>Name</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p>
|
|
|
|
|
|
<span class="application">rndc-confgen</span>
|
|
|
|
|
|
— rndc key generation tool
|
|
|
|
|
|
</p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</div>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refsynopsisdiv">
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<h2>Synopsis</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<div class="cmdsynopsis"><p>
|
|
|
|
|
|
<code class="command">rndc-confgen</code>
|
|
|
|
|
|
[<code class="option">-a</code>]
|
|
|
|
|
|
[<code class="option">-A <em class="replaceable"><code>algorithm</code></em></code>]
|
|
|
|
|
|
[<code class="option">-b <em class="replaceable"><code>keysize</code></em></code>]
|
|
|
|
|
|
[<code class="option">-c <em class="replaceable"><code>keyfile</code></em></code>]
|
|
|
|
|
|
[<code class="option">-h</code>]
|
|
|
|
|
|
[<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
|
|
|
|
|
|
[<code class="option">-p <em class="replaceable"><code>port</code></em></code>]
|
|
|
|
|
|
[<code class="option">-s <em class="replaceable"><code>address</code></em></code>]
|
|
|
|
|
|
[<code class="option">-t <em class="replaceable"><code>chrootdir</code></em></code>]
|
|
|
|
|
|
[<code class="option">-u <em class="replaceable"><code>user</code></em></code>]
|
|
|
|
|
|
</p></div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refsection">
|
2018-05-21 19:59:10 +00:00
|
|
|
|
<a name="id-1.13.35.7"></a><h2>DESCRIPTION</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
<p><span class="command"><strong>rndc-confgen</strong></span>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refsection">
|
2018-05-21 19:59:10 +00:00
|
|
|
|
<a name="id-1.13.35.8"></a><h2>OPTIONS</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="variablelist"><dl class="variablelist">
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-a</span></dt>
|
|
|
|
|
|
<dd>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-A <em class="replaceable"><code>algorithm</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
Specifies the algorithm to use for the TSIG key. Available
|
|
|
|
|
|
choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
|
2017-10-28 01:12:35 +00:00
|
|
|
|
hmac-sha384 and hmac-sha512. The default is hmac-sha256.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-b <em class="replaceable"><code>keysize</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
Specifies the size of the authentication key in bits.
|
|
|
|
|
|
Must be between 1 and 512 bits; the default is the
|
|
|
|
|
|
hash size.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-c <em class="replaceable"><code>keyfile</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
Used with the <span class="command"><strong>-a</strong></span> option to specify
|
|
|
|
|
|
an alternate location for <code class="filename">rndc.key</code>.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-h</span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
Prints a short summary of the options and arguments to
|
|
|
|
|
|
<span class="command"><strong>rndc-confgen</strong></span>.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-p <em class="replaceable"><code>port</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-s <em class="replaceable"><code>address</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-t <em class="replaceable"><code>chrootdir</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<dt><span class="term">-u <em class="replaceable"><code>user</code></em></span></dt>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<dd>
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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.
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</p>
|
|
|
|
|
|
</dd>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</dl></div>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refsection">
|
2018-05-21 19:59:10 +00:00
|
|
|
|
<a name="id-1.13.35.9"></a><h2>EXAMPLES</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
To allow <span class="command"><strong>rndc</strong></span> to be used with
|
|
|
|
|
|
no manual configuration, run
|
|
|
|
|
|
</p>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p><strong class="userinput"><code>rndc-confgen -a</code></strong>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</p>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
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>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
<p><strong class="userinput"><code>rndc-confgen</code></strong>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</p>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="refsection">
|
2018-05-21 19:59:10 +00:00
|
|
|
|
<a name="id-1.13.35.10"></a><h2>SEE ALSO</h2>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
|
|
|
|
|
|
<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>,
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<em class="citetitle">BIND 9 Administrator Reference Manual</em>.
|
|
|
|
|
|
</p>
|
2018-09-04 06:05:08 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
<div class="navfooter">
|
|
|
|
|
|
<hr>
|
|
|
|
|
|
<table width="100%" summary="Navigation footer">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="40%" align="left">
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<a accesskey="p" href="man.pkcs11-tokens.html">Prev</a><EFBFBD></td>
|
2018-01-23 17:52:04 +00:00
|
|
|
|
<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch12.html">Up</a></td>
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<td width="40%" align="right"><EFBFBD><a accesskey="n" href="man.rndc.conf.html">Next</a>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="40%" align="left" valign="top">
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<span class="application">pkcs11-tokens</span><EFBFBD></td>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
|
2017-10-09 10:58:27 -07:00
|
|
|
|
<td width="40%" align="right" valign="top"><EFBFBD><code class="filename">rndc.conf</code>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</div>
|
2018-11-21 23:58:39 +00:00
|
|
|
|
<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.13.4 (Development Release)</p>
|
2017-09-12 00:16:47 +00:00
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
