ddns-confgen.docbook revision 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User - Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - Permission to use, copy, modify, and/or distribute this software for any
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - purpose with or without fee is hereby granted, provided that the above
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - copyright notice and this permission notice appear in all copies.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt - PERFORMANCE OF THIS SOFTWARE.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!-- Converted by db4-upgrade version 1.0 -->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.ddns-confgen">
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refentryinfo>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle><application>ddns-confgen</application></refentrytitle>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refnamediv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refname><application>ddns-confgen</application></refname>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refnamediv>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </copyright>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-h</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt </cmdsynopsis>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-h</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-q</option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="plain" rep="norepeat">-s <replaceable class="parameter">name</replaceable></arg>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <arg choice="plain" rep="norepeat">-z <replaceable class="parameter">zone</replaceable></arg>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </cmdsynopsis>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </refsynopsisdiv>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refsection><info><title>DESCRIPTION</title></info>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt <command>tsig-keygen</command> and <command>ddns-confgen</command>
d51e441520ac756af17e4b5589e31e8eac60d1e2Evan Hunt are invocation methods for a utility that generates keys for use
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt in TSIG signing. The resulting keys can be used, for example,
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt to secure dynamic DNS updates to a zone or for the
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt When run as <command>tsig-keygen</command>, a domain name
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt can be specified on the command line which will be used as
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt the name of the generated key. If no name is specified,
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt When run as <command>ddns-confgen</command>, the generated
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt key is accompanied by configuration text and instructions
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt that can be used with <command>nsupdate</command> and
e9a9bb6b14df7dd5f86ea869e51a03387b64e0e2Evan Hunt <command>named</command> when setting up dynamic DNS,
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt including an example <command>update-policy</command>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt statement. (This usage similar to the
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt <command>rndc-confgen</command> command for setting
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt up command channel security.)
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Note that <command>named</command> itself can configure a
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt local DDNS key for use with <command>nsupdate -l</command>:
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt it does this when a zone is configured with
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <command>ddns-confgen</command> is only needed when a
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt more elaborate configuration is required: for instance,
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt if <command>nsupdate</command> is to be used from a remote
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <variablelist>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-a <replaceable class="parameter">algorithm</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies the algorithm to use for the TSIG key. Available
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt hmac-sha384 and hmac-sha512. The default is hmac-sha256.
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt Options are case-insensitive, and the "hmac-" prefix
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt may be omitted.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt Prints a short summary of options and arguments.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-k <replaceable class="parameter">keyname</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies the key name of the DDNS authentication key.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 The default is <constant>ddns-key</constant> when neither
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 the <option>-s</option> nor <option>-z</option> option is
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 specified; otherwise, the default
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 is <constant>ddns-key</constant> as a separate label
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 followed by the argument of the option, e.g.,
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <constant>ddns-key.example.com.</constant>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt The key name must have the format of a valid domain name,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt consisting of letters, digits, hyphens and periods.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt (<command>ddns-confgen</command> only.) Quiet mode: Print
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt only the key, with no explanatory text or usage examples;
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt This is essentially identical to <command>tsig-keygen</command>.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <term>-r <replaceable class="parameter">randomfile</replaceable></term>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt Specifies a source of random data for generating the
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt authorization. If the operating system does not provide a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>/dev/random</filename> or equivalent device, the
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt default source of randomness is keyboard input.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>randomdev</filename> specifies the name of a
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt character device or file containing random data to be used
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt instead of the default. The special value
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <filename>keyboard</filename> indicates that keyboard input
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt should be used.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <term>-s <replaceable class="parameter">name</replaceable></term>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt Generate configuration example to allow dynamic updates
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt of a single hostname. The example <command>named.conf</command>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt text shows how to set an update policy for the specified
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt using the "name" nametype. The default key name is
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 ddns-key.<replaceable class="parameter">name</replaceable>.
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 Note that the "self" nametype cannot be used, since
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 the name to be updated may differ from the key name.
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 This option cannot be used with the <option>-z</option> option.
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 </varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <varlistentry>
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <term>-z <replaceable class="parameter">zone</replaceable></term>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt Generate configuration example to allow dynamic updates
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt of a zone: The example <command>named.conf</command> text
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 shows how to set an update policy for the specified
45d4d69a8d662b6a00e3723c5488af40174a63cbTatuya JINMEI 神明達哉 <replaceable class="parameter">zone</replaceable>
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt using the "zonesub" nametype, allowing updates to
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt all subdomain names within that
46bc64f4b1a0e84ab0397943453fe83a17baf2c4Evan Hunt <replaceable class="parameter">zone</replaceable>.
6493425eaa8d09485bcbf78e4f854b1a35ef71edTatuya JINMEI 神明達哉 This option cannot be used with the <option>-s</option> option.
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </varlistentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </variablelist>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citerefentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citerefentry>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt </citerefentry>,
351b62535d4c4f89883bfdba025999dd32490266Evan Hunt <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refsection>