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