1.0 Introduction
1.1 Basic theory of operation
1.2 Quick build & install
2.0 Building nsd
2.1 Unpacking the source
2.2 Configuring NSD
2.3 Building
2.4 Installing
3.0 Running NSD
3.1 Logging
3.2 AXFR access
3.3 Keeping in sync the secondary zones with ``nsdc update''
3.4 Sending notify to the secondaries on reload or restart



1.0 Introduction

This is NSD Name Server Daemon (NSD) version 2.3.3.

NSD is a complete implementation of an authoritative DNS name server.
For further information about what NSD is and what NSD is not please
consult the REQUIREMENTS document which is a part of this distribution
(thanks to Olaf).

The source code is available for download from:

        http://www.nlnetlabs.nl/downloads


1.1 Basic Theory of Operation

NSD consists of two programs: the zone compiler 'zonec' and the name
server 'nsd' itself. The name server works with an intermediate
database prepared by the zone compiler from standard zone files.

For NSD operation this means that zones have to be compiled by zonec
before NSD can use them.

All this can be controlled by a simple control script called 'nsdc'
which uses a simple configuration file.


1.2 Quick build and install

Step 1: Unpack the source with gtar -xzvf nsd-2.3.3.tar.gz

Step 2: Create user nsd or any other unprivileged user of your
        choice. In case of later make sure to use
        --with-user=<username> while running configure.

Step 3: ./configure

Step 4: make all

Step 5: make install

Step 6: Add "axfr" and/or "axfr-zone.name.tld" entries to your
        hosts.allow and/or hosts deny

        Example:

                axfr: ALL : allow

Step 7: Create and edit /etc/nsd/nsd.zones file possibly from
        nsd.zones.sample template that comes with the distribution.

Step 8: Copy necessary master zone files into appropriate directories
        under /etc/nsd/primary & /etc/nsd/secondary You might consider
        using contrib/build-nsdzones.pl script to automate task 7 & 8.

Step 9: Run nsdc update if necessary

Step 10: Run nsdc rebuild

Step 11: Run nsdc start

Step 12: Test the NSD with dig or host.

Step 13: If you're happy add nsdc start into your OS boot up sequence.

Step 14: If desired add nsdc update to your superuser crontab to
         update the zones from master servers periodically.

         Got any problems or questions with the steps above? Read the
         rest of this file.



2.0 Building NSD


2.1 Unpacking the source

Use your favorite combination of tar and gnu zip to unpack the source,
for example

$ gtar -xzvf nsd-2.3.3.tar.gz

will unpack the source into the ./nsd-2.3.3 directory...


2.2 Configuring NSD

NSD can be configured using GNU autoconf's configure script. In
addition to standard configure options, one may use the following:

  CC=compiler
 
        Specify the C compiler.  The default is gcc or cc.  The
        compiler must support ANSI C89.

  CPPFLAGS=flags

        Specify the C preprocessor flags.  For gcc, -ansi (or
        -std=c89) is considered a preprocessor flag because it alters
        the way header files are processed on many systems.  If you
        specify -ansi make sure you specify the correct options to
        enable standard Unix functions ('-D_POSIX_C_SOURCE=200112
        -D_XOPEN_SOURCE=600' on Linux and systems that conform to the
        Single Unix Specification version 3, -D__EXTENSIONS__ on
        Solaris, etc.).

  CFLAGS=flags

        Specify the C compiler flags.  These include code generation,
        optimization, warning, and debugging flags.  These flags are
        also passed to the linker.

        The default for gcc is "-g -O2".

  LD=linker

        Specify the linker (defaults to the C compiler).

  LDFLAGS=flags

        Specify linker flags.

  LIBS=libs
 
        Specify additional libraries to link with.

  --enable-root-server

        Configure NSD as a root server. Unless this option is
        specified, NSD will refuse to server ``.'' zone as a
        misconfiguration safeguard.

  --disable-ipv6

        Disables IPv6 support in NSD.

  --enable-plugins

        Enable plugin support (experimental).  See nsd-plugin.h for
        the plugin API defined by NSD.  See contrib/example-plugin.c
        for an example plugin.

  --enable-checking

        Enable some internal development checks.  Useful if you want
        to modify NSD or develop plugins.  This option enables the
        standard C "assert" macro.

  --diable-dnssec

        Disable support for DNSSEC (RFC 4033, 4034, and 4035).

  --disable-axfr

        Disables outbound AXFR functionalities altogether.

  --disable-tsig

        Disable TSIG support in the nsd-xfer(8) AXFR client program.
        The nsd(8) server does not yet support TSIG.

  --enable-bind8-stats

        Enables BIND8-like statistics.

  --with-configdir=dir

        Specified, NSD configuration directory, default /etc/nsd

  --with-pidfile=path

        Pathname to the NSD pidfile, default is platform specific,
        mostly /var/run/nsd.pid

  --with-zonesfile=path

        Pathname to the NSD list of zones, default /etc/nsd/nsd.zones

  --with-dbfile=path

        Pathname to the NSD database, default is /etc/nsd/nsd.db

  --with-configfile=path  

        Pathname to the NSD configuration file Pathname to the NSD
        configuration file, default /etc/nsd/nsdc.conf

  --with-zonesdir=dir

        NSD default location for master zone files, default /etc/nsd/

  --with-user=username

        User name or ID to answer the queries with, default is nsd

  --with-libwrap=pathname

        Compile in libwrap (tcp_wrappers) support.

  --with-facility=facility

        Specify the syslog facility to use.  The default is
        LOG_DAEMON.  See the syslog(3) manual page for the available
        facilities.

  --with-ssl=path

        Specify the location of the OpenSSL libraries.  OpenSSL 0.9.7
        or higher is required for TSIG support.  Use --disable-tsig if
        you do not have OpenSSL installed.


