1<!-- 2 - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC") 3 - 4 - Permission to use, copy, modify, and/or distribute this software for any 5 - purpose with or without fee is hereby granted, provided that the above 6 - copyright notice and this permission notice appear in all copies. 7 - 8 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 9 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 10 - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 11 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 12 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 13 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 14 - PERFORMANCE OF THIS SOFTWARE. 15--> 16<!-- Id --> 17<html> 18<head> 19<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 20<title>ddns-confgen</title> 21<meta name="generator" content="DocBook XSL Stylesheets V1.71.1"> 22</head> 23<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"> 24<a name="man.ddns-confgen"></a><div class="titlepage"></div> 25<div class="refnamediv"> 26<h2>Name</h2> 27<p><span class="application">ddns-confgen</span> — ddns key generation tool</p> 28</div> 29<div class="refsynopsisdiv"> 30<h2>Synopsis</h2> 31<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> 32<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> 33</div> 34<div class="refsect1" lang="en"> 35<a name="id2543434"></a><h2>DESCRIPTION</h2> 36<p> 37 <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span> 38 are invocation methods for a utility that generates keys for use 39 in TSIG signing. The resulting keys can be used, for example, 40 to secure dynamic DNS updates to a zone or for the 41 <span><strong class="command">rndc</strong></span> command channel. 42 </p> 43<p> 44 When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name 45 can be specified on the command line which will be used as 46 the name of the generated key. If no name is specified, 47 the default is <code class="constant">tsig-key</code>. 48 </p> 49<p> 50 When run as <span><strong class="command">ddns-confgen</strong></span>, the generated 51 key is accompanied by configuration text and instructions 52 that can be used with <span><strong class="command">nsupdate</strong></span> and 53 <span><strong class="command">named</strong></span> when setting up dynamic DNS, 54 including an example <span><strong class="command">update-policy</strong></span> 55 statement. (This usage similar to the 56 <span><strong class="command">rndc-confgen</strong></span> command for setting 57 up command channel security.) 58 </p> 59<p> 60 Note that <span><strong class="command">named</strong></span> itself can configure a 61 local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>: 62 it does this when a zone is configured with 63 <span><strong class="command">update-policy local;</strong></span>. 64 <span><strong class="command">ddns-confgen</strong></span> is only needed when a 65 more elaborate configuration is required: for instance, 66 if <span><strong class="command">nsupdate</strong></span> is to be used from a remote 67 system. 68 </p> 69</div> 70<div class="refsect1" lang="en"> 71<a name="id2543508"></a><h2>OPTIONS</h2> 72<div class="variablelist"><dl> 73<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt> 74<dd><p> 75 Specifies the algorithm to use for the TSIG key. Available 76 choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, 77 hmac-sha384 and hmac-sha512. The default is hmac-sha256. 78 Options are case-insensitive, and the "hmac-" prefix 79 may be omitted. 80 </p></dd> 81<dt><span class="term">-h</span></dt> 82<dd><p> 83 Prints a short summary of options and arguments. 84 </p></dd> 85<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt> 86<dd><p> 87 Specifies the key name of the DDNS authentication key. 88 The default is <code class="constant">ddns-key</code> when neither 89 the <code class="option">-s</code> nor <code class="option">-z</code> option is 90 specified; otherwise, the default 91 is <code class="constant">ddns-key</code> as a separate label 92 followed by the argument of the option, e.g., 93 <code class="constant">ddns-key.example.com.</code> 94 The key name must have the format of a valid domain name, 95 consisting of letters, digits, hyphens and periods. 96 </p></dd> 97<dt><span class="term">-q</span></dt> 98<dd><p> 99 (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print 100 only the key, with no explanatory text or usage examples; 101 This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>. 102 </p></dd> 103<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt> 104<dd><p> 105 Specifies a source of random data for generating the 106 authorization. If the operating system does not provide a 107 <code class="filename">/dev/random</code> or equivalent device, the 108 default source of randomness is keyboard input. 109 <code class="filename">randomdev</code> specifies the name of a 110 character device or file containing random data to be used 111 instead of the default. The special value 112 <code class="filename">keyboard</code> indicates that keyboard input 113 should be used. 114 </p></dd> 115<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt> 116<dd><p> 117 (<span><strong class="command">ddns-confgen</strong></span> only.) 118 Generate configuration example to allow dynamic updates 119 of a single hostname. The example <span><strong class="command">named.conf</strong></span> 120 text shows how to set an update policy for the specified 121 <em class="replaceable"><code>name</code></em> 122 using the "name" nametype. The default key name is 123 ddns-key.<em class="replaceable"><code>name</code></em>. 124 Note that the "self" nametype cannot be used, since 125 the name to be updated may differ from the key name. 126 This option cannot be used with the <code class="option">-z</code> option. 127 </p></dd> 128<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt> 129<dd><p> 130 (<span><strong class="command">ddns-confgen</strong></span> only.) 131 Generate configuration example to allow dynamic updates 132 of a zone: The example <span><strong class="command">named.conf</strong></span> text 133 shows how to set an update policy for the specified 134 <em class="replaceable"><code>zone</code></em> 135 using the "zonesub" nametype, allowing updates to 136 all subdomain names within that 137 <em class="replaceable"><code>zone</code></em>. 138 This option cannot be used with the <code class="option">-s</code> option. 139 </p></dd> 140</dl></div> 141</div> 142<div class="refsect1" lang="en"> 143<a name="id2543705"></a><h2>SEE ALSO</h2> 144<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>, 145 <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>, 146 <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>, 147 <em class="citetitle">BIND 9 Administrator Reference Manual</em>. 148 </p> 149</div> 150<div class="refsect1" lang="en"> 151<a name="id2543744"></a><h2>AUTHOR</h2> 152<p><span class="corpauthor">Internet Systems Consortium</span> 153 </p> 154</div> 155</div></body> 156</html> 157