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