userguide.xml 35.8 KB
Newer Older
1
2
3
4
5
6
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY mdash  "&#x2014;" >
]>
<book>
7
8
  <?xml-stylesheet href="userguide.css" type="text/css"?>

9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
  <bookinfo>
    <title>BIND 10 User Guide</title>
    <subtitle>Administrator Reference for BIND 10</subtitle>

    <copyright>
      <year>2010</year><holder>Internet Systems Consortium, Inc.</holder>
    </copyright>

<!--    <abstract><para>This is the definitive reference and user's guide for BIND 10</para></abstract> -->

  </bookinfo>

  <chapter id="intro">
    <title>Introduction</title>
    <para>
      BIND is the popular implementation of a DNS server, developer
      interfaces, and DNS tools.
26
27
      BIND 10 is a rewrite of BIND 9.  BIND 10 is written in C++ and Python
      and provides a modular environment for serving and maintaining DNS.
28
29
    </para>

30
31
32
33
34
35
    <note>
      <para>
        This guide covers the experimental prototype version of
        BIND 10.
      </para>
    </note>
36

37
38
39
40
41
42
43
    <note>
      <para>
        BIND 10, at this time, does not provide an recursive
        DNS server. It does provide a EDNS0- and DNSSEC-capable
        authoritative DNS server.
      </para>
    </note>
44

45
    <section>
46
47
      <title>Supported Platforms</title>
      <para>
48
49
50
  BIND 10 builds have been tested on Debian GNU/Linux 5,
  Ubuntu 9.10, NetBSD 5, Solaris 10, FreeBSD 7, and CentOS
  Linux 5.3.
51

52
53
  It has been tested on Sparc, i386, and amd64 hardware
  platforms.
54
55
56
57
58
59
60
61
62
63

        It is planned for BIND 10 to build, install and run on
        Windows and standard Unix-type platforms.
      </para>
    </section>

    <section>
      <title>Required Software</title>
      <para>
        BIND 10 requires Python 3.1.  Later versions may work, but Python
64
        3.1 is the minimum version which will work.
65
66
67
68
69
70
71
      </para>

      <note><para>
        For the Y1 prototype release, the only supported data source
        backend is SQLite3. The authoritative server requires
        SQLite 3.3.9 or newer,
        and the <command>b10-xfrin</command> module requires the
72
        Python _sqlite3.so module.
73
74
75
76
77
78
      </para></note>
<!-- TODO: this will change ... -->

<!-- TODO: list where to get these from -->

      <note>
79
80
81
82
83
84
85
        <para>
          Some operating systems do not provide these dependencies
          in their default installation nor standard packages
          collections.
          You may need to install them separately.
        </para>
      </note>
86
    </section>
87

88
89
    <section id="starting_stopping">
      <title>Starting and Stopping the Server</title>
90

91
92
93
94
95
96
97
98
99
100
101
102
103
104
      <para>
        BIND 10 is modular.  Part of this modularity is
        accomplished using multiple cooperating processes which, together,
        provide DNS functionality.  This is a change from the previous generation
        of BIND software, which used a single process.
      </para>

      <para>
        At first, running many different processes may seem confusing.  However,
        these processes are started, stopped, and maintained by a single command,
        <command>bind10</command>.  Additionally, most processes started by
        the <command>bind10</command> command have names starting with "b10-",
        with one exception, <command>msgq</command>.
      </para>
105
106
107
108
109
110
111
112
113
114
      
      <para>
        Starting and stopping the server is performed by a single command,
        <command>bind10</command>.  This command starts a master process
        which will start other processes as needed.
      </para>
      
      <para>
        Most of these are run automatically by a single command,
        <command>bind10</command> and should not be run manually.
115

116
117
118
119
        <itemizedlist>
          <listitem>
            <simpara>
              <command>msgq</command> &mdash;
120
121
122
              message bus daemon.
              This process coordinates communication between all of the other
              BIND 10 processes.
123
124
125
126
127
            </simpara>
          </listitem>
          <listitem>
            <simpara>
              <command>b10-auth</command> &mdash;
128
129
              authoritative DNS server.
              This process serves DNS requests.
130
131
132
133
134
            </simpara>
          </listitem>
          <listitem>
            <simpara>
              <command>b10-cfgmgr</command> &mdash;
135
136
              configuration manager.
              This process maintains all of the configuration for BIND 10.
137
138
139
140
141
            </simpara>
          </listitem>
          <listitem>
            <simpara>
              <command>b10-cmdctl</command> &mdash;
