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