man.ddns-confgen.html revision ab3bdbd2ee61b06fa1dc4d3adbcff46cd808185a
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen - Copyright (C) 2004-2014 Internet Systems Consortium, Inc. ("ISC")
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen - Copyright (C) 2000-2003 Internet Software Consortium.
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen - Permission to use, copy, modify, and/or distribute this software for any
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen - purpose with or without fee is hereby granted, provided that the above
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen - copyright notice and this permission notice appear in all copies.
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen - PERFORMANCE OF THIS SOFTWARE.
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<link rel="start" href="Bv9ARM.html" title="BIND 9 Administrator Reference Manual">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<link rel="up" href="Bv9ARM.ch10.html" title="Manual pages">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<link rel="prev" href="man.rndc-confgen.html" title="rndc-confgen">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<link rel="next" href="man.arpaname.html" title="arpaname">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
839c67ba93b58e394daa435f7b99587eec97cefbTimo Sirainen<table width="100%" summary="Navigation header">
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<tr><th colspan="3" align="center"><span class="application">ddns-confgen</span></th></tr>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen<th width="60%" align="center">Manual pages</th>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<td width="20%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<a name="man.ddns-confgen"></a><div class="titlepage"></div>
a87ee34b90aa7bb236751803c292c4deb6cfb058Timo Sirainen<p><span class="application">ddns-confgen</span> — ddns key generation tool</p>
a87ee34b90aa7bb236751803c292c4deb6cfb058Timo Sirainen<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>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen<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>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen <span><strong class="command">tsig-keygen</strong></span> and <span><strong class="command">ddns-confgen</strong></span>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen are invocation methods for a utility that generates keys for use
4d3e576109a91270c04821f8d727cd1afec8c801Timo Sirainen in TSIG signing. The resulting keys can be used, for example,
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen to secure dynamic DNS updates to a zone or for the
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen <span><strong class="command">rndc</strong></span> command channel.
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen When run as <span><strong class="command">tsig-keygen</strong></span>, a domain name
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen can be specified on the command line which will be used as
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen the name of the generated key. If no name is specified,
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen the default is <code class="constant">tsig-key</code>.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen When run as <span><strong class="command">ddns-confgen</strong></span>, the generated
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen key is accompanied by configuration text and instructions
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen that can be used with <span><strong class="command">nsupdate</strong></span> and
06843a896589e98fb259e6d7558326655126a407Timo Sirainen <span><strong class="command">named</strong></span> when setting up dynamic DNS,
06843a896589e98fb259e6d7558326655126a407Timo Sirainen including an example <span><strong class="command">update-policy</strong></span>
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen statement. (This usage similar to the
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen <span><strong class="command">rndc-confgen</strong></span> command for setting
4a6f9ed8e5412508dcba1eabb58a3680ad5e9b68Timo Sirainen up command channel security.)
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen Note that <span><strong class="command">named</strong></span> itself can configure a
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen local DDNS key for use with <span><strong class="command">nsupdate -l</strong></span>:
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen it does this when a zone is configured with
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen <span><strong class="command">update-policy local;</strong></span>.
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen <span><strong class="command">ddns-confgen</strong></span> is only needed when a
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen more elaborate configuration is required: for instance,
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen if <span><strong class="command">nsupdate</strong></span> is to be used from a remote
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen<dt><span class="term">-a <em class="replaceable"><code>algorithm</code></em></span></dt>
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen Specifies the algorithm to use for the TSIG key. Available
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen hmac-sha384 and hmac-sha512. The default is hmac-sha256.
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen Options are case-insensitive, and the "hmac-" prefix
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen may be omitted.
6b35ba747072480bfc86ed7cc69df1d418e2ae20Timo Sirainen Prints a short summary of options and arguments.
d03a871a77f8ec36f48f5fea98d810e51b186fdbTimo Sirainen<dt><span class="term">-k <em class="replaceable"><code>keyname</code></em></span></dt>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen Specifies the key name of the DDNS authentication key.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen The default is <code class="constant">ddns-key</code> when neither
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen the <code class="option">-s</code> nor <code class="option">-z</code> option is
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen specified; otherwise, the default
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen is <code class="constant">ddns-key</code> as a separate label
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen followed by the argument of the option, e.g.,
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen <code class="constant">ddns-key.example.com.</code>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen The key name must have the format of a valid domain name,
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen consisting of letters, digits, hyphens and periods.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen (<span><strong class="command">ddns-confgen</strong></span> only.) Quiet mode: Print
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen only the key, with no explanatory text or usage examples;
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen This is essentially identical to <span><strong class="command">tsig-keygen</strong></span>.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen<dt><span class="term">-r <em class="replaceable"><code>randomfile</code></em></span></dt>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen Specifies a source of random data for generating the
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen authorization. If the operating system does not provide a
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen <code class="filename">/dev/random</code> or equivalent device, the
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen default source of randomness is keyboard input.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen <code class="filename">randomdev</code> specifies the name of a
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen character device or file containing random data to be used
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen instead of the default. The special value
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen <code class="filename">keyboard</code> indicates that keyboard input
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen should be used.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen<dt><span class="term">-s <em class="replaceable"><code>name</code></em></span></dt>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen (<span><strong class="command">ddns-confgen</strong></span> only.)
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen Generate configuration example to allow dynamic updates
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen of a single hostname. The example <span><strong class="command">named.conf</strong></span>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen text shows how to set an update policy for the specified
d03a871a77f8ec36f48f5fea98d810e51b186fdbTimo Sirainen <em class="replaceable"><code>name</code></em>
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen using the "name" nametype. The default key name is
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen ddns-key.<em class="replaceable"><code>name</code></em>.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen Note that the "self" nametype cannot be used, since
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen the name to be updated may differ from the key name.
146e7e3fabdd843d50680cdb6e4f7829890f5fcfTimo Sirainen This option cannot be used with the <code class="option">-z</code> option.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<dt><span class="term">-z <em class="replaceable"><code>zone</code></em></span></dt>
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen (<span><strong class="command">ddns-confgen</strong></span> only.)
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen Generate configuration example to allow dynamic updates
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen of a zone: The example <span><strong class="command">named.conf</strong></span> text
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen shows how to set an update policy for the specified
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen <em class="replaceable"><code>zone</code></em>
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen using the "zonesub" nametype, allowing updates to
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen all subdomain names within that
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen <em class="replaceable"><code>zone</code></em>.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen This option cannot be used with the <code class="option">-s</code> option.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<p><span class="citerefentry"><span class="refentrytitle">nsupdate</span>(1)</span>,
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen <span class="citerefentry"><span class="refentrytitle">named.conf</span>(5)</span>,
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen <span class="citerefentry"><span class="refentrytitle">named</span>(8)</span>,
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen <em class="citetitle">BIND 9 Administrator Reference Manual</em>.
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<p><span class="corpauthor">Internet Systems Consortium</span>
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<table width="100%" summary="Navigation footer">
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<a accesskey="p" href="man.rndc-confgen.html">Prev</a>�</td>
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<td width="20%" align="center"><a accesskey="u" href="Bv9ARM.ch10.html">Up</a></td>
047ebb958b682bc058097eddc34df574c3f3d6d4Timo Sirainen<td width="40%" align="right">�<a accesskey="n" href="man.arpaname.html">Next</a>
03b33ccb012636e453189ceef3865dee7812392eTimo Sirainen<span class="application">rndc-confgen</span>�</td>
03b33ccb012636e453189ceef3865dee7812392eTimo Sirainen<td width="20%" align="center"><a accesskey="h" href="Bv9ARM.html">Home</a></td>
03b33ccb012636e453189ceef3865dee7812392eTimo Sirainen<td width="40%" align="right" valign="top">�<span class="application">arpaname</span>
03b33ccb012636e453189ceef3865dee7812392eTimo Sirainen<p style="text-align: center;">BIND 9.11.0pre-alpha</p>