142
143
              command and control service.
              This process allows external control of the BIND 10 system.
144
145
            </simpara>
          </listitem>
146

147
148
149
          <listitem>
            <simpara>
              <command>b10-xfrin</command> &mdash;
150
151
152
              Incoming zone transfer service.
              This process is started as needed to transfer a new copy
              of a zone into BIND 10, when acting as a secondary server.
153
154
            </simpara>
          </listitem>
155

156
157
158
        </itemizedlist>
      </para>
    </section>
159

160
161
162
163
164
165
166
167
168
169
    <section id="managing_once_running">
      <title>Managing BIND 10</title>
      
      <para>
        Once BIND 10 is running, two commands are used to interact directly with
        the system:
        <itemizedlist>
          <listitem>
            <simpara>
              <command>bindctl</command> &mdash;
170
171
172
              interactive administration interface.
              This is a command-line tool which allows an administrator
              to control BIND 10.
173
174
175
176
177
            </simpara>
          </listitem>
          <listitem>
            <simpara>
              <command>b10-loadzone</command> &mdash;
178
179
180
              zone file loader.
              This tool will load standard masterfile-format zone files into
              BIND 10.
181
182
            </simpara>
          </listitem>
183
184
185
186
187
          <listitem>
            <simpara>
              <command>b10-cmdctl-usermgr</command> &mdash;
              user access control.
              This tool allows an administrator to authorize additional users
188
              to manage BIND 10.
189
190
            </simpara>
          </listitem>
191
192
193
194
  <!-- TODO usermgr -->
        </itemizedlist>
      </para>
    </section>
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

    <para>
      The tools and modules are covered in full detail in this users guide.
<!-- TODO point to these -->
      In addition, manual pages are also provided in the default installation.
    </para>
      
<!--
bin/
  bindctl*
  host*
lib/
  libauth
  libdns
  libexceptions
  python3.1/site-packages/isc/{cc,config}
sbin/
  bind10
share/
214
  share/bind10/
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
    auth.spec
    b10-cmdctl.pem
    bob.spec
    passwd.csv
  man/
var/
  bind10/b10-config.db
-->

    <para>
      BIND 10 also provides libraries and programmer interfaces
      for C++ and Python for the message bus, configuration backend,
      and, of course, DNS. These include detailed developer
      documentation and code examples.
<!-- TODO point to this -->
    </para>

  </chapter>

234
235
  <chapter id="installation">
    <title>Installation</title>
236

237
238
    <section>
      <title>Building Requirements</title>
239
        <note>
240
          <simpara>
241
242
243
            Some operating systems have split their distribution packages into
            a run-time and a development package.  You will need to install
            the development package versions, which include header files and
Michael Graff's avatar
Michael Graff committed
244
            libraries, to build BIND 10 from source code.
245
          </simpara>
246
247
        </note>

248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
        <para>
          Building from source code requires the Boost
          build-time headers. At least Boost version 1.34 is required.
  <!-- TODO: we don't check for this version -->
  <!-- NOTE: jreed has tested with 1.34, 1.38, and 1.41. -->
        </para>

        <para>
          If the Boost System Library is detected at configure time,
          BIND 10 will be built using an alternative method for
          networking I/O using Boost ASIO support.  This provides
          asynchrony support; with ASIO the Authoritative DNS server
          can handle other queries while the processing of a TCP
          transaction stalls.
          This dependency is not required unless you need
          <!-- TODO: want --> this feature as TCP transport support is
          provided using alternative code.
        </para>

        <para>
          Building BIND 10 also requires a C++ compiler and
          standard development headers.
          BIND 10 builds have been tested with GCC g++ 3.4.3, 4.1.2,
          4.2.1, 4.3.2, and 4.4.1.
        </para>
    </section>

275
276
    <section id="quickstart">
      <title>Quick start</title>
277
278
279
280
281
282
283
284
      <note>
        <simpara>
          This quickly covers the standard steps for installing
          and deploying BIND 10 as an authoritative name server using
          its defaults. For troubleshooting, full customizations and further
          details, see the respective chapters in the BIND 10 user guide.
        </simpara>
      </note>
285

286
287
288
289
290
291
292
      <note>
        <simpara>
          The Y1 prototype of the b10-auth server listens on
          0.0.0.0 (all interfaces) port 5300. (This is not the standard
          domain service port.)
        </simpara>
      </note>
293

294
295
296
297
298
      <para>
        To quickly get started with BIND 10, follow these steps.
      </para>

      <orderedlist>
