man.ddns-confgen.html revision 9d557856c2a19ec95ee73245f60a92f8675cf5ba
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<!--
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
1633838b8255282d10af15c5c84cee5a51466712Bob Halley - Copyright (C) 2000-2003 Internet Software Consortium.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley -
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - Permission to use, copy, modify, and/or distribute this software for any
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - purpose with or without fee is hereby granted, provided that the above
1633838b8255282d10af15c5c84cee5a51466712Bob Halley - copyright notice and this permission notice appear in all copies.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley -
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley - PERFORMANCE OF THIS SOFTWARE.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley-->
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<html>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<head>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<title>ddns-confgen</title>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<link rel="next" href="man.arpaname.html" title="arpaname">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley</head>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="navheader">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<table width="100%" summary="Navigation header">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
0fe778098d216ebe5b34c21cfb9be1982ceef8e8Michael Graff<tr>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<td width="20%" align="left">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<th width="60%" align="center">Manual pages</th>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</td>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley</tr>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</table>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<hr>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="refentry">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<a name="man.ddns-confgen"></a><div class="titlepage"></div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="refnamediv">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<h2>Name</h2>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="refsynopsisdiv">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<h2>Synopsis</h2>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="cmdsynopsis"><p><code class="command">tsig-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [name]</p></div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="cmdsynopsis"><p><code class="command">ddns-confgen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>] [<code class="option">-q</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ]</p></div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</div>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="refsection">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<a name="id-1.14.26.7"></a><h2>DESCRIPTION</h2>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley <span class="command"><strong>tsig-keygen</strong></span> and <span class="command"><strong>ddns-confgen</strong></span>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley are invocation methods for a utility that generates keys for use
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley in TSIG signing. The resulting keys can be used, for example,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley to secure dynamic DNS updates to a zone or for the
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley <span class="command"><strong>rndc</strong></span> command channel.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley </p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley When run as <span class="command"><strong>tsig-keygen</strong></span>, a domain name
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley can be specified on the command line which will be used as
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley the name of the generated key. If no name is specified,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley the default is <code class="constant">tsig-key</code>.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley </p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley When run as <span class="command"><strong>ddns-confgen</strong></span>, the generated
cab399250b57177899791dbad53a8f3bc47fc0f2Bob Halley key is accompanied by configuration text and instructions
cab399250b57177899791dbad53a8f3bc47fc0f2Bob Halley that can be used with <span class="command"><strong>nsupdate</strong></span> and
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley <span class="command"><strong>named</strong></span> when setting up dynamic DNS,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley including an example <span class="command"><strong>update-policy</strong></span>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley statement. (This usage similar to the
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley <span class="command"><strong>rndc-confgen</strong></span> command for setting
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley up command channel security.)
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley </p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley Note that <span class="command"><strong>named</strong></span> itself can configure a
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley local DDNS key for use with <span class="command"><strong>nsupdate -l</strong></span>:
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley it does this when a zone is configured with
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley <span class="command"><strong>update-policy local;</strong></span>.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley <span class="command"><strong>ddns-confgen</strong></span> is only needed when a
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley more elaborate configuration is required: for instance,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley if <span class="command"><strong>nsupdate</strong></span> is to be used from a remote
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley system.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley </p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley</div>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<div class="refsection">
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<a name="id-1.14.26.8"></a><h2>OPTIONS</h2>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<div class="variablelist"><dl class="variablelist">
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<dd><p>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley Specifies the algorithm to use for the TSIG key. Available
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley hmac-sha384 and hmac-sha512. The default is hmac-sha256.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley Options are case-insensitive, and the "hmac-" prefix
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley may be omitted.
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley </p></dd>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<dt><span class="term">-h</span></dt>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley<dd><p>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley Prints a short summary of options and arguments.
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley </p></dd>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley<dd><p>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley Specifies the key name of the DDNS authentication key.
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley The default is <code class="constant">ddns-key</code> when neither
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley the <code class="option">-s</code> nor <code class="option">-z</code> option is
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley specified; otherwise, the default
b1a67f989f703e1b8266b95be194e8a6c058e6ceAndreas Gustafsson is <code class="constant">ddns-key</code> as a separate label
b1a67f989f703e1b8266b95be194e8a6c058e6ceAndreas Gustafsson followed by the argument of the option, e.g.,
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley <code class="constant">ddns-key.example.com.</code>
fa795c6d23bce1b31ba0500dab9e60d95f8c5ea0Bob Halley The key name must have the format of a valid domain name,
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley consisting of letters, digits, hyphens and periods.
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley </p></dd>
8b935d4a13cf70dcc3c97649e91ae06d711fd7c2Bob Halley<dt><span class="term">-q</span></dt>
68109fb883d3ca2922efeea62fe746313a634f4eBob Halley<dd><p>
(<span class="command"><strong>ddns-confgen</strong></span> only.) Quiet mode: Print
only the key, with no explanatory text or usage examples;
This is essentially identical to <span class="command"><strong>tsig-keygen</strong></span>.
</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>name</code></em></span></dt>
<dd><p>
(<span class="command"><strong>ddns-confgen</strong></span> only.)
Generate configuration example to allow dynamic updates
of a single hostname. The example <span class="command"><strong>named.conf</strong></span>
text shows how to set an update policy for the specified
<em class="replaceable"><code>name</code></em>
using the "name" nametype. The default key name is
ddns-key.<em class="replaceable"><code>name</code></em>.
Note that the "self" nametype cannot be used, since
the name to be updated may differ from the key name.
This option cannot be used with the <code class="option">-z</code> option.
</p></dd>
<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
<dd><p>
(<span class="command"><strong>ddns-confgen</strong></span> only.)
Generate configuration example to allow dynamic updates
of a zone: The example <span class="command"><strong>named.conf</strong></span> text
shows how to set an update policy for the specified
<em class="replaceable"><code>zone</code></em>
using the "zonesub" nametype, allowing updates to
all subdomain names within that
<em class="replaceable"><code>zone</code></em>.
This option cannot be used with the <code class="option">-s</code> option.
</p></dd>
</dl></div>
</div>
<div class="refsection">
<a name="id-1.14.26.9"></a><h2>SEE ALSO</h2>
<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
<span class="citerefentry"><span class="refentrytitle">named.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-confgen.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.arpaname.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
<span class="application">rndc-confgen</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">arpaname</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>