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