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