contrib/bind-9.2.4rc7/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.8 2004/06/03 05:21:15 marka Exp $ -->
  19
  20 <HTML
  21 ><HEAD
  22 ><TITLE
  23 >rndc-confgen</TITLE
  24 ><META
  25 NAME="GENERATOR"
  26 CONTENT="Modular DocBook HTML Stylesheet Version 1.73
  27 "></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 ><SPAN
  39 CLASS="APPLICATION"
  40 >rndc-confgen</SPAN
  41 ></A
  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 >  [<TT
  66 CLASS="OPTION"
  67 >-a</TT
  68 >] [<TT
  69 CLASS="OPTION"
  70 >-b <TT
  71 CLASS="REPLACEABLE"
  72 ><I
  73 >keysize</I
  74 ></TT
  75 ></TT
  76 >] [<TT
  77 CLASS="OPTION"
  78 >-c <TT
  79 CLASS="REPLACEABLE"
  80 ><I
  81 >keyfile</I
  82 ></TT
  83 ></TT
  84 >] [<TT
  85 CLASS="OPTION"
  86 >-h</TT
  87 >] [<TT
  88 CLASS="OPTION"
  89 >-k <TT
  90 CLASS="REPLACEABLE"
  91 ><I
  92 >keyname</I
  93 ></TT
  94 ></TT
  95 >] [<TT
  96 CLASS="OPTION"
  97 >-p <TT
  98 CLASS="REPLACEABLE"
  99 ><I
 100 >port</I
 101 ></TT
 102 ></TT
 103 >] [<TT
 104 CLASS="OPTION"
 105 >-r <TT
 106 CLASS="REPLACEABLE"
 107 ><I
 108 >randomfile</I
 109 ></TT
 110 ></TT
 111 >] [<TT
 112 CLASS="OPTION"
 113 >-s <TT
 114 CLASS="REPLACEABLE"
 115 ><I
 116 >address</I
 117 ></TT
 118 ></TT
 119 >] [<TT
 120 CLASS="OPTION"
 121 >-t <TT
 122 CLASS="REPLACEABLE"
 123 ><I
 124 >chrootdir</I
 125 ></TT
 126 ></TT
 127 >] [<TT
 128 CLASS="OPTION"
 129 >-u <TT
 130 CLASS="REPLACEABLE"
 131 ><I
 132 >user</I
 133 ></TT
 134 ></TT
 135 >]</P
 136 ></DIV
 137 ><DIV
 138 CLASS="REFSECT1"
 139 ><A
 140 NAME="AEN44"
 141 ></A
 142 ><H2
 143 >DESCRIPTION</H2
 144 ><P
 145 >        <B
 146 CLASS="COMMAND"
 147 >rndc-confgen</B
 148 > generates configuration files
 149         for <B
 150 CLASS="COMMAND"
 151 >rndc</B
 152 >.  It can be used as a
 153         convenient alternative to writing the
 154         <TT
 155 CLASS="FILENAME"
 156 >rndc.conf</TT
 157 > file
 158         and the corresponding <B
 159 CLASS="COMMAND"
 160 >controls</B
 161 >
 162         and <B
 163 CLASS="COMMAND"
 164 >key</B
 165 >
 166         statements in <TT
 167 CLASS="FILENAME"
 168 >named.conf</TT
 169 > by hand.
 170         Alternatively, it can be run with the <B
 171 CLASS="COMMAND"
 172 >-a</B
 173 >
 174         option to set up a <TT
 175 CLASS="FILENAME"
 176 >rndc.key</TT
 177 > file and
 178         avoid the need for a <TT
 179 CLASS="FILENAME"
 180 >rndc.conf</TT
 181 > file
 182         and a <B
 183 CLASS="COMMAND"
 184 >controls</B
 185 > statement altogether.
 186     </P
 187 ></DIV
 188 ><DIV
 189 CLASS="REFSECT1"
 190 ><A
 191 NAME="AEN57"
 192 ></A
 193 ><H2
 194 >OPTIONS</H2
 195 ><P
 196 ></P
 197 ><DIV
 198 CLASS="VARIABLELIST"
 199 ><DL
 200 ><DT
 201 >-a</DT
 202 ><DD
 203 ><P
 204 >             Do automatic <B
 205 CLASS="COMMAND"
 206 >rndc</B
 207 > configuration.
 208               This creates a file <TT
 209 CLASS="FILENAME"
 210 >rndc.key</TT
 211 >
 212               in <TT
 213 CLASS="FILENAME"
 214 >/etc</TT
 215 > (or whatever
 216               <TT
 217 CLASS="VARNAME"
 218 >sysconfdir</TT
 219 >
 220               was specified as when <SPAN
 221 CLASS="ACRONYM"
 222 >BIND</SPAN
 223 > was built)
 224               that is read by both <B
 225 CLASS="COMMAND"
 226 >rndc</B
 227 >
 228               and <B
 229 CLASS="COMMAND"
 230 >named</B
 231 > on startup.  The
 232               <TT
 233 CLASS="FILENAME"
 234 >rndc.key</TT
 235 > file defines a default
 236               command channel and authentication key allowing
 237               <B
 238 CLASS="COMMAND"
 239 >rndc</B
 240 > to communicate with
 241               <B
 242 CLASS="COMMAND"
 243 >named</B
 244 > with no further configuration.
 245           </P
 246 ><P
 247 >             Running <B
 248 CLASS="COMMAND"
 249 >rndc-confgen -a</B
 250 > allows
 251               BIND 9 and <B
 252 CLASS="COMMAND"
 253 >rndc</B
 254 > to be used as drop-in
 255               replacements for BIND 8 and <B
 256 CLASS="COMMAND"
 257 >ndc</B
 258 >,
 259               with no changes to the existing BIND 8
 260               <TT
 261 CLASS="FILENAME"
 262 >named.conf</TT
 263 > file.
 264           </P
 265 ></DD
 266 ><DT
 267 >-b <TT
 268 CLASS="REPLACEABLE"
 269 ><I
 270 >keysize</I
 271 ></TT
 272 ></DT
 273 ><DD
 274 ><P
 275 >              Specifies the size of the authentication key in bits.
 276                Must be between 1 and 512 bits; the default is 128.
 277           </P
 278 ></DD
 279 ><DT
 280 >-c <TT
 281 CLASS="REPLACEABLE"
 282 ><I
 283 >keyfile</I
 284 ></TT
 285 ></DT
 286 ><DD
 287 ><P
 288 >              Used with the <B
 289 CLASS="COMMAND"
 290 >-a</B
 291 > option to specify
 292                an alternate location for <TT
 293 CLASS="FILENAME"
 294 >rndc.key</TT
 295 >.
 296           </P
 297 ></DD
 298 ><DT
 299 >-h</DT
 300 ><DD
 301 ><P
 302 >              Prints a short summary of the options and arguments to
 303                <B
 304 CLASS="COMMAND"
 305 >rndc-confgen</B
 306 >.
 307           </P
 308 ></DD
 309 ><DT
 310 >-k <TT
 311 CLASS="REPLACEABLE"
 312 ><I
 313 >keyname</I
 314 ></TT
 315 ></DT
 316 ><DD
 317 ><P
 318 >              Specifies the key name of the rndc authentication key.
 319                This must be a valid domain name.
 320                The default is <TT
 321 CLASS="CONSTANT"
 322 >rndc-key</TT
 323 >.
 324           </P
 325 ></DD
 326 ><DT
 327 >-p <TT
 328 CLASS="REPLACEABLE"
 329 ><I
 330 >port</I
 331 ></TT
 332 ></DT
 333 ><DD
 334 ><P
 335 >              Specifies the command channel port where <B
 336 CLASS="COMMAND"
 337 >named</B
 338 >
 339                listens for connections from <B
 340 CLASS="COMMAND"
 341 >rndc</B
 342 >.
 343                The default is 953.
 344           </P
 345 ></DD
 346 ><DT
 347 >-r <TT
 348 CLASS="REPLACEABLE"
 349 ><I
 350 >randomfile</I
 351 ></TT
 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 <TT
 377 CLASS="REPLACEABLE"
 378 ><I
 379 >address</I
 380 ></TT
 381 ></DT
 382 ><DD
 383 ><P
 384 >              Specifies the IP address where <B
 385 CLASS="COMMAND"
 386 >named</B
 387 >
 388                listens for command channel connections from
 389                <B
 390 CLASS="COMMAND"
 391 >rndc</B
 392 >.  The default is the loopback
 393                address 127.0.0.1.
 394           </P
 395 ></DD
 396 ><DT
 397 >-t <TT
 398 CLASS="REPLACEABLE"
 399 ><I
 400 >chrootdir</I
 401 ></TT
 402 ></DT
 403 ><DD
 404 ><P
 405 >              Used with the <B
 406 CLASS="COMMAND"
 407 >-a</B
 408 > option to specify
 409                a directory where <B
 410 CLASS="COMMAND"
 411 >named</B
 412 > will run
 413                chrooted.  An additional copy of the <TT
 414 CLASS="FILENAME"
 415 >rndc.key</TT
 416 >
 417                will be written relative to this directory so that
 418                it will be found by the chrooted <B
 419 CLASS="COMMAND"
 420 >named</B
 421 >.
 422           </P
 423 ></DD
 424 ><DT
 425 >-u <TT
 426 CLASS="REPLACEABLE"
 427 ><I
 428 >user</I
 429 ></TT
 430 ></DT
 431 ><DD
 432 ><P
 433 >              Used with the <B
 434 CLASS="COMMAND"
 435 >-a</B
 436 > option to set the owner
 437                of the <TT
 438 CLASS="FILENAME"
 439 >rndc.key</TT
 440 > file generated.  If
 441                <B
 442 CLASS="COMMAND"
 443 >-t</B
 444 > is also specified only the file in
 445                the chroot area has its owner changed.
 446           </P
 447 ></DD
 448 ></DL
 449 ></DIV
 450 ></DIV
 451 ><DIV
 452 CLASS="REFSECT1"
 453 ><A
 454 NAME="AEN141"
 455 ></A
 456 ><H2
 457 >EXAMPLES</H2
 458 ><P
 459 >        To allow <B
 460 CLASS="COMMAND"
 461 >rndc</B
 462 > to be used with
 463         no manual configuration, run
 464     </P
 465 ><P
 466 >        <TT
 467 CLASS="USERINPUT"
 468 ><B
 469 >rndc-confgen -a</B
 470 ></TT
 471 >
 472     </P
 473 ><P
 474 >        To print a sample <TT
 475 CLASS="FILENAME"
 476 >rndc.conf</TT
 477 > file and
 478         corresponding <B
 479 CLASS="COMMAND"
 480 >controls</B
 481 > and <B
 482 CLASS="COMMAND"
 483 >key</B
 484 >
 485         statements to be manually inserted into <TT
 486 CLASS="FILENAME"
 487 >named.conf</TT
 488 >,
 489         run
 490     </P
 491 ><P
 492 >        <TT
 493 CLASS="USERINPUT"
 494 ><B
 495 >rndc-confgen</B
 496 ></TT
 497 >
 498     </P
 499 ></DIV
 500 ><DIV
 501 CLASS="REFSECT1"
 502 ><A
 503 NAME="AEN154"
 504 ></A
 505 ><H2
 506 >SEE ALSO</H2
 507 ><P
 508 >      <SPAN
 509 CLASS="CITEREFENTRY"
 510 ><SPAN
 511 CLASS="REFENTRYTITLE"
 512 >rndc</SPAN
 513 >(8)</SPAN
 514 >,
 515       <SPAN
 516 CLASS="CITEREFENTRY"
 517 ><SPAN
 518 CLASS="REFENTRYTITLE"
 519 >rndc.conf</SPAN
 520 >(5)</SPAN
 521 >,
 522       <SPAN
 523 CLASS="CITEREFENTRY"
 524 ><SPAN
 525 CLASS="REFENTRYTITLE"
 526 >named</SPAN
 527 >(8)</SPAN
 528 >,
 529       <I
 530 CLASS="CITETITLE"
 531 >BIND 9 Administrator Reference Manual</I
 532 >.
 533     </P
 534 ></DIV
 535 ><DIV
 536 CLASS="REFSECT1"
 537 ><A
 538 NAME="AEN167"
 539 ></A
 540 ><H2
 541 >AUTHOR</H2
 542 ><P
 543 >        Internet Systems Consortium
 544     </P
 545 ></DIV
 546 ></BODY
 547 ></HTML
 548 >