named.conf(4)

NAME

named.conf — configuration file for NameDaemon

SYNOPSIS

/etc/named.conf

DESCRIPTION

BIND 9 configuration is broadly similar to BIND 8.x. However, there are a few new areas of configuration, such as views. BIND 8.x configuration files should work with few alterations in BIND 9.2, although more complex configurations need to be reviewed to check if they can be more efficiently implemented using the new features implemented in BIND 9.2. BIND 4.9.7 configuration files can be converted to the BIND 9.2 format using the shell script, /usr/bin/named-bootconf.sh.

Configuration File Elements

The following configuration elements are used in BIND 9.2 configuration file documentation:

acl_name: The name of an address_match_list as defined by the acl statement.
address_match_list: A list of one or more ip_addr, ip_prefix, key_id, or acl_name elements.
domain_name: A quoted string which will be used as a DNS name, for example my.test.domain.
dotted_decimal: One or more integers valued 0 through 255 separated only by dots (.), such as 123, 45.67 or 89.123.45.67.
ip4_addr: An IPv4 address with exactly four elements in dotted_decimal notation.
ip6_addr: An IPv6 address, such as fe80::200:f8ff:fe01:9742.
ip_addr: An ip4_addr or ip6_addr.
ip_port: An IP port number. This is limited to 0 through 65535, with values below 1024 typically restricted to root-owned processes. In some cases, an asterisk (*) character can be used as a placeholder to select a random high-numbered port.
ip_prefix: An IP network specified as an ip_addr, followed by a slash (/) and then the number of bits in the netmask. Trailing zeros in ip_addr may be omitted. For example, 127/8 is the network 127.0.0.0 with netmask 255.0.0.0 and 1.2.3.0/28 is network 1.2.3.0 with netmask 255.255.255.240.
key_id: A domain_name representing the name of a shared key, to be used for transaction security.
key_list: A list of one or more key_ids, separated by semicolons and ending with a semicolon.
number: A non-negative 32-bit unsigned integer (i.e., a number between 0 and 4294967295, inclusive). Its acceptable value might further be limited by the context in which it is used.
path_name: A quoted string which will be used as a pathname, such as zones/master/my.test.domain.
size_spec: A number, the word "unlimited", or the word "default". An unlimited size_spec requests unlimited use, or the maximum available amount. A default size_spec uses the limit that was in force when the server was started. A number can optionally be followed by a scaling factor: "K" or "k" for kilobytes, "M" or "m" for megabytes, and "G" or "g" for gigabytes, which scale by 1024, 1024*1024, and 1024*1024*1024 respectively. The value must be representable as a 64-bit unsigned integer (0 to 18446744073709551615, inclusive). Using "unlimited" is the best way to set a really large number.
yes_or_no: Either "yes" or "no". The words "true" and "false" are also accepted, as are the numbers 1 and 0.
dialup_option: One of yes, no, notify, notify-passive, refresh or passive. When used in a zone, notify-passive, refresh, and passive are restricted to slave and stub zones.

Address Match Lists Syntax

address_match_list3D address_match_list_element ;
 [ address_match_list_element; ... ] 
address_match_list_element3D [ ! ] (ip_address [/length] | 
 key key_id | acl_name | { address_match_list } ) 

Address Match Lists Definition and Usage

Address match lists are primarily used to determine access control for various server operations. They are also used to define priorities for querying other nameservers and to set the addresses on which named will listen for queries. The elements which constitute an address match list may be any of the following:

