Bring BSD-licensed ext2fs from FreeBSD

[ikiwiki.git] / docs / handbook / handbook-network-dns.mdwn

\r
\r
## 19.11 DNS \r
\r
***Contributed by Chern Lee. ***\r
\r
### 19.11.1 Overview \r
\r
DragonFly utilizes, by default, a version of BIND (Berkeley Internet Name Domain), which is the most common implementation of the DNS protocol. DNS is the protocol through which names are mapped to IP addresses, and vice versa. For example, a query for `www.dragonflybsd.org` will receive a reply with the IP address of The DragonFly Project's web server, whereas, a query for `ftp.dragonflybsd.org` will return the IP address of the corresponding FTP machine. Likewise, the opposite can happen. A query for an IP address can resolve its hostname. It is not necessary to run a name server to perform DNS lookups on a system.\r
\r
DNS is coordinated across the Internet through a somewhat complex system of authoritative root name servers, and other smaller-scale name servers who host and cache individual domain information.\r
\r
This document refers to BIND 9.x.\r
\r
RFC1034 and RFC1035 dictate the DNS protocol.\r
\r
Currently, BIND is maintained by the [Internet Software Consortium (www.isc.org)](http://www.isc.org/).\r
\r
### 19.11.2 Terminology \r
\r
To understand this document, some terms related to DNS must be understood.\r
\r
[[!table  data="""
| Term | Definition 
 Forward DNS | Mapping of hostnames to IP addresses 
 Origin | Refers to the domain covered in a particular zone file 
  **named** , BIND, name server | Common names for the BIND name server package within DragonFly 
 Resolver | A system process through which a machine queries a name server for zone information 
 Reverse DNS | The opposite of forward DNS; mapping of IP addresses to hostnames 
 Root zone | The beginning of the Internet zone hierarchy. All zones fall under the root zone, similar to how all files in a file system fall under the root directory. 
 Zone | An individual domain, subdomain, or portion of the DNS administered by the same authority |\r
"""]]\r
Examples of zones:\r
\r

* `.` is the root zone\r

* `org.` is a zone under the root zone\r

* `example.org` is a zone under the `org.` zone\r

* `foo.example.org.` is a subdomain, a zone under the `example.org.` zone\r

* `1.2.3.in-addr.arpa` is a zone referencing all IP addresses which fall under the 3.2.1.* IP space.\r
\r
As one can see, the more specific part of a hostname appears to its left. For example, `example.org.` is more specific than `org.`, as `org.` is more specific than the root zone. The layout of each part of a hostname is much like a filesystem: the `/dev` directory falls within the root, and so on.\r
\r
### 19.11.3 Reasons to Run a Name Server \r
\r
Name servers usually come in two forms: an authoritative name server, and a caching name server.\r
\r
An authoritative name server is needed when:\r
\r

* one wants to serve DNS information to the world, replying authoritatively to queries.\r

* a domain, such as `example.org`, is registered and IP addresses need to be assigned to hostnames under it.\r

* an IP address block requires reverse DNS entries (IP to hostname).\r

* a backup name server, called a slave, must reply to queries when the primary is down or inaccessible.\r
\r
A caching name server is needed when:\r
\r

* a local DNS server may cache and respond more quickly than querying an outside name server.\r

* a reduction in overall network traffic is desired (DNS traffic has been measured to account for 5% or more of total Internet traffic).\r
\r
When one queries for `www.dragonflybsd.org`, the resolver usually queries the uplink ISP's name server, and retrieves the reply. With a local, caching DNS server, the query only has to be made once to the outside world by the caching DNS server. Every additional query will not have to look to the outside of the local network, since the information is cached locally.\r
\r
### 19.11.4 How It Works \r
\r
In DragonFly, the BIND daemon is called  **named**  for obvious reasons.\r
\r
[[!table  data="""
| File | Description 
  **named**  | the BIND daemon 
 `ndc` | name daemon control program 
 `/etc/namedb` | directory where BIND zone information resides 
 `/etc/namedb/named.conf` | daemon configuration file |\r
"""]]\r
Zone files are usually contained within the `/etc/namedb` directory, and contain the DNS zone information served by the name server.\r
\r
### 19.11.5 Starting BIND \r
\r
Since BIND is installed by default, configuring it all is relatively simple.\r
\r
To ensure the named daemon is started at boot, put the following modifications in `/etc/rc.conf`:\r
\r
    \r
    named_enable="YES"\r
\r
\r
To start the daemon manually (after configuring it)\r
\r
    \r
    # ndc start\r
\r
\r
### 19.11.6 Configuration Files \r
\r
#### 19.11.6.1 Using `make-localhost` \r
\r
Be sure to:\r
\r
    \r
    # cd /etc/namedb\r
    # sh make-localhost\r
\r
\r
to properly create the local reverse DNS zone file in `/etc/namedb/localhost.rev`.\r
\r
#### 19.11.6.2 `/etc/namedb/named.conf` \r
\r
    \r
    // $DragonFlyBSD$\r
    //\r
    // Refer to the named(8) manual page for details.  If you are ever going\r
    // to setup a primary server, make sure you've understood the hairy\r
    // details of how DNS is working.  Even with simple mistakes, you can\r
    // break connectivity for affected parties, or cause huge amount of\r
    // useless Internet traffic.\r
    \r
    options {\r
            directory "/etc/namedb";\r
    \r
    // In addition to the "forwarders" clause, you can force your name\r
    // server to never initiate queries of its own, but always ask its\r
    // forwarders only, by enabling the following line:\r
    //\r
    //      forward only;\r
    \r
    // If you've got a DNS server around at your upstream provider, enter\r
    // its IP address here, and enable the line below.  This will make you\r
    // benefit from its cache, thus reduce overall DNS traffic in the\r
    Internet.\r
    /*\r
            forwarders {\r
                    127.0.0.1;\r
            };\r
    
*/\r
\r
\r
Just as the comment says, to benefit from an uplink's cache, `forwarders` can be enabled here. Under normal circumstances, a name server will recursively query the Internet looking at certain name servers until it finds the answer it is looking for. Having this enabled will have it query the uplink's name server (or name server provided) first, taking advantage of its cache. If the uplink name server in question is a heavily trafficked, fast name server, enabling this may be worthwhile.\r
\r
 **Warning:** `127.0.0.1` will ***not*** work here. Change this IP address to a name server at your uplink.\r
\r
    \r
            /*\r
    
* If there is a firewall between you and name servers you want\r
    
* to talk to, you might need to uncomment the query-source\r
    
* directive below.  Previous versions of BIND always asked\r
    
* questions using port 53, but BIND 8.1 uses an unprivileged\r
    
* port by default.\r
    
*/\r
            // query-source address * port 53;\r
    \r
            /*\r
    
* If running in a sandbox, you may have to specify a different\r
    
* location for the dumpfile.\r
    
*/\r
            // dump-file "s/named_dump.db";\r
    };\r
    \r
    // Note: the following will be supported in a future release.\r
    /*\r
    host { any; } {\r
            topology {\r
                    127.0.0.0/8;\r
            };\r
    };\r
    
*/\r
    \r
    // Setting up secondaries is way easier and the rough picture for this\r
    // is explained below.\r
    //\r
    // If you enable a local name server, don't forget to enter 127.0.0.1\r
    // into your /etc/resolv.conf so this server will be queried first.\r
    // Also, make sure to enable it in /etc/rc.conf.\r
    \r
    zone "." {\r
            type hint;\r
            file "named.root";\r
    };\r
    \r
    zone "0.0.127.IN-ADDR.ARPA" {\r
            type master;\r
            file "localhost.rev";\r
    };\r
    \r
    zone\r
    "0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.IP6.INT" {\r
            type master;\r
            file "localhost.rev";\r
    };\r
    \r
    // NB: Do not use the IP addresses below, they are faked, and only\r
    // serve demonstration/documentation purposes!\r
    //\r
    // Example secondary config entries.  It can be convenient to become\r
    // a secondary at least for the zone where your own domain is in.  Ask\r
    // your network administrator for the IP address of the responsible\r
    // primary.\r
    //\r
    // Never forget to include the reverse lookup (IN-ADDR.ARPA) zone!\r
    // (This is the first bytes of the respective IP address, in reverse\r
    // order, with ".IN-ADDR.ARPA" appended.)\r
    //\r
    // Before starting to setup a primary zone, better make sure you fully\r
    // understand how DNS and BIND works, however.  There are sometimes\r
    // unobvious pitfalls.  Setting up a secondary is comparably simpler.\r
    //\r
    // NB: Don't blindly enable the examples below. :-)  Use actual names\r
    // and addresses instead.\r
    //\r
    // NOTE!!! DragonFly runs bind in a sandbox (see named_flags in rc.conf).\r
    // The directory containing the secondary zones must be write accessible\r
    // to bind.  The following sequence is suggested:\r
    //\r
    //      mkdir /etc/namedb/s\r
    //      chown bind:bind /etc/namedb/s\r
    //      chmod 750 /etc/namedb/s\r
\r
\r
For more information on running BIND in a sandbox, see [network-dns.html#NETWORK-NAMED-SANDBOX Running named in a sandbox].\r
\r
    \r
    /*\r
    zone "example.com" {\r
            type slave;\r
            file "s/example.com.bak";\r
            masters {\r
                    192.168.1.1;\r
            };\r
    };\r
    \r
    zone "0.168.192.in-addr.arpa" {\r
            type slave;\r
            file "s/0.168.192.in-addr.arpa.bak";\r
            masters {\r
                    192.168.1.1;\r
            };\r
    };\r
    
*/\r
\r
\r
In `named.conf`, these are examples of slave entries for a forward and reverse zone.\r
\r
For each new zone served, a new zone entry must be added to `named.conf`\r
\r
For example, the simplest zone entry for `example.org` can look like:\r
\r
    \r
    zone "example.org" {\r
        type master;\r
        file "example.org";\r
    };\r
\r
\r
The zone is a master, as indicated by the `type` statement, holding its zone information in `/etc/namedb/example.org` indicated by the `file` statement.\r
\r
    \r
    zone "example.org" {\r
        type slave;\r
        file "example.org";\r
    };\r
\r
\r
In the slave case, the zone information is transferred from the master name server for the particular zone, and saved in the file specified. If and when the master server dies or is unreachable, the slave name server will have the transferred zone information and will be able to serve it.\r
\r
#### 19.11.6.3 Zone Files \r
\r
An example master zone file for `example.org` (existing within `/etc/namedb/example.org`) is as follows:\r
\r
    \r
    $TTL 3600\r
    \r
    example.org. IN SOA ns1.example.org. admin.example.org. (\r
                            5               ; Serial\r
                            10800           ; Refresh\r
                            3600            ; Retry\r
                            604800          ; Expire\r
                            86400 )         ; Minimum TTL\r
    \r
    ; DNS Servers\r
    @       IN NS           ns1.example.org.\r
    @       IN NS           ns2.example.org.\r
    \r
    ; Machine Names\r
    localhost       IN A    127.0.0.1\r
    ns1             IN A    3.2.1.2\r
    ns2             IN A    3.2.1.3\r
    mail            IN A    3.2.1.10\r
    @               IN A    3.2.1.30\r
    \r
    ; Aliases\r
    www             IN CNAME        @\r
    \r
    ; MX Record\r
    @               IN MX   10      mail.example.org.\r
\r
\r
Note that every hostname ending in a ***.*** is an exact hostname, whereas everything without a trailing ***.*** is referenced to the origin. For example, `www` is translated into `www + origin`. In our fictitious zone file, our origin is `example.org.`, so `www` would translate to `www.example.org.`\r
\r
The format of a zone file follows:\r
\r
    \r
    recordname      IN recordtype   value\r
\r
\r
The most commonly used DNS records:\r
\r
SOA:: start of zone authorityNS:: an authoritative name serverA:: A host addressCNAME:: the canonical name for an aliasMX:: mail exchangerPTR:: a domain name pointer (used in reverse DNS)\r
\r
    \r
    example.org. IN SOA ns1.example.org. admin.example.org. (\r
                            5               ; Serial\r
                            10800           ; Refresh after 3 hours\r
                            3600            ; Retry after 1 hour\r
                            604800          ; Expire after 1 week\r
                            86400 )         ; Minimum TTL of 1 day\r
\r
\r
`example.org.`:: the domain name, also the origin for this zone file.`ns1.example.org.`:: the primary/authoritative name server for this zone`admin.example.org.`:: the responsible person for this zone, email address with @ replaced. (`<[mailto:admin@example.org admin@example.org]>` becomes `admin.example.org`)`5`:: the serial number of the file. this must be incremented each time the zone file is modified. Nowadays, many admins prefer a `yyyymmddrr` format for the serial number. 2001041002 would mean last modified 04/10/2001, the latter 02 being the second time the zone file has been modified this day. The serial number is important as it alerts slave name servers for a zone when it is updated.\r
\r
    \r
    @       IN NS           ns1.example.org.\r
\r
\r
This is an `NS` entry. Every name server that is going to reply authoritatively for the zone must have one of these entries. The `@` as seen here could have been `example.org.` The `@` translates to the origin.\r
\r
    \r
    localhost       IN A    127.0.0.1\r
    ns1             IN A    3.2.1.2\r
    ns2             IN A    3.2.1.3\r
    mail            IN A    3.2.1.10\r
    @               IN A    3.2.1.30\r
\r
\r
The A record indicates machine names. As seen above, `ns1.example.org` would resolve to `3.2.1.2`. Again, the origin symbol, `@`, is used here, thus meaning `example.org` would resolve to `3.2.1.30`.\r
\r
    \r
    www             IN CNAME        @\r
\r
\r
The canonical name record is usually used for giving aliases to a machine. In the example, `www` is aliased to the machine addressed to the origin, or `example.org` (`3.2.1.30`). `CNAME`s can be used to provide alias hostnames, or round robin one hostname among multiple machines.\r
\r
    \r
    @               IN MX   10      mail.example.org.\r
\r
\r
The `MX` record indicates which mail servers are responsible for handling incoming mail for the zone. `mail.example.org` is the hostname of the mail server, and 10 being the priority of that mail server.\r
\r
One can have several mail servers, with priorities of 3, 2, 1. A mail server attempting to deliver to `example.org` would first try the highest priority MX, then the second highest, etc, until the mail can be properly delivered.\r
\r
For in-addr.arpa zone files (reverse DNS), the same format is used, except with `PTR` entries instead of `A` or `CNAME`.\r
\r
    \r
    $TTL 3600\r
    \r
    1.2.3.in-addr.arpa. IN SOA ns1.example.org. admin.example.org. (\r
                            5               ; Serial\r
                            10800           ; Refresh\r
                            3600            ; Retry\r
                            604800          ; Expire\r
                            3600 )          ; Minimum\r
    \r
    @       IN NS   ns1.example.org.\r
    @       IN NS   ns2.example.org.\r
    \r
    2       IN PTR  ns1.example.org.\r
    3       IN PTR  ns2.example.org.\r
    10      IN PTR  mail.example.org.\r
    30      IN PTR  example.org.\r
\r
\r
This file gives the proper IP address to hostname mappings of our above fictitious domain.\r
\r
### 19.11.7 Caching Name Server \r
\r
A caching name server is a name server that is not authoritative for any zones. It simply asks queries of its own, and remembers them for later use. To set one up, just configure the name server as usual, omitting any inclusions of zones.\r
\r
### 19.11.8 Running  **named**  in a Sandbox \r
\r
For added security you may want to run [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#named&section8) as an unprivileged user, and configure it to [chroot(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=chroot&section=8) into a sandbox directory. This makes everything outside of the sandbox inaccessible to the  **named**  daemon. Should  **named**  be compromised, this will help to reduce the damage that can be caused. By default, DragonFly has a user and a group called `bind`, intended for this use.\r
\r
 **Note:** Various people would recommend that instead of configuring  **named**  to `chroot`, you should run  **named**  inside a [jail(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#jail&section8). This section does not attempt to cover this situation.\r
\r
Since  **named**  will not be able to access anything outside of the sandbox (such as shared libraries, log sockets, and so on), there are a number of steps that need to be followed in order to allow  **named**  to function correctly. In the following checklist, it is assumed that the path to the sandbox is `/etc/namedb` and that you have made no prior modifications to the contents of this directory. Perform the following steps as `root`.\r
\r

* Create all directories that  **named**  expects to see:\r
      \r
      # cd /etc/namedb\r
      # mkdir -p bin dev etc var/tmp var/run master slave\r
      # chown bind:bind slave var/*./imagelib/callouts/1.png\r
  \r
  [network-dns.html#CHOWN-SLAVE ./imagelib/callouts/1.png]::  **named**  only needs write access to these directories, so that is all we give it.\r

* Rearrange and create basic zone and configuration files:\r
      \r
      # cp /etc/localtime etc./imagelib/callouts/1.png\r
      # mv named.conf etc && ln -sf etc/named.conf\r
      # mv named.root master\r
      # sh make-localhost && mv localhost.rev localhost-v6.rev master\r
      # cat > master/named.localhost\r
      $ORIGIN localhost.\r
      $TTL 6h\r
      @ IN      SOA     localhost. postmaster.localhost. (\r
                        1       ; serial\r
                        3600    ; refresh\r
                        1800    ; retry\r
                        604800  ; expiration\r
                        3600 )  ; minimum\r
        IN      NS      localhost.\r
        IN      A               127.0.0.1\r
      ^D\r
  \r
  [network-dns.html#LOCALTIME ./imagelib/callouts/1.png]:: This allows  **named**  to log the correct time to [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#syslogd&section8)\r

* Use [cp(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#cp&section1) to copy `named-xfer` in `/usr/libexec` into your sandbox.\r

* Make a `dev/null` that  **named**  can see and write to:\r
      \r
      # cd /etc/namedb/dev && mknod null c 2 2\r
      # chmod 666 null\r
  \r

* Symlink ` /var/run/ndc` to `/etc/namedb/var/run/ndc`:\r
      \r
      # ln -sf /etc/namedb/var/run/ndc /var/run/ndc\r
  \r
   **Note:** This simply avoids having to specify the `-c` option to [ndc(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ndc&section8) every time you run it. Since the contents of /var/run are deleted on boot, if this is something that you find useful you may wish to add this command to root's crontab, making use of the `@reboot` option. See [crontab(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=crontab&section=5) for more information regarding this.\r

* Configure [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#syslogd&section8) to create an extra `log` socket that  **named**  can write to. To do this, add `-l /etc/namedb/dev/log` to the `syslogd_flags` variable in `/etc/rc.conf`.\r

* Arrange to have  **named**  start and `chroot` itself to the sandbox by adding the following to `/etc/rc.conf`:\r
      \r
      named_enable="YES"\r
      named_flags="-u bind -g bind -t /etc/namedb /etc/named.conf"\r
  \r
   **Note:** Note that the configuration file `***/etc/named.conf***` is denoted by a full pathname ***relative to the sandbox***, i.e. in the line above, the file referred to is actually `/etc/namedb/etc/named.conf`.\r
\r
The next step is to edit `/etc/namedb/etc/named.conf` so that  **named**  knows which zones to load and where to find them on the disk. There follows a commented example (anything not specifically commented here is no different from the setup for a DNS server not running in a sandbox):\r
\r
    \r
    options {\r
            directory "/";./imagelib/callouts/1.png\r
            named-xfer "/bin/named-xfer";./imagelib/callouts/2.png\r
            version "";         // Don't reveal BIND version\r
            query-source address * port 53;\r
    };\r
    // ndc control socket\r
    controls {\r
            unix "/var/run/ndc" perm 0600 owner 0 group 0;\r
    };\r
    // Zones follow:\r
    zone "localhost" IN {\r
            type master;\r
            file "master/named.localhost";./imagelib/callouts/3.png\r
            allow-transfer { localhost; };\r
            notify no;\r
    };\r
    zone "0.0.127.in-addr.arpa" IN {\r
            type master;\r
            file "master/localhost.rev";\r
            allow-transfer { localhost; };\r
            notify no;\r
    };\r
    zone "0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.ip6.int" {\r
        type master;\r
        file "master/localhost-v6.rev";\r
        allow-transfer { localhost; };\r
        notify no;\r
    };\r
    zone "." IN {\r
            type hint;\r
            file "master/named.root";\r
    };\r
    zone "private.example.net" in {\r
            type master;\r
            file "master/private.example.net.db";\r
        allow-transfer { 192.168.10.0/24; };\r
    };\r
    zone "10.168.192.in-addr.arpa" in {\r
            type slave;\r
            masters { 192.168.10.2; };\r
            file "slave/192.168.10.db";./imagelib/callouts/4.png\r
    };\r
\r
\r
[network-dns.html#DIRECTORY ./imagelib/callouts/1.png]:: The `directory` statement is specified as `/`, since all files that  **named**  needs are within this directory (recall that this is equivalent to a ***normal*** user's `/etc/namedb`.[network-dns.html#NAMED-XFER ./imagelib/callouts/2.png]:: Specifies the full path to the `named-xfer` binary (from  **named** 's frame of reference). This is necessary since  **named**  is compiled to look for `named-xfer` in `/usr/libexec` by default.[network-dns.html#MASTER ./imagelib/callouts/3.png]:: Specifies the filename (relative to the `directory` statement above) where  **named**  can find the zonefile for this zone.[network-dns.html#SLAVE ./imagelib/callouts/4.png]:: Specifies the filename (relative to the `directory` statement above) where  **named**  should write a copy of the zonefile for this zone after successfully transferring it from the master server. This is why we needed to change the ownership of the directory `slave` to `bind` in the setup stages above.\r
\r
After completing the steps above, either reboot your server or restart [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#syslogd&section8) and start [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=named&section=8), making sure to use the new options specified in `syslogd_flags` and `named_flags`. You should now be running a sandboxed copy of  **named** !\r
\r
### 19.11.9 Security \r
\r
Although BIND is the most common implementation of DNS, there is always the issue of security. Possible and exploitable security holes are sometimes found.\r
\r
It is a good idea to subscribe to [CERT](http://www.cert.org/) and [../handbook/eresources.html#ERESOURCES-MAIL freebsd-security-notifications] to stay up to date with the current Internet and FreeBSD security issues.\r
\r
 **Tip:** If a problem arises, keeping sources up to date and having a fresh build of named would not hurt.\r
\r
### 19.11.10 Further Reading \r
\r
BIND/named manual pages: [ndc(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ndc&section8) [named(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=named&section=8) [named.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command=named.conf&section=5)\r
\r

* [Official ISC Bind Page](http://www.isc.org/products/BIND/)\r

* [BIND FAQ](http://www.nominum.com/getOpenSourceResource.php?id=6)\r

* [O'Reilly DNS and BIND 4th Edition](http://www.oreilly.com/catalog/dns4/)\r

* [RFC1034 - Domain Names - Concepts and Facilities](ftp://ftp.isi.edu/in-notes/rfc1034.txt)\r

* [RFC1035 - Domain Names - Implementation and Specification](ftp://ftp.isi.edu/in-notes/rfc1035.txt)\r
\r
\r
\r
CategoryHandbook\r
CategoryHandbook-advancednetworking\r
\r
[http%3A%2F%2Ffloopityjoop.com%2FLast+Name+Meanings.html Last Name Meanings]\r