ddns-confgen.docbook revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen - Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen - This Source Code Form is subject to the terms of the Mozilla Public
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen - License, v. 2.0. If a copy of the MPL was not distributed with this
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen - file, You can obtain one at http://mozilla.org/MPL/2.0/.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen<!-- Converted by db4-upgrade version 1.0 -->
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="man.ddns-confgen">
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <refentryinfo>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen </refentryinfo>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <refentrytitle><application>ddns-confgen</application></refentrytitle>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <refname><application>ddns-confgen</application></refname>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <refpurpose>ddns key generation tool</refpurpose>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen </refnamediv>
740e369c027c3589f4074e7ea0a51204082853cbTimo Sirainen <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <refsynopsisdiv>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-h</option></arg>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
fc1584e525d413183d37e1052081f3685a06c7fcAki Tuomi </cmdsynopsis>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-a <replaceable class="parameter">algorithm</replaceable></option></arg>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-h</option></arg>
638734376d265a1529985755da671c09cfc22e06Timo Sirainen <arg choice="opt" rep="norepeat"><option>-k <replaceable class="parameter">keyname</replaceable></option></arg>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <arg choice="opt" rep="norepeat"><option>-q</option></arg>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <arg choice="opt" rep="norepeat"><option>-r <replaceable class="parameter">randomfile</replaceable></option></arg>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <arg choice="plain" rep="norepeat">-s <replaceable class="parameter">name</replaceable></arg>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <arg choice="plain" rep="norepeat">-z <replaceable class="parameter">zone</replaceable></arg>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen </cmdsynopsis>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen </refsynopsisdiv>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <refsection><info><title>DESCRIPTION</title></info>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <command>tsig-keygen</command> and <command>ddns-confgen</command>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen are invocation methods for a utility that generates keys for use
638734376d265a1529985755da671c09cfc22e06Timo Sirainen in TSIG signing. The resulting keys can be used, for example,
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen to secure dynamic DNS updates to a zone or for the
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen When run as <command>tsig-keygen</command>, a domain name
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen can be specified on the command line which will be used as
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen the name of the generated key. If no name is specified,
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen When run as <command>ddns-confgen</command>, the generated
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen key is accompanied by configuration text and instructions
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen that can be used with <command>nsupdate</command> and
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <command>named</command> when setting up dynamic DNS,
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen including an example <command>update-policy</command>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen statement. (This usage similar to the
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <command>rndc-confgen</command> command for setting
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen up command channel security.)
063254ba79239f1c0a78ea08d4aa22f8f11d984cTimo Sirainen Note that <command>named</command> itself can configure a
063254ba79239f1c0a78ea08d4aa22f8f11d984cTimo Sirainen local DDNS key for use with <command>nsupdate -l</command>:
063254ba79239f1c0a78ea08d4aa22f8f11d984cTimo Sirainen it does this when a zone is configured with
d4002fe1f64d25a792f76fb102ef7dc519cd4e24Martti Rannanjärvi <command>ddns-confgen</command> is only needed when a
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen more elaborate configuration is required: for instance,
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen if <command>nsupdate</command> is to be used from a remote
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen </refsection>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <refsection><info><title>OPTIONS</title></info>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <variablelist>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <term>-a <replaceable class="parameter">algorithm</replaceable></term>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Specifies the algorithm to use for the TSIG key. Available
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256,
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen hmac-sha384 and hmac-sha512. The default is hmac-sha256.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Options are case-insensitive, and the "hmac-" prefix
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen may be omitted.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Prints a short summary of options and arguments.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen </varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <varlistentry>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen <term>-k <replaceable class="parameter">keyname</replaceable></term>
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen Specifies the key name of the DDNS authentication key.
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen The default is <constant>ddns-key</constant> when neither
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen the <option>-s</option> nor <option>-z</option> option is
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen specified; otherwise, the default
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen is <constant>ddns-key</constant> as a separate label
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen followed by the argument of the option, e.g.,
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen The key name must have the format of a valid domain name,
b8eb60a9ba83e2f3f6d969e810553eb937be2128Timo Sirainen consisting of letters, digits, hyphens and periods.
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen </varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen (<command>ddns-confgen</command> only.) Quiet mode: Print
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen only the key, with no explanatory text or usage examples;
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen This is essentially identical to <command>tsig-keygen</command>.
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen </varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <term>-r <replaceable class="parameter">randomfile</replaceable></term>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen Specifies a source of random data for generating the
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen authorization. If the operating system does not provide a
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <filename>/dev/random</filename> or equivalent device, the
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen default source of randomness is keyboard input.
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <filename>randomdev</filename> specifies the name of a
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen character device or file containing random data to be used
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen instead of the default. The special value
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <filename>keyboard</filename> indicates that keyboard input
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen should be used.
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen </varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <varlistentry>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <term>-s <replaceable class="parameter">name</replaceable></term>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen Generate configuration example to allow dynamic updates
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen of a single hostname. The example <command>named.conf</command>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen text shows how to set an update policy for the specified
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <replaceable class="parameter">name</replaceable>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen using the "name" nametype. The default key name is
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen ddns-key.<replaceable class="parameter">name</replaceable>.
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen Note that the "self" nametype cannot be used, since
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen the name to be updated may differ from the key name.
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen This option cannot be used with the <option>-z</option> option.
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen </varlistentry>
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen <varlistentry>
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen <term>-z <replaceable class="parameter">zone</replaceable></term>
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen Generate configuration example to allow dynamic updates
b43d7e2b753d69fa6eafcf647d75e6af1dcc0fc8Timo Sirainen of a zone: The example <command>named.conf</command> text
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen shows how to set an update policy for the specified
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <replaceable class="parameter">zone</replaceable>
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen using the "zonesub" nametype, allowing updates to
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen all subdomain names within that
1a878b9d2a823abc6b1c8b1631e50a15d534665fTimo Sirainen <replaceable class="parameter">zone</replaceable>.
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen This option cannot be used with the <option>-s</option> option.
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen </varlistentry>
7dd326f772ed4193e1bfdafdb46fea616970e1acJosef 'Jeff' Sipek </variablelist>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <refsection><info><title>SEE ALSO</title></info>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <refentrytitle>nsupdate</refentrytitle><manvolnum>1</manvolnum>
fe080d248e2bd374e9d86c8a34ec6f14e88b8a14Timo Sirainen </citerefentry>,
fe080d248e2bd374e9d86c8a34ec6f14e88b8a14Timo Sirainen <citerefentry>
fe080d248e2bd374e9d86c8a34ec6f14e88b8a14Timo Sirainen <refentrytitle>named.conf</refentrytitle><manvolnum>5</manvolnum>
1b0b44348d1f94f1f0e418d80323646e1e335c2bTimo Sirainen </citerefentry>,
1b0b44348d1f94f1f0e418d80323646e1e335c2bTimo Sirainen <citerefentry>
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen <refentrytitle>named</refentrytitle><manvolnum>8</manvolnum>
1b0b44348d1f94f1f0e418d80323646e1e335c2bTimo Sirainen </citerefentry>,
7204b8112e005ff81dcf628f7880ef1feed1effeTimo Sirainen <citetitle>BIND 9 Administrator Reference Manual</citetitle>.
e15b305e90c9834734ccf35ed78f0ad29d570ee9Timo Sirainen </refsection>