man.ddns-confgen.html revision 81199ce5ba7bd719add38189b06987e0a6e583a1
2952abf7cbbba6c6f821ee18579ca29d87549574Mark Andrews - Copyright (C) 2004-2015 Internet Systems Consortium, Inc. ("ISC")
efb82ed87e916c82b481bee4aa6651f2dbd4cedaMark Andrews - Copyright (C) 2000-2003 Internet Software Consortium.
7c693bfdbe488ca8fa4f0831c71f5809972f6cc7Mark Andrews - Permission to use, copy, modify, and/or distribute this software for any
7c693bfdbe488ca8fa4f0831c71f5809972f6cc7Mark Andrews - purpose with or without fee is hereby granted, provided that the above
7092864f71e0bbb108041ef01ac3d2b41f90c4a9Mark Andrews - copyright notice and this permission notice appear in all copies.
7092864f71e0bbb108041ef01ac3d2b41f90c4a9Mark Andrews - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
24ee607afa66e5ba5fa8b2f18c34a5c430b8a3feMark Andrews - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
24ee607afa66e5ba5fa8b2f18c34a5c430b8a3feMark Andrews - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
24ee607afa66e5ba5fa8b2f18c34a5c430b8a3feMark Andrews - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
2113dfd6e20a9ca16000ed226517b4660087c1f2Mark Andrews - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
2113dfd6e20a9ca16000ed226517b4660087c1f2Mark Andrews - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
2113dfd6e20a9ca16000ed226517b4660087c1f2Mark Andrews - PERFORMANCE OF THIS SOFTWARE.
2dafa707cc9af9cca66d68c1d2c3af0c768c2900Mark Andrews<!-- $Id$ -->
2dafa707cc9af9cca66d68c1d2c3af0c768c2900Mark Andrews<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
c7817270552b2faab56466b89731b6f290b352a4Mark Andrews<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
c7817270552b2faab56466b89731b6f290b352a4Mark Andrews<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
c7817270552b2faab56466b89731b6f290b352a4Mark Andrews<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
22e5a52c3b5bfef7e75d95629e08cab7592fee5cMark Andrews<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
22e5a52c3b5bfef7e75d95629e08cab7592fee5cMark Andrews<link rel="next" href="man.arpaname.html" title="arpaname">
6d453e1bb296e88732655f3d736e571eeaaca254Mark Andrews<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
240e57ab983296e6d52031a594d3345728191b48Mark Andrews<table width="100%" summary="Navigation header">
240e57ab983296e6d52031a594d3345728191b48Mark Andrews<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
cdb674387ca19dc8550553d90d8f9731befb6f1fMark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
02ced31b6aa999099214d2688b1a80ac5d93c57bMark Andrews<th width="60%" align="center">Manual pages</th>
02ced31b6aa999099214d2688b1a80ac5d93c57bMark Andrews<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
d4f5efb4d63e2e17081a49a3457f05fe06fbb5abMark Andrews<a name="man.ddns-confgen"></a><div class="titlepage"></div>
cfaf65f53fb0c1779e7b2e07216e5fbfd3a2d52eMark Andrews<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
f07fe5a1ac9d1345eb7a36a0bc38716a03e25f61Mark Andrews<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>
f07fe5a1ac9d1345eb7a36a0bc38716a03e25f61Mark Andrews<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>
ce8cd4a3efd27ef145847216d513bb341bfe208cMark Andrews <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
393e4679cf4dd8bafb031d8a61ece95af61fbedcMark Andrews are invocation methods for a utility that generates keys for use
393e4679cf4dd8bafb031d8a61ece95af61fbedcMark Andrews in TSIG signing. The resulting keys can be used, for example,
854dac0f186e5b491d65f6d73dd6e440e7a2c227Mark Andrews to secure dynamic DNS updates to a zone or for the
854dac0f186e5b491d65f6d73dd6e440e7a2c227Mark Andrews <span><strong class="command">rndc</strong></span> command channel.
431fd1b0b5c3c049f9397ed4be8915715ead9cdbMark Andrews When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
431fd1b0b5c3c049f9397ed4be8915715ead9cdbMark Andrews can be specified on the command line which will be used as
cc7d91bd5c6b9be5a3c67a99112b885602c24873Mark Andrews the name of the generated key. If no name is specified,
cc7d91bd5c6b9be5a3c67a99112b885602c24873Mark Andrews the default is <code class="constant">tsig-key</code>.
39ef7dddef12152afa3a2fc1c1962cdf6d30b5cbMark Andrews When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
f22ef4dfb973c4714eedd3818050fde74fb20e48Mark Andrews key is accompanied by configuration text and instructions
f22ef4dfb973c4714eedd3818050fde74fb20e48Mark Andrews that can be used with <span><strong class="command">nsupdate</strong></span> and
f22ef4dfb973c4714eedd3818050fde74fb20e48Mark Andrews <span><strong class="command">named</strong></span> when setting up dynamic DNS,
3b572928731d3595990fe360c80977a2d043eb02Tatuya JINMEI 神明達哉 including an example <span><strong class="command">update-policy</strong></span>
84f5576c149ed0cf18555bcd7cf1ffbe491bb08fMark Andrews statement. (This usage similar to the
50d3f097d4c2779c8fb2397882d91e0cbca2c260Mark Andrews <span><strong class="command">rndc-confgen</strong></span> command for setting
84f5576c149ed0cf18555bcd7cf1ffbe491bb08fMark Andrews up command channel security.)
6953fd6e20fddcb6389e642aa872cb7425a95f6dMark Andrews Note that <span><strong class="command">named</strong></span> itself can configure a
6953fd6e20fddcb6389e642aa872cb7425a95f6dMark Andrews local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
6953fd6e20fddcb6389e642aa872cb7425a95f6dMark Andrews it does this when a zone is configured with
2b67af24fa02867fbc703e89277400b10d0c8b92Mark Andrews <span><strong class="command">update-policy local;</strong></span>.
2b67af24fa02867fbc703e89277400b10d0c8b92Mark Andrews <span><strong class="command">ddns-confgen</strong></span> is only needed when a
2b67af24fa02867fbc703e89277400b10d0c8b92Mark Andrews more elaborate configuration is required: for instance,
f02b985650a6f1277a3a45f18561d519916c1890Mark Andrews if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
0b5d8941bb41edbe1296619485c16df536ecc05fMark Andrews<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
bcdf37e0ff7d73310b7bf247d755194a5718ba38Mark Andrews Specifies the algorithm to use for the TSIG key. Available
bcdf37e0ff7d73310b7bf247d755194a5718ba38Mark Andrews choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
a34d19803a206febe10866394393ec1c09b28984Mark Andrews hmac-sha384 and hmac-sha512. The default is hmac-sha256.
a34d19803a206febe10866394393ec1c09b28984Mark Andrews Options are case-insensitive, and the "hmac-" prefix
cbef026164ceabccb2e85403434b722d77f7b5eeMark Andrews may be omitted.
2db8db63992d081c75d664340866e2a21913705dMark Andrews Prints a short summary of options and arguments.
2db8db63992d081c75d664340866e2a21913705dMark Andrews<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
7076f000ea3487299a9da9318915d042aaba62c5Mark Andrews Specifies the key name of the DDNS authentication key.
7076f000ea3487299a9da9318915d042aaba62c5Mark Andrews The default is <code class="constant">ddns-key</code> when neither
7076f000ea3487299a9da9318915d042aaba62c5Mark Andrews the <code class="option">-s</code> nor <code class="option">-z</code> option is
7076f000ea3487299a9da9318915d042aaba62c5Mark Andrews specified; otherwise, the default
7076f000ea3487299a9da9318915d042aaba62c5Mark Andrews is <code class="constant">ddns-key</code> as a separate label
8626c376a038da969de1ee6c158957dfe638daacMark Andrews followed by the argument of the option, e.g.,
8626c376a038da969de1ee6c158957dfe638daacMark Andrews <code class="constant">ddns-key.example.com.</code>
8626c376a038da969de1ee6c158957dfe638daacMark Andrews The key name must have the format of a valid domain name,
c6ee5082db1e40ab64e08a540620da79996efa9cTatuya JINMEI 神明達哉 consisting of letters, digits, hyphens and periods.
9a6522317c97e5487cea816173f63a0e5b4e428aTatuya JINMEI 神明達哉 (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
f5a156fa25e6d341e703782de6368fbe9e256ddeTatuya JINMEI 神明達哉 only the key, with no explanatory text or usage examples;
f22ef4dfb973c4714eedd3818050fde74fb20e48Mark Andrews This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
5a9efbf6bf951267e0844990f5b2cb69f5d5f01fTatuya JINMEI 神明達哉<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
08eadd404a59a6befcf51cb13695abee5d03456dMark Andrews Specifies a source of random data for generating the
08eadd404a59a6befcf51cb13695abee5d03456dMark Andrews authorization. If the operating system does not provide a
c55dd77de4ce71b858afb291e44577b51be8b780Mark Andrews <code class="filename">/dev/random</code> or equivalent device, the
c55dd77de4ce71b858afb291e44577b51be8b780Mark Andrews default source of randomness is keyboard input.
c55dd77de4ce71b858afb291e44577b51be8b780Mark Andrews <code class="filename">randomdev</code> specifies the name of a
eca38a9d43391482bfa22e2eb7b86e19be8bf461Mark Andrews character device or file containing random data to be used
eca38a9d43391482bfa22e2eb7b86e19be8bf461Mark Andrews instead of the default. The special value
eca38a9d43391482bfa22e2eb7b86e19be8bf461Mark Andrews <code class="filename">keyboard</code> indicates that keyboard input
d79296d147cd4c35784dd3efd7ed7f09d976ee61Mark Andrews should be used.
4f5a43c5f084290054ddf212add7b4c2abe6edc5Tatuya JINMEI 神明達哉<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
46390a96dd5f15c9a0b3663bdb7791bdecec3052Mark Andrews (<span><strong class="command">ddns-confgen</strong></span> only.)
9a482d1fcead22ab0d639c463c77672846485f3eMark Andrews Generate configuration example to allow dynamic updates
9a482d1fcead22ab0d639c463c77672846485f3eMark Andrews of a single hostname. The example <span><strong class="command">named.conf</strong></span>
9a482d1fcead22ab0d639c463c77672846485f3eMark Andrews text shows how to set an update policy for the specified
9a482d1fcead22ab0d639c463c77672846485f3eMark Andrews using the "name" nametype. The default key name is
d48f9877255f41b6074777da0639b6bc2bfad388Mark Andrews ddns-key.<em class="replaceable"><code>name</code></em>.
d48f9877255f41b6074777da0639b6bc2bfad388Mark Andrews Note that the "self" nametype cannot be used, since
d48f9877255f41b6074777da0639b6bc2bfad388Mark Andrews the name to be updated may differ from the key name.
d48f9877255f41b6074777da0639b6bc2bfad388Mark Andrews This option cannot be used with the <code class="option">-z</code> option.
5d51f534831bd648436d22e4faf203fb9abdf3d4Mark Andrews<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
a45a6ea2b03448751d7c44931e8ac7666e7cc2ceMark Andrews (<span><strong class="command">ddns-confgen</strong></span> only.)
a45a6ea2b03448751d7c44931e8ac7666e7cc2ceMark Andrews Generate configuration example to allow dynamic updates
a45a6ea2b03448751d7c44931e8ac7666e7cc2ceMark Andrews of a zone: The example <span><strong class="command">named.conf</strong></span> text
a45a6ea2b03448751d7c44931e8ac7666e7cc2ceMark Andrews shows how to set an update policy for the specified
15bda409010cbf2d3e43baf10f28bae5f7b1abefMark Andrews using the "zonesub" nametype, allowing updates to
b5205d860b1672c405c57004e6823af873799b42Mark Andrews all subdomain names within that
b5205d860b1672c405c57004e6823af873799b42Mark Andrews <em class="replaceable"><code>zone</code></em>.
b5205d860b1672c405c57004e6823af873799b42Mark Andrews This option cannot be used with the <code class="option">-s</code> option.
12b1bf8b14ac3b6ec4de9cae6fea10f389b5e5dbMark Andrews<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
12b1bf8b14ac3b6ec4de9cae6fea10f389b5e5dbMark Andrews <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
12b1bf8b14ac3b6ec4de9cae6fea10f389b5e5dbMark Andrews <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
e22bd3c4bc0de0b96531fab5c2c944251e02e975Mark Andrews <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
529035492ea0a427cc8d007cd743934d4494d9d3Mark Andrews<p><span class="corpauthor">Internet Systems Consortium</span>
cd6d8d61b076eea02826596334a105b918393627Mark Andrews<table width="100%" summary="Navigation footer">
f04809663f4ba3df0e2ef1247d67bdd6ce0157d6Mark Andrews<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
f04809663f4ba3df0e2ef1247d67bdd6ce0157d6Mark Andrews<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
7d7f929274e48808b4771162d6302a99e69865d8Mark Andrews<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
21b76ee598c937c6736cbc7ab69684bb3332428aMark Andrews<span class="application">rndc-confgen</span>�</td>
21b76ee598c937c6736cbc7ab69684bb3332428aMark Andrews<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
21b76ee598c937c6736cbc7ab69684bb3332428aMark Andrews<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
b66ca17f2990433a3e277b50cc3c15f19cdd0771Mark Andrews<p style="text-align: center;">BIND 9.11.0pre-alpha</p>