2.3 Building

Say a prayer and type ``make''

If you prayed to the right God, continue to the step 2.4


2.4 Installing

Become a superuser (if necessary) and type ``make install''

This step should install three binaries

nsd             - the daemon itself
nsdc            - a shell script to control the daemon
zonec           - zone compiler
nsd-notify      - a simple C program to send outbound notifies
nsd-xfer        - a program to receive zones from a master server
                  using AXFR.

Plus the manual pages.



3.0 Running NSD

Before running NSD you need to build a name database specified with
``--with-dbfile'' or /etc/nsd/nsd.db by default.

The nsdc shell script can do it for you if you create a nsd.zones file
file, for example /etc/nsd/nsd.zones which should be of the following
format:

; Zone Name     Master zone file name
zone    bluesky.com     primary/bluesky.com
zone    greysky.com     secondary/greysky.com masters 10.1.1.1

Where bluesky.com should be the domain name you will be serving with
NSD.

The second line indicates that nsdc update should try to axfr the zone
greysky.com from the master server 10.1.1.1. Multiple masters are 
supported. They are queried in order, if the first one fails the second
one is queried, and so on.

Since NSD is primarily written to be run on the root name servers,
this file most likely to contain something like:

zone    .               root.zone

You should only do that if you're intending to run a root server, NSD
is not suited for running a . cache. Therefore if you choose to server
the .  zone you have to make sure that the complete root zone is
timely and fully updated.

To prevent misconfiguration, NSD configure has --enable-root-server
switch, that is by default disabled.

The first word on a line must be ``zone''. It indicates that the zone
should be loaded as authoritative data. Cached non authoritative data
is no longer supported (keyword ``cache'' is obsolete)

Second word is the name (origin) of the zone and the third word is the
pathname to the master zone file. If you use zonec with the -d option
the pathname may be relative to the NSD zones directory.

Optionally masters list-of-ip-addresses can be present to update the
respective zone with axfr from the given master servers. This option
is ignored by zonec and is only relevant for nsdc update.

If everything is done properly and installed into the default location
then all you need to build your nsd.db is to type

nsdc rebuild

This starts zonec on your zone files. If zonec reports no errors, your
database is now ready for the daemon which can be started with

nsdc start

To check if the daemon is running use

nsdc running

To reload a new database after you recompiled it with 'nsdc rebuild'
without stopping the daemon issue

nsdc reload

To restart the daemon (should never be necessary, unless you do some
development work)

nsdc restart

To shut it down (for example on the system shutdown) do

nsdc stop

To update the secondary zones from its masters one can use

nsdc update

This command will check the serial number of the masters against the
serial numbers in the local zone files and initiate axfr if necessary.
Then the database will be rebuilt with nsdc rebuild and reloaded with
nsdc reload if there were any changes.

nsdc notify

With this option nsdc will send notify to all the slave servers
mentioned in the nsd.zones file with ``notify'' keyword.


3.1 Logging

NSD doesn't do any logging. We believe that logging is a separate task
and has to be done independently from the core operation.

The CAIDA dnsstat tool referenced below is recommended to nsd
operators as a mean of keeping statistics and check on abnormal query
loads.

        http://www.caida.org/tools/utilities/dnsstat/dnsstat-3.5.1a.tar.gz

This consciously is not part of nsd itself in order to keep nsd
focused and minimize its complexity. It is better to leave logging and
tracing to separate dedicated tools. dnsstat can also easily be
configured and/or modified to suit local statistics requirements
without any danger of affecting the name server itself. We have run
dnsstat on the same machine as nsd, we would recommend using a
multiprocessor if performance is an issue. Of course it can also run
on a separate machine that has MAC layer access to the network of the
server.

A sample invocation of dnsstat:

/usr/local/Coral/bin/crl_dnsstat -D -Ci=60 -Cd=240 -C'filter dst 10.1.1.3'  -h -u if:fxp1

A sample output of a slightly modified version:

# dnsstat output version: 0.2 "dfk"

# begin trace interval at 1025267664.859043, duration 15.000000
# DNS messages: 74973 (4998.200000/s); DNS queries: 151983 (10132.200000/s)
# print threshold: 30 messages/sec

