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