man.ddns-confgen.html revision ec899c963c91c16c393e067996400ae244921110
6fe48fb46e53ffc37542853a1edb74cb481b7d94Automatic Updater - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
c78c39caab4cf8b5daefc9c65878f7f5ed3eb7a0Tinderbox User - Copyright (C) 2000-2003 Internet Software Consortium.
ab496cc3df1648e9ad992a87c35c2c0870fdc69dTinderbox User - Permission to use, copy, modify, and/or distribute this software for any
7c1468ed500356839a4a222517364e6ce18cb1a2Tinderbox User - purpose with or without fee is hereby granted, provided that the above
c57668a2fbbe558c1bd21652813616f2f517c469Tinderbox User - copyright notice and this permission notice appear in all copies.
287a6a8f9040dc43560cd69cddf83bfc0f53b76fTinderbox User - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8de3f14f1c300c3e1ed99084cc03485b42c92bf1Tinderbox User - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
950d203b64f512b85fcc093ee1e9e3e531a1aea3Tinderbox User - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
b886b04d8d2b085cbf3e1bf4442dee87f43ba5e4Tinderbox User - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews - PERFORMANCE OF THIS SOFTWARE.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<!-- $Id$ -->
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
e676a596869d8a80a644c99a848afb53d1c5975eMark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<link rel="next" href="man.arpaname.html" title="arpaname">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<table width="100%" summary="Navigation header">
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<th width="60%" align="center">Manual pages</th>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews<a name="man.ddns-confgen"></a><div class="titlepage"></div>
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater<div class="cmdsynopsis"><p><code class="command">tsig-keygen</code> [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>] [<code class="option">-h</code>] [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>] [name]</p></div>
aa9c561961e9d877946ebaa8795fa2be054ab7bfEvan Hunt<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">-q</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> ]</p></div>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater are invokation methods for a utility that generates keys for use
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater in TSIG signing. The resulting keys can be used, for example,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews to secure dynamic DNS updates to a zone or for the
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <span><strong class="command">rndc</strong></span> command channel.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews can be specified on the command line which will be used as
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater the name of the generated key. If no name is specified,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews the default is <code class="constant">tsig-key</code>.
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
9513a2a6670951f5cf5477fcfec9f933fcaff628Automatic Updater key is accompanied by configuration text and instructions
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews that can be used with <span><strong class="command">nsupdate</strong></span> and
eabc9c3c07cd956d3c436bd7614cb162dabdda76Mark Andrews <span><strong class="command">named</strong></span> when setting up dynamic DNS,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews including an example <span><strong class="command">update-policy</strong></span>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews statement. (This usage similar to the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <span><strong class="command">rndc-confgen</strong></span> command for setting
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews up command channel security.)
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt Note that <span><strong class="command">named</strong></span> itself can configure a
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
95637507c3d47481fbf0a8a8c750a57f944f677fMark Andrews it does this when a zone is configured with
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt <span><strong class="command">update-policy local;</strong></span>.
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt <span><strong class="command">ddns-confgen</strong></span> is only needed when a
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt more elaborate configuration is required: for instance,
2ae159b376dac23870d8005563c585acf85a4b5aEvan Hunt if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
ee11dfc481f2ef6a032a715454f6290961a722d2Tinderbox User<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews Specifies the algorithm to use for the TSIG key. Available
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-sha256.
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User Options are case-insensitive, and the "hmac-" prefix
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User may be omitted.
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User Prints a short summary of options and arguments.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson Specifies the key name of the DDNS authentication key.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User The default is <code class="constant">ddns-key</code> when neither
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews the <code class="option">-s</code> nor <code class="option">-z</code> option is
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User specified; otherwise, the default
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews is <code class="constant">ddns-key</code> as a separate label
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User followed by the argument of the option, e.g.,
efb0e886f18894a1d2489f1ad74ad14b579e11c7Mark Andrews <code class="constant">ddns-key.example.com.</code>
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews The key name must have the format of a valid domain name,
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User consisting of letters, digits, hyphens and periods.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews only the key, with no explanatory text or usage examples;
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User Specifies a source of random data for generating the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews authorization. If the operating system does not provide a
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <code class="filename">/dev/random</code> or equivalent device, the
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews default source of randomness is keyboard input.
28a5dd720187fddb16055a0f64b63a7b66f29f64Mark Andrews <code class="filename">randomdev</code> specifies the name of a
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews character device or file containing random data to be used
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews instead of the default. The special value
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User <code class="filename">keyboard</code> indicates that keyboard input
0e573cdd111e060e5f6c18249b5ccacbe8abe278Tinderbox User should be used.
fd972434c29fc1169d66594e4cc7697d33036c2bTinderbox User<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
37d8e0a4455876fe1e4cca511076cc2c5ab9eedeTinderbox User (<span><strong class="command">ddns-confgen</strong></span> only.)
fd972434c29fc1169d66594e4cc7697d33036c2bTinderbox User Generate configuration example to allow dynamic updates
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont of a single hostname. The example <span><strong class="command">named.conf</strong></span>
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User text shows how to set an update policy for the specified
2a31bd531072824ef252c18303859d6af7451b00Francis Dupont using the "name" nametype. The default key name is
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User Note that the "self" nametype cannot be used, since
5747235bf35e7398984fd6b4632743396895ea7aTinderbox User the name to be updated may differ from the key name.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
a03cb08d0c4f1ca5fbc121d2f02bdffa7eb52286Mark Andrews<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews (<span><strong class="command">ddns-confgen</strong></span> only.)
78f3ed4bc2fcd3d270bfd599804f3b27a1db4d91Mark Andrews Generate configuration example to allow dynamic updates
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User of a zone: The example <span><strong class="command">named.conf</strong></span> text
5747235bf35e7398984fd6b4632743396895ea7aTinderbox User shows how to set an update policy for the specified
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews using the "zonesub" nametype, allowing updates to
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User all subdomain names within that
dedefc0bdbb4e6e39eeb98aa2fc6883efec2ddb0Mark Andrews <em class="replaceable"><code>zone</code></em>.
c651f15b30f1dae5cc2f00878fb5da5b3a35a468Mark Andrews This option cannot be used with the <code class="option">-s</code> option.
e40c4e4c17d4df338e2a7db0f84d8dbb3858964cTinderbox User<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
cdfc81e048bd34c1d628380247bda6b80a89e20eAutomatic Updater <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<p><span class="corpauthor">Internet Systems Consortium</span>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<table width="100%" summary="Navigation footer">
0eb371ca0dab50ae3462e98794a6126198c52f4bMark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
fe80a4909bf62b602feaf246866e9d29f7654194Automatic Updater<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<span class="application">rndc-confgen</span>�</td>
91216cff91b34c9ff6e846dc23f248219cafe660Andreas Gustafsson<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
9ecb5d33470ebfb3719a1b8d56bcefdf4b27f7b2Tinderbox User<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>