299
300
    
        <listitem>
301
302
303
          <simpara>
            Install required build dependencies.
          </simpara>
304
        </listitem>
305

306
        <listitem>
307
308
309
          <simpara>
            Download the BIND 10 source tar file from
            <ulink url="ftp://ftp.isc.org/isc/bind10/"/>.
310
311
          </simpara>
        </listitem>
312

313
314
315
316
317
        <listitem>
          <para>Extract the tar file:
          <screen>$ <userinput>gzcat bind10-<replaceable>VERSION</replaceable>.tar.gz | tar -xvf -</userinput></screen>
          </para>
        </listitem>
318

319
320
321
322
323
324
        <listitem>
          <para>Go into the source and run configure:
            <screen>$ <userinput>cd bind10-<replaceable>VERSION</replaceable></userinput>
  $ <userinput>./configure</userinput></screen>
          </para>
        </listitem>
325

326
327
328
329
330
        <listitem>
          <para>Build it:
            <screen>$ <userinput>make</userinput></screen>
          </para>
        </listitem>
331

332
333
334
335
336
        <listitem>
          <para>Install it (to default /usr/local):
            <screen>$ <userinput>make install</userinput></screen>
          </para>
        </listitem>
337

338
339
340
341
342
        <listitem>
          <para>Start the server:
            <screen>$ <userinput>/usr/local/sbin/bind10</userinput></screen>
          </para>
        </listitem>
343

344
        <listitem>
345

346
347
348
349
350
351
352
353
354
355
356
357
         <para>Test it; for example:
            <screen>$ <userinput>dig @127.0.0.1 -p 5300 -c CH -t TXT authors.bind</userinput></screen>
         </para>
        </listitem>

        <listitem>
          <para>Load desired zone file(s), for example:
            <screen>$ <userinput>b10-loadzone <replaceable>your.zone.example.org</replaceable></userinput></screen>
          </para>
        </listitem>

        <listitem>
358
359
          <simpara>
            Test the new zone.
360
361
          </simpara>
        </listitem>
362

363
      </orderedlist>
364
365
366
367
368

    </section>

    <section id="install">
      <title>Installation from source</title>
369
      <para>
370
371
372
373
374
        BIND 10 is open source software written in C++ and Python.
        It is freely available in source code form from ISC via
        the Subversion code revision control system or as a downloadable
        tar file. It may also be available in pre-compiled ready-to-use
        packages from operating system vendors.
375
376
      </para>

377
378
      <section>
        <title>Download Tar File</title>
379
380
381
382
383
384
385
        <para>
          Downloading a release tar file is the recommended method to
          obtain the source code.
        </para>
        
        <para>
          The BIND 10 releases are available as tar file downloads from
386
387
          <ulink url="ftp://ftp.isc.org/isc/bind10/"/>.
          Periodic development snapshots may also be available.
388
389
390
391
392
393
        </para>
  <!-- TODO -->
      </section>

      <section>
        <title>Retrieve from Subversion</title>
394
395
396
397
398
        <para>
          Downloading this "bleeding edge" code is recommended only for
          developers or advanced users.  Using development code in a production
          environment is not recommended.
        </para>
399
400
401
402
403
404
405
406
407
408

        <note>
          <para>
            When using source code retrieved via Subversion additional
            software will be required:  automake (v1.11 or newer),
            libtoolize, and autoconfigure (2.59 or newer).
            These may need to be installed.
          </para>
        </note>

409
410
411
412
413
414
415
416
417
418
419
        <para>
          The latest development code, including temporary experiments
          and un-reviewed code, is available via the BIND 10 code revision
          control system. This is powered by Subversion and all the BIND 10
          development is public.
          The leading development is done in the <quote>trunk</quote>
          and the first year prototype containing reviewed code is in
          <filename>branches/Y1</filename>.
        </para>
        <para>
          The code can be checked out from <filename>svn://bind10.isc.org/svn/bind10</filename>; for example to check out the trunk:
420

421
422
        <screen>$ <userinput>svn co svn://bind10.isc.org/svn/bind10/trunk</userinput></screen>
        </para>
423

424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
        <para>
          When checking out the code from
          the code version control system, it doesn't include the
          generated configure script, Makefile.in files, nor the
          related configure files.
          They can be created by running <command>autoreconf</command>
          with the <option>--install</option> switch.
          This will run <command>autoconf</command>,
          <command>aclocal</command>,
          <command>libtoolize</command>,
          <command>autoheader</command>,
          <command>automake</command>,
          and related commands.
        </para>

