external/bsd/bind/dist/doc/arm/man.ddns-confgen.html

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