ddns-confgen.8 5.46 KB
Newer Older
Tinderbox User's avatar
Tinderbox User committed
1
.\" Copyright (C) 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
Automatic Updater's avatar
regen  
Automatic Updater committed
2
.\" 
Tinderbox User's avatar
Tinderbox User committed
3 4 5
.\" This Source Code Form is subject to the terms of the Mozilla Public
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
.\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
6 7 8
.\"
.hy 0
.ad l
Tinderbox User's avatar
Tinderbox User committed
9 10
'\" t
.\"     Title: ddns-confgen
Automatic Updater's avatar
regen  
Automatic Updater committed
11
.\"    Author: 
Tinderbox User's avatar
Tinderbox User committed
12
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
Tinderbox User's avatar
Tinderbox User committed
13
.\"      Date: 2014-03-06
Automatic Updater's avatar
regen  
Automatic Updater committed
14
.\"    Manual: BIND9
Tinderbox User's avatar
Tinderbox User committed
15 16
.\"    Source: ISC
.\"  Language: English
Automatic Updater's avatar
regen  
Automatic Updater committed
17
.\"
Tinderbox User's avatar
Tinderbox User committed
18 19 20 21 22 23 24 25 26 27 28 29 30
.TH "DDNS\-CONFGEN" "8" "2014\-03\-06" "ISC" "BIND9"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Automatic Updater's avatar
regen  
Automatic Updater committed
31 32 33 34
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
Tinderbox User's avatar
Tinderbox User committed
35 36 37
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
Automatic Updater's avatar
regen  
Automatic Updater committed
38
.SH "NAME"
Tinderbox User's avatar
Tinderbox User committed
39
ddns-confgen \- ddns key generation tool
40
.SH "SYNOPSIS"
Tinderbox User's avatar
Tinderbox User committed
41
.HP \w'\fBtsig\-keygen\fR\ 'u
Tinderbox User's avatar
Tinderbox User committed
42
\fBtsig\-keygen\fR [\fB\-a\ \fR\fB\fIalgorithm\fR\fR] [\fB\-h\fR] [\fB\-r\ \fR\fB\fIrandomfile\fR\fR] [name]
Tinderbox User's avatar
Tinderbox User committed
43
.HP \w'\fBddns\-confgen\fR\ 'u
Tinderbox User's avatar
Tinderbox User committed
44
\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]
45 46
.SH "DESCRIPTION"
.PP
Tinderbox User's avatar
Tinderbox User committed
47
\fBtsig\-keygen\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
48
and
Tinderbox User's avatar
Tinderbox User committed
49
\fBddns\-confgen\fR
Tinderbox User's avatar
Tinderbox User committed
50
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
Tinderbox User's avatar
Tinderbox User committed
51
\fBrndc\fR
Tinderbox User's avatar
Tinderbox User committed
52
command channel\&.
Tinderbox User's avatar
Tinderbox User committed
53 54
.PP
When run as
Tinderbox User's avatar
Tinderbox User committed
55 56
\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
\fBtsig\-key\fR\&.
Tinderbox User's avatar
Tinderbox User committed
57 58 59
.PP
When run as
\fBddns\-confgen\fR, the generated key is accompanied by configuration text and instructions that can be used with
Automatic Updater's avatar
regen  
Automatic Updater committed
60 61
\fBnsupdate\fR
and
Tinderbox User's avatar
Tinderbox User committed
62 63
\fBnamed\fR
when setting up dynamic DNS, including an example
Automatic Updater's avatar
regen  
Automatic Updater committed
64
\fBupdate\-policy\fR
Tinderbox User's avatar
Tinderbox User committed
65
statement\&. (This usage similar to the
Tinderbox User's avatar
Tinderbox User committed
66
\fBrndc\-confgen\fR
Tinderbox User's avatar
Tinderbox User committed
67
command for setting up command channel security\&.)
68
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
69 70 71
Note that
\fBnamed\fR
itself can configure a local DDNS key for use with
Tinderbox User's avatar
Tinderbox User committed
72
\fBnsupdate \-l\fR: it does this when a zone is configured with
Tinderbox User's avatar
Tinderbox User committed
73
\fBupdate\-policy local;\fR\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
74 75 76
\fBddns\-confgen\fR
is only needed when a more elaborate configuration is required: for instance, if
\fBnsupdate\fR
Tinderbox User's avatar
Tinderbox User committed
77
is to be used from a remote system\&.
78
.SH "OPTIONS"
Automatic Updater's avatar
regen  
Automatic Updater committed
79
.PP
80
\-a \fIalgorithm\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
81
.RS 4
Tinderbox User's avatar
Tinderbox User committed
82
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\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
83 84
.RE
.PP
85
\-h
Automatic Updater's avatar
regen  
Automatic Updater committed
86
.RS 4
Tinderbox User's avatar
Tinderbox User committed
87
Prints a short summary of options and arguments\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
88 89
.RE
.PP
90
\-k \fIkeyname\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
91
.RS 4
Tinderbox User's avatar
Tinderbox User committed
92
Specifies the key name of the DDNS authentication key\&. The default is
Automatic Updater's avatar
regen  
Automatic Updater committed
93 94 95 96 97 98 99
\fBddns\-key\fR
when neither the
\fB\-s\fR
nor
\fB\-z\fR
option is specified; otherwise, the default is
\fBddns\-key\fR
Tinderbox User's avatar
Tinderbox User committed
100 101 102
as a separate label followed by the argument of the option, e\&.g\&.,
\fBddns\-key\&.example\&.com\&.\fR
The key name must have the format of a valid domain name, consisting of letters, digits, hyphens and periods\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
103 104
.RE
.PP
105
\-q
Automatic Updater's avatar
regen  
Automatic Updater committed
106
.RS 4
Tinderbox User's avatar
Tinderbox User committed
107
(\fBddns\-confgen\fR
Tinderbox User's avatar
Tinderbox User committed
108 109
only\&.) Quiet mode: Print only the key, with no explanatory text or usage examples; This is essentially identical to
\fBtsig\-keygen\fR\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
110 111
.RE
.PP
112
\-r \fIrandomfile\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
113
.RS 4
Tinderbox User's avatar
Tinderbox User committed
114 115 116 117 118 119 120
Specifies a source of random data for generating the authorization\&. If the operating system does not provide a
/dev/random
or equivalent device, the default source of randomness is keyboard input\&.
randomdev
specifies the name of a character device or file containing random data to be used instead of the default\&. The special value
keyboard
indicates that keyboard input should be used\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
121 122
.RE
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
123
\-s \fIname\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
124
.RS 4
Tinderbox User's avatar
Tinderbox User committed
125
(\fBddns\-confgen\fR
Tinderbox User's avatar
Tinderbox User committed
126 127
only\&.) Generate configuration example to allow dynamic updates of a single hostname\&. The example
\fBnamed\&.conf\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
128 129
text shows how to set an update policy for the specified
\fIname\fR
Tinderbox User's avatar
Tinderbox User committed
130
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
Automatic Updater's avatar
regen  
Automatic Updater committed
131
\fB\-z\fR
Tinderbox User's avatar
Tinderbox User committed
132
option\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
133 134 135 136
.RE
.PP
\-z \fIzone\fR
.RS 4
Tinderbox User's avatar
Tinderbox User committed
137
(\fBddns\-confgen\fR
Tinderbox User's avatar
Tinderbox User committed
138 139
only\&.) Generate configuration example to allow dynamic updates of a zone: The example
\fBnamed\&.conf\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
140 141 142
text shows how to set an update policy for the specified
\fIzone\fR
using the "zonesub" nametype, allowing updates to all subdomain names within that
Tinderbox User's avatar
Tinderbox User committed
143
\fIzone\fR\&. This option cannot be used with the
Automatic Updater's avatar
regen  
Automatic Updater committed
144
\fB\-s\fR
Tinderbox User's avatar
Tinderbox User committed
145
option\&.
Automatic Updater's avatar
regen  
Automatic Updater committed
146
.RE
147 148
.SH "SEE ALSO"
.PP
Automatic Updater's avatar
regen  
Automatic Updater committed
149 150 151
\fBnsupdate\fR(1),
\fBnamed.conf\fR(5),
\fBnamed\fR(8),
Tinderbox User's avatar
Tinderbox User committed
152
BIND 9 Administrator Reference Manual\&.
153 154
.SH "AUTHOR"
.PP
Tinderbox User's avatar
Tinderbox User committed
155
\fBInternet Systems Consortium, Inc\&.\fR
Automatic Updater's avatar
regen  
Automatic Updater committed
156
.SH "COPYRIGHT"
Tinderbox User's avatar
Tinderbox User committed
157
.br
Tinderbox User's avatar
Tinderbox User committed
158
Copyright \(co 2009, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
Automatic Updater's avatar
regen  
Automatic Updater committed
159
.br