439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
      </section>


      <section>
        <title>Configure before the build</title>
        <para>
          BIND 10 uses the GNU Build System to discover build environment
          details.
          To generate the makefiles using the defaults, simply run:
          <screen>$ <userinput>./configure</userinput></screen>
        </para>
        <para>
          Run <command>./configure</command> with the <option>--help</option>
          switch to view the different options. The commonly-used options are:

          <variablelist>

          <varlistentry>
            <term>--with-boostlib</term>
            <listitem> 
              <simpara>Define the path to find the Boost system library.
              </simpara>
            </listitem> 
          </varlistentry>

          <varlistentry>
            <term>--without-boostlib</term> or
            <term>--with-boostlib=no</term>
            <listitem> 
              <simpara>Disable the Boost ASIO support.</simpara>
            </listitem> 
          </varlistentry>

          <varlistentry>
            <term>--with-pythonpath</term>
            <listitem> 
              <simpara>Define the path to Python 3.1 if it is not in the
                standard execution path.
              </simpara>
            </listitem> 
          </varlistentry>

          <varlistentry>
            <term>--with-boost-include</term>
            <listitem> 
              <simpara>Define the path to find the Boost headers.
              </simpara>
            </listitem> 
          </varlistentry>

          <varlistentry>
            <term>--prefix</term>
            <listitem>
492
493
        <simpara>Define the the installation location (the
          default is <filename>/usr/local/</filename>).
494
495
496
497
498
499
500
501
502
503
504
              </simpara>
            </listitem> 
          </varlistentry>

          </variablelist>

        </para>
  <!-- TODO: gtest, lcov -->

        <para>
          For example, the following configures it to build
505
506
    with BOOST ASIO support, find the Boost headers, find the
    Python interpreter, and sets the installation location:
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523

          <screen>$ <userinput>./configure --with-boostlib=/usr/pkg/lib \
      --with-boost-include=/usr/pkg/include \
      --with-pythonpath=/usr/pkg/bin/python3.1 \
      --prefix=/opt/bind10</userinput></screen>
        </para>

        <para>
          If the configure fails, it may be due to missing or old
          dependencies.
        </para>

      </section>

      <section>
        <title>Build</title>
        <para>
524
525
    After the configure step is complete, to build the executables
    from the C++ code and prepare the Python scripts, run:
526
527
528
529
530
531
532
533

          <screen>$ <userinput>make</userinput></screen>
        </para>
      </section>

      <section>
        <title>Install</title>
        <para>
534
535
    To install the BIND 10 executables, support files,
    and documentation, run:
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
          <screen>$ <userinput>make install</userinput></screen>
        </para>
        <note><para>The install step may require superuser
        privileges.</para></note>

      </section>

  <!-- TODO: tests -->

      <section>
        <title>Install Hierarchy</title>
        <para>
          The following is the layout of the complete BIND 10 installation:
        <itemizedlist>
        <listitem>
        <simpara><filename>bin/</filename> &mdash; general tools and
        diagnostic clients.</simpara>
        </listitem>
        <listitem>
        <simpara><filename>etc/bind10/</filename> &mdash; configuration files.
        </simpara>
  <!-- TODO: create the etc/bind10/ directory? -->
        </listitem>
        <listitem>
        <simpara><filename>lib/</filename> &mdash; libraries and
        python modules.</simpara>
        </listitem>
        <listitem>
        <simpara><filename>libexec/bind10/</filename> &mdash; executables that
        a user wouldn't normally run directly. Nor would they be used
        independently. These are the BIND 10 modules which are daemons
        started by the <command>bind10</command> tool.
        </simpara>
        </listitem>
        <listitem>
        <simpara><filename>sbin/</filename> &mdash; commands used by
        the system administrator.
        </simpara>
        </listitem>
        <listitem>
        <simpara><filename>share/bind10/</filename> &mdash; configuration
          specifications.
        </simpara>
        </listitem>
        <listitem>
        <simpara><filename>share/man/</filename> &mdash; manual pages (online
          documentation).
        </simpara>
        </listitem>
        <listitem>
        <simpara><filename>var/bind10/</filename> &mdash; data source and
          configuration databases.
  <!-- TODO: move the sqlite3 database there -->
        </simpara>
        </listitem>
        </itemizedlist>
592
      </para>
593
594
595
596
597
598
599
600
601
602
      </section>
    </section>

  <!--
      <section id="install.troubleshooting">
        <title>Troubleshooting</title>
        <para>
        </para>
      </section>
  -->
603
604
  
  </chapter>
605

606
607
  <chapter id="bind10">
    <title>Starting BIND10 with bind10</title>
608
609
610
611
612
613
614
615
616
617
618
619
620
621
    <para>
      BIND 10 provides the <command>bind10</command> command which 
      starts up the required daemons to provide the message
      communication bus, configurations, <!-- TODO: security, -->
      and the DNS server(s).
      Also known as BoB or the Boss of BIND, <command>bind10</command>
      will also restart processes that exit.
    </para>

    <para>
      After starting the <command>msgq</command> communications channel,
      <command>bind10</command> connects to it, 
      runs the configuration manager, and reads its own configuration.
      Then it starts the other modules.
622
623
624
625
626
627
    </para>

    <para>
      The <command>msgq</command> and <command>b10-cfgmgr</command>
      services make up the core. The <command>msgq</command> daemon
      provides the communication channel between every part of the system.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
628
      The <command>b10-cfgmgr</command> daemon is always needed by every
629
630
631
      module, if only to send information about themselves somewhere,
      but more importantly to ask about their own settings, and
      about other modules.
632
      The <command>bind10</command> master process will also start up
Jeremy C. Reed's avatar
Jeremy C. Reed committed
633
634
635
      <command>b10-cmdctl</command> for admins to communicate with the
      system, <command>b10-auth</command> for Authoritative DNS service,
      and <command>b10-xfrin</command> for inbound DNS zone transfers.
636
637
    </para>

638
    <section id="start">
639
640
641
      <title>Starting BIND 10</title>
      <para>
        To start the BIND 10 service, simply run <command>bind10</command>.
642
        Run it with the <option>--verbose</option> switch to
643
644
645
        get additional debugging or diagnostic output.
      </para>
<!-- TODO: note it doesn't go into background -->
646
    </section>
647
648
649

  </chapter>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
650
651
652
653
654
655
656
657
658
  <chapter id="msgq">
    <title>Command channel</title>

      <para>
        The BIND 10 components use the <command>msgq</command>
        message routing daemon to intercommunicate.
        This is called the <quote>Command Channel</quote>.
        The members of the channel subscribe to listen to certain
        messages and are programmed to handle received messages.
659
660
  Example messages include shutdown, get configurations, and set
  configurations.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
      </para>

      <note><simpara>
        This Command Channel is not used for DNS message passing.
      </simpara></note>

      <para>
        Administrators do not communicate directly with the
        <command>msgq</command> daemon. The only configuration is
        to choose the port number it listens on.
        By default, BIND 10 uses port 9912 for the
        <command>msgq</command> service.
        It listens on 127.0.0.1.
      </para>

<!-- TODO: upcoming plans:
Unix domain sockets
-->

  </chapter>

682
683
684
685
  <chapter id="cfgmgr">
    <title>Configuration manager</title>

      <para>
686
687
688
689
   The configuration manager, <command>b10-cfgmgr</command>,
   handles all BIND 10 system configuration.  It provides
   persistent storage for configuration, and notifies running
   modules of configuration changes.</para>
690
691

      <para>
692
693
694
695
  The <command>b10-auth</command> and <command>b10-xfrin</command>
  daemons and other components receive their configurations
  from the configuration manager over the <command>msgq</command>
  command channel.
696
697
      </para>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
698
699
700
701
      <para>The administrator doesn't connect to it directly, but
        uses a user interface to communicate with the configuration
        manager via <command>b10-cmdctl</command>'s REST-ful interface.
        <command>b10-cmdctl</command> is covered in <xref linkend="cmdctl"/>.
702
703
704
705
      </para>

<!-- TODO -->
      <note><para>
706
707
  The Y1 prototype release only provides the
  <command>bindctl</command> as a user interface to
Jeremy C. Reed's avatar
Jeremy C. Reed committed
708
        <command>b10-cmdctl</command>.
709
710
711
712
713
714
715
        Upcoming releases will provide another interactive command-line
        interface and a web-based interface.
      </para></note>

      <para>
        The <command>b10-cfgmgr</command> daemon can send all
        specifications and all current settings to the
716
717
  <command>bindctl</command> client (via
  <command>b10-cmdctl</command>).
718
719
      </para>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
      <para>
        <command>b10-cfgmgr</command> relays configurations received
        from <command>b10-cmdctl</command> to the appropriate modules.
      </para>
<!-- TODO:
        Configuration settings for itself are defined as ConfigManager.
