ddns-confgen.html revision 852ccdd42a71550c974111b49415204ffeca6573
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - Copyright (C) 2004, 2005, 2007, 2009 Internet Systems Consortium, Inc. ("ISC")
f202f2587b9ba4753afba49b796f599cc12b4d0fAndreas Gustafsson - Copyright (C) 2001, 2003 Internet Software Consortium.
f202f2587b9ba4753afba49b796f599cc12b4d0fAndreas Gustafsson - Permission to use, copy, modify, and distribute this software for any
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - purpose with or without fee is hereby granted, provided that the above
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - copyright notice and this permission notice appear in all copies.
f202f2587b9ba4753afba49b796f599cc12b4d0fAndreas Gustafsson - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
83a28ca274521e15086fc39febde507bcc4e145eMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - PERFORMANCE OF THIS SOFTWARE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- $Id: ddns-confgen.html,v 1.3 2009/06/10 01:12:50 tbox Exp $ -->
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<a name="man.ddns-confgen"></a><div class="titlepage"></div>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<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">-r <em class="replaceable"><code>randomfile</code></em></code>] [<code class="option">-s</code>] [<code class="option">-q</code>] [name]</p></div>
704e6c8876907aac0bf7380effca8bca400d4acdMark Andrews<p><span><strong class="command">ddns-confgen</strong></span>
704e6c8876907aac0bf7380effca8bca400d4acdMark Andrews generates a key for use by <span><strong class="command">nsupdate</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and <span><strong class="command">named</strong></span>. It simplifies configuration
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews of dynamic zones by generating a key and providing the
26e2a07a0b6a3b1eccef82ba31270d0c54ad4f06Mark Andrews <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
c1a883f2e04d94e99c433b1f6cfd0c0338f4ed85Mark Andrews syntax that will be needed to use it, including an example
7b8b5e34b6daf793373580dfb095f56af5e918ceAutomatic Updater <span><strong class="command">update-policy</strong></span> statement.
0e27506ce3135f9bd49e12564ad0e15256135118Automatic Updater If a domain name is specified on the command line, it will
5c6b95ba1b2e35f8dd6b0a7f25aacba91fff3aa2Tinderbox User be used in the name of the generated key and in the sample
1124950b35ae05a12e804e670607fe5ba775cb4aTinderbox User <span><strong class="command">named.conf</strong></span> syntax. For example,
724df78acd95dc0f313bc2b80a099f7ecd48b620Tinderbox User <span><strong class="command">ddns-confgen example.com</strong></span> would
b7f3400f3b34fee8e29ac4a43f62c153b42b3200Tinderbox User generate a key called "ddns-key.example.com", and sample
7d169212b4e9e9b2400b0bd14ef7fe785af8597fTinderbox User <span><strong class="command">named.conf</strong></span> command that could be used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein in the zone definition for "example.com".
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Note that <span><strong class="command">named</strong></span> itself can configure a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">ddns-confgen</strong></span> is only needed when a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein more elaborate configuration is required: for instance, if
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Specifies the algorithm to use for the TSIG key. Available
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Prints a short summary of the options and arguments to
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">ddns-confgen</strong></span>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies the key name of the DDNS authentication key.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt The default is <code class="constant">ddns-key</code>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The key name must have the format of a valid domain name,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt consisting of letters, digits, hyphens and periods.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Quiet mode: Print only the key, with no explanatory text or
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein usage examples.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies a source of random data for generating the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt authorization. If the operating system does not provide a
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews <code class="filename">/dev/random</code> or equivalent device, the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein default source of randomness is keyboard input.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <code class="filename">randomdev</code> specifies the name of a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein character device or file containing random data to be used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein instead of the default. The special value
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <code class="filename">keyboard</code> indicates that keyboard input
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein should be used.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Self mode: The example <span><strong class="command">named.conf</strong></span> text
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein shows how to set an update policy using the "self" nametype,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein using a single key per each domain name for updates, instead of
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein the "subdomain" nametype which allows matching on any name
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein within a specified domain.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
3b9d9ad58b2d85a10960819f5c7a4606b33e9ab2Evan Hunt<p><span class="corpauthor">Internet Systems Consortium</span>