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