ddns-confgen.html revision 4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - Permission to use, copy, modify, and/or distribute this software for any
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - purpose with or without fee is hereby granted, provided that the above
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - copyright notice and this permission notice appear in all copies.
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff - PERFORMANCE OF THIS SOFTWARE.
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff<!-- $Id: ddns-confgen.html,v 1.9 2009/07/11 01:12:45 tbox Exp $ -->
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<a name="man.ddns-confgen"></a><div class="titlepage"></div>
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
64828244e04e86dfa40f0a4f0c05f27923da499dMichael Graff<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>
f181f94ec8da8b1dbcc6353e8be965ea4a5ea282Michael Graff<p><span><strong class="command">ddns-confgen</strong></span>
21e7034ec046105c00a0dab86c83732e2e77ad99Michael Graff generates a key for use by <span><strong class="command">nsupdate</strong></span>
31fab17bcdbe302592a6c0dc5374ef56333ee879Michael Graff and <span><strong class="command">named</strong></span>. It simplifies configuration
213973a334f92d4aef4ef62b4538fc2e4d0e8082Michael Graff of dynamic zones by generating a key and providing the
3024dbecbac365171bc6de0f3fa04951d6558be3Michael Graff <span><strong class="command">nsupdate</strong></span> and <span><strong class="command">named.conf</strong></span>
f181f94ec8da8b1dbcc6353e8be965ea4a5ea282Michael Graff syntax that will be needed to use it, including an example
3ac63b472022ff92691d1fe69ac715a729671965Michael Graff <span><strong class="command">update-policy</strong></span> statement.
e45d323a2a0f4ca08d4b139546e60a5fa7bd3f0cMichael Graff If a domain name is specified on the command line, it will
29f28fe573d4b3b318b3b026d567c1eb86738015Michael Graff be used in the name of the generated key and in the sample
86944a4c8002e80ae9b6eb5a5e29b797879be45fMichael Graff <span><strong class="command">named.conf</strong></span> syntax. For example,
11efdeb076d65fa9f0c5fc067dc040e7c99dfba6Michael Graff <span><strong class="command">ddns-confgen example.com</strong></span> would
21e7034ec046105c00a0dab86c83732e2e77ad99Michael Graff generate a key called "ddns-key.example.com", and sample
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff <span><strong class="command">named.conf</strong></span> command that could be used
e51511aa3281f8dc384eb1283115c7f8d5c402aeMichael Graff in the zone definition for "example.com".
11efdeb076d65fa9f0c5fc067dc040e7c99dfba6Michael Graff Note that <span><strong class="command">named</strong></span> itself can configure a
439c0011e642fb1d26011116144af698125262dbMichael Graff local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>.
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff <span><strong class="command">ddns-confgen</strong></span> is only needed when a
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff more elaborate configuration is required: for instance, if
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff <span><strong class="command">nsupdate</strong></span> is to be used from a remote system.
31fab17bcdbe302592a6c0dc5374ef56333ee879Michael Graff<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
31fab17bcdbe302592a6c0dc5374ef56333ee879Michael Graff Specifies the algorithm to use for the TSIG key. Available
31fab17bcdbe302592a6c0dc5374ef56333ee879Michael Graff choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
31fab17bcdbe302592a6c0dc5374ef56333ee879Michael Graff hmac-sha384 and hmac-sha512. The default is hmac-sha256.
fe14eafefa91fada7cea0a55b09196c01477406cBob Halley Prints a short summary of the options and arguments to
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff <span><strong class="command">ddns-confgen</strong></span>.
ebdd11e84734e28ddd64562e82a7c646a58a04f4Michael Graff<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
ebdd11e84734e28ddd64562e82a7c646a58a04f4Michael Graff Specifies the key name of the DDNS authentication key.
ebdd11e84734e28ddd64562e82a7c646a58a04f4Michael Graff The default is <code class="constant">ddns-key</code> when neither
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff the <code class="option">-s</code> nor <code class="option">-z</code> option is
84c46a7acb961cac19c0d857bfdd00f3383a9bc6Michael Graff specified; otherwise, the default
84c46a7acb961cac19c0d857bfdd00f3383a9bc6Michael Graff is <code class="constant">ddns-key</code> as a separate label
3ac63b472022ff92691d1fe69ac715a729671965Michael Graff followed by the argument of the option, e.g.,
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff <code class="constant">ddns-key.example.com.</code>
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff The key name must have the format of a valid domain name,
213973a334f92d4aef4ef62b4538fc2e4d0e8082Michael Graff consisting of letters, digits, hyphens and periods.
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff Quiet mode: Print only the key, with no explanatory text or
ff9bb3fc5453bbf310b67c560fbf04a5c0fb60daMichael Graff usage examples.
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
fe14eafefa91fada7cea0a55b09196c01477406cBob Halley Specifies a source of random data for generating the
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff authorization. If the operating system does not provide a
66bd3b3c6b171271c705b897823dcdcf29464698Michael Graff <code class="filename">/dev/random</code> or equivalent device, the
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff default source of randomness is keyboard input.
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff <code class="filename">randomdev</code> specifies the name of a
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff character device or file containing random data to be used
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff instead of the default. The special value
439c0011e642fb1d26011116144af698125262dbMichael Graff <code class="filename">keyboard</code> indicates that keyboard input
11efdeb076d65fa9f0c5fc067dc040e7c99dfba6Michael Graff should be used.
11efdeb076d65fa9f0c5fc067dc040e7c99dfba6Michael Graff<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
84c46a7acb961cac19c0d857bfdd00f3383a9bc6Michael Graff Single host mode: The example <span><strong class="command">named.conf</strong></span> text
3ac63b472022ff92691d1fe69ac715a729671965Michael Graff shows how to set an update policy for the specified
84c46a7acb961cac19c0d857bfdd00f3383a9bc6Michael Graff <em class="replaceable"><code>name</code></em>
84c46a7acb961cac19c0d857bfdd00f3383a9bc6Michael Graff using the "name" nametype.
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff The default key name is
30251e07d1705d1a85b0e1d5a969496e1aed612eMichael Graff ddns-key.<em class="replaceable"><code>name</code></em>.
30251e07d1705d1a85b0e1d5a969496e1aed612eMichael Graff Note that the "self" nametype cannot be used, since
e51511aa3281f8dc384eb1283115c7f8d5c402aeMichael Graff the name to be updated may differ from the key name.
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff This option cannot be used with the <code class="option">-z</code> option.
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff zone mode: The example <span><strong class="command">named.conf</strong></span> text
2992344aacdb08e4af936c176d49ef789f5673ddMichael Graff shows how to set an update policy for the specified
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff <em class="replaceable"><code>zone</code></em>
bb143613cf26e0f27dfd9caf1a7336065d064b26Michael Graff using the "zonesub" nametype, allowing updates to all subdomain
fe14eafefa91fada7cea0a55b09196c01477406cBob Halley names within
11fcc67616fac1bc6a28b3d4fed24641137888e7Michael Graff that <em class="replaceable"><code>zone</code></em>.
f181f94ec8da8b1dbcc6353e8be965ea4a5ea282Michael Graff This option cannot be used with the <code class="option">-s</code> option.
213973a334f92d4aef4ef62b4538fc2e4d0e8082Michael Graff<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
30251e07d1705d1a85b0e1d5a969496e1aed612eMichael Graff <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
30251e07d1705d1a85b0e1d5a969496e1aed612eMichael Graff <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
213973a334f92d4aef4ef62b4538fc2e4d0e8082Michael Graff <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
ad3a5c4b7e21af04d1b872f933c2e19e5c0a135bMichael Graff<p><span class="corpauthor">Internet Systems Consortium</span>