external/bsd/bind/dist/bin/confgen/ddns-confgen.8

   1 .\"     $NetBSD: ddns-confgen.8,v 1.5 2014/12/10 04:37:51 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\"
   5 .\" Permission to use, copy, modify, and/or distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15 .\" PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" Id
  18 .\"
  19 .hy 0
  20 .ad l
  21 .\"     Title: ddns\-confgen
  22 .\"    Author:
  23 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  24 .\"      Date: March 6, 2014
  25 .\"    Manual: BIND9
  26 .\"    Source: BIND9
  27 .\"
  28 .TH "DDNS\-CONFGEN" "8" "March 6, 2014" "BIND9" "BIND9"
  29 .\" disable hyphenation
  30 .nh
  31 .\" disable justification (adjust text to left margin only)
  32 .ad l
  33 .SH "NAME"
  34 ddns\-confgen \- ddns key generation tool
  35 .SH "SYNOPSIS"
  36 .HP 12
  37 \fBtsig\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [name]
  38 .HP 13
  39 \fBddns\-confgen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-k\ \fR\fB\fIkeyname\fR\fR] [\fB\-q\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [\-s\ \fIname\fR | \-z\ \fIzone\fR]
  40 .SH "DESCRIPTION"
  41 .PP
  42 \fBtsig\-keygen\fR
  43 and
  44 \fBddns\-confgen\fR
  45 are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys can be used, for example, to secure dynamic DNS updates to a zone or for the
  46 \fBrndc\fR
  47 command channel.
  48 .PP
  49 When run as
  50 \fBtsig\-keygen\fR, a domain name can be specified on the command line which will be used as the name of the generated key. If no name is specified, the default is
  51 \fBtsig\-key\fR.
  52 .PP
  53 When run as
  54 \fBddns\-confgen\fR, the generated key is accompanied by configuration text and instructions that can be used with
  55 \fBnsupdate\fR
  56 and
  57 \fBnamed\fR
  58 when setting up dynamic DNS, including an example
  59 \fBupdate\-policy\fR
  60 statement. (This usage similar to the
  61 \fBrndc\-confgen\fR
  62 command for setting up command channel security.)
  63 .PP
  64 Note that
  65 \fBnamed\fR
  66 itself can configure a local DDNS key for use with
  67 \fBnsupdate \-l\fR: it does this when a zone is configured with
  68 \fBupdate\-policy local;\fR.
  69 \fBddns\-confgen\fR
  70 is only needed when a more elaborate configuration is required: for instance, if
  71 \fBnsupdate\fR
  72 is to be used from a remote system.
  73 .SH "OPTIONS"
  74 .PP
  75 \-a \fIalgorithm\fR
  76 .RS 4
  77 Specifies the algorithm to use for the TSIG key. Available choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384 and hmac\-sha512. The default is hmac\-sha256. Options are case\-insensitive, and the "hmac\-" prefix may be omitted.
  78 .RE
  79 .PP
  80 \-h
  81 .RS 4
  82 Prints a short summary of options and arguments.
  83 .RE
  84 .PP
  85 \-k \fIkeyname\fR
  86 .RS 4
  87 Specifies the key name of the DDNS authentication key. The default is
  88 \fBddns\-key\fR
  89 when neither the
  90 \fB\-s\fR
  91 nor
  92 \fB\-z\fR
  93 option is specified; otherwise, the default is
  94 \fBddns\-key\fR
  95 as a separate label followed by the argument of the option, e.g.,
  96 \fBddns\-key.example.com.\fR
  97 The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods.
  98 .RE
  99 .PP
 100 \-q
 101 .RS 4
 102 (\fBddns\-confgen\fR
 103 only.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to
 104 \fBtsig\-keygen\fR.
 105 .RE
 106 .PP
 107 \-r \fIrandomfile\fR
 108 .RS 4
 109 Specifies a source of random data for generating the authorization. If the operating system does not provide a
 110 \fI/dev/random\fR
 111 or equivalent device, the default source of randomness is keyboard input.
 112 \fIrandomdev\fR
 113 specifies the name of a character device or file containing random data to be used instead of the default. The special value
 114 \fIkeyboard\fR
 115 indicates that keyboard input should be used.
 116 .RE
 117 .PP
 118 \-s \fIname\fR
 119 .RS 4
 120 (\fBddns\-confgen\fR
 121 only.) Generate configuration example to allow dynamic updates of a single hostname. The example
 122 \fBnamed.conf\fR
 123 text shows how to set an update policy for the specified
 124 \fIname\fR
 125 using the "name" nametype. The default key name is ddns\-key.\fIname\fR. Note that the "self" nametype cannot be used, since the name to be updated may differ from the key name. This option cannot be used with the
 126 \fB\-z\fR
 127 option.
 128 .RE
 129 .PP
 130 \-z \fIzone\fR
 131 .RS 4
 132 (\fBddns\-confgen\fR
 133 only.) Generate configuration example to allow dynamic updates of a zone: The example
 134 \fBnamed.conf\fR
 135 text shows how to set an update policy for the specified
 136 \fIzone\fR
 137 using the "zonesub" nametype, allowing updates to all subdomain names within that
 138 \fIzone\fR. This option cannot be used with the
 139 \fB\-s\fR
 140 option.
 141 .RE
 142 .SH "SEE ALSO"
 143 .PP
 144 \fBnsupdate\fR(1),
 145 \fBnamed.conf\fR(5),
 146 \fBnamed\fR(8),
 147 BIND 9 Administrator Reference Manual.
 148 .SH "AUTHOR"
 149 .PP
 150 Internet Systems Consortium
 151 .SH "COPYRIGHT"
 152 Copyright \(co 2009, 2014 Internet Systems Consortium, Inc. ("ISC")
 153 .br