ddns-confgen.html revision 7ae7246a6339bb3a79ffc9f2f9c486de9a2bf65e
5cd4555ad444fd391002ae32450572054369fd42Rob Austein - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - Permission to use, copy, modify, and distribute this software for any
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User - purpose with or without fee is hereby granted, provided that the above
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews - copyright notice and this permission notice appear in all copies.
ec5347e2c775f027573ce5648b910361aa926c01Automatic Updater - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
dafcb997e390efa4423883dafd100c975c4095d6Mark Andrews<!-- $Id: ddns-confgen.html,v 1.7 2009/06/17 01:12:48 tbox Exp $ -->
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
1753d3c4d74241a847794f7e7cfd94cc79be6600Evan Hunt<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>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<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 name | -z zone</code>] [<code class="option">-q</code>] [name]</p></div>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<p><span><strong class="command">ddns-confgen</strong></span>
c1a883f2e04d94e99c433b1f6cfd0c0338f4ed85Mark Andrews generates a key for use by <span><strong class="command">nsupdate</strong></span>
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User and <span><strong class="command">named</strong></span>. It simplifies configuration
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein of dynamic zones by generating a key and providing the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein syntax that will be needed to use it, including an example
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">update-policy</strong></span> statement.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein If a domain name is specified on the command line, it will
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein be used in the name of the generated key and in the sample
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <span><strong class="command">named.conf</strong></span> syntax. For example,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">ddns-confgen example.com</strong></span> would
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein generate a key called "ddns-key.example.com", and sample
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <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>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">ddns-confgen</strong></span> is only needed when a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein more elaborate configuration is required: for instance, if
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Specifies the algorithm to use for the TSIG key. Available
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein hmac-sha384 and hmac-sha512. The default is hmac-sha256.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson Prints a short summary of the options and arguments to
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <span><strong class="command">ddns-confgen</strong></span>.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<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.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson The default is <code class="constant">ddns-key</code> when neither
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson the <span><strong class="command">-s</strong></span> nor <span><strong class="command">-z</strong></span> option is
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified; otherwise, the default
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is <code class="constant">ddns-key</code> as a separate label
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein followed by the argument of the option, e.g.,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <code class="constant">ddns-key.example.com.</code>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson The key name must have the format of a valid domain name,
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson 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>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson Specifies a source of random data for generating the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein authorization. If the operating system does not provide a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <code class="filename">/dev/random</code> or equivalent device, the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein default source of randomness is keyboard input.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <code class="filename">randomdev</code> specifies the name of a
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson character device or file containing random data to be used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein instead of the default. The special value
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <code class="filename">keyboard</code> indicates that keyboard input
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson should be used.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson Self mode: The example <span><strong class="command">named.conf</strong></span> text
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson shows how to set an update policy for the specified
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson using the "self" nametype, instead of the "subdomain"
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson nametype which allows matching on any name within a
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein specified domain.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This option cannot be used with the <span><strong class="command">-z</strong></span> option.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson zone mode: The example <span><strong class="command">named.conf</strong></span> text
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson shows how to set an update policy for the specified
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein using the "zonesub" nametype, allowing updates to all subdomain
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson that <em class="replaceable"><code>zone</code></em>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein This option cannot be used with the <span><strong class="command">-s</strong></span> option.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
9ffbbce6a624b6051b3d001edcbad1e02c69bd45Andreas Gustafsson<p><span class="corpauthor">Internet Systems Consortium</span>