#src              op type  class queries    msgs      rd notes
 208.18.162.10     - -     -         533     533       0
 "                 0 MX    IN          6
 "                 0 A     IN        264
 "                 0 ANY   IN        263
 209.11.18.248     - -     -         661     661       0
 "                 0 A     IN        655
 "                 0 MX    IN          6
 210.117.65.137    - -     -         745     745       0
 "                 0 A     IN        745
 216.54.221.131    - -     -         477     477       0
 "                 0 A     IN        477
 193.97.205.80     - -     -         681     681       0
 "                 0 A     IN          3
 "                 0 ANY   IN        678
 168.30.240.11     - -     -         685     685       0
 "                 0 A     IN        405
 "                 0 MX    IN        280
 210.94.6.67       - -     -         742     742       0
 "                 0 A     IN        742
 63.66.68.237      - -     -        1375    1375       0
 "                 0 A     IN       1375
 168.30.240.12     - -     -         493     493       0
 "                 0 A     IN        493
 139.142.205.225   - -     -        5579    5579       0
 "                 0 A     IN       3006
 "                 0 MX    IN       2573
 210.117.65.2      - -     -         700     700       0
 "                 0 A     IN        700
# end trace interval 


3.2 AXFR access

When compiled with libwrap nsd will use daemon name ``axfr'' and
``axfr-zone'' to verify access privileges for the client trying to
initiate the transfer.  Since NSD doesn't do any hostname resolution
internally the access list provided in the /etc/hosts.allow or
/etc/hosts.deny should be ip number based.

Example:

axfr-nlnetlabs.nl. : ns.sidn.nl : allow
axfr : 127.0.0.1 : allow
axfr : ns1.ripe.net : allow
axfr : ns1.sidn.nl : allow
axfr : ALL : deny

At first a check is made whether the particular client is allowed to
do transfer of the particular zone.

NOTE: Make sure you don't forget the trailing dot. So for example
``axfr-se.''  and NOT ``axfr-se''

If -DAXFR_DAEMON_PREFIX is defined (which is the case by default) and
the first lookup for ``axfr'' has failed (denied) then nsd will try
second lookup in hosts.allow or hosts.deny for the daemon name
axfr-zone.name.tld.  (with trailing dot).


3.3 Keeping in sync the secondary zones with ``nsdc update''

Originally NSD was not designed to be run as a secondary server. That
means that keeping and updating the local master zone files is outside
of the scope of the package and should be done either out of band or
with help of separate tools. However starting with 1.0.1-beta4 NSD
provides such functionality to a limited extent.

It makes no difference for zonec(8) and nsd(8) whether the master zone
file was created and maintained locally or was obtained via AXFR/IXFR
or out of band. However it is possible to specify the master servers
in nsd.zones file by adding ``masters'' keyword followed by ip address
of the master to instruct nsdc(8) update to update these zones with
nsd-xfer(8) utility if necessary.

; zone name file [ masters ip-address ]
zone nlnetlabs.nl secondary/nlnetlabs.nl masters 213.53.69.1

Given the line above nsdc(8) update will invoke nsd-xfer(8) to check
whether the zone was modified and if so will AXFR the zone from the
master 213.53.69.1

Due to the static nature of nsd(8) database it has to be rebuilt
completely whenever one of the zones changes. Therefore it is
recommended to do the database rebuilds at certain scheduled time, for
example every hour.  nsdc(8) update will rebuild the database and
reload the daemon if necessary.

the follow cron(8) command will take care of synchronizing the
database with the master servers:

# nsd zone update every hour
1       *       *       *       *       /usr/local/sbin/nsdc update


3.3.1 Using TSIG with synchronizing with master servers

It is as well possible to update the master zone files (in bound AXFR)
with nsdc(8) update using TSIG.

This is done by passing the tsig key to nsd-xfer(8).

nsd-xfer(8) uses the same cryptic file format as named-xfer(8) (to
be backward compatible).  This is a so called tsig-info file. 

First of all ${keysdir} should be set in the nsdc(8) configuration
file to reflect the directory where all the TSIG keys will be stored.

For example keysdir=/etc/nsd/keys would be a good location.

Lets say we have following:

zone: nlnetlabs.nl
server: 213.53.69.1
key-name: nlnetlabs-axfr
algorithm: hmac-md5
secret: Y87923jksdXlsdv+LeXpUA==

Then we need to create file ${NSDKEYSDIR}/nlnetlabs.nl.tsiginfo containing:
213.53.69.1
nlnetlabs-axfr
157
Y87923jksdXlsdv+LeXpUA==

Cryptic? Yes. The first line tells this key is to be used for
213.53.69.1 Second one is the name of the key. 157 stands for hmac-md5
algorithm and the last line is the secret.


3.4 Sending notify to the secondaries on reload or restart

It is possible to send outbound notifies to the secondaries every time
nsd database is (re)loaded. You have to directly specify the
ip-addresses of the secondaries in the nsd.zones file, for example:

zone    .               root.zone               notify 128.9.0.107 192.33.4.12 128.8.10.90
