1224090Sdougb<!-- 2224090Sdougb - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC") 3224090Sdougb - 4224090Sdougb - Permission to use, copy, modify, and/or distribute this software for any 5224090Sdougb - purpose with or without fee is hereby granted, provided that the above 6224090Sdougb - copyright notice and this permission notice appear in all copies. 7224090Sdougb - 8224090Sdougb - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 9224090Sdougb - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 10224090Sdougb - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 11224090Sdougb - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 12224090Sdougb - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 13224090Sdougb - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 14224090Sdougb - PERFORMANCE OF THIS SOFTWARE. 15224090Sdougb--> 16234010Sdougb<!-- $Id$ --> 17224090Sdougb<html> 18224090Sdougb<head> 19224090Sdougb<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 20224090Sdougb<title>ddns-confgen</title> 21224090Sdougb<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 22224090Sdougb</head> 23224090Sdougb<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> 24224090Sdougb<a name="man.ddns-confgen"></a><div class="titlepage"></div> 25224090Sdougb<div class="refnamediv"> 26224090Sdougb<h2>Name</h2> 27224090Sdougb<p><span class="application">ddns-confgen</span> — ddns key generation tool</p> 28224090Sdougb</div> 29224090Sdougb<div class="refsynopsisdiv"> 30224090Sdougb<h2>Synopsis</h2> 31224090Sdougb<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>] [ -s <em class="replaceable"><code>name</code></em> | -z <em class="replaceable"><code>zone</code></em> ] [<code class="option">-q</code>] [name]</p></div> 32224090Sdougb</div> 33224090Sdougb<div class="refsect1" lang="en"> 34234010Sdougb<a name="id2543396"></a><h2>DESCRIPTION</h2> 35224090Sdougb<p><span><strong class="command">ddns-confgen</strong></span> 36224090Sdougb generates a key for use by <span><strong class="command">nsupdate</strong></span> 37224090Sdougb and <span><strong class="command">named</strong></span>. It simplifies configuration 38224090Sdougb of dynamic zones by generating a key and providing the 39224090Sdougb <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span> 40224090Sdougb syntax that will be needed to use it, including an example 41224090Sdougb <span><strong class="command">update-policy</strong></span> statement. 42224090Sdougb </p> 43224090Sdougb<p> 44224090Sdougb If a domain name is specified on the command line, it will 45224090Sdougb be used in the name of the generated key and in the sample 46224090Sdougb <span><strong class="command">named.conf</strong></span> syntax. For example, 47224090Sdougb <span><strong class="command">ddns-confgen example.com</strong></span> would 48224090Sdougb generate a key called "ddns-key.example.com", and sample 49224090Sdougb <span><strong class="command">named.conf</strong></span> command that could be used 50224090Sdougb in the zone definition for "example.com". 51224090Sdougb </p> 52224090Sdougb<p> 53224090Sdougb Note that <span><strong class="command">named</strong></span> itself can configure a 54224090Sdougb local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>. 55224090Sdougb <span><strong class="command">ddns-confgen</strong></span> is only needed when a 56224090Sdougb more elaborate configuration is required: for instance, if 57224090Sdougb <span><strong class="command">nsupdate</strong></span> is to be used from a remote system. 58224090Sdougb </p> 59224090Sdougb</div> 60224090Sdougb<div class="refsect1" lang="en"> 61234010Sdougb<a name="id2543456"></a><h2>OPTIONS</h2> 62224090Sdougb<div class="variablelist"><dl> 63224090Sdougb<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 64224090Sdougb<dd><p> 65224090Sdougb Specifies the algorithm to use for the TSIG key. Available 66224090Sdougb choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, 67224090Sdougb hmac-sha384 and hmac-sha512. The default is hmac-sha256. 68224090Sdougb </p></dd> 69224090Sdougb<dt><span class="term">-h</span></dt> 70224090Sdougb<dd><p> 71224090Sdougb Prints a short summary of the options and arguments to 72224090Sdougb <span><strong class="command">ddns-confgen</strong></span>. 73224090Sdougb </p></dd> 74224090Sdougb<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> 75224090Sdougb<dd><p> 76224090Sdougb Specifies the key name of the DDNS authentication key. 77224090Sdougb The default is <code class="constant">ddns-key</code> when neither 78224090Sdougb the <code class="option">-s</code> nor <code class="option">-z</code> option is 79224090Sdougb specified; otherwise, the default 80224090Sdougb is <code class="constant">ddns-key</code> as a separate label 81224090Sdougb followed by the argument of the option, e.g., 82224090Sdougb <code class="constant">ddns-key.example.com.</code> 83224090Sdougb The key name must have the format of a valid domain name, 84224090Sdougb consisting of letters, digits, hyphens and periods. 85224090Sdougb </p></dd> 86224090Sdougb<dt><span class="term">-q</span></dt> 87224090Sdougb<dd><p> 88224090Sdougb Quiet mode: Print only the key, with no explanatory text or 89224090Sdougb usage examples. 90224090Sdougb </p></dd> 91224090Sdougb<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt> 92224090Sdougb<dd><p> 93224090Sdougb Specifies a source of random data for generating the 94224090Sdougb authorization. If the operating system does not provide a 95224090Sdougb <code class="filename">/dev/random</code> or equivalent device, the 96224090Sdougb default source of randomness is keyboard input. 97224090Sdougb <code class="filename">randomdev</code> specifies the name of a 98224090Sdougb character device or file containing random data to be used 99224090Sdougb instead of the default. The special value 100224090Sdougb <code class="filename">keyboard</code> indicates that keyboard input 101224090Sdougb should be used. 102224090Sdougb </p></dd> 103224090Sdougb<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt> 104224090Sdougb<dd><p> 105224090Sdougb Single host mode: The example <span><strong class="command">named.conf</strong></span> text 106224090Sdougb shows how to set an update policy for the specified 107224090Sdougb <em class="replaceable"><code>name</code></em> 108224090Sdougb using the "name" nametype. 109224090Sdougb The default key name is 110224090Sdougb ddns-key.<em class="replaceable"><code>name</code></em>. 111224090Sdougb Note that the "self" nametype cannot be used, since 112224090Sdougb the name to be updated may differ from the key name. 113224090Sdougb This option cannot be used with the <code class="option">-z</code> option. 114224090Sdougb </p></dd> 115224090Sdougb<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt> 116224090Sdougb<dd><p> 117224090Sdougb zone mode: The example <span><strong class="command">named.conf</strong></span> text 118224090Sdougb shows how to set an update policy for the specified 119224090Sdougb <em class="replaceable"><code>zone</code></em> 120224090Sdougb using the "zonesub" nametype, allowing updates to all subdomain 121224090Sdougb names within 122224090Sdougb that <em class="replaceable"><code>zone</code></em>. 123224090Sdougb This option cannot be used with the <code class="option">-s</code> option. 124224090Sdougb </p></dd> 125224090Sdougb</dl></div> 126224090Sdougb</div> 127224090Sdougb<div class="refsect1" lang="en"> 128234010Sdougb<a name="id2543643"></a><h2>SEE ALSO</h2> 129224090Sdougb<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>, 130224090Sdougb <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>, 131224090Sdougb <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, 132224090Sdougb <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 133224090Sdougb </p> 134224090Sdougb</div> 135224090Sdougb<div class="refsect1" lang="en"> 136234010Sdougb<a name="id2543682"></a><h2>AUTHOR</h2> 137224090Sdougb<p><span class="corpauthor">Internet Systems Consortium</span> 138224090Sdougb </p> 139224090Sdougb</div> 140224090Sdougb</div></body> 141224090Sdougb</html> 142