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