ddns-confgen.docbook revision 754cb8a2b33fa6cfaa15d6470f66e5fb0eab4764
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
1fdd2470b625a58b57d0b155e6caf8c4fc0afe8aAutomatic Updater "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
75c0816e8295e180f4bc7f10db3d0d880383bc1cMark Andrews [<!ENTITY mdash "—">]>
4a14ce5ba00ab7bc55c99ffdcf59c7a4ab902721Automatic Updater - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - 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
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater - PERFORMANCE OF THIS SOFTWARE.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein<!-- $Id: ddns-confgen.docbook,v 1.3 2009/06/11 23:47:55 tbox Exp $ -->
e21a2904f02a03fa06b6db04d348f65fe9c67b2bMark Andrews <refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refentryinfo>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refentrytitle><application>ddns-confgen</application></refentrytitle>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refname><application>ddns-confgen</application></refname>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <refpurpose>ddns key generation tool</refpurpose>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </refnamediv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </copyright>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <cmdsynopsis>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <arg><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </cmdsynopsis>
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater </refsynopsisdiv>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generates a key for use by <command>nsupdate</command>
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater and <command>named</command>. It simplifies configuration
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater of dynamic zones by generating a key and providing the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <command>nsupdate</command> and <command>named.conf</command>
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater syntax that will be needed to use it, including an example
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater <command>update-policy</command> statement.
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater If a domain name is specified on the command line, it will
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater be used in the name of the generated key and in the sample
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater <command>named.conf</command> syntax. For example,
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater <command>ddns-confgen example.com</command> would
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein generate a key called "ddns-key.example.com", and sample
8ec3c085233cedb22b05da36e2773c8f357a7e45Automatic Updater <command>named.conf</command> command that could be used
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein in the zone definition for "example.com".
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Note that <command>named</command> itself can configure a
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater local DDNS key for use with <command>nsupdate -l</command>.
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater <command>ddns-confgen</command> is only needed when a
a1ad6695ed6f988406cf155aa26376f84f73bcb9Automatic Updater more elaborate configuration is required: for instance, if
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater <command>nsupdate</command> is to be used from a remote system.
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater <variablelist>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-a <replaceable class="parameter">algorithm</replaceable></term>
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater Specifies the algorithm to use for the TSIG key. Available
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein hmac-sha384 and hmac-sha512. The default is hmac-sha256.
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater </varlistentry>
8de0d8a6905e397ed0a26054815420685f9b435eAutomatic Updater <varlistentry>
507151045be68c671ffd4e2f37e17cdfa0376fc4Automatic Updater Prints a short summary of the options and arguments to
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews <term>-k <replaceable class="parameter">keyname</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies the key name of the DDNS authentication key.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein The key name must have the format of a valid domain name,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein consisting of letters, digits, hyphens and periods.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Quiet mode: Print only the key, with no explanatory text or
71c66a876ecca77923638d3f94cc0783152b2f03Mark Andrews usage examples.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <term>-r <replaceable class="parameter">randomfile</replaceable></term>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Specifies a source of random data for generating the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein authorization. If the operating system does not provide a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>/dev/random</filename> or equivalent device, the
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein default source of randomness is keyboard input.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>randomdev</filename> specifies the name of a
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein character device or file containing random data to be used
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein instead of the default. The special value
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <filename>keyboard</filename> indicates that keyboard input
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein should be used.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein <varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein Self mode: The example <command>named.conf</command> text
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein shows how to set an update policy using the "self" nametype,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein using a single key per each domain name for updates, instead of
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein the "subdomain" nametype which allows matching on any name
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein within a specified domain.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </varlistentry>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein </variablelist>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews </citerefentry>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <citerefentry>
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
b05bdb520d83f7ecaad708fe305268c3420be01dMark Andrews </citerefentry>,
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
5a4557e8de2951a2796676b5ec4b6a90caa5be14Mark Andrews <para><corpauthor>Internet Systems Consortium</corpauthor>
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - Local variables:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein - mode: sgml