man.ddns-confgen.html revision 9210d8796eaf4125ac58c034f9b5ca167857a55a
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!--
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - Copyright (C) 2004-2009 Internet Systems Consortium, Inc. ("ISC")
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - Copyright (C) 2000-2003 Internet Software Consortium.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews -
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - 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.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews -
d4ef65050feac78554addf6e16a06c6e2e0bd331Brian Wellington - 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,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - 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.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington-->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- $Id: man.ddns-confgen.html,v 1.4 2009/06/16 01:12:45 tbox Exp $ -->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<html>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<head>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<title>ddns-confgen</title>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</head>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<div class="navheader">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<table width="100%" summary="Navigation header">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
c1a883f2e04d94e99c433b1f6cfd0c0338f4ed85Mark Andrews<tr>
fd4dcaddae08b0fb28b0ec4faf26a9d8b1f923caAutomatic Updater<td width="20%" align="left">
a7c412f37cc73d0332887a746e81220cbf09dd00Mark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
6a6ceba6fe09c81558362f238dd727576af7108dTinderbox User<th width="60%" align="center">Manual pages</th>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews<td width="20%" align="right">�</td>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</tr>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</table>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<hr>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</div>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<div class="refentry" lang="en">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<a name="man.ddns-confgen"></a><div class="titlepage"></div>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews<div class="refnamediv">
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<h2>Name</h2>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<p><span class="application">ddns-confgen</span> &#8212; ddns key generation tool</p>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</div>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<div class="refsynopsisdiv">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<h2>Synopsis</h2>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<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>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington</div>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<div class="refsect1" lang="en">
c40265eba0c99708887d68e67901924065ba2514Brian Wellington<a name="id2609560"></a><h2>DESCRIPTION</h2>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<p><span><strong class="command">ddns-confgen</strong></span>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington generates a key for use by <span><strong class="command">nsupdate</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt and <span><strong class="command">named</strong></span>. It simplifies configuration
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt of dynamic zones by generating a key and providing the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt syntax that will be needed to use it, including an example
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <span><strong class="command">update-policy</strong></span> statement.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </p>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<p>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt If a domain name is specified on the command line, it will
c40265eba0c99708887d68e67901924065ba2514Brian Wellington be used in the name of the generated key and in the sample
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <span><strong class="command">named.conf</strong></span> syntax. For example,
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <span><strong class="command">ddns-confgen example.com</strong></span> would
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt generate a key called "ddns-key.example.com", and sample
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews <span><strong class="command">named.conf</strong></span> command that could be used
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein in the zone definition for "example.com".
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt </p>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<p>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt Note that <span><strong class="command">named</strong></span> itself can configure a
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt <span><strong class="command">ddns-confgen</strong></span> is only needed when a
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt more elaborate configuration is required: for instance, if
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt </p>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt</div>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<div class="refsect1" lang="en">
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<a name="id2634633"></a><h2>OPTIONS</h2>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<div class="variablelist"><dl>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt<dd><p>
85c5ed3577655f4f710f0af5ee93edd71c336055Evan Hunt Specifies the algorithm to use for the TSIG key. Available
c40265eba0c99708887d68e67901924065ba2514Brian Wellington choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </p></dd>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<dt><span class="term">-h</span></dt>
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews<dd><p>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Prints a short summary of the options and arguments to
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <span><strong class="command">ddns-confgen</strong></span>.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington </p></dd>
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews<dd><p>
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews Specifies the key name of the DDNS authentication key.
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews The default is <code class="constant">ddns-key</code>.
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews The key name must have the format of a valid domain name,
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews consisting of letters, digits, hyphens and periods.
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews </p></dd>
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews<dt><span class="term">-q</span></dt>
0f8c9b5eed7e8714ceb7d6d3675555df9c5f6350Mark Andrews<dd><p>
c40265eba0c99708887d68e67901924065ba2514Brian Wellington Quiet mode: Print only the key, with no explanatory text or
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein usage examples.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </p></dd>
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dd><p>
2637d30fbd235fe98145f4312b10cc41a13bf7dcJeremy C. Reed 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
c40265eba0c99708887d68e67901924065ba2514Brian Wellington default source of randomness is keyboard input.
c40265eba0c99708887d68e67901924065ba2514Brian Wellington <code class="filename">randomdev</code> specifies the name of a
a26ad011f382d12058478704cb5e90e6f4366d01Andreas Gustafsson character device or file containing random data to be used
a26ad011f382d12058478704cb5e90e6f4366d01Andreas Gustafsson 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 </p></dd>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dt><span class="term">-s</span></dt>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<dd><p>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein Self mode: The example <span><strong class="command">named.conf</strong></span> text
a26ad011f382d12058478704cb5e90e6f4366d01Andreas Gustafsson shows how to set an update policy using the "self" nametype,
a26ad011f382d12058478704cb5e90e6f4366d01Andreas Gustafsson using a single key per each domain name for updates, instead of
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews the "subdomain" nametype which allows matching on any name
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews within a specified domain.
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews </p></dd>
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews</dl></div>
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews</div>
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews<div class="refsect1" lang="en">
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews<a name="id2634832"></a><h2>SEE ALSO</h2>
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
3bc4221346e5045c5679dd0d84f4f7d888a9da79Mark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews </p>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews</div>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<div class="refsect1" lang="en">
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<a name="id2634870"></a><h2>AUTHOR</h2>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews </p>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews</div>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews</div>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<div class="navfooter">
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<hr>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<table width="100%" summary="Navigation footer">
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<tr>
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<td width="40%" align="left">
ff6de396a93b9b73a37173059a595f3d295b57cbMark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
92551304a9abff9284de5b79a48e83d781989339Mark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
92551304a9abff9284de5b79a48e83d781989339Mark Andrews<td width="40%" align="right">�</td>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</tr>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<tr>
561a29af8c54a216e7d30b5b4f6e0d21661654ecMark Andrews<td width="40%" align="left" valign="top">
561a29af8c54a216e7d30b5b4f6e0d21661654ecMark Andrews<span class="application">rndc-confgen</span>�</td>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<td width="40%" align="right" valign="top">�</td>
92551304a9abff9284de5b79a48e83d781989339Mark Andrews</tr>
92551304a9abff9284de5b79a48e83d781989339Mark Andrews</table>
7791dd06ea69d0fb2494788ad4c24d568f40bcdfMark Andrews</div>
e9359db5e958bf05f9b9c5fe3c27d533f0f05550Mark Andrews</body>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</html>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein