man.ddns-confgen.html revision 0ce865f8b2e652d6fe0c029e3538f4cc7e009fe1
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce - Copyright (C) 2000-2016 Internet Systems Consortium, Inc. ("ISC")
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce - This Source Code Form is subject to the terms of the Mozilla Public
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce - License, v. 2.0. If a copy of the MPL was not distributed with this
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce - file, You can obtain one at http://mozilla.org/MPL/2.0/.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<link rel="home" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<link rel="up" href="Bv9ARM.ch13.html" title="Manual pages">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<link rel="next" href="man.arpaname.html" title="arpaname">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
7171a7584dda534dde5409f3e7f4657e845ece15Fabiano Fidêncio<a name="man.ddns-confgen"></a><div class="titlepage"></div>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce — ddns key generation tool
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek [<code class="option">-a <em class="replaceable"><code>algorithm</code></em></code>]
efc65e78fa4e01e6cecc8690a9899af61213be62Fabiano Fidêncio [<code class="option">-k <em class="replaceable"><code>keyname</code></em></code>]
efc65e78fa4e01e6cecc8690a9899af61213be62Fabiano Fidêncio [<code class="option">-r <em class="replaceable"><code>randomfile</code></em></code>]
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek -s <em class="replaceable"><code>name</code></em>
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek | -z <em class="replaceable"><code>zone</code></em>
65a38b8c9cabde6c46cc0e9868f54cb9bb10afbfFabiano Fidêncio <span class="command"><strong>tsig-keygen</strong></span> and <span class="command"><strong>ddns-confgen</strong></span>
65a38b8c9cabde6c46cc0e9868f54cb9bb10afbfFabiano Fidêncio are invocation methods for a utility that generates keys for use
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek in TSIG signing. The resulting keys can be used, for example,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek to secure dynamic DNS updates to a zone or for the
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <span class="command"><strong>rndc</strong></span> command channel.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek When run as <span class="command"><strong>tsig-keygen</strong></span>, a domain name
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek can be specified on the command line which will be used as
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek the name of the generated key. If no name is specified,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek the default is <code class="constant">tsig-key</code>.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek When run as <span class="command"><strong>ddns-confgen</strong></span>, the generated
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek key is accompanied by configuration text and instructions
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek that can be used with <span class="command"><strong>nsupdate</strong></span> and
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <span class="command"><strong>named</strong></span> when setting up dynamic DNS,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek including an example <span class="command"><strong>update-policy</strong></span>
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek statement. (This usage similar to the
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <span class="command"><strong>rndc-confgen</strong></span> command for setting
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek up command channel security.)
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek Note that <span class="command"><strong>named</strong></span> itself can configure a
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek local DDNS key for use with <span class="command"><strong>nsupdate -l</strong></span>:
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek it does this when a zone is configured with
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <span class="command"><strong>update-policy local;</strong></span>.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <span class="command"><strong>ddns-confgen</strong></span> is only needed when a
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek more elaborate configuration is required: for instance,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek if <span class="command"><strong>nsupdate</strong></span> is to be used from a remote
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <div class="variablelist"><dl class="variablelist">
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
65a38b8c9cabde6c46cc0e9868f54cb9bb10afbfFabiano Fidêncio Specifies the algorithm to use for the TSIG key. Available
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek hmac-sha384 and hmac-sha512. The default is hmac-sha256.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek Options are case-insensitive, and the "hmac-" prefix
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek may be omitted.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek Prints a short summary of options and arguments.
7171a7584dda534dde5409f3e7f4657e845ece15Fabiano Fidêncio<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek Specifies the key name of the DDNS authentication key.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek The default is <code class="constant">ddns-key</code> when neither
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek the <code class="option">-s</code> nor <code class="option">-z</code> option is
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek specified; otherwise, the default
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek is <code class="constant">ddns-key</code> as a separate label
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek followed by the argument of the option, e.g.,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <code class="constant">ddns-key.example.com.</code>
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek The key name must have the format of a valid domain name,
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek consisting of letters, digits, hyphens and periods.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek (<span class="command"><strong>ddns-confgen</strong></span> only.) Quiet mode: Print
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek only the key, with no explanatory text or usage examples;
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek This is essentially identical to <span class="command"><strong>tsig-keygen</strong></span>.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
7171a7584dda534dde5409f3e7f4657e845ece15Fabiano Fidêncio Specifies a source of random data for generating the
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek authorization. If the operating system does not provide a
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <code class="filename">/dev/random</code> or equivalent device, the
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek default source of randomness is keyboard input.
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <code class="filename">randomdev</code> specifies the name of a
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek character device or file containing random data to be used
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek instead of the default. The special value
4db56d8c90a6467a216590e5ba3bdcd2a2bf1ae9Jakub Hrozek <code class="filename">keyboard</code> indicates that keyboard input
7171a7584dda534dde5409f3e7f4657e845ece15Fabiano Fidêncio should be used.
7171a7584dda534dde5409f3e7f4657e845ece15Fabiano Fidêncio<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce (<span class="command"><strong>ddns-confgen</strong></span> only.)
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce Generate configuration example to allow dynamic updates
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce of a single hostname. The example <span class="command"><strong>named.conf</strong></span>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce text shows how to set an update policy for the specified
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce using the "name" nametype. The default key name is
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce ddns-key.<em class="replaceable"><code>name</code></em>.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce Note that the "self" nametype cannot be used, since
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce the name to be updated may differ from the key name.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce This option cannot be used with the <code class="option">-z</code> option.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce (<span class="command"><strong>ddns-confgen</strong></span> only.)
4358d76475f0292461a2a479d2149472db103c1dFabiano Fidêncio Generate configuration example to allow dynamic updates
4358d76475f0292461a2a479d2149472db103c1dFabiano Fidêncio of a zone: The example <span class="command"><strong>named.conf</strong></span> text
4358d76475f0292461a2a479d2149472db103c1dFabiano Fidêncio shows how to set an update policy for the specified
4358d76475f0292461a2a479d2149472db103c1dFabiano Fidêncio <em class="replaceable"><code>zone</code></em>
4358d76475f0292461a2a479d2149472db103c1dFabiano Fidêncio using the "zonesub" nametype, allowing updates to
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce all subdomain names within that
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce This option cannot be used with the <code class="option">-s</code> option.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch13.html">Up</a></td>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
b1829f05cf9bdc3d89c1058481281198ebc968d0Fabiano Fidêncio<span class="application">rndc-confgen</span>�</td>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
a8d1a344e580f29699aed9b88d87fc3c6f5d113bSimo Sorce<p xmlns:db="http://docbook.org/ns/docbook" style="text-align: center;">BIND 9.11.1rc1</p>