contrib/bind9/bin/rndc/rndc-confgen.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2001-2003  Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and 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
  18 <!-- $Id: rndc-confgen.html,v 1.3.2.5.2.4 2004/08/22 23:39:00 marka Exp $ -->
  19
  20 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  21 <HTML
  22 ><HEAD
  23 ><TITLE
  24 >rndc-confgen</TITLE
  25 ><META
  26 NAME="GENERATOR"
  27 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 BGCOLOR="#FFFFFF"
  31 TEXT="#000000"
  32 LINK="#0000FF"
  33 VLINK="#840084"
  34 ALINK="#0000FF"
  35 ><H1
  36 ><A
  37 NAME="AEN1"
  38 ></A
  39 ><SPAN
  40 CLASS="APPLICATION"
  41 >rndc-confgen</SPAN
  42 ></H1
  43 ><DIV
  44 CLASS="REFNAMEDIV"
  45 ><A
  46 NAME="AEN9"
  47 ></A
  48 ><H2
  49 >Name</H2
  50 ><SPAN
  51 CLASS="APPLICATION"
  52 >rndc-confgen</SPAN
  53 >&nbsp;--&nbsp;rndc key generation tool</DIV
  54 ><DIV
  55 CLASS="REFSYNOPSISDIV"
  56 ><A
  57 NAME="AEN13"
  58 ></A
  59 ><H2
  60 >Synopsis</H2
  61 ><P
  62 ><B
  63 CLASS="COMMAND"
  64 >rndc-confgen</B
  65 >  [<VAR
  66 CLASS="OPTION"
  67 >-a</VAR
  68 >] [<VAR
  69 CLASS="OPTION"
  70 >-b <VAR
  71 CLASS="REPLACEABLE"
  72 >keysize</VAR
  73 ></VAR
  74 >] [<VAR
  75 CLASS="OPTION"
  76 >-c <VAR
  77 CLASS="REPLACEABLE"
  78 >keyfile</VAR
  79 ></VAR
  80 >] [<VAR
  81 CLASS="OPTION"
  82 >-h</VAR
  83 >] [<VAR
  84 CLASS="OPTION"
  85 >-k <VAR
  86 CLASS="REPLACEABLE"
  87 >keyname</VAR
  88 ></VAR
  89 >] [<VAR
  90 CLASS="OPTION"
  91 >-p <VAR
  92 CLASS="REPLACEABLE"
  93 >port</VAR
  94 ></VAR
  95 >] [<VAR
  96 CLASS="OPTION"
  97 >-r <VAR
  98 CLASS="REPLACEABLE"
  99 >randomfile</VAR
 100 ></VAR
 101 >] [<VAR
 102 CLASS="OPTION"
 103 >-s <VAR
 104 CLASS="REPLACEABLE"
 105 >address</VAR
 106 ></VAR
 107 >] [<VAR
 108 CLASS="OPTION"
 109 >-t <VAR
 110 CLASS="REPLACEABLE"
 111 >chrootdir</VAR
 112 ></VAR
 113 >] [<VAR
 114 CLASS="OPTION"
 115 >-u <VAR
 116 CLASS="REPLACEABLE"
 117 >user</VAR
 118 ></VAR
 119 >]</P
 120 ></DIV
 121 ><DIV
 122 CLASS="REFSECT1"
 123 ><A
 124 NAME="AEN44"
 125 ></A
 126 ><H2
 127 >DESCRIPTION</H2
 128 ><P
 129 >        <B
 130 CLASS="COMMAND"
 131 >rndc-confgen</B
 132 > generates configuration files
 133         for <B
 134 CLASS="COMMAND"
 135 >rndc</B
 136 >.  It can be used as a
 137         convenient alternative to writing the
 138         <TT
 139 CLASS="FILENAME"
 140 >rndc.conf</TT
 141 > file
 142         and the corresponding <B
 143 CLASS="COMMAND"
 144 >controls</B
 145 >
 146         and <B
 147 CLASS="COMMAND"
 148 >key</B
 149 >
 150         statements in <TT
 151 CLASS="FILENAME"
 152 >named.conf</TT
 153 > by hand.
 154         Alternatively, it can be run with the <B
 155 CLASS="COMMAND"
 156 >-a</B
 157 >
 158         option to set up a <TT
 159 CLASS="FILENAME"
 160 >rndc.key</TT
 161 > file and
 162         avoid the need for a <TT
 163 CLASS="FILENAME"
 164 >rndc.conf</TT
 165 > file
 166         and a <B
 167 CLASS="COMMAND"
 168 >controls</B
 169 > statement altogether.
 170     </P
 171 ></DIV
 172 ><DIV
 173 CLASS="REFSECT1"
 174 ><A
 175 NAME="AEN57"
 176 ></A
 177 ><H2
 178 >OPTIONS</H2
 179 ><P
 180 ></P
 181 ><DIV
 182 CLASS="VARIABLELIST"
 183 ><DL
 184 ><DT
 185 >-a</DT
 186 ><DD
 187 ><P
 188 >             Do automatic <B
 189 CLASS="COMMAND"
 190 >rndc</B
 191 > configuration.
 192               This creates a file <TT
 193 CLASS="FILENAME"
 194 >rndc.key</TT
 195 >
 196               in <TT
 197 CLASS="FILENAME"
 198 >/etc</TT
 199 > (or whatever
 200               <VAR
 201 CLASS="VARNAME"
 202 >sysconfdir</VAR
 203 >
 204               was specified as when <ACRONYM
 205 CLASS="ACRONYM"
 206 >BIND</ACRONYM
 207 > was built)
 208               that is read by both <B
 209 CLASS="COMMAND"
 210 >rndc</B
 211 >
 212               and <B
 213 CLASS="COMMAND"
 214 >named</B
 215 > on startup.  The
 216               <TT
 217 CLASS="FILENAME"
 218 >rndc.key</TT
 219 > file defines a default
 220               command channel and authentication key allowing
 221               <B
 222 CLASS="COMMAND"
 223 >rndc</B
 224 > to communicate with
 225               <B
 226 CLASS="COMMAND"
 227 >named</B
 228 > on the local host
 229               with no further configuration.
 230           </P
 231 ><P
 232 >             Running <B
 233 CLASS="COMMAND"
 234 >rndc-confgen -a</B
 235 > allows
 236               BIND 9 and <B
 237 CLASS="COMMAND"
 238 >rndc</B
 239 > to be used as drop-in
 240               replacements for BIND 8 and <B
 241 CLASS="COMMAND"
 242 >ndc</B
 243 >,
 244               with no changes to the existing BIND 8
 245               <TT
 246 CLASS="FILENAME"
 247 >named.conf</TT
 248 > file.
 249           </P
 250 ><P
 251 >             If a more elaborate configuration than that
 252               generated by <B
 253 CLASS="COMMAND"
 254 >rndc-confgen -a</B
 255 >
 256               is required, for example if rndc is to be used remotely,
 257               you should run <B
 258 CLASS="COMMAND"
 259 >rndc-confgen</B
 260 > without the
 261               <B
 262 CLASS="COMMAND"
 263 >-a</B
 264 > option and set up a
 265               <TT
 266 CLASS="FILENAME"
 267 >rndc.conf</TT
 268 > and
 269               <TT
 270 CLASS="FILENAME"
 271 >named.conf</TT
 272 >
 273               as directed.
 274           </P
 275 ></DD
 276 ><DT
 277 >-b <VAR
 278 CLASS="REPLACEABLE"
 279 >keysize</VAR
 280 ></DT
 281 ><DD
 282 ><P
 283 >              Specifies the size of the authentication key in bits.
 284                Must be between 1 and 512 bits; the default is 128.
 285           </P
 286 ></DD
 287 ><DT
 288 >-c <VAR
 289 CLASS="REPLACEABLE"
 290 >keyfile</VAR
 291 ></DT
 292 ><DD
 293 ><P
 294 >              Used with the <B
 295 CLASS="COMMAND"
 296 >-a</B
 297 > option to specify
 298                an alternate location for <TT
 299 CLASS="FILENAME"
 300 >rndc.key</TT
 301 >.
 302           </P
 303 ></DD
 304 ><DT
 305 >-h</DT
 306 ><DD
 307 ><P
 308 >              Prints a short summary of the options and arguments to
 309                <B
 310 CLASS="COMMAND"
 311 >rndc-confgen</B
 312 >.
 313           </P
 314 ></DD
 315 ><DT
 316 >-k <VAR
 317 CLASS="REPLACEABLE"
 318 >keyname</VAR
 319 ></DT
 320 ><DD
 321 ><P
 322 >              Specifies the key name of the rndc authentication key.
 323                This must be a valid domain name.
 324                The default is <CODE
 325 CLASS="CONSTANT"
 326 >rndc-key</CODE
 327 >.
 328           </P
 329 ></DD
 330 ><DT
 331 >-p <VAR
 332 CLASS="REPLACEABLE"
 333 >port</VAR
 334 ></DT
 335 ><DD
 336 ><P
 337 >              Specifies the command channel port where <B
 338 CLASS="COMMAND"
 339 >named</B
 340 >
 341                listens for connections from <B
 342 CLASS="COMMAND"
 343 >rndc</B
 344 >.
 345                The default is 953.
 346           </P
 347 ></DD
 348 ><DT
 349 >-r <VAR
 350 CLASS="REPLACEABLE"
 351 >randomfile</VAR
 352 ></DT
 353 ><DD
 354 ><P
 355 >              Specifies a source of random data for generating the
 356                authorization.  If the operating
 357                system does not provide a <TT
 358 CLASS="FILENAME"
 359 >/dev/random</TT
 360 >
 361                or equivalent device, the default source of randomness
 362                is keyboard input.  <TT
 363 CLASS="FILENAME"
 364 >randomdev</TT
 365 > specifies
 366                the name of a character device or file containing random
 367                data to be used instead of the default.  The special value
 368                <TT
 369 CLASS="FILENAME"
 370 >keyboard</TT
 371 > indicates that keyboard
 372                input should be used.
 373           </P
 374 ></DD
 375 ><DT
 376 >-s <VAR
 377 CLASS="REPLACEABLE"
 378 >address</VAR
 379 ></DT
 380 ><DD
 381 ><P
 382 >              Specifies the IP address where <B
 383 CLASS="COMMAND"
 384 >named</B
 385 >
 386                listens for command channel connections from
 387                <B
 388 CLASS="COMMAND"
 389 >rndc</B
 390 >.  The default is the loopback
 391                address 127.0.0.1.
 392           </P
 393 ></DD
 394 ><DT
 395 >-t <VAR
 396 CLASS="REPLACEABLE"
 397 >chrootdir</VAR
 398 ></DT
 399 ><DD
 400 ><P
 401 >              Used with the <B
 402 CLASS="COMMAND"
 403 >-a</B
 404 > option to specify
 405                a directory where <B
 406 CLASS="COMMAND"
 407 >named</B
 408 > will run
 409                chrooted.  An additional copy of the <TT
 410 CLASS="FILENAME"
 411 >rndc.key</TT
 412 >
 413                will be written relative to this directory so that
 414                it will be found by the chrooted <B
 415 CLASS="COMMAND"
 416 >named</B
 417 >.
 418           </P
 419 ></DD
 420 ><DT
 421 >-u <VAR
 422 CLASS="REPLACEABLE"
 423 >user</VAR
 424 ></DT
 425 ><DD
 426 ><P
 427 >              Used with the <B
 428 CLASS="COMMAND"
 429 >-a</B
 430 > option to set the owner
 431                of the <TT
 432 CLASS="FILENAME"
 433 >rndc.key</TT
 434 > file generated.  If
 435                <B
 436 CLASS="COMMAND"
 437 >-t</B
 438 > is also specified only the file in
 439                the chroot area has its owner changed.
 440           </P
 441 ></DD
 442 ></DL
 443 ></DIV
 444 ></DIV
 445 ><DIV
 446 CLASS="REFSECT1"
 447 ><A
 448 NAME="AEN147"
 449 ></A
 450 ><H2
 451 >EXAMPLES</H2
 452 ><P
 453 >        To allow <B
 454 CLASS="COMMAND"
 455 >rndc</B
 456 > to be used with
 457         no manual configuration, run
 458     </P
 459 ><P
 460 >        <KBD
 461 CLASS="USERINPUT"
 462 >rndc-confgen -a</KBD
 463 >
 464     </P
 465 ><P
 466 >        To print a sample <TT
 467 CLASS="FILENAME"
 468 >rndc.conf</TT
 469 > file and
 470         corresponding <B
 471 CLASS="COMMAND"
 472 >controls</B
 473 > and <B
 474 CLASS="COMMAND"
 475 >key</B
 476 >
 477         statements to be manually inserted into <TT
 478 CLASS="FILENAME"
 479 >named.conf</TT
 480 >,
 481         run
 482     </P
 483 ><P
 484 >        <KBD
 485 CLASS="USERINPUT"
 486 >rndc-confgen</KBD
 487 >
 488     </P
 489 ></DIV
 490 ><DIV
 491 CLASS="REFSECT1"
 492 ><A
 493 NAME="AEN160"
 494 ></A
 495 ><H2
 496 >SEE ALSO</H2
 497 ><P
 498 >      <SPAN
 499 CLASS="CITEREFENTRY"
 500 ><SPAN
 501 CLASS="REFENTRYTITLE"
 502 >rndc</SPAN
 503 >(8)</SPAN
 504 >,
 505       <SPAN
 506 CLASS="CITEREFENTRY"
 507 ><SPAN
 508 CLASS="REFENTRYTITLE"
 509 >rndc.conf</SPAN
 510 >(5)</SPAN
 511 >,
 512       <SPAN
 513 CLASS="CITEREFENTRY"
 514 ><SPAN
 515 CLASS="REFENTRYTITLE"
 516 >named</SPAN
 517 >(8)</SPAN
 518 >,
 519       <I
 520 CLASS="CITETITLE"
 521 >BIND 9 Administrator Reference Manual</I
 522 >.
 523     </P
 524 ></DIV
 525 ><DIV
 526 CLASS="REFSECT1"
 527 ><A
 528 NAME="AEN173"
 529 ></A
 530 ><H2
 531 >AUTHOR</H2
 532 ><P
 533 >        Internet Systems Consortium
 534     </P
 535 ></DIV
 536 ></BODY
 537 ></HTML
 538 >