TODO: show examples
-->

<!-- TODO:
config changes are actually commands to cfgmgr
-->

<!-- TODO: what about run time config to change this? -->
<!-- jelte: > config set cfgmgr/config_database <file> -->
<!-- TODO: what about command line switch to change this? -->
      <para>
        The stored configuration file is at
        <filename>/usr/local/var/bind10/b10-config.db</filename>.
        (The full path is what was defined at build configure time for
740
741
        <option>--localstatedir</option>.
        The default is <filename>/usr/local/var/</filename>.)
742
743
744
745
  The format is loosely based on JSON and is directly parseable
  python, but this may change in a future version.
  This configuration data file is not manually edited by the
  administrator.
Jeremy C. Reed's avatar
Jeremy C. Reed committed
746
      </para>
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761

<!--

Well the specfiles have a more fixed format (they must contain specific
stuff), but those are also directly parseable python structures (and
'coincidentally', our data::element string representation is the same)

loosely based on json, tweaked to be directly parseable in python, but a
subset of that.
wiki page is http://bind10.isc.org/wiki/DataElementDesign

nope, spec files are written by module developers, and db should be done
through bindctl and friends

-->
762
763

    <para>
764
765
766
767
768
769
770
771
772
      The configuration manager does not have any command line arguments.
      Normally it is not started manually, but is automatically
      started using the <command>bind10</command> master process
      (as covered in <xref linkend="bind10"/>).
    </para>

<!-- TODO: upcoming plans:
configuration for configuration manager itself. And perhaps we might
change the messaging protocol, but an admin should never see any of that
Jeremy C. Reed's avatar
Jeremy C. Reed committed
773
774
775
776
777
778
779
-->

<!-- TODO: show examples, test this -->
<!--
, so an admin can simply run bindctl,
do config show, and it shows all modules; config show >module> shows all
options for that module
780
781
782
783
784
785
786
-->

  </chapter>

  <chapter id="cmdctl">
    <title>Remote control daemon</title>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
787
788
789
790
791
792
793
794
    <para>
      <command>b10-cmdctl</command> is the gateway between
      administrators and the BIND 10 system.
      It is a HTTPS server that uses standard HTTP Digest
      Authentication for username and password validation.
      It provides a REST-ful interface for accessing and controlling
      BIND 10.
    </para>
795
796
<!-- TODO: copy examples from wiki, try with wget -->

Jeremy C. Reed's avatar
Jeremy C. Reed committed
797
    <para>
798
      When <command>b10-cmdctl</command> starts, it firsts
799
800
      asks <command>b10-cfgmgr</command> about what modules are
      running and what their configuration is (over the
801
      <command>msgq</command> channel). Then it will start listening
Jeremy C. Reed's avatar
Jeremy C. Reed committed
802
803
804
805
806
807
808
809
810
      on HTTPS for clients &mdash; the user interface &mdash; such
      as <command>bindctl</command>.
    </para>

    <para>
      <command>b10-cmdctl</command> directly sends commands
      (received from the user interface) to the specified component.
      Configuration changes are actually commands to
      <command>b10-cfgmgr</command> so are sent there.
811
    </para>
812

Jeremy C. Reed's avatar
Jeremy C. Reed committed
813
814
815
816
817
818
819
820
821
822
823
824
825
<!--
TODO:
"For bindctl to list a module's available configurations and
available commands, it communicates over the cmdctl REST interface.
cmdctl then asks cfgmgr over the msgq command channel. Then cfgmgr
asks the module for its specification and also cfgmgr looks in its
own configuration database for current values."

(05:32:03) jelte: i think cmdctl doesn't request it upon a incoming
GET, but rather requests it once and then listens in for updates,
but you might wanna check with likun
-->

826
827
<!-- TODO: replace /usr/local -->
<!-- TODO: permissions -->
828
829
830
831
832
833
834
835
836
837
838
    <para>The HTTPS server requires a private key,
      such as a RSA PRIVATE KEY.
      The default location is at
      <filename>/usr/local/etc/bind10/cmdctl-keyfile.pem</filename>.
      (A sample key is at
      <filename>/usr/local/share/bind10/cmdctl-keyfile.pem</filename>.)
      It also uses a certificate located at
      <filename>/usr/local/etc/bind10/cmdctl-certfile.pem</filename>.
      (A sample certificate is at
      <filename>/usr/local/share/bind10/cmdctl-certfile.pem</filename>.)
      This may be a self-signed certificate or purchased from a
839
840
      certification authority.
    </para>
