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