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