841
842

    <note><para>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
843
844
845
846
847
848
849
850
      The HTTPS server doesn't support a certificate request from a
      client (at this time).
<!-- TODO: maybe allow request from server side -->
      The <command>b10-cmdctl</command> daemon does not provide a
      public service. If any client wants to control BIND 10, then
      a certificate needs to be first recieved from the BIND 10
      administrator.
      The BIND 10 installation provides a sample PEM bundle that matches
851
852
853
      the sample key and certificate.
    </para></note>
<!-- TODO: cross-ref -->
Jeremy C. Reed's avatar
Jeremy C. Reed committed
854
855
856
857
858

<!-- TODO
openssl req -new -x509 -keyout server.pem -out server.pem -days 365 -nodes
but that is a single file, maybethis should go back to that format?
-->
859
860
861
862
863
864
865

<!--
    <para>
(08:20:56) shane: It is in theory possible to run without cmdctl.
(08:21:02) shane: I think we discussed this.
    </para>
-->
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892

<!-- TODO: Please check https://bind10.isc.org/wiki/cmd-ctrld -->


    <para>
      The <command>b10-cmdctl</command> daemon also requires
      the user account file located at
      <filename>/usr/local/etc/bind10/cmdctl-accounts.csv</filename>.
      This comma-delimited file lists the accounts with a user name,
      hashed password, and salt.
      (A sample file is at
      <filename>/usr/local/share/bind10/cmdctl-accounts.csv</filename>.
      It contains the user named <quote>root</quote> with the password
      <quote>bind10</quote>.)
    </para>

    <para>
      The administrator may create a user account with the
      <command>b10-cmdctl-usermgr</command> tool.
    </para>
<!-- TODO: show example -->

<!-- TODO: does cmdctl need to be restarted to change cert or key
or accounts database -->

    <para>
      By default the HTTPS server listens on the localhost port 8080.
893
894
      The port can be set by using the <option>--port</option> command line option.
      The address to listen on can be set using the <option>--address</option> command
895
896
897
      line argument.
      Each HTTPS connection is stateless and timesout in 1200 seconds
      by default.  This can be
898
      redefined by using the <option>--idle-timeout</option> command line argument.
899
900
    </para>

901
    <section id="cmdctl.spec">
902
      <title>Configuration specification for b10-cmdctl</title>
903
      <para>
904
905
906
907
        The configuration items for <command>b10-cmdctl</command> are:
key_file
cert_file
accounts_file
908
      </para>
909
910
<!-- TODO -->

911
      <para>
912
913
914
        The control commands are:
print_settings
shutdown
915
      </para>
916
<!-- TODO -->
917
    </section>
918
919
920

<!--
TODO
921
922
(12:21:30) jinmei: I'd like to have sample session using a command line www client such as wget
(12:21:33) jinmei: btw
923
924
-->

925
926
  </chapter>

Jeremy C. Reed's avatar
Jeremy C. Reed committed
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
  <chapter id="bindctl">
    <title>Control and configure user interface</title>

    <note><para>
      For the Y1 prototype release, <command>bindctl</command>
      is the only user interface. It is expected that upcoming
      releases will provide another interactive command-line
      interface and a web-based interface for controlling and
      configuring BIND 10.
    </para></note>

    <para>
      The <command>bindctl</command> tool provides an interactive
      prompt for configuring, controlling, and querying the BIND 10
      components.
942
      It communicates directly with a REST-ful interface over HTTPS
Jeremy C. Reed's avatar
Jeremy C. Reed committed
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
      provided by <command>b10-cmdctl</command>. It doesn't
      communicate to any other components directly.
    </para>

<!-- TODO: explain and show interface -->

    <para>
      Configuration changes are actually commands to
      <command>b10-cfgmgr</command>. So when <command>bindctl</command>
      sends a configuration, it is sent to <command>b10-cmdctl</command>
      (over a HTTPS connection); then <command>b10-cmdctl</command>
      sends the command (over a <command>msgq</command> command
      channel) to <command>b10-cfgmgr</command> which then stores
      the details and relays (over a <command>msgq</command> command
      channel) the configuration on to the specified module.
    </para>

    <para>
    </para>

  </chapter>

965
966
  <chapter id="authserver">
    <title>Authoritative Server</title>
967

968
    <para>
969
970
971
972
      The <command>b10-auth</command> is the authoritative DNS server.
      It supports EDNS0 and DNSSEC. It supports IPv6.
      Normally it is started by the <command>bind10</command> master
      process.