an IP address (IPv4 or IPv6)
an IP prefix (in the `/'-notation)
a key ID, as defined by the key statement
the name of an address match list previously defined with the acl statement
a nested address match list enclosed in braces

Elements can be negated with a leading exclamation mark (!). The match list names of any, none, localhost, and localnets are predefined. For more information on these match list names, refer to the acl statement section. The addition of the key clause made the name of this syntactic element something of a misnomer, since security keys can be used to validate access without regard to a host or network address. However, the term "address match list" is still being used.

When a given IP address or prefix is compared to an address match list, the list is traversed in order until an element matches. The interpretation of a match depends on whether the list is being used for access control, defining listen-on ports and whether the element was negated. When used as an access control list, a non-negated match allows access and a negated match denies access. If there is no match, access is denied.

The clauses allow-notify, allow-query, allow-transfer, allow-update, and blackhole which can be specified in the options and/or zone use the address match lists. Similarly, the listen-on option causes the server not to accept queries on any of the machine's addresses which do not match the list.

Because of the first-match aspect of the algorithm, an element that defines a subset of another element in the list should come before the broader element, regardless of whether either is negated. For example, in 1.2.3/24; ! 1.2.3.13; the 1.2.3.13 element is not of any use because the algorithm will match any lookup for 1.2.3.13 to the 1.2.3/24 element. Using ! 1.2.3.13; 1.2.3/24 fixes that problem by having 1.2.3.13 blocked by the negation but all other 1.2.3.* hosts fall through.

Comment Syntax

Comments in BIND 9.2 configuration file can be written in C, C++, or shell/perl constructs.

WARNING: Unlike a zone file, you cannot use semicolon (;) character to start a comment in the BIND 9.2 configuration file. The semicolon indicates the end of a configuration statement.

Configuration File Grammar

A BIND 9.2 configuration file consists of statements and comments. Statements end with a semicolon. Statements and comments are the only elements that can appear without enclosing braces. Many statements contain a block of substatements, which are terminated with a semicolon. The following statements are supported:

acl: defines a named IP address matching list, for access control and other uses.
controls: declares control channels to be used by the rndc utility.
include: includes a file.
key: specifies key information for use in authentication and authorization using TSIG.
logging: specifies what the server logs, and where the log messages are sent.
options: controls global server configuration options and sets defaults for other statements.
server: sets certain configuration options on a per-server basis.
trusted-keys: defines trusted DNSSEC keys.
view: defines a view.
zone: defines a zone.

The logging and options statements may occur only once per configuration.

acl Statement Grammar

acl acl-name {
   address_match_list 
}; 

acl Statement Definition and Usage

The acl statement assigns a symbolic name to an address match list. It gets its name from the primary use of address match lists: "Access Control Lists" (ACLs). Note that an address match list's name must be defined with acl before it can be used elsewhere; no forward references are allowed. The following ACLs are built-in:

any: Matches all hosts.
none: Matches no hosts.
localhost: Matches the IPv4 addresses of all network interfaces on the system.
localnets: Matches any host on an IPv4 network for which the system has an interface.

The localhost and localnets ACLs do not currently support IPv6 (i.e., localhost does not match the host's IPv6 addresses, and localnets does not match the host's attached IPv6 networks) due to the lack of a standard method of determining the complete set of local IPv6 addresses for a host.

controls Statement Grammar

controls { 
  inet (ip_addr| * ) [port ip_port] allow { address_match_list } 
     keys { key_list }; 
  [ inet ...; ] 
}; 

controls Statement Definition and Usage

The controls statement declares control channels to be used by system administrators to affect the operation of the local nameserver. These control channels are used by the rndc utility to send commands to and retrieve non-DNS results from a nameserver.

An inet control channel is a TCP/IP socket accessible to the Internet, created at the specified ip_port on the specified ip_addr. If no port is specified, port 953 is used by default. * cannot be used for ip_port.

The ability to issue commands over the control channel is restricted by the allow and keys clauses. Connections to the control channel are permitted based on the address permissions in address_match_list. key_id members of the address_match_list are ignored, and instead are interpreted independently based on the key_list. Each key_id in the key_list is allowed to be used to authenticate commands and responses given over the control channel by digitally signing each message between the server and a command client. All commands to the control channel must be signed by one of its specified keys to be honored.

If no controls statement is present, named will set up a default control channel listening on the loopback address 127.0.0.1 and its IPv6 counterpart ::1. In this case, and also when the controls statement is present but does not have a keys clause, named will attempt to load the command channel key from the file rndc.key in /etc. To create a rndc.key file, run rndc-confgen -a. The rndc.key feature was implemented to ease the transition of systems from BIND 8, which did not have digital signatures on its command channel messages and thus did not have a keys clause.

Since the rndc.key feature is only intended to allow the backward-compatible usage of BIND 8 configuration files, this feature does not have a high degree of configurability. You cannot easily change the key name or the size of the secret, so you should make a rndc.conf with your own key if you wish to change them. The rndc.key file also has its permissions set such that only the owner of the file (the user that named is running as) can access it. If you desire greater flexibility in allowing other users to access rndc commands, then you need to create an rndc.conf and make it group-readable by a group that contains the users who should have access.

The UNIX control channel type of BIND 8 is not supported in BIND 9.2, and is not expected to be added in future releases. If it is present in the controls statement from a BIND 8 configuration file, it is ignored and a warning is logged.

include Statement Grammar

include filename;

include Statement Definition and Usage

The include statement inserts the specified file at the point where the include statement is encountered. The include statement facilitates the administration of configuration files by permitting the reading or writing of some things but not others. For example, the statement could include private keys that are readable only by a nameserver.

key Statement Grammar

key key_id { 
   algorithm string; 
   secret string; 
}; 

key Statement Definition and Usage

The key statement defines a shared secret key for use with TSIG. The key statement can occur at the top level of the configuration file or inside a view statement. Keys defined in top-level key statements can be used in all views. Keys intended for use in a controls statement must be defined at the top level.

The key_id, also known as the key name, is a domain name uniquely identifying the key. It can be used in a server statement to sign requests with this key or in address match lists to verify that incoming requests have been signed with a key matching this name, algorithm, and secret.

The algorithm_id is a string that specifies a security/authentication algorithm. "hmac-md5" is the only algorithm which is currently supported with TSIG authentication. The secret_string is a base-64 encoded secret string to be used by the algorithm.

logging Statement Grammar

logging {
   [ channel channel_name {
     ( file path name
         [ versions ( number | unlimited ) ]
         [ size size spec ]
       | syslog syslog_facility
       | stderr
       | null );
     [ severity (critical | error | warning | notice |
                 info | debug [ level ] | dynamic ); ]
     [ print-category yes or no; ]
     [ print-severity yes or no; ]
     [ print-time yes or no; ]
   }; ]
   [ category category_name {
     channel_name ; [ channel_name ; ... ]
   }; ]
   ...
};

logging Statement Definition and Usage

The logging statement configures a wide variety of logging options for the nameserver. Its channel phrase associates output methods, format options and severity levels with a name that can be used with the category phrase to select how various classes of messages are logged.

Only one logging statement is used to define any number of channels and categories. If there is no logging statement, the logging configuration will be:

logging {
     category "unmatched" { "null"; };
     category "default" { "default_syslog"; "default_debug"; };
};

In BIND 9.2, the logging configuration is established only when the entire configuration file has been parsed. In BIND 8, it was established as soon as the logging statement was parsed. When the server starts up, all logging messages related to syntax errors in the configuration file go to the default channels, or to standard error if the -g option was specified.

The channel Phrase

All log output goes to one or more user defined or pre-defined channels; Every channel definition must include a destination clause that says whether messages selected for the channel go to a file, or to a particular syslog facility, or to the standard error stream, or are discarded. It can optionally also limit the message severity level that will be accepted by the channel (the default is info) , and whether to include a named-generated time stamp, the category name and/or severity level (the default is not to include any). The channel options are irrelevant when the null destination clause discards all messages sent to the channel.

The file destination clause directs the channel to a disk file. It can include limitations both on file size limit and number of versions of the file, saved each time the file is opened.

If you use the versions log file option, then named will retain that many backup versions of the file by renaming them when opening.

For example, if you choose to keep three old versions of the file lamers.log, then just before it is opened:

lamers.log.1 is renamed to lamers.log.2,
lamers.log.0 is renamed to lamers.log.1, and
lamers.log is renamed to lamers.log.0.

Use versions unlimited; if you do not want to limit the number of versions. If a size option is associated with the log file, then renaming is only done when the file being opened exceeds the indicated size. No backup versions are kept by default; any existing log file is simply appended.

The size option for files is used to limit log growth. If the file size exceeds the limit, then named will stop writing to the file unless it has a versions option associated with it. If backup versions are kept, the files are rolled as described above and a new file is opened. If there is no versions option, no more data will be written to the log until the log file is removed or truncated to less than the maximum size. The default behavior is not to limit the size of the file.

Example usage of the size and versions options:

channel "an_example_channel" {
    file "example.log" versions 3 size 20m;
    print-time yes;
    print-category yes;
};

The syslog destination clause directs the channel to the system log. Its argument is a syslog facility as described in the syslog(3C) man page. The syslog(3C) man page describes how syslog will handle messages sent to this facility. If you have a system which uses a very old version of syslog that uses only two arguments to the openlog() function, then syslog destination clause is ignored.

The severity clause works like syslog's "priorities", except that they can also be used if you are writing straight to a file rather than using syslog. Messages which are not at least of the severity level given will not be selected for the channel; messages of higher severity levels will be accepted. If you are using syslog, then the syslog.conf priorities will also determine what eventually passes through.

For example, defining a channel facility and severity as daemon and debug but only logging daemon.warning via syslog.conf will cause messages of severity info and notice to be dropped. If the situation were reversed, with named writing messages of only warning or higher, then syslogd would print all messages it received from the channel.

The stderr destination clause directs the channel to the server's standard error stream. This is intended for use when the server is running as a foreground process, for example when debugging the configuration.

The server can supply extensive debugging information when it is in debugging mode. If the server's global debug level is greater than zero, then debugging mode will be active. The global debug level is set either by starting the named server with the -d flag followed by a positive integer, or by running rndc trace. The global debug level can be set to zero, and debugging mode turned off, by running rndc notrace. All debugging messages in the server have a debug level, and higher debug levels give more detailed output. For example:

channel "specific_debug_level" {
    file "foo";
    severity debug 3;
};

In the above example, channels that specify a particular debug severity will get debugging output of level 3 or less any time the server is in debugging mode, regardless of the global debugging level. Channels with dynamic severity use the server's global level to determine what messages to print.

If print-time has been turned on, then the date and time will be logged. print-time may be specified for a syslog channel, but is usually pointless since syslog also prints the date and time. If print-category is requested, then the category of the message will be logged as well. Finally, if print-severity is ON, then the severity level of the message will be logged. The print- options may be used in any combination, and will always be printed in the order: time, category, severity. Here is an example where all three print- options are ON:

28-Feb-2000 15:05:32.863 general: notice: running

There are four pre-defined channels that are used for named's default logging as follows:

channel "default_syslog" {
    syslog daemon;                      // send to syslog's daemon
                                        // facility
    severity info;                      // only send priority info
                                        // and higher
};

channel "default_debug" {
    file "named.run";                   // write to named.run in
                                        // the working directory
                                        // Note: stderr is used instead
                                        // of "named.run"
                                        // if the server is started
                                        // with the '-f' option.
    severity dynamic;                   // log at the server's
                                        // current debug level
};

channel "default_stderr" {              // writes to stderr
    stderr;
    severity info;                      // only send priority info
                                        // and higher
};

channel "null" {
   null;                                // toss anything sent to
                                        // this channel
};

The default_debug channel has the special property that it only produces output when the server's debug level is a non-zero value. It normally writes to a file named.run in the server's working directory.

For security reasons, when the -u command line option is used, the named.run file is created only after named has changed to the new UID, and any debug output is generated while named is starting up and still running as root is discarded. If you need to capture this output, you must run the server with the -g option and redirect standard error to a file.

Once a channel is defined, it cannot be redefined. Thus you cannot alter the built-in channels directly, but you can modify the default logging by pointing categories at channels you have defined.

The category Phrase

Pre-defined categories allow the administrator to fine-tune what messages they want to log and where they want to log those messages to. If a list of channels is not specified for a category, then log messages in that category will be sent to the default category instead. If you do not specify a default category, the following category is used:

category "default" { "default_syslog"; "default_debug"; };

For example, if you want to log security events to a file and also wish to keep the default logging behavior, you need to specify the following:

channel "my_security_channel" {
    file "my_security_file";
    severity info;
};

category "security" {
    "my_security_channel";
    "default_syslog";
    "default_debug";
};

To discard all messages in a category, specify the null channel as follows:

category "xfer-out" { "null"; };
category "notify" { "null"; };

Following are the available categories and brief descriptions of the types of log information they contain. More categories may be added in future BIND releases.

default: The default category defines the logging options for those categories where no specific configuration has been defined.
general: The catch-all. All unclassified categories belong to this category.
database: Messages relating to the databases used internally by the name server to store zone and cache data.
security: Approval and denial of requests.
config: Configuration file parsing and processing.
resolver: DNS resolution, such as recursive lookups performed on behalf of clients by a caching name server.
xfer-in: Zone transfers the server is receiving.
xfer-out: Zone transfers the server is sending.
notify: The NOTIFY protocol
client: Processing of client requests
unmatched: Messages that named was unable to determine the class of or for which there was no matching view. A one-line summary is also logged to the client category. This category is best sent to a file or stderr, by default it is sent to the null channel.
network: Network operations
update: Dynamic updates
queries: Enable query logging
dispatch: Dispatching of incoming packets to the server modules where they are to be processed.
dnssec: DNSSEC and TSIG protocol processing.
lame-servers: Lame servers. These are misconfigurations in remote servers, discovered by BIND 9 when trying to query those servers during resolution.

lwres Statement Grammar

This is the grammar of the lwres statement in the named.conf file:

lwres {
    [ listen-on { ip_addr [port ip_port] ; [ ip_addr [port ip_port] ;
        ... ] }; ]
    [ view view_name; ]
    [ search { domain_name ; [ domain_name ; ... ] }; ]
    [ ndots number; ]
};

lwres Statement Definition and Usage

The lwres statement configures the name server to also act as a lightweight resolver server. There may be be multiple lwres statements configuring lightweight resolver servers with different properties. The listen-on statement specifies a list of addresses and ports that a lightweight resolver daemon should accept requests on. If no port is specified, port 921 is used. If this statement is omitted, requests will be accepted on 127.0.0.1, port 921.

The view statement binds this instance of a lightweight resolver daemon to a view in the DNS namespace, so that the response will be constructed in the same manner as a normal DNS query matching this view. If this statement is omitted, the default view is used, and if there is no default view, an error is triggered.

The search statement is equivalent to the search statement in /etc/resolv.conf. It provides a list of domains which are appended to relative names in queries.

The ndots statement is equivalent to the ndots statement in /etc/resolv.conf. It indicates the minimum number of dots in a relative domain name that should result in an exact match lookup before search path elements are appended.

options Statement Grammar

This is the grammar of the options statement in the named.conf file:

options {
    [ version version_string; ]
    [ directory path_name; ]
    [ tkey-domain domainname; ]
    [ tkey-dhkey key_name key_tag; ]
    [ dump-file path_name; ]
    [ pid-file path_name; ]
    [ statistics-file path_name; ]
    [ zone-statistics yes_or_no; ]
    [ auth-nxdomain yes_or_no; ]
    [ dialup dialup_option; ]
    [ minimal-responses yes_or_no; ]
    [ notify yes_or_no | explicit; ]
    [ recursion yes_or_no; ]
    [ forward ( only | first ); ]
    [ forwarders { ip_addr [port ip_port] ;
                 [ ip_addr [port ip_port] ; ... ] }; ]
    [ allow-notify { address_match_list }; ]
    [ allow-query { address_match_list }; ]
    [ allow-transfer { address_match_list }; ]
    [ allow-recursion { address_match_list }; ]
    [ allow-v6-synthesis { address_match_list }; ]
    [ blackhole { address_match_list }; ]
    [ listen-on [ port ip_port ] { address_match_list }; ]
    [ listen-on-v6 [ port ip_port ] { address_match_list }; ]
    [ query-source [ address ( ip_addr | * ) ]
                         [ port ( ip_port | * ) ]; ]
    [ max-transfer-time-in number; ]
    [ max-transfer-time-out number; ]
    [ max-transfer-idle-in number; ]
    [ max-transfer-idle-out number; ]
    [ tcp-clients number; ]
    [ recursive-clients number; ]
    [ serial-query-rate number; ]
    [ transfer-format ( one-answer | many-answers ); ]
    [ transfers-in  number; ]
    [ transfers-out number; ]
    [ transfers-per-ns number; ]
    [ transfer-source (ip4_addr | *) [port ip_port] ; ]
    [ transfer-source-v6 (ip6_addr | *) [port ip_port] ; ]
    [ notify-source (ip4_addr | *) [port ip_port] ; ]
    [ notify-source-v6 (ip6_addr | *) [port ip_port] ; ]
    [ also-notify { ip_addr [port ip_port] ;
                     [ ip_addr [port ip_port] ; ... ] }; ]
    [ coresize size_spec ; ]
    [ datasize size_spec ; ]
    [ files size_spec ; ]
    [ stacksize size_spec ; ]
    [ cleaning-interval number; ]
    [ heartbeat-interval number; ]
    [ interface-interval number; ]
    [ sortlist { address_match_list }];
    [ lame-ttl number; ]
    [ max-ncache-ttl number; ]
    [ max-cache-ttl number; ]
    [ sig-validity-interval number ; ]
    [ use-ixfr yes_or_no ; ]
    [ provide-ixfr yes_or_no; ]
    [ request-ixfr yes_or_no; ]
    [ min-refresh-time number ; ]
    [ max-refresh-time number ; ]
    [ min-retry-time number ; ]
    [ max-retry-time number ; ]
    [ port ip_port; ]
    [ additional-from-auth yes_or_no ; ]
    [ additional-from-cache yes_or_no ; ]
    [ random-device path_name ; ]
    [ max-cache-size size_spec ; ]
    [ match-mapped-addresses yes_or_no; ]
    [ edns yes_or_no; ]
};

options Statement Definition and Usage

The options statement sets up global options to be used by BIND. This statement may appear only once in a configuration file. If more than one occurrence is found, the first occurrence determines the actual options used, and a warning will be generated. If there is no options statement, an options block with each option set to its default will be used.

version: The version that the server should report via a query of name version.bind in class CHAOS. Default is the real version number of this server.
directory: The working directory of the server. Any non-absolute pathnames in the configuration file will be taken as relative to this directory. The default location for most server output files (e.g. named.run) is this directory. If a directory is not specified, the working directory defaults to (.), the directory from which the server was started. The directory specified should be an absolute path.
tkey-domain: The domain appended to the names of all shared keys generated with TKEY. When a client requests a TKEY exchange, it may or may not specify the desired name for the key. If present, the name of the shared key will be client specified part + tkey-domain. Otherwise, the name of the shared key will be random hex digits + tkey-domain. In most cases, the domain name should be the server's domain name.
tkey-dhkey: The Diffie-Hellman key used by the server to generate shared keys with clients using the Diffie-Hellman mode of TKEY. The server must be able to load the public and private keys from files in the working directory. In most cases, the keyname should be the server's host name.
dump-file: The pathname of the file to which the server dumps the database with rndc dumpdb. Default is named_dump.db.
pid-file: The pathname of the file in which the server writes its process ID. If not specified, the default pathname /var/run/named.pid The pid-file is used by programs that need to send signals to the running nameserver.
statistics-file: The pathname of the file in which the server appends statistics using rndc stats. Default is named.stats in the server's current directory.
port: The UDP/TCP port number the server uses for receiving and sending DNS protocol traffic. Default is 53. This option is mainly intended for server testing; a server using a port other than 53 will not be able to communicate with the global DNS.
random-device: The source of entropy to be used by the server. Entropy is primarily needed for DNSSEC operations, such as TKEY transactions and dynamic update of signed zones. This option specifies the device (or file) from which to read entropy. If this is a file, operations requiring entropy will fail when the file has been exhausted. The default value is /dev/random (or equivalent) when present, and none otherwise. The random-device option takes effect during the initial configuration load at server startup time and is ignored on subsequent reloads.

Boolean Options

auth-nxdomain

If "yes", then the AA bit is always set on NXDOMAIN responses, even if the server is not actually authoritative. The default is "no". If you are using an old version of BIND, you might need to set this option to "yes".

dialup

If "yes", then the server treats all zones as if they are doing zone transfers across a dial on demand dialup link, which can be brought up by traffic originating from this server. This has different effects according to zone type and concentrates the zone maintenance so that it all happens in a short interval, once every heartbeat-interval and hopefully during the one call. It also suppresses some of the normal zone maintenance traffic. The default is "no". The dialup option may also be specified in the view and zone statements, in which case, it overrides the global dialup option.

If the zone is a master zone then the server will send out a NOTIFY request to all the slaves. This will trigger the zone serial number check in the slave (provided, it supports NOTIFY) allowing the slave to verify the zone while the connection is active.

If the zone is a slave or stub zone, then the server will suppress the regular "zone up to date" (refresh) queries and only perform them when the heartbeat-interval expires in addition to sending NOTIFY requests.

Finer control can be achieved by using notify which only sends NOTIFY messages, notify-passive which sends NOTIFY messages and suppresses the normal refresh queries, refresh which suppresses normal refresh processing and sends refresh queries when the heartbeat-interval expires and passive which just disables normal refresh processing.

minimal-responses

If "yes", then the server will only add records to the authority when generating responses and additional data sections when they are required (e.g. delegations, negative responses). This may improve the performance of the server. Default is "no".

notify

If "yes" (the default), DNS NOTIFY messages are sent when a zone for which the server is authoritative, changes. The messages are sent to the servers listed in the zone's NS records (except the master server identified in the SOA MNAME field), and to any servers listed in the also-notify option. If explicit, notify messages are sent only to servers explicitly listed using also-notify. If "no", no notify messages are sent.

The notify option may also be specified in the zone statement, in which case it overrides the notify specified in the options statement. It needs to be turned off only when the slaves crash.

recursion

If "yes", and a DNS query requests recursion, then the server will attempt to answer the query. If recursion is off and the server does not know the answer, it will return a referral response. The default is "yes". Note that setting recursion to "no" does not prevent clients from getting data from the server's cache; it only prevents new data from being cached as an effect of client queries. Caching may still occur as an effect of the server's internal operation, such as NOTIFY address lookups.

zone-statistics

If "yes", the server will, by default, collect statistical data on all zones in the server. These statistics may be accessed using rndc stats, which will dump them to the file listed in the statistics-file.

provide-ixfr

clause determines whether the local server, acting as master, will respond with an incremental zone transfer when the given remote server, a slave, requests it. If set to "yes", incremental transfer will be provided whenever possible. If set to "no", all transfers to the remote server will be non-incremental. If not set, the value of the provide-ixfr option in the view or global options block is used as a default.

request-ixfr

The request-ixfr clause determines whether the local server, acting as a slave, will request incremental zone transfers from the given remote server, a master. If not set, the value of the request-ixfr option in the view or global options block is used as a default.

additional-from-auth, additional-from-cache

These options control the behavior of an authoritative server when answering queries which have additional data, or when following CNAME and DNAME chains.

When both of these options are set to "yes" (the default) and a query is being answered from authoritative data (a zone configured into the server), the additional data section of the reply will be filled in using data from other authoritative zones and from the cache. In some situations this is undesirable, such as when there is concern over the correctness of the cache, or in servers where slave zones may be added and modified by untrusted third parties. Also, avoiding the search for this additional data will speed up server operations at the possible expense of additional queries to resolve what would otherwise be provided in the additional section. For example, if a query asks for an MX record for host foo.example.com, and the record found is "MX 10 mail.example.net", normally the address records (A, A6, and AAAA) for mail.example.net will be provided as well, if known. Set these options to "no" to disable this behavior. These options are intended for use in authoritative-only servers, or in authoritative-only views. Attempts to set them to "no" without also specifying recursion "no" will cause the server to ignore the options and log a warning message.

Specifying additional-from-cache no actually disables the use of the cache not only for additional data lookups but also when looking up the answer. This is usually the desired behavior in an authoritative-only server where the correctness of the cached data is an issue.

When a name server is non-recursively queried for a name that is not below the apex of any served zone, it normally answers with an "upwards referral" to the root servers or the servers of some other known parent of the query name.

Since the data in an upwards referral comes from the cache, the server will not be able to provide upwards referrals when additional-from-cache no has been specified. Instead, it will respond to such queries with REFUSED. This should not cause any problems since upwards referrals are not required for the resolution process.

match-mapped-addresses

If "yes", then an IPv4-mapped IPv6 address will match any address match list entries that match the corresponding IPv4 address.

edns

(Extended DNS) clause determines whether the local server will attempt to use EDNS when communicating with any remote server. Default is "yes". If "no" then EDNS will not be used when communicating with any remote server. Then, to enable the EDNS feature for a server, the customer needs to set edns yes in the server statement for that server.

Forwarding

The forwarding facility can be used to create a large site-wide cache on a few servers, reducing traffic over links to external nameservers. It can also be used to allow queries by servers that do not have direct access to the Internet, but wish to look up exterior names anyway. Forwarding occurs only on those queries for which the server is not authoritative and does not have the answer in its cache.

forward

This option is useful only if the forwarders list is not empty. The default value first, causes the server to query the forwarders first, and if that is unable to answer the question, the server will then look for the answer itself. If only is specified, the server will only query the forwarders.

forwarders

Specifies the IP addresses to be used for forwarding. The default is the empty list (no forwarding).

Forwarding can also be configured on a per-domain basis, allowing for the global forwarding options to be overridden in a variety of ways. You can set a particular domain to use different forwarders, or have a different forward only/first: behavior, or not forward at all.

Access Control

Access to the server can be restricted based on the IP address of the requesting system.

allow-notify: Specifies which hosts are allowed to notify slaves of a zone change in addition to the zone masters. allow-notify may also be specified in the zone statement, in which case it overrides the options allow-notify statement. It is only meaningful for a slave zone. If not specified, the default is to process notify messages only from a zone's master.
allow-query: Specifies which hosts are allowed to ask ordinary questions. allow-query may also be specified in the zone statement, in which case it overrides the options allow-query statement. If not specified, the default is to allow queries from all hosts.
allow-recursion: Specifies which hosts are allowed to make recursive queries through this server. If not specified, the default is to allow recursive queries from all hosts. Note that disallowing recursive queries for a host does not prevent the host from retrieving data that is already in the server's cache.
allow-v6-synthesis: Specifies the hosts which need to receive synthetic responses to IPv6 queries. See below for more details.
allow-transfer: Specifies the hosts which are allowed to receive zone transfers from the server. allow-transfer may also be specified in the zone statement, in which case it overrides the options allow-transfer statement. If not specified, the default is to allow transfers from all hosts.
blackhole: Specifies a list of addresses that the server will not accept queries from or use to resolve a query. Queries from these addresses will not be responded to. Default is none.

Interfaces

The interfaces and ports that the server will answer queries from, may be specified using the listen-on option. listen-on takes an optional port, and an address_match_list The server will listen on all interfaces allowed by the address match list. If a port is not specified, port 53 will be used.

Multiple listen-on statements are allowed. For example,

listen-on { 5.6.7.8; };
listen-on port 1234 { !1.2.3.4; 1.2/16; };

will enable the nameserver on port 53 for the IP address 5.6.7.8, and on port 1234 of an address on the machine in net 1.2 that is not 1.2.3.4. If no listen-on is specified, the server will listen on port 53 on all interfaces. The listen-on-v6 option is used to specify the ports on which the server will listen for incoming queries sent using IPv6.

The server does not bind a separate socket to each IPv6 interface address as it does for IPv4. Instead, it always listens on the IPv6 wildcard address. Therefore, the only values allowed for the address_match_list argument to the listen-on-v6 statement are:

{ any; }
and
{ none;}

Multiple listen-on-v6 options can be used to listen on multiple ports:

listen-on-v6 port 53 { any; };
listen-on-v6 port 1234 { any; };

To make the server not to listen on any IPv6 address, use

listen-on-v6 { none; };

If no listen-on-v6 statement is specified, the server will not listen on any IPv6 address.

Query Address

If the server is unable to answer a question, it will query other nameservers. query-source specifies the address and port used for such queries. For queries sent over IPv6, there is a separate query-source-v6 option. If address is * or is omitted, a wildcard IP address (INADDR_ANY) will be used. If port is * or is omitted, a random unprivileged port will be used. Default address and port are:

query-source address * port *;
query-source-v6 address * port *

Note: The address specified in the query-source option is used for both UDP and TCP queries, but the port applies only to UDP queries. TCP queries always use a random unprivileged port.

Zone Transfers

BIND has mechanisms in place to facilitate zone transfers and set limits on the amount of load that transfers place on the system. The following options apply to zone transfers.

also-notify: Defines a global list of IP addresses of name servers that are also sent NOTIFY messages whenever a fresh copy of the zone is loaded, in addition to the servers listed in the zone's NS records. This helps to ensure that copies of the zones will quickly converge on stealth servers. If an also-notify list is given in a zone statement, it will override the options also-notify statement. When a zone notify statement is set to "no", the IP addresses in the global also-notify list will not be sent NOTIFY messages for that zone. The default is the empty list (no global notification list).
max-transfer-time-in: Inbound zone transfers running longer than this many minutes will be terminated. Default is 120 minutes (2 hours).
max-transfer-idle-in: Inbound zone transfers making no progress in this many minutes will be terminated. Default is 60 minutes (1 hour).
max-transfer-time-out: Outbound zone transfers running longer than this many minutes will be terminated. Default is 120 minutes (2 hours).
max-transfer-idle-out: Outbound zone transfers making no progress in this many minutes will be terminated. The default is 60 minutes (1 hour).
serial-query-rate: Slave servers will periodically query master servers to find out if zone serial numbers have changed. Each such query uses a minute amount of the slave server's network bandwidth. To limit the amount of bandwidth used, BIND 9.2 limits the rate at which queries are sent. The value of the serial-query-rate option, an integer, is the maximum number of queries sent per second. The default is 20.
transfer-format: Zone transfers can be sent using two different formats, one-answer and many-answers. The transfer-format option is used on the master server to determine which format it sends. one-answer uses one DNS message per resource record transferred. many-answers packs as many resource records as possible into a message. many-answers is more efficient, but is only supported by relatively new slave servers, such as BIND 9.2, BIND 8.x and patched versions of BIND 4.9.x. The default is many-answers. transfer-format may be overridden on a per-server basis by using the server statement.
transfers-in: The maximum number of concurrently running inbound zone transfers. Default value is 10. Increasing transfers-in may speed up the convergence of slave zones, but it may also increase the load on the local system.
transfers-out: The maximum number of concurrently running outbound zone transfers. Zone transfer requests in excess of the limit will be refused. Default value is 10.
transfers-per-ns: The maximum number of concurrently running inbound zone transfers from a given remote nameserver. Default value is 2. Increasing transfers-per-ns may speed up the convergence of slave zones, but it also may increase the load on the remote nameserver. transfers-per-ns may be overridden on a per-server basis by using the transfers phrase of the server statement.
transfer-source: transfer-source determines which local address will be bound to IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the source IPv4 address, and optionally the UDP port, used for the refresh queries and forwarded dynamic updates. If not set, it defaults to a system-controlled value which will usually be the address of the interface "closest to" the remote end. This address must appear in the remote end's allow-transfer option for the zone being transferred, if one is specified. This statement sets the transfer-source for all zones, but can be overridden on a per-view or per-zone basis by including a transfer-source statement within the view or zone block in the configuration file.
transfer-source-v6: The same as transfer-source, except that zone transfers are performed using IPv6.
notify-source: notify-source determines which local source address, and optionally UDP port, will be used to send NOTIFY messages. This address must appear in the slave server's masters zone clause or in an allow-notify clause. This statement sets the notify-source for all zones, but can be overridden on a per-zone/per-view basis by including a notify-source statement within the zone or view block in the configuration file.
notify-source-v6: The same as notify-source, but applies to notify messages sent to IPv6 addresses.

Operating System Resource Limits

The server's usage of many system resources can be limited. Scaled values are allowed when specifying resource limits. For example, 1G can be used instead of 1073741824 to specify a limit of one gigabyte. An "unlimited_size_spec" requests unlimited use, or the maximum available amount. The default uses the limit that was in force when the server was started.

The following options set operating system resource limits for the name server process. A warning will be issued if the unsupported limit is used.

coresize: The maximum size of a core dump. The default is default.
datasize: The maximum amount of data memory the server may use. The default is default. This is a hard limit on server memory usage. If the server attempts to allocate memory in excess of this limit, the allocation will fail, which may in turn leave the server unable to perform DNS service. Therefore, this option is rarely useful as a way of limiting the amount of memory used by the server, but it can be used to raise an operating system data size limit that is too small by default. If you wish to limit the amount of memory used by the server, use the max-cache-size and recursive-clients options instead.
files: The maximum number of files the server may have open concurrently. Default is unlimited.
stacksize: The maximum amount of stack memory the server may use. The default is default.

Server Resource Limits

The following options set limits on the server's resource consumption that are enforced internally by the server rather than the operating system.

recursive-clients: The maximum number of simultaneous recursive lookups the server will perform on behalf of clients. The default is 1000. Because each recursing client uses a fair bit of memory, on the order of 20 kilobytes, the value of the recursive-clients option may have to be decreased on hosts with limited memory.
tcp-clients: The maximum number of simultaneous client TCP connections that the server will accept. Default is 100.
max-cache-size: The maximum amount of memory to use for the server's cache, in bytes. When the amount of data in the cache reaches this limit, the server will cause records to expire prematurely so that the limit is not exceeded. In a server with multiple views, the limit applies separately to the cache of each view. Default is unlimited, meaning that records are purged from the cache only when their TTLs expire.

Periodic Task Intervals

cleaning-interval: The server will remove expired resource records from the cache every cleaning-interval minutes. The default is 60 minutes. If set to 0, no periodic cleaning will occur.
heartbeat-interval: The server will perform zone maintenance tasks for all zones marked as dialup whenever this interval expires. Default is 60 minutes. Reasonable values are up to 1 day (1440 minutes). If set to 0, no zone maintenance for these zones will occur.
interface-interval: The server will scan the network interface list every interface-interval minutes. Default is 60 minutes. If set to 0, interface scanning will only occur when the configuration file is loaded. After the scan, listeners will be started on any new interfaces (provided they are allowed by the listen-on configuration). Listeners on interfaces that have gone away will be cleaned up.

The sortlist Statement

The response to a DNS query may consist of multiple resource records (RRs) forming a resource records set (RRset). The name server will normally return the RRs within the RRset in an indeterminate order. The client resolver code should rearrange the RRs as appropriate, i.e., using any addresses on the local net in preference to other addresses. However, not all resolvers can do this or are correctly configured. When a client is using a local server the sorting can be performed in the server, based on the client's address. This only requires configuring the nameservers, not all the clients. The sortlist statement (refer to the sortlist section below) takes an address_match_list and interprets it. Each top level statement in the sortlist must itself be an explicit address_match_list with one or two elements. The first element (which may be an IP address, an IP prefix, an ACL name or a nested address_match_list) of each top level list is checked against the source address of the query until a match is found.

Once the source address of the query has been matched, if the top level statement contains only one element, the actual primitive element that matched the source address is used to select the address in the response to move to the beginning of the response. If the statement is a list of two elements, then the second element is interpreted in a special way. Each top level element is assigned a distance and the address in the response with the minimum distance is moved to the beginning of the response. In the following example, any queries received from any of the addresses of the host itself will get responses preferring addresses on any of the locally connected networks. Next will be addresses on the 192.168.1/24 network, and after that either the 192.168.2/24 or 192.168.3/24 network with no preference shown between these two networks. Queries received from a host on the 192.168.1/24 network will prefer other addresses on that network to the 192.168.2/24 and 192.168.3/24 networks. Queries received from a host on the 192.168.4/24 or the 192.168.5/24 network will only prefer other addresses on their directly connected networks.

sortlist {
    { localhost;
                                      // IF   the local host
        { localnets;
                                      // THEN first fit on the
            192.168.1/24;
                                      //   following nets
            { 192.168.2/24; 192.168.3/24; }; }; };
    { 192.168.1/24;
                                      // IF   on class C 192.168.1
        { 192.168.1/24;
                                      // THEN use .1, or .2 or .3
            { 192.168.2/24; 192.168.3/24; }; }; };
    { 192.168.2/24;
                                      // IF   on class C 192.168.2
        { 192.168.2/24;
                                      // THEN use .2, or .1 or .3
            { 192.168.1/24; 192.168.3/24; }; }; };
    { 192.168.3/24;
                                      // IF   on class C 192.168.3
        { 192.168.3/24;
                                      // THEN use .3, or .1 or .2
            { 192.168.1/24; 192.168.2/24; }; }; };
    { { 192.168.4/24; 192.168.5/24; };
                                      // if .4 or .5, prefer that net
    };
};

The following example will give reasonable behavior for the local host and hosts on directly connected networks. It is similar to the behavior of the address sort in BIND 4.9.x. Responses sent to queries from the local host will favor any of the directly connected networks. Responses sent to queries from any other hosts on a directly connected network will prefer addresses on that same network. Responses to other queries will not be sorted.

sortlist {
           { localhost; localnets; };
           { localnets; };
};

Synthetic IPv6 Responses

Many existing stub resolvers support IPv6 DNS lookups as defined in RFC1886, using AAAA records for forward lookups and nibble labels in the ip6.int domain for reverse lookups, but do not support RFC2874-style lookups (using A6 records and binary labels in the ip6.arpa domain).

For those who wish to continue to use such stub resolvers rather than switching to the BIND 9.2 lightweight resolver, BIND 9.2 provides a way to automatically convert RFC1886-style lookups into RFC2874-style lookups and return the results as "synthetic" AAAA and PTR records. This feature is disabled by default and can be enabled on a per-client basis by adding a allow-v6-synthesis { address_match_list }; clause to the options or view statement. When it is enabled, recursive AAAA queries cause the server to first try an A6 lookup and if that fails, it tries an AAAA lookup. No matter which one succeeds, the results are returned as a set of synthetic AAAA records. Similarly, recursive PTR queries in ip6.int will cause a lookup in ip6.arpa using binary labels, and if that fails, another lookup in ip6.int. The results are returned as a synthetic PTR record in ip6.int.

The synthetic records have a TTL of zero. DNSSEC validation of synthetic responses is not currently supported; therefore responses containing synthetic RRs will not have the AD flag set.

Tuning

lame-ttl

Sets the number of seconds to cache a lame server indication. 0 disables caching. (This is NOT recommended.) Default is 600 (10 minutes). Maximum value is 1800 (30 minutes).

max-ncache-ttl

To reduce network traffic and increase performance, the server stores negative answers. max-ncache-ttl is used to set a maximum retention time for these answers in the server in seconds. The default max-ncache-ttl is 10800 seconds (3 hours). max-ncache-ttl cannot exceed 7 days and will be truncated to 7 days if set to a greater value.

max-cache-ttl

Sets the maximum time for which the server will cache ordinary (positive) answers. Default is one week (7 days).

sig-validity-interval

Specifies the number of days into the future when DNSSEC signatures automatically generated as a result of dynamic updates will expire. Default is 30 days. The signature inception time is unconditionally set to one hour before the current time to allow for a limited amount of clock skew.

min-refresh-time, max-refresh-time,

min-retry-time, max-retry-time

These options control the server's behavior on refreshing a zone (querying for SOA changes) or retrying failed transfers. Usually the SOA values for the zone are used, but these values are set by the master, giving slave server administrators little control over their contents.

These options allow the administrator to set a minimum and maximum refresh and retry time either per-zone, per-view, or per-server. These options are valid for master, slave and stub zones, and clamp the SOA refresh and retry times to the specified values.

The Statistics File

The statistics file generated by BIND 9.2 is similar, but not identical, to that generated by BIND 8. The statistics dump begins with the line +++ Statistics Dump +++ (973798949), where the number in parentheses is a standard Unix-style timestamp, measured as seconds since January 1, 1970. Following that line are a series of lines containing a counter type, the value of the counter, optionally a zone name, and optionally a view name. The lines without view and zone listed are global statistics for the entire server. Lines with a zone and view name for the given view and zone (the view name is omitted for the default view). The statistics dump ends with the line --- Statistics Dump --- (973798949), where the number is identical to the number in the beginning line. The following statistics counters are maintained:

success: The number of successful queries made to the server or zone. A successful query is defined as query which returns a NOERROR response other than a referral response.
referral: The number of queries which resulted in referral responses.
nxrrset: The number of queries which resulted in NOERROR responses with no data.
nxdomain: The number of queries which resulted in NXDOMAIN responses.
recursion: The number of queries which caused the server to perform recursion in order to find the final answer.
failure: The number of queries which resulted in a failure response other than those above.

server Statement Grammar

server ip_addr {
    [ bogus yes_or_no ; ]
    [ provide-ixfr yes_or_no ; ]
    [ request-ixfr yes_or_no ; ]
    [ edns yes_or_no ; ]
    [ transfers number ; ]
    [ transfer-format ( one-answer | many-answers ) ; ]]
    [ keys { string ; [ string ; [...]] } ; ]
};

server Statement Definition and Usage

The server statement defines characteristics to be associated with a remote nameserver. The server statement can occur at the top level of the configuration file or inside a view statement. If a view statement contains one or more server statements, only those apply to the view and any top-level ones are ignored. If a view contains no server statements, any top-level server statements are used as defaults.

If you discover that a remote server is giving out bad data, marking it as "bogus" will prevent further queries to it. Default value of bogus is "no". The provide-ixfr clause determines whether the local server, acting as master, will respond with an incremental zone transfer when the given remote server, a slave, requests it. If set to "yes", incremental transfer will be provided whenever possible. If set to "no", all transfers to the remote server will be nonincremental. If not set, the value of the provide-ixfr option in the view or global options block is used as a default.

IXFR requests to servers that do not support IXFR will automatically fall back to AXFR. Therefore, there is no need to manually list which servers support IXFR and which ones do not; the global default of yes should always work. The purpose of the provide-ixfr and request-ixfr clauses is to make it possible to disable the use of IXFR even when both master and slave claim to support it, for example if one of the servers is defective and crashes or corrupts data when IXFR is used.

The edns (Extended DNS) clause determines whether the local server will attempt to use EDNS when communicating with the remote server. Default is "yes".

The server supports two zone transfer methods. The first, one-answer, uses one DNS message per resource record transferred. many-answers packs as many resource records as possible into a message. many-answers is more efficient, but is only known to be understood by BIND 9, BIND 8.x, and patched versions of BIND 4.9.5. You can specify which method to use for a server with the transfer-format option. If transfer-format is not specified, the transfer-format specified by the options statement will be used. The transfers clause is used to limit the number of concurrent inbound zone transfers from the specified server. If no transfers clause is specified, the limit is set according to the transfers-per-ns option.

The keys clause is used to identify a key_id defined by the key statement, to be used for transaction security when talking to the remote server. The key statement must come before the server statement that references it. When a request is sent to the remote server, a request signature will be generated using the key specified here and appended to the message. A request originating from the remote server is not required to be signed by this key. Although the grammar of the keys clause allows for multiple keys, only a single key per server is currently supported.

trusted-keys Statement Grammar

trusted-keys {
    string number number number string ;
    [ string number number number string ; [...]]
};

trusted-keys Statement Definition and Usage

The trusted-keys statement defines DNSSEC security roots. A security root is defined when the public key for a non-authoritative zone is known, but cannot be securely obtained through DNS, either because it is the DNS root zone or its parent zone is unsigned. Once a key has been configured as a trusted key, it is treated as if it had been validated and proven secure. The resolver attempts DNSSEC validation on all DNS data in subdomains of a security root.

The trusted-keys statement can contain multiple key entries, each consisting of the key's domain name, flags, protocol, algorithm, and the base-64 representation of the key data.

view Statement Grammar

view
 view_name [class] {
      match-clients { address_match_list } ;
      match-destinations { address_match_list } ;
      match-recursive-only { yes_or_no } ;
      [ view_option; ...]
      [ zone-statistics yes_or_no ; ]
      [ zone_statement; ...]
};

view Statement Definition and Usage

The view statement lets a name server answer a DNS query differently depending on who is asking. It is particularly useful for implementing split DNS setups without having to run multiple servers. Each view statement defines a view of the DNS namespace that will be seen by a subset of clients. A client matches a view if its source IP address matches the address_match_list of the view's match-clients clause and its destination IP address matches the address_match_list of the view's match-destinations clause.

If not specified, both match-clients and match-destinations default to matching all addresses. A view can also be specified as match-recursive-only, which means that only recursive requests from matching clients will match that view. The order of the view statements is significant - a client request will be resolved in the context of the first view that it matches.

Zones defined within a view statement will only be accessible to clients that match the view. By defining a zone of the same name in multiple views, different zone data can be given to different clients, for example, "internal" and "external" clients in a split DNS setup.

Many of the options given in the options statement can also be used within a view statement, and then apply only when resolving queries with that view. When no view-specific value is given, the value in the options statement is used as a default. Also, zone options can have default values specified in the view statement; these view-specific defaults take precedence over those in the options statement.

Views are class-specific. If no class is given, class IN is assumed. Note that all non-IN views must contain a hint zone, since only the IN class has compiled-in default hints. If there are no view statements in the config file, a default view that matches any client is automatically created in class IN, and any zone statements specified on the top level of the configuration file are considered to be part of this default view. If any explicit view statements are present, all zone statements must occur inside view statements.

Here is an example of a typical split DNS setup implemented using view statements.

view "internal" {
               // This should match our internal networks.
      match-clients { 10.0.0.0/8; };
               // Provide recursive service to internal clients only.
      recursion yes;
               // Provide a complete view of the example.com zone
               // including addresses of internal hosts.
      zone "example.com" {
            type master;
            file "example-internal.db";
      };
};

view "external" {

     match-clients { any; };
               // Refuse recursive service to external clients.
      recursion no;
               // Provide a restricted view of the example.com zone
               // containing only publicly accessible hosts.
      zone "example.com" {
           type master;
           file "example-external.db";
      };
};

zone Statement Grammar

zone zone_name [class] [{
    type ( master | slave | hint | stub | forward ) ;
    [ allow-notify { address_match_list } ; ]
    [ allow-query { address_match_list } ; ]
    [ allow-transfer { address_match_list } ; ]
    [ allow-update { address_match_list } ; ]
    [ update-policy { update_policy_rule [...] } ; ]
    [ allow-update-forwarding { address_match_list } ; ]
    [ also-notify { ip_addr [port ip_port] ;
                        [ ip_addr [port ip_port] ; ... ] }; ]
    [ dialup dialup_option ; ]
    [ file string ; ]
    [ forward (only|first) ; ]
    [ forwarders { ip_addr [port ip_port] ;
                    [ ip_addr [port ip_port] ; ... ] }; ]
    [ masters [port ip_port] { ip_addr [port ip_port]
                            [key key]; [...] } ; ]
    [ max-transfer-idle-in number ; ]
    [ max-transfer-idle-out number ; ]
    [ max-transfer-time-in number ; ]
    [ max-transfer-time-out number ; ]
    [ notify yes_or_no | explicit ; ]
    [ transfer-source (ip4_addr | *) [port ip_port] ; ]
    [ transfer-source-v6 (ip6_addr | *) [port ip_port] ; ]
    [ notify-source (ip4_addr | *) [port ip_port] ; ]
    [ notify-source-v6 (ip6_addr | *) [port ip_port] ; ]
    [ zone-statistics yes_or_no ; ]
    [ sig-validity-interval number ; ]
    [ database string ; ]
    [ min-refresh-time number ; ]
    [ max-refresh-time number ; ]
    [ min-retry-time number ; ]
    [ max-retry-time number ; ]

}];

zone Statement Definition and Usage

Zone Types

master: The server has a master copy of the data for the zone and will be able to provide authoritative answers for it.
slave: A slave zone is a replica of a master zone. The masters list specifies one or more IP addresses of master servers that the slave contacts to update its copy of the zone. By default, transfers are made from port 53 on the servers; this can be changed for all servers by specifying a port number before the list of IP addresses, or on a per-server basis after the IP address. Authentication to the master can also be done with per-server TSIG keys. If a file is specified, then the replica will be written to this file whenever the zone is changed, and reloaded from this file on a server restart. Use of a file is recommended, since it often speeds server start-up and eliminates a needless waste of bandwidth. If the database files are very large, it is recommended to place them in different directories.
stub: A stub zone is similar to a slave zone, except that it replicates only the NS records of a master zone instead of the entire zone. Stub zones are not a standard part of the DNS; they are a feature specific to the BIND implementation. Stub zones can be used to eliminate the need for glue NS record in a parent zone at the expense of maintaining a stub zone entry and a set of name server addresses in named.conf. This usage is not recommended for new configurations, and BIND 9.2 supports it only in a limited way. In BIND 4/8, zone transfers of a parent zone included the NS records from stub children of that zone. This meant that, in some cases, users could get away with configuring child stubs only in the master server for the parent zone. BIND 9 never mixes together zone data from different zones in this way. Therefore, if a BIND 9 master serving a parent zone has child stub zones configured, all the slave servers for the parent zone also need to have the same child stub zones configured. Stub zones can also be used to force the resolution of a given domain to use a particular set of authoritative servers. For example, the caching name servers on a private network using RFC2157 addressing may be configured with stub zones for 10.in-addr.arpa to use a set of internal name servers as the authoritative servers for that domain.
forward: A forward zone can be used to configure forwarding on a per-domain basis. A zone statement of type forward can contain a forward and/or forwarders statement, which will apply to queries within the domain given by the zone name. If no forwarders statement is present or an empty list for forwarders is given, then no forwarding will be done for the domain, canceling the effects of any forwarders in the options statement. Thus if you want to use this type of zone to change the behavior of the global forward option (that is, "forward first to", then "forward only", or vice versa, but want to use the same servers as set globally) you need to re-specify the global forwarders.
hint: The initial set of root nameservers is specified using a hint zone. When the server starts up, it uses the root hints to find a root nameserver and get the most recent list of root nameservers. If no hint zone is specified for class IN, the server uses a compiled-in default set of root servers hints. Classes other than IN have no built-in defaults hints.

Class

The zone's name may optionally be followed by a class. If a class is not specified, class IN (for Internet), is assumed. This is correct for the vast majority of cases. The "hesiod" class is named for an information service from MIT's Project Athena. It is used to share information about various systems databases, such as users, groups, printers and so on. The keyword HS is a synonym for hesiod. Another MIT development is CHAOSnet, a LAN protocol created in the mid-1970s. Zone data for it can be specified with the CHAOS class.

Zone Options

allow-notify: See the description of allow-notify.
allow-query: See the description of allow-query.
allow-transfer: See the description of allow-transfer.
allow-update: Specifies which hosts are allowed to submit Dynamic DNS updates for master zones. The default is to deny updates from all hosts. Please note that this option is not applicable for slave zones. See "Dynamic Update Policies" below for more details.
update-policy: Specifies a "Simple Secure Update" policy. See "Dynamic Update Policies" below for more details.
allow-update-forwarding: Specifies which hosts are allowed to submit Dynamic DNS updates to slave zones to be forwarded to the master. The default is { none; }, which means that no update forwarding will be performed. To enable update forwarding, specify allow-update-forwarding { any; };. Specifying values other than { none; } or { any; } is usually counterproductive, since the responsibility for update access control should rest with the master server, not the slaves. Note that enabling the update forwarding feature on a slave server may expose master servers relying on insecure IP address based access control to attacks;
also-notify: Only meaningful if notify is active for this zone. The set of machines that will receive a DNS NOTIFY message for this zone is made up of all the listed nameservers (other than the primary master) for the zone plus any IP addresses specified with also-notify. A port may be specified with each also-notify address to send the notify messages to a port other than the default of 53. also-notify is not meaningful for stub zones. The default is the empty list.
database: Specify the type of database to be used for storing the zone data. The string following the database keyword is interpreted as a list of whitespace-delimited words. The first word identifies the database type, and any subsequent words are passed as arguments to the database to be interpreted in a way specific to the database type. The default is rbt, BIND 9.2's native in-memory red-black-tree database. This database does not take arguments. Other values are possible if additional database drivers have been linked into the server.
dialup: See the description of dialup.
forward: Only meaningful if the zone has a forwarders list. The only value causes the lookup to fail after trying the forwarders and getting no answer, while first would allow a normal lookup to be tried.
forwarders: Used to override the list of global forwarders. If it is not specified in a zone of type forward, no forwarding is done for the zone; the global options are not used.
max-transfer-time-in: See the description of max-transfer-time-in above.
max-transfer-idle-in: See the description of max-transfer-idle-in above.
max-transfer-time-out: See the description of max-transfer-time-out above.
max-transfer-idle-out: See the description of max-transfer-idle-out above.
notify: See the description of notify above.
zone-statistics: If yes, the server will keep statistical information for this zone, which can be dumped to the statistics-file defined in the server options.
sig-validity-interval: See the description of sig-validity-interval.
transfer-source: See the description of transfer-source.
transfer-source-v6: See the description of transfer-source-v6.
notify-source: See the description of notify-source.
notify-source-v6: See the description of notify-source-v6.
min-refresh-time, max-refresh-time,
min-retry-time, max-retry-time: See the descriptions above.

Dynamic Update Policies

BIND 9.2 supports two alternative methods of granting clients, the right to perform dynamic updates to a zone, configured by the allow-update and update-policy option, respectively.

The allow-update clause works the same way as in previous versions of BIND. It grants given clients the permission to update any record of any name in the zone.

The update-policy clause is new in BIND 9.2 and allows more fine-grained control over what updates are allowed. A set of rules is specified, where each rule either grants or denies permissions for one or more names to be updated by one or more identities. If the dynamic update request message is signed (that is, it includes either a TSIG or SIG(0) record), the identity of the signer can be determined.

Rules are specified in the update-policy zone option, and are only meaningful for master zones. When the update-policy statement is present, it is a configuration error for the allow-update statement to be present. The update-policy statement only examines the signer of a message; the source address is not relevant.

A sample rule definition is as shown below:

( grant | deny ) identity nametype name [ types ]

Each rule grants or denies privileges. Once a message has successfully matched a rule, the operation is immediately granted or denied and no further rules are examined. A rule is matched when the signer matches the identity field, the name matches the name field, and the type is specified in the type field. The identity field specifies a name or a wildcard name. The nametype field has four values: name, subdomain, wildcard, and self:

name: Matches when the updated name is the same as the name in the name field.
subdomain: Matches when the updated name is a subdomain of the name in the name field (which includes the name itself).
wildcard: Matches when the updated name is a valid expansion of the wildcard name in the name field.
self: Matches when the updated name is the same as the message signer. The name field is ignored.

If no types are specified, the rule matches all types except SIG, NS, SOA, and NXT. Types may be specified by name, including "ANY" (ANY matches all types except NXT, which can never be updated).

Zone File

Types of Resource Records and When to Use Them:

This section describes the concept of a Resource Record (RR) and explains when each is used as per RFC 1034.

Resource Records

A domain name identifies a node. Each node has a set of resource information, which may be empty. The set of resource information associated with a particular name is composed of separate RRs. The order of RRs in a set is not significant and need not be preserved by nameservers, resolvers, or other parts of the DNS. However, sorting of multiple RRs is permitted for optimization purposes, for example, to specify that a particular nearby server be tried first.

The components of a Resource Record are:

owner name: the domain name where the RR is found.
type: an encoded 16-bit value that specifies the type of the resource in this resource record. Types refer to abstract resources.
TTL: the Time To Live (TTL) of the RR. This field is a 32-bit integer in units of seconds, and is primarily used by resolvers when they cache RRs. The TTL describes how long a RR can be cached before it should be discarded.
class: an encoded 16-bit value that identifies a protocol family or instance of a protocol.
RDATA: the type and sometimes class-dependent data that describes the resource.

The following are the types of valid RRs (some of these listed, although not obsolete, are experimental (x) or historical (h) and no longer in general use):

A: a host address.
A6: an IPv6 address.
AAAA: obsolete format of IPv6 address
CNAME: identifies the canonical name of an alias.
DNAME: delegates reverse addresses. Replaces the domain name specified with another name to be looked up. Described in RFC 2672.
HINFO: identifies the CPU and OS used by a host.
KEY: stores a public key associated with a DNS name.
MX: identifies a mail exchange for the domain. See RFC 974 for details.
NS: the authoritative nameserver for the domain.
NXT: used in DNSSEC to securely indicate that RRs with an owner name in a certain name interval do not exist in a zone and indicate what RR types are present for an existing name. See RFC 2535 for details.
PTR: a pointer to another part of the domain name space.
SIG( signature")": contains data authenticated in the secure DNS. See RFC 2535 for details.
SOA: identifies the start of a zone of authority.
SRV: information about well known network services (replaces WKS).

The following classes of resource records are currently valid in the DNS:

IN: the Internet system.
RDATA: is the type-dependent or class-dependent data that describes the resource:
A: for the IN class, a 32 bit IP address.
A6: maps a domain name to an IPv6 address, with a provision for indirection for leading "prefix" bits.
CNAME: a domain name.
DNAME: provides alternate naming to an entire subtree of the domain name space, rather than to a single node. It causes some suffix of a queried name to be substituted with a name from the DNAME record's RDATA.
MX: a 16-bit preference value (lower is better) followed by a host name willing to act as a mail exchange for the owner domain.
NS: a fully qualified domain name.
PTR: a fully qualified domain name.
SOA: several fields.

The owner name is often implicit, rather than forming an integral part of the RR. For example, many nameservers internally form tree or hash structures for the name space, and chain RRs off nodes. The remaining RR parts are the fixed header (type, class, TTL) which is consistent for all RRs, and a variable part (RDATA) that fits the needs of the resource being described.

The meaning of the TTL field is a time limit on how long an RR can be kept in a cache. This limit does not apply to authoritative data in zones; it is also timed out, but by the refreshing policies for the zone. The TTL is assigned by the administrator for the zone where the data originates. While short TTLs can be used to minimize caching, and a zero TTL prohibits caching, the realities of Internet performance suggest that these times should be on the order of days for the typical host. If a change can be anticipated, the TTL can be reduced prior to the change to minimize inconsistency during the change, and then increased back to its former value following the change.

The data in the RDATA section of RRs is carried as a combination of binary strings and domain names. The domain names are frequently used as "pointers" to other data in the DNS.

Textual Expression of RRs

RRs are represented in binary form in the packets of the DNS protocol, and are usually represented in highly encoded form when stored in a nameserver or resolver. In the examples provided in RFC 1034, a style similar to that used in master files was employed in order to show the contents of RRs. In this format, most RRs are shown on a single line, although continuation lines are possible using parentheses.

The start of the line gives the owner of the RR. If a line begins with a blank, then the owner is assumed to be the same as that of the previous RR. Blank lines are often included for readability.

Following the owner, we list the TTL, type, and class of the RR. Class and type use the mnemonics defined above, and TTL is an integer before the type field. In order to avoid ambiguity in parsing, type and class mnemonics are disjoint, TTLs are integers, and the type mnemonic is always last. The IN class and TTL values are often omitted from examples in the interests of clarity.

The resource data or RDATA section of the RR are given using knowledge of the typical representation for the data.

For example, RRs carried in a message can be shown as:

      ISI.EDU.MX10 VENERA.ISI.EDU.
      MX10 VAXA.ISI.EDU
      VENERA.ISI.EDUA128.9.0.32
      A10.1.0.52
      VAXA.ISI.EDUA10.2.0.27
      A128.9.0.33

The MX RRs have an RDATA section which consists of a 16 bit number followed by a domain name. The address RRs use a standard IP address format to contain a 32 bit internet address.

This example shows six RRs, with two RRs at each of three domain names. Similarly RRs may also be shown as:

      XX.LCS.MIT.EDU. INA10.0.0.44
      CHAMIT.EDU. 2420

This example shows two addresses for XX.LCS.MIT.EDU, each of a different class.

MX Records

As described above, domain servers store information as a series of resource records, each of which contains a particular piece of information about a given domain name (which is usually, but not always, a host). The simplest way to think of a RR is as a typed pair of datum, a domain name matched with relevant data, and stored with some additional type information to help systems determine when the RR is relevant.

MX records are used to control delivery of e-mail. The data specified in the record is a priority and a domain name. The priority controls the order in which email delivery is attempted, with the lowest number first. If two priorities are the same, a server is chosen randomly. If no servers at a given priority are responding, the mail transport agent will fall back to the next largest priority. Priority numbers do not have any absolute meaning - they are relevant only respective to other MX records for that domain name. The domain name given is the machine to which the mail will be delivered. It must have an associated A record - CNAME is not sufficient.

For a given domain, if there is both a CNAME record and an MX record, the MX record is in error, and will be ignored. Instead, the mail will be delivered to the server specified in the MX record pointed to by the CNAME.

      example.com.INMX10mail.example.com.
      INMX10mail2.example.com.
      INMX20mail.backup.org.
      mail.example.com.INA10.0.0.1
      mail2.example.com.INA10.0.0.2

For example:

Mail delivery will be attempted to mail.example.com and mail2.example.com (in any order), and if neither of those succeed, delivery to mail.backup.org will be attempted.

Setting TTLs

The TTL of the RR field is a 32-bit integer represented in units of seconds, and is primarily used by resolvers when they cache RRs. The TTL describes how long a RR can be cached before it should be discarded. The following three types of TTL are currently used in a zone file.

SOA: The last field in the SOA is the negative caching TTL. This controls how long other servers will cache no-such-domain (NXDOMAIN) responses from you. The maximum time for negative caching is 3 hours (3h).
$TTL: The $TTL directive at the top of the zone file (before the SOA) gives a default TTL for every RR without a specific TTL set.
RR TTLs: Each RR can have a TTL as the second field in the RR, which will control how long other servers can cache the it.

All of these TTLs default to units of seconds, though units can be explicitly specified, for example, 1h30m.

Inverse Mapping in IPv4

Reverse name resolution (that is, translation from IP address to name) is achieved by means of the in-addr.arpa domain and PTR records. Entries in the in-addr.arpa domain are made in least-to-most significant order, read left to right. This is the opposite order to the way IP addresses are usually written. Thus, a machine with an IP address of 10.1.2.3 would have a corresponding in-addr.arpa name of 3.2.1.10.in-addr.arpa. This name should have a PTR resource record whose data field is the name of the machine or, optionally, multiple PTR records if the machine has more than one name. For example, in the [example.com]

domain:
      $ORIGIN2.1.10.in-addr.arpa
      3IN PTR foo.example.com.

Note: The $ORIGIN lines in the examples are for providing context to the examples only-they do not necessarily appear in the actual usage. They are only used here to indicate that the example is relative to the listed origin.

Other Zone File Directives

The Master File Format was initially defined in RFC 1035 and has subsequently been extended. While the Master File Format itself is class independent all records in a Master File must be of the same class. Master File Directives include $ORIGIN, $INCLUDE, and $TTL.

The $ORIGIN Directive

Syntax:

$ORIGIN domain-name [comment]

$ORIGIN sets the domain name that will be appended to any unqualified records. When a zone is first read in there is an implicit $ORIGIN zone-name. The current $ORIGIN is appended to the domain specified in the $ORIGIN argument if it is not absolute.

$ORIGIN example.com.
WWW     CNAME   MAIN-SERVER

is equivalent to

WWW.EXAMPLE.COM. CNAME MAIN-SERVER.EXAMPLE.COM.

The $INCLUDE Directive

Syntax:

$INCLUDE filename [origin] [comment]

Read and process the file filename as if it were included into the file at this point. If origin is specified the file is processed with $ORIGIN set to that value, otherwise the current $ORIGIN is used. The origin and the current domain name revert to the values they had prior to the $INCLUDE once the file has been read.

Note: RFC 1035 specifies that the current origin should be restored after an $INCLUDE, but it is silent on whether the current domain name should also be restored. BIND 9 restores both of them. This could be construed as a deviation from RFC 1035, a feature, or both.

The $TTL Directive

Syntax:

$TTL default-ttl [comment]

Set the default Time To Live (TTL) for subsequent records with undefined TTLs. Valid TTLs are of the range 0-2147483647 seconds. $TTL is defined in RFC 2308.

BIND Master File Extension: the $GENERATE Directive

Syntax:

$GENERATE range lhs type rhs [comment]

$GENERATE is used to create a series of resource records that only differ from each other by an iterator. $GENERATE can be used to easily generate the sets of records required to support sub /24 reverse delegations described in RFC 2317: Classless IN-ADDR.ARPA delegation.

$ORIGIN 0.0.192.IN-ADDR.ARPA.
$GENERATE 1-2 0 NS SERVER$.EXAMPLE.
$GENERATE 1-127 $ CNAME $.0

is equivalent to

0.0.192.IN-ADDR.ARPA NS SERVER1.EXAMPLE.
0.0.192.IN-ADDR.ARPA NS SERVER2.EXAMPLE.
0.0.192.IN-ADDR.ARPA CNAME 1.0.0.0.192.IN-ADDR.ARPA
0.0.192.IN-ADDR.ARPA CNAME 2.0.0.0.192.IN-ADDR.ARPA
 ...
0.0.192.IN-ADDR.ARPA CNAME 127.0.0.0.192.IN-ADDR.ARPA
 .

range

This can be either of the two forms: start-stop or start-stop/step. If the first form is used, then step is set to 1. All of start, stop and step must be positive.

lhslhs

describes the owner name of the resource records to be created. Any single $ symbols within the lhs side are replaced by the iterator value.

To get a $ in the output you need to escape the $ using a backslash \, e.g. \$. The $ may optionally be followed by modifiers which change the offset from the interator, field width and base. Modifiers are introduced by a { immediately following the $ as ${offset[,width[,base]]}. e.g. ${-20,3,d} which subtracts 20 from the current value, prints the result as a decimal in a zero padded field of with 3. Available output forms are decimal (d), octal (o), and hexadecimal (x or X for uppercase). The default modifier is ${0,0,d}. If the lhs is not absolute, the current $ORIGIN is appended to the name.

For compatibility with earlier versions $$ is still recognized a indicating a literal $ in the output.

type

At present the only supported types are PTR, CNAME, DNAME, A, AAAA and NS.

rhsrhs

is a domain name. It is processed similarly to lhs.

The $GENERATE directive is a BIND extension and not part of the standard zone file format.

WARNINGS

IPv6 is supported on HP-UX 11i Version 1.0, with the optional IPv6 software installed. Currently, IPv6 is not supported on systems running HP-UX 11i Version 1.6.

AUTHOR

named.conf was developed by Internet Software Consortium (ISC).

named.conf(4)

Technical documentation

» Table of Contents

» Index

NAME

SYNOPSIS

DESCRIPTION

Configuration File Elements

Address Match Lists Syntax

Address Match Lists Definition and Usage

Comment Syntax

Configuration File Grammar

acl Statement Grammar

acl Statement Definition and Usage

controls Statement Grammar

controls Statement Definition and Usage

include Statement Grammar

include Statement Definition and Usage

key Statement Grammar

key Statement Definition and Usage

logging Statement Grammar

logging Statement Definition and Usage

The channel Phrase

The category Phrase

lwres Statement Grammar

lwres Statement Definition and Usage

options Statement Grammar

options Statement Definition and Usage

Boolean Options

Forwarding

Access Control

Interfaces

Query Address

Zone Transfers

Operating System Resource Limits

Server Resource Limits

Periodic Task Intervals

The sortlist Statement

Synthetic IPv6 Responses

Tuning

The Statistics File

server Statement Grammar

server Statement Definition and Usage

trusted-keys Statement Grammar

trusted-keys Statement Definition and Usage

view Statement Grammar

view Statement Definition and Usage

zone Statement Grammar

zone Statement Definition and Usage

Class

Zone Options

Dynamic Update Policies

Zone File

Resource Records

Textual Expression of RRs

MX Records

Setting TTLs

Inverse Mapping in IPv4

Other Zone File Directives

The $ORIGIN Directive

The $INCLUDE Directive

The $TTL Directive

BIND Master File Extension: the $GENERATE Directive

WARNINGS

AUTHOR

SEE ALSO