external/bsd/bind/dist/bin/rndc/rndc.conf.5

   1 .\"     $NetBSD: rndc.conf.5,v 1.6 2014/12/10 04:37:52 christos Exp $
   2 .\"
   3 .\" Copyright (C) 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
   4 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
   5 .\"
   6 .\" Permission to use, copy, modify, and/or distribute this software for any
   7 .\" purpose with or without fee is hereby granted, provided that the above
   8 .\" copyright notice and this permission notice appear in all copies.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  11 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  12 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  13 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  14 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  15 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  16 .\" PERFORMANCE OF THIS SOFTWARE.
  17 .\"
  18 .\" Id
  19 .\"
  20 .hy 0
  21 .ad l
  22 .\"     Title: \fIrndc.conf\fR
  23 .\"    Author:
  24 .\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
  25 .\"      Date: March 14, 2013
  26 .\"    Manual: BIND9
  27 .\"    Source: BIND9
  28 .\"
  29 .TH "\fIRNDC.CONF\fR" "5" "March 14, 2013" "BIND9" "BIND9"
  30 .\" disable hyphenation
  31 .nh
  32 .\" disable justification (adjust text to left margin only)
  33 .ad l
  34 .SH "NAME"
  35 rndc.conf \- rndc configuration file
  36 .SH "SYNOPSIS"
  37 .HP 10
  38 \fBrndc.conf\fR
  39 .SH "DESCRIPTION"
  40 .PP
  41 \fIrndc.conf\fR
  42 is the configuration file for
  43 \fBrndc\fR, the BIND 9 name server control utility. This file has a similar structure and syntax to
  44 \fInamed.conf\fR. Statements are enclosed in braces and terminated with a semi\-colon. Clauses in the statements are also semi\-colon terminated. The usual comment styles are supported:
  45 .PP
  46 C style: /* */
  47 .PP
  48 C++ style: // to end of line
  49 .PP
  50 Unix style: # to end of line
  51 .PP
  52 \fIrndc.conf\fR
  53 is much simpler than
  54 \fInamed.conf\fR. The file uses three statements: an options statement, a server statement and a key statement.
  55 .PP
  56 The
  57 \fBoptions\fR
  58 statement contains five clauses. The
  59 \fBdefault\-server\fR
  60 clause is followed by the name or address of a name server. This host will be used when no name server is given as an argument to
  61 \fBrndc\fR. The
  62 \fBdefault\-key\fR
  63 clause is followed by the name of a key which is identified by a
  64 \fBkey\fR
  65 statement. If no
  66 \fBkeyid\fR
  67 is provided on the rndc command line, and no
  68 \fBkey\fR
  69 clause is found in a matching
  70 \fBserver\fR
  71 statement, this default key will be used to authenticate the server's commands and responses. The
  72 \fBdefault\-port\fR
  73 clause is followed by the port to connect to on the remote name server. If no
  74 \fBport\fR
  75 option is provided on the rndc command line, and no
  76 \fBport\fR
  77 clause is found in a matching
  78 \fBserver\fR
  79 statement, this default port will be used to connect. The
  80 \fBdefault\-source\-address\fR
  81 and
  82 \fBdefault\-source\-address\-v6\fR
  83 clauses which can be used to set the IPv4 and IPv6 source addresses respectively.
  84 .PP
  85 After the
  86 \fBserver\fR
  87 keyword, the server statement includes a string which is the hostname or address for a name server. The statement has three possible clauses:
  88 \fBkey\fR,
  89 \fBport\fR
  90 and
  91 \fBaddresses\fR. The key name must match the name of a key statement in the file. The port number specifies the port to connect to. If an
  92 \fBaddresses\fR
  93 clause is supplied these addresses will be used instead of the server name. Each address can take an optional port. If an
  94 \fBsource\-address\fR
  95 or
  96 \fBsource\-address\-v6\fR
  97 of supplied then these will be used to specify the IPv4 and IPv6 source addresses respectively.
  98 .PP
  99 The
 100 \fBkey\fR
 101 statement begins with an identifying string, the name of the key. The statement has two clauses.
 102 \fBalgorithm\fR
 103 identifies the authentication algorithm for
 104 \fBrndc\fR
 105 to use; currently only HMAC\-MD5 (for compatibility), HMAC\-SHA1, HMAC\-SHA224, HMAC\-SHA256 (default), HMAC\-SHA384 and HMAC\-SHA512 are supported. This is followed by a secret clause which contains the base\-64 encoding of the algorithm's authentication key. The base\-64 string is enclosed in double quotes.
 106 .PP
 107 There are two common ways to generate the base\-64 string for the secret. The BIND 9 program
 108 \fBrndc\-confgen\fR
 109 can be used to generate a random key, or the
 110 \fBmmencode\fR
 111 program, also known as
 112 \fBmimencode\fR, can be used to generate a base\-64 string from known input.
 113 \fBmmencode\fR
 114 does not ship with BIND 9 but is available on many systems. See the EXAMPLE section for sample command lines for each.
 115 .SH "EXAMPLE"
 116 .PP
 117 .RS 4
 118 .nf
 119       options {
 120         default\-server  localhost;
 121         default\-key     samplekey;
 122       };
 123 .fi
 124 .RE
 125 .sp
 126 .PP
 127 .RS 4
 128 .nf
 129       server localhost {
 130         key             samplekey;
 131       };
 132 .fi
 133 .RE
 134 .sp
 135 .PP
 136 .RS 4
 137 .nf
 138       server testserver {
 139         key             testkey;
 140         addresses       { localhost port 5353; };
 141       };
 142 .fi
 143 .RE
 144 .sp
 145 .PP
 146 .RS 4
 147 .nf
 148       key samplekey {
 149         algorithm       hmac\-sha256;
 150         secret          "6FMfj43Osz4lyb24OIe2iGEz9lf1llJO+lz";
 151       };
 152 .fi
 153 .RE
 154 .sp
 155 .PP
 156 .RS 4
 157 .nf
 158       key testkey {
 159         algorithm       hmac\-sha256;
 160         secret          "R3HI8P6BKw9ZwXwN3VZKuQ==";
 161       };
 162 .fi
 163 .RE
 164 .sp
 165 .PP
 166 In the above example,
 167 \fBrndc\fR
 168 will by default use the server at localhost (127.0.0.1) and the key called samplekey. Commands to the localhost server will use the samplekey key, which must also be defined in the server's configuration file with the same name and secret. The key statement indicates that samplekey uses the HMAC\-SHA256 algorithm and its secret clause contains the base\-64 encoding of the HMAC\-SHA256 secret enclosed in double quotes.
 169 .PP
 170 If
 171 \fBrndc \-s testserver\fR
 172 is used then
 173 \fBrndc\fR
 174 will connect to server on localhost port 5353 using the key testkey.
 175 .PP
 176 To generate a random secret with
 177 \fBrndc\-confgen\fR:
 178 .PP
 179 \fBrndc\-confgen\fR
 180 .PP
 181 A complete
 182 \fIrndc.conf\fR
 183 file, including the randomly generated key, will be written to the standard output. Commented\-out
 184 \fBkey\fR
 185 and
 186 \fBcontrols\fR
 187 statements for
 188 \fInamed.conf\fR
 189 are also printed.
 190 .PP
 191 To generate a base\-64 secret with
 192 \fBmmencode\fR:
 193 .PP
 194 \fBecho "known plaintext for a secret" | mmencode\fR
 195 .SH "NAME SERVER CONFIGURATION"
 196 .PP
 197 The name server must be configured to accept rndc connections and to recognize the key specified in the
 198 \fIrndc.conf\fR
 199 file, using the controls statement in
 200 \fInamed.conf\fR. See the sections on the
 201 \fBcontrols\fR
 202 statement in the BIND 9 Administrator Reference Manual for details.
 203 .SH "SEE ALSO"
 204 .PP
 205 \fBrndc\fR(8),
 206 \fBrndc\-confgen\fR(8),
 207 \fBmmencode\fR(1),
 208 BIND 9 Administrator Reference Manual.
 209 .SH "AUTHOR"
 210 .PP
 211 Internet Systems Consortium
 212 .SH "COPYRIGHT"
 213 Copyright \(co 2004, 2005, 2007, 2013, 2014 Internet Systems Consortium, Inc. ("ISC")
 214 .br
 215 Copyright \(co 2000, 2001 Internet Software Consortium.
 216 .br