973
974
    </para>

975
976
977
978
979
    <note><simpara>
      The Y1 prototype release listens on all interfaces and the non-standard
      port 5300.
    </simpara></note>

980
    <section>
981
      <title>Server Configurations</title>
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009

<!-- TODO: offers command line options but not used
since we used bind10 -->

      <para>
        <command>b10-auth</command> is configured via the
        <command>b10-cfgmgr</command> configuration manager.
        The module name is <quote>Auth</quote>.
        The configuration data item is:

        <variablelist>
    
          <varlistentry>
            <term>database_file</term>
            <listitem> 
              <simpara>This is an optional string to define the path to find
                 the SQLite3 database file.
<!-- TODO: -->
Note: Later the DNS server will use various data source backends.
This may be a temporary setting until then.
              </simpara>
            </listitem>
          </varlistentry>

        </variablelist>

      </para>

1010
      <para>
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026

        The configuration command is:

        <variablelist>

          <varlistentry>
            <term>shutdown</term>
            <listitem> 
              <simpara>Stop the authoritative DNS server.
              </simpara>
<!-- TODO: what happens when this is sent, will bind10 restart? -->
            </listitem>
          </varlistentry>

        </variablelist>

1027
      </para>
1028
1029
1030

<!-- TODO: examples of setting or running above? -->

1031
    </section>
1032

1033
    <section>
1034
      <title>Data Source Backends</title>
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044

      <note><para>
        For the Y1 prototype release, <command>b10-auth</command>
        only supports the SQLite3 data source backend.
        Upcoming versions will be able to use multiple different
        data sources, such as MySQL, Berkeley DB, or in-memory DB.
      </para></note>


<!-- TODO: really is /tmp/zone.sqlite3 until fixed. -->
1045
      <para>
1046
1047
1048
1049
1050
        By default, the SQLite3 backend uses the data file located at
        <filename>/usr/local/var/bind10/zone.sqlite3</filename>.
        (The full path is what was defined at build configure time for
        <option>--localstatedir</option>.
        The default is <filename>/usr/local/var/</filename>.)
1051
1052
  This data file location may be changed by defining the
  <quote>database_file</quote> configuration.
1053
      </para>
1054

1055
    </section>
1056

1057
    <section>
1058
      <title>Loading Master Zones Files</title>
1059

1060
      <para>
1061
1062
1063
1064
        RFC 1035 style DNS master zone files may imported
        into a BIND 10 data source by using the
        <command>b10-loadzone</command> utility.
      </para>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1065

1066
1067
1068
      <para>
        <command>b10-loadzone</command> supports the following
        special directives (control entries):
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1069

1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
        <variablelist>

          <varlistentry>
            <term>$INCLUDE</term>
            <listitem> 
              <simpara>Loads an additional zone file. This may be recursive.
              </simpara>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>$ORIGIN</term>
            <listitem> 
              <simpara>Defines the relative domain name.
              </simpara>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>$TTL</term>
            <listitem> 
              <simpara>Defines the time-to-live value used for following
                records that don't include a TTL.
              </simpara>
            </listitem>
          </varlistentry>

        </variablelist>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1098

1099
      </para>
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110

      <para>
        The <option>-o</option> argument may be used to define the
        default origin for loaded zone file records.
      </para>

      <note>
      <para>
        In the Y1 prototype release, only the SQLite3 back end is used.
        By default, it stores the zone data in
        <filename>/usr/local/var/bind10/zone.sqlite3</filename>
Jeremy C. Reed's avatar
Jeremy C. Reed committed
1111
        unless the <option>-d</option> switch is used to set the
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
        database filename.
        Multiple zones are stored in a single SQLite3 zone database.
      </para>
      </note>

      <para>
        If you reload a zone already existing in the database,
        all records from that prior zone disappear and a while new set
        appears.
      </para>

<!--TODO: permissions for xfrin or loadzone to create the file -->

1125
    </section>
1126

1127
1128
<!--
TODO
1129
    <section>
1130
1131
      <title>Troubleshooting</title>
      <para>
1132
      </para>
1133
    </section>
1134
-->
1135
1136
1137
1138
1139
1140
1141
1142
1143

  </chapter>

<!-- TODO: how to help: run unit tests, join lists, review trac tickets -->

  <!-- <index>    <title>Index</title> </index> -->

</book>

1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
<!--

TODO:

Overview

Getting BIND 10 Installed
  Basics
  Dependencies
  Optional
  Advanced

How Does Everything Work Together?

Need Help?

-->