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