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