8. Configuration Reference
The operational functionality of BIND 9 is defined using the file named.conf, which is typically located in /etc or /usr/local/etc/namedb, depending on the operating system or distribution. A further file rndc.conf will be present if rndc is being run from a remote host, but is not required if rndc is being run from localhost (the same system as BIND 9 is running on).
8.1. Configuration File (named.conf)
The file named.conf
may contain three types of entities:
- Comment
- Block
Blocks are containers for statements which either have common functionality - for example, the definition of a cryptographic key in a
key
block - or which define the scope of the statement - for example, a statement which appears in azone
block has scope only for that zone.Blocks are organized hierarchically within
named.conf
and may have a number of different properties:Certain blocks cannot be nested inside other blocks and thus may be regarded as the topmost-level blocks: for example, the
options
block and thelogging
block.Certain blocks can appear multiple times, in which case they have an associated name to disambiguate them: for example, the
zone
block (zone example.com { ... };
) or thekey
block (key mykey { ... };
).Certain blocks may be “nested” within other blocks. For example, the
zone
block may appear within aview
block.
The description of each block in this manual lists its permissible locations.
- Statement
Statements define and control specific BIND behaviors.
Statements may have a single parameter (a Value) or multiple parameters (Argument/Value pairs). For example, the
recursion
statement takes a single value parameter - in this case, the stringyes
orno
(recursion yes;
) - while theport
statement takes a numeric value defining the DNS port number (port 53;
). More complex statements take one or more argument/value pairs. Thealso-notify
statement may take a number of such argument/value pairs, such asalso-notify port 5353;
, whereport
is the argument and5353
is the corresponding value.Statements can appear in a single block - for example, an
algorithm
statement can appear only in akey
block - or in multiple blocks - for example, analso-notify
statement can appear in anoptions
block where it has global (server-wide) scope, in azone
block where it has scope only for the specific zone (and overrides any global statement), or even in aview
block where it has scope for only that view (and overrides any global statement).
The file named.conf
may further contain one or more instances of the
include Directive. This directive is provided for
administrative convenience in assembling a complete named.conf
file and plays
no subsequent role in BIND 9 operational characteristics or functionality.
Note
Over a period of many years the BIND ARM acquired a bewildering array of terminology. Many of the terms used described similar concepts and served only to add a layer of complexity, possibly confusion, and perhaps mystique to BIND 9 configuration. The ARM now uses only the terms Block, Statement, Argument, Value, and Directive to describe all entities used in BIND 9 configuration.
8.1.2. Configuration Layout Styles
BIND is very picky about opening and closing brackets/braces, semicolons, and all the other separators defined in the formal syntaxes in later sections. There are many layout styles that can assist in minimizing errors, as shown in the following examples:
// dense single-line style
zone "example.com" in{type secondary; file "secondary.example.com"; primaries {10.0.0.1;};};
// single-statement-per-line style
zone "example.com" in{
type secondary;
file "secondary.example.com";
primaries {10.0.0.1;};
};
// spot the difference
zone "example.com" in{
type secondary;
file "sec.secondary.com";
primaries {10.0.0.1;}; };
8.1.3. include
Directive
include filename;
8.1.3.1. include
Directive Definition and Usage
The include directive inserts the specified file (or files if a valid glob expression is detected) at the point where the include directive is encountered. The include directive 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 the name server.
8.1.4. Address Match Lists
8.1.4.1. Syntax
An address match list is a list of semicolon-separated address_match_element s.
{ <address_match_element>; ... };
Each element is then defined as:
address_match_element
[ ! ] ( <ip_address> | <netprefix> | key <server_key> | <acl_name> | { address_match_list } )
8.1.4.2. Definition and Usage
Address match lists are primarily used to determine access control for
various server operations. They are also used in the listen-on
and
sortlist
statements. The elements which constitute an address match
list can be any of the following:
ip_address: an IP address (IPv4 or IPv6)
netprefix: an IP prefix (in
/
notation)server_key: a key ID, as defined by the
key
statementacl_name: the name of an address match list defined with the
acl
statementa nested address match list enclosed in braces
Elements can be negated with a leading exclamation mark (!
), and the
match list names “any”, “none”, “localhost”, and “localnets” are
predefined. More information on those names can be found in the
description of the acl
statement.
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. Nonetheless, the term “address match list” is still used throughout the documentation.
When a given IP address or prefix is compared to an address match list, the comparison takes place in approximately O(1) time. However, key comparisons require that the list of keys be traversed until a matching key is found, and therefore may be somewhat slower.
The interpretation of a match depends on whether the list is being used
for access control, defining listen-on
ports, or in a sortlist
,
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-recursion
,
allow-recursion-on
, allow-query
, allow-query-on
,
allow-query-cache
, allow-query-cache-on
, allow-transfer
,
allow-update
, allow-update-forwarding
, and blackhole
all use address match lists. Similarly, the
listen-on
option causes the server to refuse queries on any of
the machine’s addresses which do not match the list.
Order of insertion is significant. If more than one element in an ACL is
found to match a given IP address or prefix, preference is given to
the one that came first in the ACL definition. Because of this
first-match behavior, 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 completely useless because the algorithm
matches 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 blocking 1.2.3.13
via the negation, but all other 1.2.3.* hosts pass through.
8.1.5. Glossary of Terms Used
Following is a list of terms used throughout the BIND configuration file documentation:
acl_name
The name of an address_match_list as defined by the
acl
statement.address_match_list
See Address Match Lists.
boolean
Either
yes
orno
. The wordstrue
andfalse
are also accepted, as are the numbers1
and0
.domain_name
A quoted string which is used as a DNS name; for example:
my.test.domain
.duration
A duration in BIND 9 can be written in three ways: as a single number representing seconds, as a string of numbers with TTL-style time-unit suffixes, or in ISO 6801 duration format.
Allowed TTL time-unit suffixes are: “W” (week), “D” (day), “H” (hour), “M” (minute), and “S” (second). Examples: “1W” (1 week), “3d12h” (3 days, 12 hours).
ISO 8601 duration format consists of the letter “P”, followed by an optional series of numbers with unit suffixes “Y” (year), “M” (month), “W” (week), and “D” (day); this may optionally be followed by the letter “T”, and another series of numbers with unit suffixes “H” (hour), “M” (minute), and “S” (second). Examples: “P3M10D” (3 months, 10 days), “P2WT12H” (2 weeks, 12 hours), “pt15m” (15 minutes). For more information on ISO 8601 duration format, see RFC 3339, appendix A.
Both TTL-style and ISO 8601 duration formats are case-insensitive.
fixedpoint
A non-negative real number that can be specified to the nearest one-hundredth. Up to five digits can be specified before a decimal point, and up to two digits after, so the maximum value is 99999.99. Acceptable values might be further limited by the contexts in which they are used.
integer
A non-negative 32-bit integer (i.e., a number between 0 and 4294967295, inclusive). Its acceptable value might be further limited by the context in which it is used.
ip_address
An ipv4_address or ipv6_address.
ipv4_address
An IPv4 address with exactly four integer elements valued 0 through 255 and separated by dots (
.
), such as192.168.1.1
(a “dotted-decimal” notation with all four elements present).ipv6_address
An IPv6 address, such as
2001:db8::1234
. IPv6-scoped addresses that have ambiguity on their scope zones must be disambiguated by an appropriate zone ID with the percent character (%
) as a delimiter. It is strongly recommended to use string zone names rather than numeric identifiers, to be robust against system configuration changes. However, since there is no standard mapping for such names and identifier values, only interface names as link identifiers are supported, assuming one-to-one mapping between interfaces and links. For example, a link-local addressfe80::1
on the link attached to the interfacene0
can be specified asfe80::1%ne0
. Note that on most systems link-local addresses always have ambiguity and need to be disambiguated.netprefix
An IP network specified as an ip_address, followed by a slash (
/
) and then the number of bits in the netmask. Trailing zeros in an ip_address may be omitted. For example,127/8
is the network127.0.0.0
with netmask255.0.0.0
and1.2.3.0/28
is network1.2.3.0
with netmask255.255.255.240
. When specifying a prefix involving an IPv6-scoped address, the scope may be omitted. In that case, the prefix matches packets from any scope.percentage
An integer value followed by
%
to represent percent.port
An IP port integer. It is limited to 0 through 65535, with values below 1024 typically restricted to use by processes running as root. In some cases, an asterisk (
*
) character can be used as a placeholder to select a random high-numbered port.portrange
A list of a port or a port range. A port range is specified in the form of
range
followed by two port s,port_low
andport_high
, which represents port numbers fromport_low
throughport_high
, inclusive.port_low
must not be larger thanport_high
. For example,range 1024 65535
represents ports from 1024 through 65535. The asterisk (*
) character is not allowed as a valid port or as a port range boundary.remote-servers
A named list of one or more ip_address es with optional tls_id, server_key, and/or port. A
remote-servers
list may include otherremote-servers
lists. Seeprimaries
block.server_key
A domain_name representing the name of a shared key, to be used for transaction security. Keys are defined using
key
blocks.size
sizeval
A 64-bit unsigned integer. Integers may take values 0 <= value <= 18446744073709551615, though certain parameters (such as
max-journal-size
) may use a more limited range within these extremes. In most cases, setting a value to 0 does not literally mean zero; it means “undefined” or “as big as possible,” depending on the context. See the explanations of particular parameters that usesize
for details on how they interpret its use. Numeric values can optionally be followed by a scaling factor:K
ork
for kilobytes,M
orm
for megabytes, andG
org
for gigabytes, which scale by 1024, 1024*1024, and 1024*1024*1024 respectively.Some statements also accept the keywords
unlimited
ordefault
:unlimited
generally means “as big as possible,” and is usually the best way to safely set a very large number.default
uses the limit that was in force when the server was started.tls_id
A named TLS configuration object which defines a TLS key and certificate. See
tls
block.
8.2. Blocks
A BIND 9 configuration consists of blocks, statements, and comments.
The following blocks 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.dnssec-policy
Describes a DNSSEC key and signing policy for zones. See
dnssec-policy
for details.key
Specifies key information for use in authentication and authorization using TSIG.
key-store
Describes a DNSSEC key store. See key-store Grammar for details.
logging
Specifies what information the server logs and where the log messages are sent.
masters
Synonym for
primaries
.options
Controls global server configuration options and sets defaults for other statements.
parental-agents
Defines a named list of servers for inclusion in primary and secondary zones’
parental-agents
lists.primaries
Defines a named list of servers for inclusion in stub and secondary zones’
primaries
oralso-notify
lists. (Note: this is a synonym for the original keywordmasters
, which can still be used, but is no longer the preferred terminology.)server
Sets certain configuration options on a per-server basis.
statistics-channels
Declares communication channels to get access to
named
statistics.tls
Specifies configuration information for a TLS connection, including a
key-file
,cert-file
,ca-file
,dhparam-file
,remote-hostname
,ciphers
,protocols
,prefer-server-ciphers
, andsession-tickets
.http
Specifies configuration information for an HTTP connection, including
endpoints
,listener-clients
, andstreams-per-connection
.trust-anchors
Defines DNSSEC trust anchors: if used with the
initial-key
orinitial-ds
keyword, trust anchors are kept up-to-date using RFC 5011 trust anchor maintenance; if used withstatic-key
orstatic-ds
, keys are permanent.managed-keys
Is identical to
trust-anchors
; this option is deprecated in favor oftrust-anchors
with theinitial-key
keyword, and may be removed in a future release.trusted-keys
Defines permanent trusted DNSSEC keys; this option is deprecated in favor of
trust-anchors
with thestatic-key
keyword, and may be removed in a future release.view
Defines a view.
zone
Defines a zone.
The logging
and options
statements may only occur once per
configuration.
8.2.1. acl
Block Grammar
- acl
Grammar:
acl <string> { <address_match_element>; ... }; // may occur multiple times
Blocks: topmost
Tags: server
Assigns a symbolic name to an address match list.
8.2.2. acl
Block Definition and Usage
The acl
statement assigns a symbolic name to an address match list.
It gets its name from one of the primary uses of address match lists: Access
Control Lists (ACLs).
The following ACLs are built-in:
any
Matches all hosts.
none
Matches no hosts.
localhost
Matches the IPv4 and IPv6 addresses of all network interfaces on the system. When addresses are added or removed, the
localhost
ACL element is updated to reflect the changes.localnets
Matches any host on an IPv4 or IPv6 network for which the system has an interface. When addresses are added or removed, the
localnets
ACL element is updated to reflect the changes. Some systems do not provide a way to determine the prefix lengths of local IPv6 addresses; in such cases,localnets
only matches the local IPv6 addresses, just likelocalhost
.
8.2.3. controls
Block Grammar
- controls
Grammar:
controls { inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | * ) ] allow { <address_match_element>; ... } [ keys { <string>; ... } ] [ read-only <boolean> ]; // may occur multiple times unix <quoted_string> perm <integer> owner <integer> group <integer> [ keys { <string>; ... } ] [ read-only <boolean> ]; // may occur multiple times }; // may occur multiple times
Blocks: topmost
Tags: server
Specifies control channels to be used to manage the name server.
8.2.4. controls
Block Definition and Usage
The controls
statement declares control channels to be used by
system administrators to manage the operation of the name server. These
control channels are used by the rndc
utility to send commands to
and retrieve non-DNS results from a name server.
- unix
Grammar:
unix <quoted_string> perm <integer> owner <integer> group <integer> [ keys { <string>; ... } ] [ read-only <boolean> ]; // may occur multiple times
Blocks: controls
Tags: obsolete
Specifies a Unix domain socket as a control channel.
This option has been removed and using it will cause a fatal error.
- inet
Grammar controls:
inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | * ) ] allow { <address_match_element>; ... } [ keys { <string>; ... } ] [ read-only <boolean> ]; // may occur multiple times
Grammar statistics-channels:
inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | * ) ] [ allow { <address_match_element>; ... } ]; // may occur multiple times
Blocks: controls, statistics-channels
Tags: server
Specifies a TCP socket as a control channel.
An
inet
control channel is a TCP socket listening at the specified port on the specified ip_address, which can be an IPv4 or IPv6 address. An ip_address of*
(asterisk) is interpreted as the IPv4 wildcard address; connections are accepted on any of the system’s IPv4 addresses. To listen on the IPv6 wildcard address, use an ip_address of::
. Ifrndc
is only used on the local host, using the loopback address (127.0.0.1
or::1
) is recommended for maximum security.If no port is specified, port 953 is used. The asterisk
*
cannot be used for port.The ability to issue commands over the control channel is restricted by the
allow
andkeys
clauses.allow
Connections to the control channel are permitted based on the address_match_list. This is for simple IP address-based filtering only; any server_key elements of the address_match_list are ignored.
keys
The primary authorization mechanism of the command channel is the list of server_key s. Each listed
key
is authorized to execute commands over the control channel. See Administrative Tools for information about configuring keys inrndc
.
read-only
If the
read-only
argument ison
, the control channel is limited to the following set of read-only commands:nta -dump
,null
,status
,showzone
,testgen
, andzonestatus
. By default,read-only
is not enabled and the control channel allows read-write access.
If no controls
statement is present, named
sets 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
attempts
to load the command channel key from the file /etc/rndc.key
.
To create an rndc.key
file, run rndc-confgen -a
.
To disable the command channel, use an empty controls
statement:
controls { };
.
8.2.5. key
Block Grammar
8.2.6. key
Block Definition and Usage
The key
statement defines a shared secret key for use with TSIG (see
TSIG) or the command channel (see controls
).
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 server_key, also known as the key name, is a domain name that uniquely
identifies the key. It can be used in a server
statement to cause
requests sent to that server to be signed 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.
- algorithm
Grammar:
algorithm <string>;
Blocks: key, view.key
Tags: security
Defines the algorithm to be used in a key clause.
The
algorithm_id
is a string that specifies a security/authentication algorithm. Thenamed
server supportshmac-md5
,hmac-sha1
,hmac-sha224
,hmac-sha256
,hmac-sha384
, andhmac-sha512
TSIG authentication. Truncated hashes are supported by appending the minimum number of required bits preceded by a dash, e.g.,hmac-sha1-80
.
- secret
Grammar:
secret <string>;
Blocks: key, view.key
Tags: security
Defines a Base64-encoded string to be used as the secret by the algorithm.
The
secret_string
is the secret to be used by the algorithm, and is treated as a Base64-encoded string.
8.2.7. key-store
Block Grammar
- key-store
Grammar:
key-store <string> { directory <string>; pkcs11-uri <quoted_string>; }; // may occur multiple times
Blocks: topmost
Tags: dnssec
Configures a DNSSEC key store.
8.2.8. key-store
Block Definition and Usage
The key-store
statement defines how DNSSEC keys should be stored.
There is one built-in key store named key-directory
. Configuring
keys to use key-store "key-directory"
is identical to using
key-directory
.
The following options can be specified in a key-store
statement:
- pkcs11-uri
Grammar:
pkcs11-uri <quoted_string>;
Blocks: key-store
Tags: dnssec, pkcs11
The
uri
is a string that specifies a PKCS#11 URI Scheme (defined in RFC 7512). When set,named
will try to create keys inside the corresponding PKCS#11 token. This requires BIND to be built with OpenSSL 3, and have a PKCS#11 provider configured.
8.2.9. logging
Block Grammar
- logging
Grammar:
logging { category <string> { <string>; ... }; // may occur multiple times channel <string> { buffered <boolean>; file <quoted_string> [ versions ( unlimited | <integer> ) ] [ size <size> ] [ suffix ( increment | timestamp ) ]; null; print-category <boolean>; print-severity <boolean>; print-time ( iso8601 | iso8601-utc | iso8601-tzinfo | local | <boolean> ); severity <log_severity>; stderr; syslog [ <syslog_facility> ]; }; // may occur multiple times };
Blocks: topmost
Tags: logging
Configures logging options for the name server.
8.2.10. logging
Block Definition and Usage
The logging
statement configures a wide variety of logging options
for the name server. Its channel
phrase associates output methods,
format options, and severity levels with a name that can then be used
with the category
phrase to select how various classes of messages
are logged.
Only one logging
statement is used to define as many channels and
categories as desired. If there is no logging
statement, the
logging configuration is:
logging {
category default { default_syslog; default_debug; };
category unmatched { null; };
};
If named
is started with the -L
option, it logs to the specified
file at startup, instead of using syslog. In this case the logging
configuration is:
logging {
category default { default_logfile; default_debug; };
category unmatched { null; };
};
The logging configuration is only established when the entire
configuration file has been parsed. When the server starts up, all
logging messages regarding syntax errors in the configuration file go to
the default channels, or to standard error if the -g
option was
specified.
8.2.10.1. The channel
Phrase
- channel
Grammar:
channel <string> { buffered <boolean>; file <quoted_string> [ versions ( unlimited | <integer> ) ] [ size <size> ] [ suffix ( increment | timestamp ) ]; null; print-category <boolean>; print-severity <boolean>; print-time ( iso8601 | iso8601-utc | iso8601-tzinfo | local | <boolean> ); severity <log_severity>; stderr; syslog [ <syslog_facility> ]; }; // may occur multiple times
Blocks: logging
Tags: logging
Defines a stream of data that can be independently logged.
All log output goes to one or more channels
; there is no limit to
the number of channels that can be created.
Every channel definition must include a destination clause that says
whether messages selected for the channel go to a file, go to a particular
syslog facility, go to the standard error stream, or are discarded. The definition can
optionally also limit the message severity level that is accepted
by the channel (the default is info
), and whether to include a
named
-generated time stamp, the category name, and/or the severity level
(the default is not to include any).
- null
Grammar:
null;
Blocks: logging.channel
Tags: logging
Causes all messages sent to the logging channel to be discarded.
The
null
destination clause causes all messages sent to the channel to be discarded; in that case, other options for the channel are meaningless.
file
The
file
destination clause directs the channel to a disk file. It can include additional arguments to specify how large the file is allowed to become before it is rolled to a backup file (size
), how many backup versions of the file are saved each time this happens (versions
), and the format to use for naming backup versions (suffix
).The
size
option is used to limit log file growth. If the file ever exceeds the specified size, thennamed
stops writing to the file unless it has aversions
option associated with it. If backup versions are kept, the files are rolled as described below. If there is noversions
option, no more data is written to the log until some out-of-band mechanism removes or truncates the log to less than the maximum size. The default behavior is not to limit the size of the file.File rolling only occurs when the file exceeds the size specified with the
size
option. No backup versions are kept by default; any existing log file is simply appended. Theversions
option specifies how many backup versions of the file should be kept. If set tounlimited
, there is no limit.The
suffix
option can be set to eitherincrement
ortimestamp
. If set totimestamp
, then when a log file is rolled, it is saved with the current timestamp as a file suffix. If set toincrement
, then backup files are saved with incrementing numbers as suffixes; older files are renamed when rolling. For example, ifversions
is set to 3 andsuffix
toincrement
, then whenfilename.log
reaches the size specified bysize
,filename.log.1
is renamed tofilename.log.2
,filename.log.0
is renamed tofilename.log.1
, andfilename.log
is renamed tofilename.log.0
, whereupon a newfilename.log
is opened.Here is an example using the
size
,versions
, andsuffix
options:channel an_example_channel { file "example.log" versions 3 size 20m suffix increment; print-time yes; print-category yes; };
- syslog
Grammar:
syslog [ <syslog_facility> ];
Blocks: logging.channel
Tags: logging
Directs the logging channel to the system log.
The
syslog
destination clause directs the channel to the system log. Its argument is a syslog facility as described in thesyslog
man page. Known facilities arekern
,user
,mail
,daemon
,auth
,syslog
,lpr
,news
,uucp
,cron
,authpriv
,ftp
,local0
,local1
,local2
,local3
,local4
,local5
,local6
, andlocal7
; however, not all facilities are supported on all operating systems. Howsyslog
handles messages sent to this facility is described in thesyslog.conf
man page. On a system which uses a very old version ofsyslog
, which only uses two arguments to theopenlog()
function, this clause is silently ignored.
- severity
Grammar:
severity <log_severity>;
Blocks: logging.channel
Tags: logging
Defines the priority level of log messages.
The
severity
clause works likesyslog
’s “priorities,” except that they can also be used when writing straight to a file rather than usingsyslog
. Messages which are not at least of the severity level given are not selected for the channel; messages of higher severity levels are accepted.When using
syslog
, thesyslog.conf
priorities also determine what eventually passes through. For example, defining a channel facility and severity asdaemon
anddebug
, but only loggingdaemon.warning
viasyslog.conf
, causes messages of severityinfo
andnotice
to be dropped. If the situation were reversed, withnamed
writing messages of onlywarning
or higher, thensyslogd
would print all messages it received from the channel.
- stderr
Grammar:
stderr;
Blocks: logging.channel
Tags: logging
Directs the logging channel output to the server’s standard error stream.
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, as when debugging a configuration, for example.
The server can supply extensive debugging information when it is in
debugging mode. If the server’s global debug level is greater than zero,
debugging mode is 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;
higher debug levels give more detailed output. Channels that specify a
specific debug severity, for example:
channel specific_debug_level {
file "foo";
severity debug 3;
};
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 debug level to determine
what messages to print.
- print-time
Grammar:
print-time ( iso8601 | iso8601-utc | iso8601-tzinfo | local | <boolean> );
Blocks: logging.channel
Tags: logging
Specifies the time format for log messages.
print-time
can be set toyes
,no
, or a time format specifier, which may be one oflocal
,iso8601
,iso8601-utc
oriso8601-tzinfo
. If set tono
, the date and time are not logged. If set toyes
orlocal
, the date and time are logged in a human-readable format, using the local time zone. If set toiso8601
, the local time is logged in ISO 8601 format, but no timezone information is included in the timestamp. If set toiso8601-utc
, the date and time are logged in ISO 8601 format, with time zone set to UTC. If set toiso8601-tzinfo
, the local time is logged in ISO 8601 format, with timezone information included at the end of the timestamp. The default isno
.print-time
may be specified for asyslog
channel, but it is usually pointless sincesyslog
also logs the date and time.
- print-category
Grammar:
print-category <boolean>;
Blocks: logging.channel
Tags: logging
Includes the category in log messages.
If
print-category
is requested, then the category of the message is logged as well.
- print-severity
Grammar:
print-severity <boolean>;
Blocks: logging.channel
Tags: logging
Includes the severity in log messages.
If
print-severity
is on, then the severity level of the message is logged. Theprint-
options may be used in any combination, and are always printed in the following 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
- buffered
Grammar:
buffered <boolean>;
Blocks: logging.channel
Tags: logging
Controls flushing of log messages.
If
buffered
has been turned on, the output to files is not flushed after each log entry. By default all log messages are flushed.
There are four predefined channels that are used for named
’s default
logging, as follows. If named
is started with the -L
option, then a fifth
channel, default_logfile
, is added. How they are used is described in
category
.
channel default_syslog {
// send to syslog's daemon facility
syslog daemon;
// only send priority info and higher
severity info;
};
channel default_debug {
// write to named.run in the working directory
// Note: stderr is used instead of "named.run" if
// the server is started with the '-g' option.
file "named.run";
// log at the server's current debug level
severity dynamic;
};
channel default_stderr {
// writes to stderr
stderr;
// only send priority info and higher
severity info;
};
channel null {
// toss anything sent to this channel
null;
};
channel default_logfile {
// this channel is only present if named is
// started with the -L option, whose argument
// provides the file name
file "...";
// log at the server's current debug level
severity dynamic;
};
The default_debug
channel has the special property that it only
produces output when the server’s debug level is non-zero. It normally
writes to a file called 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 generated while named
is starting -
and still running as root - is discarded. To capture this
output, run the server with the -L
option to specify a
default logfile, or the -g
option to log to standard error which can
be redirected to a file.
Once a channel is defined, it cannot be redefined. The built-in channels cannot be altered directly, but the default logging can be modified by pointing categories at defined channels.
8.2.10.2. The category
Phrase
There are many categories, so desired logs can be sent anywhere
while unwanted logs are ignored. If
a list of channels is not specified for a category, log messages in that
category are sent to the default
category instead. If no
default category is specified, the following “default default” is used:
category default { default_syslog; default_debug; };
If named
is started with the -L
option, the default category
is:
category default { default_logfile; default_debug; };
As an example, let’s say a user wants to log security events to a file, but also wants to keep the default logging behavior. They would 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:
category xfer-out { null; };
category notify { null; };
- category
Grammar:
category <string> { <string>; ... }; // may occur multiple times
Blocks: logging
Tags: logging
Specifies the type of data logged to a particular channel.
The 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.
client
Processing of client requests.
cname
Name servers that are skipped for being a CNAME rather than A/AAAA records.
config
Configuration file parsing and processing.
database
Messages relating to the databases used internally by the name server to store zone and cache data.
default
Logging options for those categories where no specific configuration has been defined.
dispatch
Dispatching of incoming packets to the server modules where they are to be processed.
dnssec
DNSSEC and TSIG protocol processing.
dnstap
The
dnstap
DNS traffic capture system.edns-disabled
Log queries that have been forced to use plain DNS due to timeouts. This is often due to the remote servers not being RFC 1034-compliant (not always returning FORMERR or similar to EDNS queries and other extensions to the DNS when they are not understood). In other words, this is targeted at servers that fail to respond to DNS queries that they don’t understand.
Note: the log message can also be due to packet loss. Before reporting servers for non-RFC 1034 compliance they should be re-tested to determine the nature of the non-compliance. This testing should prevent or reduce the number of false-positive reports.
Note: eventually
named
will have to stop treating such timeouts as due to RFC 1034 non-compliance and start treating it as plain packet loss. Falsely classifying packet loss as due to RFC 1034 non-compliance impacts DNSSEC validation, which requires EDNS for the DNSSEC records to be returned.general
A catch-all for many things that still are not classified into categories.
lame-servers
Misconfigurations in remote servers, discovered by BIND 9 when trying to query those servers during resolution.
network
Network operations.
notify
The NOTIFY protocol.
nsid
NSID options received from upstream servers.
queries
The locations where queries should be logged.
At startup, specifying the category
queries
also enables query logging unless thequerylog
option has been specified.The query log entry first reports a client object identifier in @0x<hexadecimal-number> format. Next, it reports the client’s IP address and port number, and the query name, class, and type. Next, it reports whether the Recursion Desired flag was set (+ if set, - if not set), whether the query was signed (S), whether EDNS was in use along with the EDNS version number (E(#)), whether TCP was used (T), whether DO (DNSSEC Ok) was set (D), whether CD (Checking Disabled) was set (C), whether a valid DNS Server COOKIE was received (V), and whether a DNS COOKIE option without a valid Server COOKIE was present (K). After this, the destination address the query was sent to is reported. Finally, if any CLIENT-SUBNET option was present in the client query, it is included in square brackets in the format [ECS address/source/scope].
client @0x7f91b8005490 127.0.0.1#62536 (www.example.com): query: www.example.com IN AAAA +E(0)K (127.0.0.1) client @0x7f91b4007400 ::1#62537 (www.example.net): query: www.example.net IN AAAA +E(0)K (::1)
The first part of this log message, showing the client address/port number and query name, is repeated in all subsequent log messages related to the same query.
query-errors
Information about queries that resulted in some failure.
rate-limit
Start, periodic, and final notices of the rate limiting of a stream of responses that are logged at
info
severity in this category. These messages include a hash value of the domain name of the response and the name itself, except when there is insufficient memory to record the name for the final notice. The final notice is normally delayed until about one minute after rate limiting stops. A lack of memory can hurry the final notice, which is indicated by an initial asterisk (*). Various internal events are logged at debug level 1 and higher.Rate limiting of individual requests is logged in the
query-errors
category.resolver
DNS resolution, such as the recursive lookups performed on behalf of clients by a caching name server.
responses
The locations where query response summaries should be logged.
rpz
Information about errors in response policy zone files, rewritten responses, and, at the highest
debug
levels, mere rewriting attempts.rpz-passthru
Information about RPZ PASSTHRU policy activity. This category allows pre-approved policy activity to be logged into a dedicated channel.
security
Approval and denial of requests.
serve-stale
Indication of whether a stale answer is used following a resolver failure.
spill
Queries that have been terminated, either by dropping or responding with SERVFAIL, as a result of a fetchlimit quota being exceeded.
sslkeylog
TLS pre-master secrets (for debugging purposes).
trust-anchor-telemetry
trust-anchor-telemetry
requests received bynamed
.unmatched
Messages that
named
was unable to determine the class of, or for which there was no matchingview
. A one-line summary is also logged to theclient
category. This category is best sent to a file or stderr; by default it is sent to thenull
channel.update
Dynamic updates.
update-security
Approval and denial of update requests.
xfer-in
Zone transfers the server is receiving.
xfer-out
Zone transfers the server is sending.
zoneload
Loading of zones and creation of automatic empty zones.
8.2.10.3. The query-errors
Category
The query-errors
category is used to indicate why and how specific queries
resulted in responses which indicate an error. Normally, these messages are
logged at debug
logging levels; note, however, that if query logging is
active, some are logged at info
. The logging levels are described below:
At debug
level 1 or higher - or at info
when query logging is
active - each response with the rcode of SERVFAIL is logged as follows:
client 127.0.0.1#61502: query failed (SERVFAIL) for www.example.com/IN/AAAA at query.c:3880
This means an error resulting in SERVFAIL was detected at line 3880 of source
file query.c
. Log messages of this level are particularly helpful in identifying
the cause of SERVFAIL for an authoritative server.
At debug
level 2 or higher, detailed context information about recursive
resolutions that resulted in SERVFAIL is logged. The log message looks
like this:
fetch completed at resolver.c:2970 for www.example.com/A
in 10.000183: timed out/success [domain:example.com,
referral:2,restart:7,qrysent:8,timeout:5,lame:0,quota:0,neterr:0,
badresp:1,adberr:0,findfail:0,valfail:0]
The first part before the colon shows that a recursive resolution for
AAAA records of www.example.com completed in 10.000183 seconds, and the
final result that led to the SERVFAIL was determined at line 2970 of
source file resolver.c
.
The next part shows the detected final result and the latest result of DNSSEC validation. The latter is always “success” when no validation attempt was made. In this example, this query probably resulted in SERVFAIL because all name servers are down or unreachable, leading to a timeout in 10 seconds. DNSSEC validation was probably not attempted.
The last part, enclosed in square brackets, shows statistics collected for this
particular resolution attempt. The domain
field shows the deepest zone that
the resolver reached; it is the zone where the error was finally detected. The
meaning of the other fields is summarized in the following list.
referral
The number of referrals the resolver received throughout the resolution process. In the above
example.com
there are two.restart
The number of cycles that the resolver tried remote servers at the
domain
zone. In each cycle, the resolver sends one query (possibly resending it, depending on the response) to each known name server of thedomain
zone.qrysent
The number of queries the resolver sent at the
domain
zone.timeout
The number of timeouts the resolver received since the last response.
lame
The number of lame servers the resolver detected at the
domain
zone. A server is detected to be lame either by an invalid response or as a result of lookup in BIND 9’s address database (ADB), where lame servers are cached.quota
The number of times the resolver was unable to send a query because it had exceeded the permissible fetch quota for a server.
neterr
The number of erroneous results that the resolver encountered in sending queries at the
domain
zone. One common case is when the remote server is unreachable and the resolver receives an “ICMP unreachable” error message.badresp
The number of unexpected responses (other than
lame
) to queries sent by the resolver at thedomain
zone.adberr
Failures in finding remote server addresses of the``domain`` zone in the ADB. One common case of this is that the remote server’s name does not have any address records.
findfail
Failures to resolve remote server addresses. This is a total number of failures throughout the resolution process.
valfail
Failures of DNSSEC validation. Validation failures are counted throughout the resolution process (not limited to the
domain
zone), but should only happen indomain
.
At debug
level 3 or higher, the same messages as those at
debug
level 1 are logged for errors other than
SERVFAIL. Note that negative responses such as NXDOMAIN are not errors, and are
not logged at this debug level.
At debug
level 4 or higher, the detailed context information logged at
debug
level 2 is logged for errors other than SERVFAIL and for negative
responses such as NXDOMAIN.
8.2.11. parental-agents
Block Grammar
- parental-agents
Grammar zone (primary, secondary):
parental-agents [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... };
Grammar topmost:
parental-agents <string> [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; // may occur multiple times
Blocks: topmost, zone (primary, secondary)
Tags: zone
Defines a list of delegation agents to be used by primary and secondary zones.
8.2.12. parental-agents
Block Definition and Usage
parental-agents
lists allow for a common set of parental agents to be
easily used by multiple primary and secondary zones. A “parental agent” is a
trusted DNS server that is queried to check whether DS records for a given zones
are up-to-date.
8.2.13. primaries
Block Grammar
- primaries
Grammar zone (mirror, redirect, secondary, stub):
primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... };
Grammar topmost:
primaries <string> [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; // may occur multiple times
Blocks: topmost, zone (mirror, redirect, secondary, stub)
Tags: zone
Defines one or more primary servers for a zone.
8.2.14. primaries
Block Definition and Usage
primaries
lists allow for a common set of primary servers to be easily
used by multiple stub and secondary zones in their primaries
or
also-notify
lists. (Note: primaries
is a synonym for the original
keyword masters
, which can still be used, but is no longer the
preferred terminology.)
To force the zone transfer requests to be sent over TLS, use tls
keyword,
e.g. primaries { 192.0.2.1 tls tls-configuration-name; };
,
where tls-configuration-name
refers to a previously defined
tls statement
.
Warning
Please note that TLS connections to primaries are not
authenticated unless remote-hostname
or ca-file
are specified
within the tls statement
in use (see information on
Strict TLS and Mutual TLS
for more details). Not authenticated mode (Opportunistic
TLS) provides protection from passive
observers but does not protect from man-in-the-middle attacks on
zone transfers.
8.2.15. options
Block Grammar
- options
Grammar:
options { allow-new-zones <boolean>; allow-notify { <address_match_element>; ... }; allow-proxy { <address_match_element>; ... }; // experimental allow-proxy-on { <address_match_element>; ... }; // experimental allow-query { <address_match_element>; ... }; allow-query-cache { <address_match_element>; ... }; allow-query-cache-on { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-recursion { <address_match_element>; ... }; allow-recursion-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; answer-cookie <boolean>; attach-cache <string>; auth-nxdomain <boolean>; automatic-interface-scan <boolean>; bindkeys-file <quoted_string>; // test only blackhole { <address_match_element>; ... }; catalog-zones { zone <string> [ default-primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... } ] [ zone-directory <quoted_string> ] [ in-memory <boolean> ] [ min-update-interval <duration> ]; ... }; check-dup-records ( fail | warn | ignore ); check-integrity <boolean>; check-mx ( fail | warn | ignore ); check-mx-cname ( fail | warn | ignore ); check-names ( primary | master | secondary | slave | response ) ( fail | warn | ignore ); // may occur multiple times check-sibling <boolean>; check-spf ( warn | ignore ); check-srv-cname ( fail | warn | ignore ); check-svcb <boolean>; check-wildcard <boolean>; clients-per-query <integer>; cookie-algorithm ( siphash24 ); cookie-secret <string>; // may occur multiple times deny-answer-addresses { <address_match_element>; ... } [ except-from { <string>; ... } ]; deny-answer-aliases { <string>; ... } [ except-from { <string>; ... } ]; directory <quoted_string>; disable-algorithms <string> { <string>; ... }; // may occur multiple times disable-ds-digests <string> { <string>; ... }; // may occur multiple times disable-empty-zone <string>; // may occur multiple times dns64 <netprefix> { break-dnssec <boolean>; clients { <address_match_element>; ... }; exclude { <address_match_element>; ... }; mapped { <address_match_element>; ... }; recursive-only <boolean>; suffix <ipv6_address>; }; // may occur multiple times dns64-contact <string>; dns64-server <string>; dnskey-sig-validity <integer>; // obsolete dnsrps-enable <boolean>; // obsolete dnsrps-library <quoted_string>; // obsolete dnsrps-options { <unspecified-text> }; // obsolete dnssec-accept-expired <boolean>; dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-must-be-secure <string> <boolean>; // may occur multiple times, deprecated dnssec-policy <string>; dnssec-secure-to-insecure <boolean>; // obsolete dnssec-update-mode ( maintain | no-resign ); // obsolete dnssec-validation ( yes | no | auto ); dnstap { ( all | auth | client | forwarder | resolver | update ) [ ( query | response ) ]; ... }; dnstap-identity ( <quoted_string> | none | hostname ); dnstap-output ( file | unix ) <quoted_string> [ size ( unlimited | <size> ) ] [ versions ( unlimited | <integer> ) ] [ suffix ( increment | timestamp ) ]; dnstap-version ( <quoted_string> | none ); dual-stack-servers [ port <integer> ] { ( <quoted_string> [ port <integer> ] | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ); ... }; dump-file <quoted_string>; edns-udp-size <integer>; empty-contact <string>; empty-server <string>; empty-zones-enable <boolean>; fetch-quota-params <integer> <fixedpoint> <fixedpoint> <fixedpoint>; fetches-per-server <integer> [ ( drop | fail ) ]; fetches-per-zone <integer> [ ( drop | fail ) ]; flush-zones-on-shutdown <boolean>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; fstrm-set-buffer-hint <integer>; fstrm-set-flush-timeout <integer>; fstrm-set-input-queue-size <integer>; fstrm-set-output-notify-threshold <integer>; fstrm-set-output-queue-model ( mpsc | spsc ); fstrm-set-output-queue-size <integer>; fstrm-set-reopen-interval <duration>; geoip-directory ( <quoted_string> | none ); hostname ( <quoted_string> | none ); http-listener-clients <integer>; http-port <integer>; http-streams-per-connection <integer>; https-port <integer>; interface-interval <duration>; ipv4only-contact <string>; ipv4only-enable <boolean>; ipv4only-server <string>; ixfr-from-differences ( primary | master | secondary | slave | <boolean> ); keep-response-order { <address_match_element>; ... }; // obsolete key-directory <quoted_string>; lame-ttl <duration>; listen-on [ port <integer> ] [ proxy <string> ] [ tls <string> ] [ http <string> ] { <address_match_element>; ... }; // may occur multiple times listen-on-v6 [ port <integer> ] [ proxy <string> ] [ tls <string> ] [ http <string> ] { <address_match_element>; ... }; // may occur multiple times lmdb-mapsize <sizeval>; managed-keys-directory <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); match-mapped-addresses <boolean>; max-cache-size ( default | unlimited | <sizeval> | <percentage> ); max-cache-ttl <duration>; max-clients-per-query <integer>; max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-ncache-ttl <duration>; max-query-restarts <integer>; max-records <integer>; max-records-per-type <integer>; max-recursion-depth <integer>; max-recursion-queries <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-rsa-exponent-size <integer>; max-stale-ttl <duration>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; max-udp-size <integer>; max-validation-failures-per-fetch <integer>; // experimental max-validations-per-fetch <integer>; // experimental max-zone-ttl ( unlimited | <duration> ); // deprecated memstatistics <boolean>; memstatistics-file <quoted_string>; message-compression <boolean>; min-cache-ttl <duration>; min-ncache-ttl <duration>; min-refresh-time <integer>; min-retry-time <integer>; minimal-any <boolean>; minimal-responses ( no-auth | no-auth-recursive | <boolean> ); multi-master <boolean>; new-zones-directory <quoted_string>; no-case-compress { <address_match_element>; ... }; nocookie-udp-size <integer>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-rate <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only nta-lifetime <duration>; nta-recheck <duration>; nxdomain-redirect <string>; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); pid-file ( <quoted_string> | none ); port <integer>; preferred-glue <string>; prefetch <integer> [ <integer> ]; provide-ixfr <boolean>; qname-minimization ( strict | relaxed | disabled | off ); query-source [ address ] ( <ipv4_address> | * ); query-source-v6 [ address ] ( <ipv6_address> | * ); querylog <boolean>; rate-limit { all-per-second <integer>; errors-per-second <integer>; exempt-clients { <address_match_element>; ... }; ipv4-prefix-length <integer>; ipv6-prefix-length <integer>; log-only <boolean>; max-table-size <integer>; min-table-size <integer>; nodata-per-second <integer>; nxdomains-per-second <integer>; qps-scale <integer>; referrals-per-second <integer>; responses-per-second <integer>; slip <integer>; window <integer>; }; recursing-file <quoted_string>; recursion <boolean>; recursive-clients <integer>; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; request-nsid <boolean>; require-server-cookie <boolean>; resolver-query-timeout <integer>; resolver-use-dns64 <boolean>; response-padding { <address_match_element>; ... } block-size <integer>; response-policy { zone <string> [ add-soa <boolean> ] [ log <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ policy ( cname | disabled | drop | given | no-op | nodata | nxdomain | passthru | tcp-only <quoted_string> ) ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ ede <string> ]; ... } [ add-soa <boolean> ] [ break-dnssec <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ min-ns-dots <integer> ] [ nsip-wait-recurse <boolean> ] [ nsdname-wait-recurse <boolean> ] [ qname-wait-recurse <boolean> ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ dnsrps-enable <boolean> ] [ dnsrps-options { <unspecified-text> } ]; responselog <boolean>; reuseport <boolean>; root-key-sentinel <boolean>; rrset-order { [ class <string> ] [ type <string> ] [ name <quoted_string> ] <string> <string>; ... }; secroots-file <quoted_string>; send-cookie <boolean>; serial-query-rate <integer>; serial-update-method ( date | increment | unixtime ); server-id ( <quoted_string> | none | hostname ); servfail-ttl <duration>; session-keyalg <string>; session-keyfile ( <quoted_string> | none ); session-keyname <string>; sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete sig0checks-quota <integer>; // experimental sig0checks-quota-exempt { <address_match_element>; ... }; // experimental sortlist { <address_match_element>; ... }; // deprecated stale-answer-client-timeout ( disabled | off | <integer> ); stale-answer-enable <boolean>; stale-answer-ttl <duration>; stale-cache-enable <boolean>; stale-refresh-time <duration>; startup-notify-rate <integer>; statistics-file <quoted_string>; synth-from-dnssec <boolean>; tcp-advertised-timeout <integer>; tcp-clients <integer>; tcp-idle-timeout <integer>; tcp-initial-timeout <integer>; tcp-keepalive-timeout <integer>; tcp-listen-queue <integer>; tcp-receive-buffer <integer>; tcp-send-buffer <integer>; tkey-domain <quoted_string>; tkey-gssapi-credential <quoted_string>; tkey-gssapi-keytab <quoted_string>; tls-port <integer>; transfer-format ( many-answers | one-answer ); transfer-message-size <integer>; transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); transfers-in <integer>; transfers-out <integer>; transfers-per-ns <integer>; trust-anchor-telemetry <boolean>; try-tcp-refresh <boolean>; udp-receive-buffer <integer>; udp-send-buffer <integer>; update-check-ksk <boolean>; // obsolete update-quota <integer>; v6-bias <integer>; validate-except { <string>; ... }; version ( <quoted_string> | none ); zero-no-soa-ttl <boolean>; zero-no-soa-ttl-cache <boolean>; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: topmost
Tags: server
Defines global options to be used by BIND 9.
This is the grammar of the options
statement in the named.conf
file:
8.2.16. options
Block 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 there is
no options
statement, an options block with each option set to its
default is used.
- attach-cache
Grammar:
attach-cache <string>;
Blocks: options, view
Tags: view
Allows multiple views to share a single cache database.
This option allows multiple views to share a single cache database. Each view has its own cache database by default, but if multiple views have the same operational policy for name resolution and caching, those views can share a single cache to save memory, and possibly improve resolution efficiency, by using this option.
The
attach-cache
option may also be specified inview
statements, in which case it overrides the globalattach-cache
option.The
cache_name
specifies the cache to be shared. When thenamed
server configures views which are supposed to share a cache, it creates a cache with the specified name for the first view of these sharing views. The rest of the views simply refer to the already-created cache.One common configuration to share a cache is to allow all views to share a single cache. This can be done by specifying
attach-cache
as a global option with an arbitrary name.Another possible operation is to allow a subset of all views to share a cache while the others retain their own caches. For example, if there are three views A, B, and C, and only A and B should share a cache, specify the
attach-cache
option as a view of A (or B)’s option, referring to the other view name:view "A" { // this view has its own cache ... }; view "B" { // this view refers to A's cache attach-cache "A"; }; view "C" { // this view has its own cache ... };
Views that share a cache must have the same policy on configurable parameters that may affect caching. The current implementation requires the following configurable options be consistent among these views:
check-names
,dnssec-accept-expired
,dnssec-validation
,max-cache-ttl
,max-ncache-ttl
,max-stale-ttl
,max-cache-size
,min-cache-ttl
,min-ncache-ttl
, andzero-no-soa-ttl
.Note that there may be other parameters that may cause confusion if they are inconsistent for different views that share a single cache. For example, if these views define different sets of forwarders that can return different answers for the same question, sharing the answer does not make sense or could even be harmful. It is the administrator’s responsibility to ensure that configuration differences in different views do not cause disruption with a shared cache.
- directory
Grammar key-store:
directory <string>;
Grammar options:
directory <quoted_string>;
Blocks: key-store, options
Tags: server
Sets the server’s working directory.
This sets the working directory of the server. Any non-absolute pathnames in the configuration file are 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, and must be writable by the effective user ID of thenamed
process.The option takes effect only at the time that the configuration option is parsed; if other files are being included before or after specifying the new
directory
, thedirectory
option must be listed before any other directive (likeinclude
) that can work with relative files. The safest way to include files is to use absolute file names.
- dnstap
Grammar:
dnstap { ( all | auth | client | forwarder | resolver | update ) [ ( query | response ) ]; ... };
Blocks: options, view
Tags: logging
Enables logging of
dnstap
messages.dnstap
is a fast, flexible method for capturing and logging DNS traffic. Developed by Robert Edmonds at Farsight Security, Inc., and supported by multiple DNS implementations,dnstap
useslibfstrm
(a lightweight high-speed framing library; see https://github.com/farsightsec/fstrm) to send event payloads which are encoded using Protocol Buffers (libprotobuf-c
, a mechanism for serializing structured data developed by Google, Inc.; see https://developers.google.com/protocol-buffers/).To enable
dnstap
at compile time, thefstrm
andprotobuf-c
libraries must be available, and BIND must be configured with--enable-dnstap
.The
dnstap
option is a bracketed list of message types to be logged. These may be set differently for each view. Supported types areclient
,auth
,resolver
,forwarder
, andupdate
. Specifying typeall
causes alldnstap
messages to be logged, regardless of type.Each type may take an additional argument to indicate whether to log
query
messages orresponse
messages; if not specified, both queries and responses are logged.Example: To log all authoritative queries and responses, recursive client responses, and upstream queries sent by the resolver, use:
dnstap { auth; client response; resolver query; };
Note
In the default configuration, the dnstap output for recursive resolver traffic does not include the IP addresses used by server-side sockets. This is caused by the fact that unless the query source address is explicitly set, these sockets are bound to wildcard IP addresses and determining the specific IP address used by each of them requires issuing a system call (i.e. incurring a performance penalty).
Logged
dnstap
messages can be parsed using thednstap-read
utility (see dnstap-read - print dnstap data in human-readable form for details).For more information on
dnstap
, see https://dnstap.info.The fstrm library has a number of tunables that are exposed in
named.conf
, and can be modified if necessary to improve performance or prevent loss of data. These are:- fstrm-set-buffer-hint
Grammar:
fstrm-set-buffer-hint <integer>;
Blocks: options
Tags: logging
Sets the number of accumulated bytes in the output buffer before forcing a buffer flush.
The threshold number of bytes to accumulate in the output buffer before forcing a buffer flush. The minimum is 1024, the maximum is 65536, and the default is 8192.
- fstrm-set-flush-timeout
Grammar:
fstrm-set-flush-timeout <integer>;
Blocks: options
Tags: logging
Sets the number of seconds that unflushed data remains in the output buffer.
The number of seconds to allow unflushed data to remain in the output buffer. The minimum is 1 second, the maximum is 600 seconds (10 minutes), and the default is 1 second.
- fstrm-set-output-notify-threshold
Grammar:
fstrm-set-output-notify-threshold <integer>;
Blocks: options
Tags: logging
Sets the number of outstanding queue entries allowed on an input queue before waking the I/O thread.
The number of outstanding queue entries to allow on an input queue before waking the I/O thread. The minimum is 1 and the default is 32.
- fstrm-set-output-queue-model
Grammar:
fstrm-set-output-queue-model ( mpsc | spsc );
Blocks: options
Tags: logging
Sets the queuing semantics to use for queue objects.
The queuing semantics to use for queue objects. The default is
mpsc
(multiple producer, single consumer); the other option isspsc
(single producer, single consumer).
- fstrm-set-input-queue-size
Grammar:
fstrm-set-input-queue-size <integer>;
Blocks: options
Tags: logging
Sets the number of queue entries to allocate for each input queue.
The number of queue entries to allocate for each input queue. This value must be a power of 2. The minimum is 2, the maximum is 16384, and the default is 512.
- fstrm-set-output-queue-size
Grammar:
fstrm-set-output-queue-size <integer>;
Blocks: options
Tags: logging
Sets the number of queue entries allocated for each output queue.
The number of queue entries to allocate for each output queue. The minimum is 2, the maximum is system-dependent and based on
IOV_MAX
, and the default is 64.
- fstrm-set-reopen-interval
Grammar:
fstrm-set-reopen-interval <duration>;
Blocks: options
Tags: logging
Sets the number of seconds to wait between attempts to reopen a closed output stream.
The number of seconds to wait between attempts to reopen a closed output stream. The minimum is 1 second, the maximum is 600 seconds (10 minutes), and the default is 5 seconds. For convenience, TTL-style time-unit suffixes may be used to specify the value.
Note that all of the above minimum, maximum, and default values are set by the
libfstrm
library, and may be subject to change in future versions of the library. See thelibfstrm
documentation for more information.
- dnstap-output
Grammar:
dnstap-output ( file | unix ) <quoted_string> [ size ( unlimited | <size> ) ] [ versions ( unlimited | <integer> ) ] [ suffix ( increment | timestamp ) ];
Blocks: options
Tags: logging
Configures the path to which the
dnstap
frame stream is sent.This configures the path to which the
dnstap
frame stream is sent ifdnstap
is enabled at compile time and active.The first argument is either
file
orunix
, indicating whether the destination is a file or a Unix domain socket. The second argument is the path of the file or socket. (Note: when using a socket,dnstap
messages are only sent if another process such asfstrm_capture
(provided withlibfstrm
) is listening on the socket.)If the first argument is
file
, then up to three additional options can be added:size
indicates the size to which adnstap
log file can grow before being rolled to a new file;versions
specifies the number of rolled log files to retain; andsuffix
indicates whether to retain rolled log files with an incrementing counter as the suffix (increment
) or with the current timestamp (timestamp
). These are similar to thesize
,versions
, andsuffix
options in alogging
channel. The default is to allowdnstap
log files to grow to any size without rolling.dnstap-output
can only be set globally inoptions
. Currently, it can only be set once whilenamed
is running; once set, it cannot be changed byrndc reload
orrndc reconfig
.
- dnstap-identity
Grammar:
dnstap-identity ( <quoted_string> | none | hostname );
Blocks: options
Tags: logging
Specifies an
identity
string to send indnstap
messages.This specifies an
identity
string to send indnstap
messages. If set tohostname
, which is the default, the server’s hostname is sent. If set tonone
, no identity string is sent.
- dnstap-version
Grammar:
dnstap-version ( <quoted_string> | none );
Blocks: options
Tags: logging
Specifies a
version
string to send indnstap
messages.This specifies a
version
string to send indnstap
messages. The default is the version number of the BIND release. If set tonone
, no version string is sent.
- geoip-directory
Grammar:
geoip-directory ( <quoted_string> | none );
Blocks: options
Tags: server
Specifies the directory containing GeoIP database files.
When
named
is compiled using the MaxMind GeoIP2 geolocation API, this specifies the directory containing GeoIP database files. By default, the option is set based on the prefix used to build thelibmaxminddb
module; for example, if the library is installed in/usr/local/lib
, then the defaultgeoip-directory
is/usr/local/share/GeoIP
. Seeacl
for details aboutgeoip
ACLs.
- key-directory
Grammar:
key-directory <quoted_string>;
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Indicates the directory where public and private DNSSEC key files are found.
This is the directory where the public and private DNSSEC key files should be found when performing a dynamic update of secure zones, if different than the current working directory. (Note that this option has no effect on the paths for files containing non-DNSSEC keys such as
rndc.key
, orsession.key
.)
- lmdb-mapsize
Grammar:
lmdb-mapsize <sizeval>;
Blocks: options, view
Tags: server
Sets a maximum size for the memory map of the new-zone database in LMDB database format.
When
named
is built with liblmdb, this option sets a maximum size for the memory map of the new-zone database (NZD) in LMDB database format. This database is used to store configuration information for zones added usingrndc addzone
. Note that this is not the NZD database file size, but the largest size that the database may grow to.Because the database file is memory-mapped, its size is limited by the address space of the
named
process. The default of 32 megabytes was chosen to be usable with 32-bitnamed
builds. The largest permitted value is 1 terabyte. Given typical zone configurations without elaborate ACLs, a 32 MB NZD file ought to be able to hold configurations of about 100,000 zones.
- managed-keys-directory
Grammar:
managed-keys-directory <quoted_string>;
Blocks: options
Tags: dnssec
Specifies the directory in which to store the files that track managed DNSSEC keys.
This specifies the directory in which to store the files that track managed DNSSEC keys (i.e., those configured using the
initial-key
orinitial-ds
keywords in atrust-anchors
statement). By default, this is the working directory. The directory must be writable by the effective user ID of thenamed
process.If
named
is not configured to use views, managed keys for the server are tracked in a single file calledmanaged-keys.bind
. Otherwise, managed keys are tracked in separate files, one file per view; each file name is the view name (or, if it contains characters that are incompatible with use as a file name, the SHA256 hash of the view name), followed by the extension.mkeys
.(Note: in earlier releases, file names for views always used the SHA256 hash of the view name. To ensure compatibility after upgrading, if a file using the old name format is found to exist, it is used instead of the new format.)
- max-ixfr-ratio
Grammar:
max-ixfr-ratio ( unlimited | <percentage> );
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Sets the maximum size for IXFR responses to zone transfer requests.
This sets the size threshold (expressed as a percentage of the size of the full zone) beyond which
named
chooses to use an AXFR response rather than IXFR when answering zone transfer requests. See Incremental Zone Transfers (IXFR).The minimum value is
1%
. The keywordunlimited
disables ratio checking and allows IXFRs of any size. The default is100%
.
- new-zones-directory
Grammar:
new-zones-directory <quoted_string>;
Blocks: options, view
Tags: zone
Specifies the directory where configuration parameters are stored for zones added by
rndc addzone
.This specifies the directory in which to store the configuration parameters for zones added via
rndc addzone
. By default, this is the working directory. If set to a relative path, it is relative to the working directory. The directory must be writable by the effective user ID of thenamed
process.
- qname-minimization
Grammar:
qname-minimization ( strict | relaxed | disabled | off );
Blocks: options, view
Tags: query
Controls QNAME minimization behavior in the BIND 9 resolver.
When this is set to
strict
, BIND follows the QNAME minimization algorithm to the letter, as specified in RFC 7816.Setting this option to
relaxed
causes BIND to fall back to normal (non-minimized) query mode when it receives either NXDOMAIN or other unexpected responses (e.g., SERVFAIL, improper zone cut, REFUSED) to a minimized query.In
relaxed
modenamed
makes NS queries for<domain>
as it walks down the tree.disabled
disables QNAME minimization completely.off
is a synonym fordisabled
.The current default is
relaxed
, but it may be changed tostrict
in a future release.
- tkey-gssapi-keytab
Grammar:
tkey-gssapi-keytab <quoted_string>;
Blocks: options
Tags: security
Sets the KRB5 keytab file to use for GSS-TSIG updates.
This is the KRB5 keytab file to use for GSS-TSIG updates. If this option is set and
tkey-gssapi-credential
is not set, updates are allowed with any key matching a principal in the specified keytab.
- tkey-gssapi-credential
Grammar:
tkey-gssapi-credential <quoted_string>;
Blocks: options
Tags: security
Sets the security credential for authentication keys requested by the GSS-TSIG protocol.
This is the security credential with which the server should authenticate keys requested by the GSS-TSIG protocol. Currently only Kerberos 5 authentication is available; the credential is a Kerberos principal which the server can acquire through the default system key file, normally
/etc/krb5.keytab
. The location of the keytab file can be overridden using thetkey-gssapi-keytab
option. Normally this principal is of the formDNS/server.domain
. To use GSS-TSIG,tkey-domain
must also be set if a specific keytab is not set withtkey-gssapi-keytab
.
- tkey-domain
Grammar:
tkey-domain <quoted_string>;
Blocks: options
Tags: security
Sets the domain appended to the names of all shared keys generated with
TKEY
.This domain is appended to the names of all shared keys generated with
TKEY
. When a client requests aTKEY
exchange, it may or may not specify the desired name for the key. If present, the name of the shared key isclient-specified part
+tkey-domain
. Otherwise, the name of the shared key israndom hex digits
+tkey-domain
. In most cases, thedomainname
should be the server’s domain name, or an otherwise nonexistent subdomain like_tkey.domainname
. If using GSS-TSIG, this variable must be defined, unless a specific keytab is specified usingtkey-gssapi-keytab
.
- dump-file
Grammar:
dump-file <quoted_string>;
Blocks: options
Tags: logging
Indicates the pathname of the file where the server dumps the database after
rndc dumpdb
.This is the pathname of the file the server dumps the database to, when instructed to do so with
rndc dumpdb
. If not specified, the default isnamed_dump.db
.
- memstatistics-file
Grammar:
memstatistics-file <quoted_string>;
Blocks: options
Tags: logging
Sets the pathname of the file where the server writes memory usage statistics on exit.
This is the pathname of the file the server writes memory usage statistics to on exit. If not specified, the default is
named.memstats
.
- pid-file
Grammar:
pid-file ( <quoted_string> | none );
Blocks: options
Tags: server
Specifies the pathname of the file where the server writes its process ID.
This is the pathname of the file the server writes its process ID in. If not specified, the default is
/run/named.pid
. The PID file is used by programs that send signals to the running name server. Specifyingpid-file none
disables the use of a PID file; no file is written and any existing one is removed. Note thatnone
is a keyword, not a filename, and therefore is not enclosed in double quotes.
- recursing-file
Grammar:
recursing-file <quoted_string>;
Blocks: options
Tags: server
Specifies the pathname of the file where the server dumps queries that are currently recursing via
rndc recursing
.This is the pathname of the file where the server dumps the queries that are currently recursing, when instructed to do so with
rndc recursing
. If not specified, the default isnamed.recursing
.
- statistics-file
Grammar:
statistics-file <quoted_string>;
Blocks: options
Tags: logging, server
Specifies the pathname of the file where the server appends statistics, when using
rndc stats
.This is the pathname of the file the server appends statistics to, when instructed to do so using
rndc stats
. If not specified, the default isnamed.stats
in the server’s current directory. The format of the file is described in The Statistics File.
- bindkeys-file
Grammar:
bindkeys-file <quoted_string>; // test only
Blocks: options
Tags: dnssec
Specifies the pathname of a file to override the built-in trusted keys provided by
named
.This is the pathname of a file to override the built-in trusted keys provided by
named
. See the discussion ofdnssec-validation
for details. This is intended for server testing.
- secroots-file
Grammar:
secroots-file <quoted_string>;
Blocks: options
Tags: dnssec
Specifies the pathname of the file where the server dumps security roots, when using
rndc secroots
.This is the pathname of the file the server dumps security roots to, when instructed to do so with
rndc secroots
. If not specified, the default isnamed.secroots
.
- session-keyfile
Grammar:
session-keyfile ( <quoted_string> | none );
Blocks: options
Tags: security
Specifies the pathname of the file where a TSIG session key is written, when generated by
named
for use bynsupdate -l
.This is the pathname of the file into which to write a TSIG session key generated by
named
for use bynsupdate -l
. If not specified, the default is/run/session.key
. (See Dynamic Update Policies, and in particular the discussion of theupdate-policy
statement’slocal
option, for more information about this feature.)
- session-keyname
Grammar:
session-keyname <string>;
Blocks: options
Tags: security
Specifies the key name for the TSIG session key.
This is the key name to use for the TSIG session key. If not specified, the default is
local-ddns
.
- session-keyalg
Grammar:
session-keyalg <string>;
Blocks: options
Tags: security
Specifies the algorithm to use for the TSIG session key.
This is the algorithm to use for the TSIG session key. Valid values are hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, hmac-sha512, and hmac-md5. If not specified, the default is hmac-sha256.
- port
Grammar:
port <integer>;
Blocks: options
Tags: server, query
Specifies the UDP/TCP port number the server uses to receive and send DNS protocol traffic.
This is the UDP/TCP port number the server uses to receive and send DNS protocol traffic. The default is 53. This option is mainly intended for server testing; a server using a port other than 53 is not able to communicate with the global DNS.
- tls-port
Grammar:
tls-port <integer>;
Blocks: options
Tags: server, query
Specifies the TCP port number the server uses to receive and send DNS-over-TLS protocol traffic.
This is the TCP port number the server uses to receive and send DNS-over-TLS protocol traffic. The default is 853.
- https-port
Grammar:
https-port <integer>;
Blocks: options
Tags: server, query
Specifies the TCP port number the server uses to receive and send DNS-over-HTTPS protocol traffic.
This is the TCP port number the server uses to receive and send DNS-over-HTTPS protocol traffic. The default is 443.
- http-port
Grammar:
http-port <integer>;
Blocks: options
Tags: server, query
Specifies the TCP port number the server uses to receive and send unencrypted DNS traffic via HTTP.
This is the TCP port number the server uses to receive and send unencrypted DNS traffic via HTTP (a configuration that may be useful when encryption is handled by third-party software or by a reverse proxy).
- http-listener-clients
Grammar:
http-listener-clients <integer>;
Blocks: options
Tags: server
Limits the number of active concurrent connections on a per-listener basis.
This sets a hard limit on the number of active concurrent connections on a per-listener basis. The default value is 300; setting it to 0 removes the quota.
- http-streams-per-connection
Grammar:
http-streams-per-connection <integer>;
Blocks: options
Tags: server
Limits the number of active concurrent HTTP/2 streams on a per-connection basis.
This sets a hard limit on the number of active concurrent HTTP/2 streams on a per-connection basis. The default value is 100; setting it to 0 removes the limit. Once the limit is exceeded, the server finishes the HTTP session.
- preferred-glue
Grammar:
preferred-glue <string>;
Blocks: options, view
Tags: query
Controls the order of glue records in an A or AAAA response.
If specified, the listed type (A or AAAA) is emitted before other glue in the additional section of a query response. The default is to prefer A records when responding to queries that arrived via IPv4 and AAAA when responding to queries that arrived via IPv6.
- disable-algorithms
Grammar:
disable-algorithms <string> { <string>; ... }; // may occur multiple times
Blocks: options, view
Tags: dnssec
Disables DNSSEC algorithms from a specified zone.
This disables the specified DNSSEC algorithms at and below the specified name. Multiple
disable-algorithms
statements are allowed. Only the best-matchdisable-algorithms
clause is used to determine the algorithms.If all supported algorithms are disabled, the zones covered by the
disable-algorithms
setting are treated as insecure.Configured trust anchors in
trust-anchors
(ormanaged-keys
ortrusted-keys
) that match a disabled algorithm are ignored and treated as if they were not configured.
- disable-ds-digests
Grammar:
disable-ds-digests <string> { <string>; ... }; // may occur multiple times
Blocks: options, view
Tags: dnssec, zone
Disables DS digest types from a specified zone.
This disables the specified DS digest types at and below the specified name. Multiple
disable-ds-digests
statements are allowed. Only the best-matchdisable-ds-digests
clause is used to determine the digest types.If all supported digest types are disabled, the zones covered by
disable-ds-digests
are treated as insecure.
- dnssec-must-be-secure
Warning
This option is deprecated and will be removed in a future version of BIND.
Grammar:
dnssec-must-be-secure <string> <boolean>; // may occur multiple times, deprecated
Blocks: options, view
Tags: deprecated
Defines hierarchies that must or may not be secure (signed and validated).
This option is deprecated and will be removed in a future release.
This specifies hierarchies which must be or may not be secure (signed and validated). If
yes
, thennamed
only accepts answers if they are secure. Ifno
, then normal DNSSEC validation applies, allowing insecure answers to be accepted. The specified domain must be defined as a trust anchor, for instance in atrust-anchors
statement, ordnssec-validation auto
must be active.
- dns64
Grammar:
dns64 <netprefix> { break-dnssec <boolean>; clients { <address_match_element>; ... }; exclude { <address_match_element>; ... }; mapped { <address_match_element>; ... }; recursive-only <boolean>; suffix <ipv6_address>; }; // may occur multiple times
Blocks: options, view
Tags: query
Instructs
named
to return mapped IPv4 addresses to AAAA queries when there are no AAAA records.This directive instructs
named
to return mapped IPv4 addresses to AAAA queries when there are no AAAA records. It is intended to be used in conjunction with a NAT64. Eachdns64
defines one DNS64 prefix. Multiple DNS64 prefixes can be defined.Compatible IPv6 prefixes have lengths of 32, 40, 48, 56, 64, and 96, per RFC 6052. Bits 64..71 inclusive must be zero, with the most significant bit of the prefix in position 0.
In addition, a reverse IP6.ARPA zone is created for the prefix to provide a mapping from the IP6.ARPA names to the corresponding IN-ADDR.ARPA names using synthesized CNAMEs.
- dns64-server
Grammar:
dns64-server <string>;
Blocks: options, view
Tags: server
Specifies the name of the server for
dns64
zones.
- dns64-contact
Grammar:
dns64-contact <string>;
Blocks: options, view
Tags: server
Specifies the name of the contact for
dns64
zones.dns64-server
anddns64-contact
can be used to specify the name of the server and contact for the zones. These can be set at the view/options level but not on a per-prefix basis.dns64
will also cause IPV4ONLY.ARPA to be created if not explicitly disabled usingipv4only-enable
.
- clients
Grammar:
clients { <address_match_element>; ... };
Blocks: options.dns64, view.dns64
Tags: query
Specifies an access control list (ACL) of clients that are affected by a given
dns64
directive.Each
dns64
supports an optionalclients
ACL that determines which clients are affected by this directive. If not defined, it defaults toany;
.
- mapped
Grammar:
mapped { <address_match_element>; ... };
Blocks: options.dns64, view.dns64
Tags: query
Specifies an access control list (ACL) of IPv4 addresses that are to be mapped to the corresponding A RRset in
dns64
.Each
dns64
block supports an optionalmapped
ACL that selects which IPv4 addresses are to be mapped in the corresponding A RRset. If not defined, it defaults toany;
.
- exclude
Grammar:
exclude { <address_match_element>; ... };
Blocks: options.dns64, view.dns64
Tags: query
Allows a list of IPv6 addresses to be ignored if they appear in a domain name’s AAAA records in
dns64
.Normally, DNS64 does not apply to a domain name that owns one or more AAAA records; these records are simply returned. The optional
exclude
ACL allows specification of a list of IPv6 addresses that are ignored if they appear in a domain name’s AAAA records; DNS64 is applied to any A records the domain name owns. If not defined,exclude
defaults to ::ffff:0.0.0.0/96.
- suffix
Grammar:
suffix <ipv6_address>;
Blocks: options.dns64, view.dns64
Tags: query
Defines trailing bits for mapped IPv4 address bits in
dns64
.An optional
suffix
can also be defined to set the bits trailing the mapped IPv4 address bits. By default these bits are set to::
. The bits matching the prefix and mapped IPv4 address must be zero.
- recursive-only
Grammar:
recursive-only <boolean>;
Blocks: options.dns64, view.dns64
Tags: query
Toggles whether
dns64
synthesis occurs only for recursive queries.If
recursive-only
is set toyes
, the DNS64 synthesis only happens for recursive queries. The default isno
.
- break-dnssec
Grammar:
break-dnssec <boolean>;
Blocks: options.dns64, view.dns64
Tags: query
Enables
dns64
synthesis even if the validated result would cause a DNSSEC validation failure.If
break-dnssec
is set toyes
, the DNS64 synthesis happens even if the result, if validated, would cause a DNSSEC validation failure. If this option is set tono
(the default), the DO is set on the incoming query, and there are RRSIGs on the applicable records, then synthesis does not happen.
acl rfc1918 { 10/8; 192.168/16; 172.16/12; }; dns64 64:FF9B::/96 { clients { any; }; mapped { !rfc1918; any; }; exclude { 64:FF9B::/96; ::ffff:0000:0000/96; }; suffix ::; };
- resolver-use-dns64
Grammar:
resolver-use-dns64 <boolean>;
Blocks: options, view
Tags: server
Specifies whether to apply DNS64 mappings when sending queries.
If
resolver-use-dns64
is set toyes
, then the IPv4-to-IPv6 address transformations specified by thedns64
option will be applied to IPv4 server addresses to which recursive queries are sent. This allows a server to perform lookups via a NAT64 connection; queries that would have been sent via IPv4 are instead sent to mapped IPv6 addresses. The default isno
.
- ipv4only-enable
Grammar:
ipv4only-enable <boolean>;
Blocks: options, view
Tags: query
Enables automatic IPv4 zones if a
dns64
block is configured.This enables or disables automatic zones
ipv4only.arpa
,170.0.0.192.in-addr.arpa
, and171.0.0.192.in-addr.arpa
.By default these zones are loaded if
dns64
is configured.
- ipv4only-server
Grammar:
ipv4only-server <string>;
Blocks: options, view
Tags: server, query
Specifies the name of the server for the IPV4ONLY.ARPA zone created by
dns64
.
- ipv4only-contact
Grammar:
ipv4only-contact <string>;
Blocks: options, view
Tags: server
Specifies the contact for the IPV4ONLY.ARPA zone created by
dns64
.ipv4only-server
andipv4only-contact
can be used to specify the name of the server and contact for the IPV4ONLY.ARPA zone created bydns64
.
- dnssec-loadkeys-interval
Grammar:
dnssec-loadkeys-interval <integer>;
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Sets the frequency of automatic checks of the DNSSEC key repository.
When a zone is configured with
dnssec-policy;
, its key repository must be checked periodically to see if the next step of a key rollover is due. Thednssec-loadkeys-interval
option sets the default interval of key repository checks, in minutes, in case the next key event cannot be calculated (for example because a DS record needs to be published).The default is
60
(1 hour), the minimum is1
(1 minute), and the maximum is1440
(24 hours); any higher value is silently reduced.
This specifies which key and signing policy (KASP) should be used for this zone. This is a string referring to a
dnssec-policy
block. The default isnone
.
- dnssec-update-mode
Grammar:
dnssec-update-mode ( maintain | no-resign ); // obsolete
Blocks: options, view, zone (primary, secondary)
Tags: obsolete
This option no longer has any effect.
- nta-lifetime
Grammar:
nta-lifetime <duration>;
Blocks: options, view
Tags: dnssec
Specifies the lifetime, in seconds, for negative trust anchors added via
rndc nta
.This specifies the default lifetime, in seconds, for negative trust anchors added via
rndc nta
.A negative trust anchor selectively disables DNSSEC validation for zones that are known to be failing because of misconfiguration, rather than an attack. When data to be validated is at or below an active NTA (and above any other configured trust anchors),
named
aborts the DNSSEC validation process and treats the data as insecure rather than bogus. This continues until the NTA’s lifetime has elapsed. NTAs persist acrossnamed
restarts.For convenience, TTL-style time-unit suffixes can be used to specify the NTA lifetime in seconds, minutes, or hours. It also accepts ISO 8601 duration formats.
nta-lifetime
defaults to one hour; it cannot exceed one week.
- nta-recheck
Grammar:
nta-recheck <duration>;
Blocks: options, view
Tags: dnssec
Specifies the time interval for checking whether negative trust anchors added via
rndc nta
are still necessary.This specifies how often to check whether negative trust anchors added via
rndc nta
are still necessary.A negative trust anchor is normally used when a domain has stopped validating due to operator error; it temporarily disables DNSSEC validation for that domain. In the interest of ensuring that DNSSEC validation is turned back on as soon as possible,
named
periodically sends a query to the domain, ignoring negative trust anchors, to find out whether it can now be validated. If so, the negative trust anchor is allowed to expire early.Validity checks can be disabled for an individual NTA by using
rndc nta -f
, or for all NTAs by settingnta-recheck
to zero.For convenience, TTL-style time-unit suffixes can be used to specify the NTA recheck interval in seconds, minutes, or hours. It also accepts ISO 8601 duration formats.
The default is five minutes. It cannot be longer than
nta-lifetime
, which cannot be longer than a week.
- max-zone-ttl
Warning
This option is deprecated and will be removed in a future version of BIND.
Grammar dnssec-policy:
max-zone-ttl <duration>;
Grammar options, view, zone (primary, redirect):
max-zone-ttl ( unlimited | <duration> ); // deprecated
Blocks: dnssec-policy, options, view, zone (primary, redirect)
Tags: deprecated
Specifies a maximum permissible time-to-live (TTL) value, in seconds.
This should now be configured as part of
dnssec-policy
. Use of this option inoptions
,view
andzone
blocks is a fatal error ifdnssec-policy
has also been configured for the same zone. In zones withoutdnssec-policy
, this option is deprecated, and will be rendered non-operational in a future release.max-zone-ttl
specifies a maximum permissible TTL value in seconds. For convenience, TTL-style time-unit suffixes may be used to specify the maximum value. When a zone file is loaded, any record encountered with a TTL higher thanmax-zone-ttl
causes the zone to be rejected.This is needed in DNSSEC-maintained zones because when rolling to a new DNSKEY, the old key needs to remain available until RRSIG records have expired from caches. The
max-zone-ttl
option guarantees that the largest TTL in the zone is no higher than the set value.When used in
options
,view
andzone
blocks, settingmax-zone-ttl
to zero is equivalent to “unlimited”.
- stale-answer-ttl
Grammar:
stale-answer-ttl <duration>;
Blocks: options, view
Tags: query
Specifies the time to live (TTL) to be returned on stale answers, in seconds.
This specifies the TTL to be returned on stale answers. The default is 30 seconds. The minimum allowed is 1 second; a value of 0 is updated silently to 1 second.
For stale answers to be returned, they must be enabled, either in the configuration file using
stale-answer-enable
or viarndc serve-stale on
.
- serial-update-method
Grammar:
serial-update-method ( date | increment | unixtime );
Blocks: options, view, zone (primary)
Tags: zone
Specifies the update method to be used for the zone serial number in the SOA record.
Zones configured for dynamic DNS may use this option to set the update method to be used for the zone serial number in the SOA record.
With the default setting of
serial-update-method increment;
, the SOA serial number is incremented by one each time the zone is updated.When set to
serial-update-method unixtime;
, the SOA serial number is set to the number of seconds since the Unix epoch, unless the serial number is already greater than or equal to that value, in which case it is simply incremented by one.When set to
serial-update-method date;
, the new SOA serial number is the current date in the form “YYYYMMDD”, followed by two zeroes, unless the existing serial number is already greater than or equal to that value, in which case it is incremented by one.
- zone-statistics
Grammar:
zone-statistics ( full | terse | none | <boolean> );
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: zone, logging
Controls the level of statistics gathered for all zones.
If
full
, the server collects statistical data on all zones, unless specifically turned off on a per-zone basis by specifyingzone-statistics terse
orzone-statistics none
in thezone
statement. The statistical data includes, for example, DNSSEC signing operations and the number of authoritative answers per query type. The default isterse
, providing minimal statistics on zones (including name and current serial number, but not query type counters), and also information about the currently ongoing incoming zone transfers.These statistics may be accessed via the
statistics-channel
or usingrndc stats
, which dumps them to the file listed in thestatistics-file
. See also The Statistics File.For backward compatibility with earlier versions of BIND 9, the
zone-statistics
option can also acceptyes
orno
;yes
has the same meaning asfull
. As of BIND 9.10,no
has the same meaning asnone
; previously, it was the same asterse
.
8.2.16.1. Boolean Options
- automatic-interface-scan
Grammar:
automatic-interface-scan <boolean>;
Blocks: options
Tags: server
Controls the automatic rescanning of network interfaces when addresses are added or removed.
If
yes
and supported by the operating system, this automatically rescans network interfaces when the interface addresses are added or removed. The default isyes
. This configuration option does not affect the time-basedinterface-interval
option; it is recommended to set the time-basedinterface-interval
to 0 when the operator confirms that automatic interface scanning is supported by the operating system.The
automatic-interface-scan
implementation uses routing sockets for the network interface discovery; therefore, the operating system must support the routing sockets for this feature to work.
- allow-new-zones
Grammar:
allow-new-zones <boolean>;
Blocks: options, view
Tags: server, zone
Controls the ability to add zones at runtime via
rndc addzone
.If
yes
, then zones can be added at runtime viarndc addzone
. The default isno
.Newly added zones’ configuration parameters are stored so that they can persist after the server is restarted. The configuration information is saved in a file called
viewname.nzf
(or, ifnamed
is compiled with liblmdb, in an LMDB database file calledviewname.nzd
). “viewname” is the name of the view, unless the view name contains characters that are incompatible with use as a file name, in which case a cryptographic hash of the view name is used instead.Configurations for zones added at runtime are stored either in a new-zone file (NZF) or a new-zone database (NZD), depending on whether
named
was linked with liblmdb at compile time. See rndc - name server control utility for further details aboutrndc addzone
.
- auth-nxdomain
Grammar:
auth-nxdomain <boolean>;
Blocks: options, view
Tags: query
Controls whether BIND, acting as a resolver, provides authoritative NXDOMAIN (domain does not exist) answers.
If
yes
, then theAA
bit is always set on NXDOMAIN responses, even if the server is not actually authoritative. The default isno
.
- memstatistics
Grammar:
memstatistics <boolean>;
Blocks: options
Tags: server, logging
Controls whether memory statistics are written to the file specified by
memstatistics-file
at exit.This writes memory statistics to the file specified by
memstatistics-file
at exit. The default isno
unless-m record
is specified on the command line, in which case it isyes
.
- flush-zones-on-shutdown
Grammar:
flush-zones-on-shutdown <boolean>;
Blocks: options
Tags: zone
Controls whether pending zone writes are flushed when the name server exits.
When the name server exits upon receiving SIGTERM, flush or do not flush any pending zone writes. The default is
flush-zones-on-shutdown no
.
- root-key-sentinel
Grammar:
root-key-sentinel <boolean>;
Blocks: options, view
Tags: server
Controls whether BIND 9 responds to root key sentinel probes.
If
yes
, the server responds to root key sentinel probes as described in RFC 8509:. The default isyes
.
- reuseport
Grammar:
reuseport <boolean>;
Blocks: options
Tags: server
Enables kernel load-balancing of sockets.
This option enables kernel load-balancing of sockets on systems which support it, including Linux (SO_REUSEPORT) and FreeBSD (SO_REUSEPORT_LB). This instructs the kernel to distribute incoming socket connections among the networking threads based on a hashing scheme. For more information, see the receive network flow classification options (
rx-flow-hash
) section in theethtool
manual page. The default isyes
.Enabling
reuseport
significantly increases general throughput when incoming traffic is distributed uniformly onto the threads by the operating system. However, in cases where a worker thread is busy with a long-lasting operation, such as processing a Response Policy Zone (RPZ) or Catalog Zone update or an unusually large zone transfer, incoming traffic that hashes onto that thread may be delayed. On servers where these events occur frequently, it may be preferable to disable socket load-balancing so that other threads can pick up the traffic that would have been sent to the busy thread.Note: this option can only be set when
named
first starts. Changes will not take effect during reconfiguration; the server must be restarted.
- message-compression
Grammar:
message-compression <boolean>;
Blocks: options, view
Tags: query
Controls whether DNS name compression is used in responses to regular queries.
If
yes
, DNS name compression is used in responses to regular queries (not including AXFR or IXFR, which always use compression). Setting this option tono
reduces CPU usage on servers and may improve throughput. However, it increases response size, which may cause more queries to be processed using TCP; a server with compression disabled is out of compliance with RFC 1123 Section 6.1.3.2. The default isyes
.
- minimal-responses
Grammar:
minimal-responses ( no-auth | no-auth-recursive | <boolean> );
Blocks: options, view
Tags: query
Controls whether the server only adds records to the authority and additional data sections when they are required (e.g. delegations, negative responses). This improves server performance.
This option controls the addition of records to the authority and additional sections of responses. Such records may be included in responses to be helpful to clients; for example, MX records may have associated address records included in the additional section, obviating the need for a separate address lookup. However, adding these records to responses is not mandatory and requires additional database lookups, causing extra latency when marshalling responses.
Responses to DNSKEY, DS, CDNSKEY, and CDS requests will never have optional additional records added. Responses to NS requests will always have additional section processing.
minimal-responses
takes one of four values:no
: the server is as complete as possible when generating responses.yes
: the server only adds records to the authority and additional sections when such records are required by the DNS protocol (for example, when returning delegations or negative responses). This provides the best server performance but may result in more client queries.no-auth
: the server omits records from the authority section except when they are required, but it may still add records to the additional section.no-auth-recursive
: the same asno-auth
when recursion is requested in the query (RD=1), or the same asno
if recursion is not requested.
no-auth
andno-auth-recursive
are useful when answering stub clients, which usually ignore the authority section.no-auth-recursive
is meant for use in mixed-mode servers that handle both authoritative and recursive queries.The default is
no-auth-recursive
.
- minimal-any
Grammar:
minimal-any <boolean>;
Blocks: options, view
Tags: query
Controls whether the server replies with only one of the RRsets for a query name, when generating a positive response to a query of type ANY over UDP.
If set to
yes
, the server replies with only one of the RRsets for the query name, and its covering RRSIGs if any, when generating a positive response to a query of type ANY over UDP, instead of replying with all known RRsets for the name. Similarly, a query for type RRSIG is answered with the RRSIG records covering only one type. This can reduce the impact of some kinds of attack traffic, without harming legitimate clients. (Note, however, that the RRset returned is the first one found in the database; it is not necessarily the smallest available RRset.) Additionally,minimal-responses
is turned on for these queries, so no unnecessary records are added to the authority or additional sections. The default isno
.
- notify
Grammar:
notify ( explicit | master-only | primary-only | <boolean> );
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Controls whether
NOTIFY
messages are sent on zone changes.If set to
yes
(the default), DNS NOTIFY messages are sent when a zone the server is authoritative for changes; see using notify. The messages are sent to the servers listed in the zone’s NS records (except the primary server identified in the SOA MNAME field), and to any servers listed in thealso-notify
option.If set to
primary-only
(or the older keywordmaster-only
), notifies are only sent for primary zones. If set toexplicit
, notifies are sent only to servers explicitly listed usingalso-notify
. If set tono
, no notifies are sent.The
notify
option may also be specified in thezone
statement, in which case it overrides theoptions notify
statement. It would only be necessary to turn off this option if it caused secondary zones to crash.
- notify-to-soa
Grammar:
notify-to-soa <boolean>;
Blocks: options, view, zone (primary, secondary)
Tags: transfer
Controls whether the name servers in the NS RRset are checked against the SOA MNAME.
If
yes
, do not check the name servers in the NS RRset against the SOA MNAME. Normally a NOTIFY message is not sent to the SOA MNAME (SOA ORIGIN), as it is supposed to contain the name of the ultimate primary server. Sometimes, however, a secondary server is listed as the SOA MNAME in hidden primary configurations; in that case, the ultimate primary should be set to still send NOTIFY messages to all the name servers listed in the NS RRset.
- recursion
Grammar:
recursion <boolean>;
Blocks: options, view
Tags: query
Defines whether recursion and caching are allowed.
If
yes
, and a DNS query requests recursion, then the server attempts to do all the work required to answer the query. If recursion is off and the server does not already know the answer, it returns a referral response. The default isyes
. Note that settingrecursion 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.
- request-nsid
Grammar:
request-nsid <boolean>;
Blocks: options, server, view, view.server
Tags: query
Controls whether an empty EDNS(0) NSID (Name Server Identifier) option is sent with all queries to authoritative name servers during iterative resolution.
If
yes
, then an empty EDNS(0) NSID (Name Server Identifier) option is sent with all queries to authoritative name servers during iterative resolution. If the authoritative server returns an NSID option in its response, then its contents are logged in thensid
category at levelinfo
. The default isno
.
- require-cookie
Grammar:
require-cookie <boolean>;
Blocks: server, view.server
Tags: query
Controls whether responses without a server cookie are accepted
The
require-cookie
clause can be used to indicate that the remote server is known to support DNS COOKIE. Setting this option toyes
causesnamed
to always retry a request over TCP when it receives a UDP response without a DNS COOKIE from the remote server, even if UDP responses with DNS COOKIE have not been sent by this server before. This prevents spoofed answers from being accepted without a retry over TCP whennamed
has not yet determined whether the remote server supports DNS COOKIE. Setting this option tono
(the default) causesnamed
to rely on autodetection of DNS COOKIE support to determine when to retry a request over TCP.Note
If a UDP response is signed using TSIG,
named
accepts it even ifrequire-cookie
is set toyes
and the response does not contain a DNS COOKIE.The
send-cookie
clause determines whether the local server adds a COOKIE EDNS option to requests sent to the server. This overridessend-cookie
set at the view or option level. Thenamed
server may determine that COOKIE is not supported by the remote server and not add a COOKIE EDNS option to requests.
- require-server-cookie
Grammar:
require-server-cookie <boolean>;
Blocks: options, view
Tags: query
Controls whether a valid server cookie is required before sending a full response to a UDP request.
If
yes
, require a valid server cookie before sending a full response to a UDP request from a cookie-aware client. BADCOOKIE is sent if there is a bad or nonexistent server cookie.The default is
no
.Users wishing to test that DNS COOKIE clients correctly handle BADCOOKIE, or who are getting a lot of forged DNS requests with DNS COOKIES present, should set this to
yes
. Setting this toyes
results in a reduced amplification effect in a reflection attack, as the BADCOOKIE response is smaller than a full response, while also requiring a legitimate client to follow up with a second query with the new, valid, cookie.
- answer-cookie
Grammar:
answer-cookie <boolean>;
Blocks: options
Tags: query
Controls whether COOKIE EDNS replies are sent in response to client queries.
When set to the default value of
yes
, COOKIE EDNS options are sent when applicable in replies to client queries. If set tono
, COOKIE EDNS options are not sent in replies. This can only be set at the global options level, not per-view.answer-cookie no
is intended as a temporary measure, for use whennamed
shares an IP address with other servers that do not yet support DNS COOKIE. A mismatch between servers on the same address is not expected to cause operational problems, but the option to disable COOKIE responses so that all servers have the same behavior is provided out of an abundance of caution. DNS COOKIE is an important security mechanism, and should not be disabled unless absolutely necessary.
- send-cookie
Grammar:
send-cookie <boolean>;
Blocks: options, server, view, view.server
Tags: query
Controls whether a COOKIE EDNS option is sent along with a query.
If
yes
, then a COOKIE EDNS option is sent along with the query. If the resolver has previously communicated with the server, the COOKIE returned in the previous transaction is sent. This is used by the server to determine whether the resolver has talked to it before. A resolver sending the correct COOKIE is assumed not to be an off-path attacker sending a spoofed-source query; the query is therefore unlikely to be part of a reflection/amplification attack, so resolvers sending a correct COOKIE option are not subject to response rate limiting (RRL). Resolvers which do not send a correct COOKIE option may be limited to receiving smaller responses via thenocookie-udp-size
option.The
named
server may determine that COOKIE is not supported by the remote server and not add a COOKIE EDNS option to requests.The default is
yes
.
- stale-answer-enable
Grammar:
stale-answer-enable <boolean>;
Blocks: options, view
Tags: server, query
Enables the returning of “stale” cached answers when the name servers for a zone are not answering.
If
yes
, enable the returning of “stale” cached answers when the name servers for a zone are not answering and thestale-cache-enable
option is also enabled. The default is not to return stale answers.Stale answers can also be enabled or disabled at runtime via
rndc serve-stale on
orrndc serve-stale off
; these override the configured setting.rndc serve-stale reset
restores the setting to the one specified innamed.conf
. Note that if stale answers have been disabled byrndc
, they cannot be re-enabled by reloading or reconfiguringnamed
; they must be re-enabled withrndc serve-stale on
, or the server must be restarted.Information about stale answers is logged under the
serve-stale
log category.
- stale-answer-client-timeout
Grammar:
stale-answer-client-timeout ( disabled | off | <integer> );
Blocks: options, view
Tags: server, query
Defines the amount of time (in milliseconds) that
named
waits before attempting to answer a query with a stale RRset from cache.This option defines the amount of time (in milliseconds) that
named
waits before attempting to answer the query with a stale RRset from cache. If a stale answer is found,named
continues the ongoing fetches, attempting to refresh the RRset in cache until theresolver-query-timeout
interval is reached.This option is off by default, which is equivalent to setting it to
off
ordisabled
. It also has no effect ifstale-answer-enable
is disabled.The minimum value,
0
, causes a cached (stale) RRset to be immediately returned if it is available while still attempting to refresh the data in cache.When this option is enabled, the only supported value in the current version of BIND 9 is
0
. Non-zero values generate a warning message, and are treated as0
.
- stale-cache-enable
Grammar:
stale-cache-enable <boolean>;
Blocks: options, view
Tags: server, query
Enables the retention of “stale” cached answers.
If
yes
, enable the retaining of “stale” cached answers. Defaultno
.
- stale-refresh-time
Grammar:
stale-refresh-time <duration>;
Blocks: options, view
Tags: server, query
Sets the time window for the return of “stale” cached answers before the next attempt to contact, if the name servers for a given zone are not responding.
If the name servers for a given zone are not answering, this sets the time window for which
named
will promptly return “stale” cached answers for that RRSet being requested before a new attempt in contacting the servers is made. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.The default
stale-refresh-time
is 30 seconds, as RFC 8767 recommends that attempts to refresh to be done no more frequently than every 30 seconds. A value of zero disables the feature, meaning that normal resolution will take place first, if that fails only thennamed
will return “stale” cached answers.
- nocookie-udp-size
Grammar:
nocookie-udp-size <integer>;
Blocks: options, view
Tags: query
Sets the maximum size of UDP responses that are sent to queries without a valid server COOKIE.
This sets the maximum size of UDP responses that are sent to queries without a valid server COOKIE. A value below 128 is silently raised to 128. The default value is 4096, but the
max-udp-size
option may further limit the response size as the default formax-udp-size
is 1232.
- cookie-algorithm
Grammar:
cookie-algorithm ( siphash24 );
Blocks: options
Tags: server
Sets the algorithm to be used when generating a server cookie.
This sets the algorithm to be used when generating the server cookie. The default is “siphash24”, which is the only supported option, as the previously supported “aes” option has been removed.
- cookie-secret
Grammar:
cookie-secret <string>; // may occur multiple times
Blocks: options
Tags: server
Specifies a shared secret used for generating and verifying EDNS COOKIE options within an anycast cluster.
If set, this is a shared secret used for generating and verifying EDNS COOKIE options within an anycast cluster. If not set, the system generates a random secret at startup. The shared secret is encoded as a hex string and needs to be 128 bits.
If there are multiple secrets specified, the first one listed in
named.conf
is used to generate new server cookies. The others are only used to verify returned cookies.
- response-padding
Grammar:
response-padding { <address_match_element>; ... } block-size <integer>;
Blocks: options, view
Tags: query
Adds an EDNS Padding option to encrypted messages, to reduce the chance of guessing the contents based on size.
The EDNS Padding option is intended to improve confidentiality when DNS queries are sent over an encrypted channel, by reducing the variability in packet sizes. If a query:
contains an EDNS Padding option,
includes a valid server cookie or uses TCP,
is not signed using TSIG or SIG(0), and
is from a client whose address matches the specified ACL,
then the response is padded with an EDNS Padding option to a multiple of
block-size
bytes. If these conditions are not met, the response is not padded.If
block-size
is 0 or the ACL isnone;
, this feature is disabled and no padding occurs; this is the default. Ifblock-size
is greater than 512, a warning is logged and the value is truncated to 512. Block sizes are ordinarily expected to be powers of two (for instance, 128), but this is not mandatory.
- trust-anchor-telemetry
Grammar:
trust-anchor-telemetry <boolean>;
Blocks: options, view
Tags: dnssec
Instructs
named
to send specially formed queries once per day to domains for which trust anchors have been configured.This causes
named
to send specially formed queries once per day to domains for which trust anchors have been configured via, e.g.,trust-anchors
ordnssec-validation auto
.The query name used for these queries has the form
_ta-xxxx(-xxxx)(...).<domain>
, where each “xxxx” is a group of four hexadecimal digits representing the key ID of a trusted DNSSEC key. The key IDs for each domain are sorted smallest to largest prior to encoding. The query type is NULL.By monitoring these queries, zone operators are able to see which resolvers have been updated to trust a new key; this may help them decide when it is safe to remove an old one.
The default is
yes
.
- provide-ixfr
Grammar:
provide-ixfr <boolean>;
Blocks: options, server, view, view.server
Tags: transfer
Controls whether a primary responds to an incremental zone request (IXFR) or only responds with a full zone transfer (AXFR).
The
provide-ixfr
clause determines whether the local server, acting as primary, responds with an incremental zone transfer when the given remote server, a secondary, requests it. If set toyes
, incremental transfer is provided whenever possible. If set tono
, all transfers to the remote server are non-incremental.
- request-ixfr
Grammar:
request-ixfr <boolean>;
Blocks: options, server, view, zone (mirror, secondary), view.server
Tags: transfer
Controls whether a secondary requests an incremental zone transfer (IXFR) or a full zone transfer (AXFR).
The
request-ixfr
statement determines whether the local server, acting as a secondary, requests incremental zone transfers from the given remote server, a primary.IXFR requests to servers that do not support IXFR 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 theprovide-ixfr
andrequest-ixfr
statements is to make it possible to disable the use of IXFR even when both primary and secondary claim to support it: for example, if one of the servers is buggy and crashes or corrupts data when IXFR is used.It may also be set in the zone block; if set there, it overrides the global or view setting for that zone. It may also be set in the
server
block.
- request-ixfr-max-diffs
Grammar:
request-ixfr-max-diffs <integer>;
Blocks: options, server, view, zone (mirror, secondary), view.server
Tags: transfer
Sets the maximum number of incoming incremental zone transfer (IXFR) differences, exceeding which triggers a full zone transfer (AXFR).
The
request-ixfr-max-diffs
clause configured for the local server, acting as a secondary, sets the maximum number of incremental zone transfer (IXFR) differences after which the secondary server will abort the incremental zone transfer process and requeast a full zone transfer (AXFR). The default value is0
, which means there is no maximum limit.It may also be set in the zone block; if set there, it overrides the global or view setting for that zone. It may also be set in the
server
block.
- request-expire
Grammar:
request-expire <boolean>;
Blocks: options, server, view, zone (mirror, secondary), view.server
Tags: transfer, query
Specifies whether the local server requests the EDNS EXPIRE value, when acting as a secondary.
The
request-expire
statement determines whether the local server, when acting as a secondary, requests the EDNS EXPIRE value. The EDNS EXPIRE value indicates the remaining time before the zone data expires and needs to be refreshed. This is used when a secondary server transfers a zone from another secondary server; when transferring from the primary, the expiration timer is set from the EXPIRE field of the SOA record instead. The default isyes
.
- match-mapped-addresses
Grammar:
match-mapped-addresses <boolean>;
Blocks: options
Tags: server
Allows IPv4-mapped IPv6 addresses to match address-match list entries for corresponding IPv4 addresses.
If
yes
, then an IPv4-mapped IPv6 address matches any address-match list entries that match the corresponding IPv4 address.This option was introduced to work around a kernel quirk in some operating systems that causes IPv4 TCP connections, such as zone transfers, to be accepted on an IPv6 socket using mapped addresses. This caused address-match lists designed for IPv4 to fail to match. However,
named
now solves this problem internally. The use of this option is discouraged.
- ixfr-from-differences
Grammar zone (mirror, primary, secondary):
ixfr-from-differences <boolean>;
Grammar options, view:
ixfr-from-differences ( primary | master | secondary | slave | <boolean> );
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Controls how IXFR transfers are calculated.
When
yes
and the server loads a new version of a primary zone from its zone file or receives a new version of a secondary file via zone transfer, it compares the new version to the previous one and calculates a set of differences. The differences are then logged in the zone’s journal file so that the changes can be transmitted to downstream secondaries as an incremental zone transfer.By allowing incremental zone transfers to be used for non-dynamic zones, this option saves bandwidth at the expense of increased CPU and memory consumption at the primary server. In particular, if the new version of a zone is completely different from the previous one, the set of differences is of a size comparable to the combined size of the old and new zone versions, and the server needs to temporarily allocate memory to hold this complete difference set.
ixfr-from-differences
also acceptsprimary
andsecondary
at the view and options levels, which causesixfr-from-differences
to be enabled for all primary or secondary zones, respectively. It is off for all zones by default.Note: if inline signing is enabled for a zone, the user-provided
ixfr-from-differences
setting is ignored for that zone.
- multi-master
Grammar:
multi-master <boolean>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Controls whether serial number mismatch errors are logged.
This should be set when there are multiple primary servers for a zone and the addresses refer to different machines. If
yes
,named
does not log when the serial number on the primary is less than whatnamed
currently has. The default isno
.
- dnssec-validation
Grammar:
dnssec-validation ( yes | no | auto );
Blocks: options, view
Tags: dnssec
Enables DNSSEC validation in
named
.This option enables DNSSEC validation in
named
.If set to
auto
, DNSSEC validation is enabled and a default trust anchor for the DNS root zone is used. This trust anchor is provided as part of BIND and is kept up-to-date using Dynamic Trust Anchor Management key management. Adding an explicit static key using thetrust-anchors
statement with astatic-key
anchor type (or using the deprecatedtrusted-keys
statement) for the root zone is not supported with theauto
setting, and is treated as a configuration error.If set to
yes
, DNSSEC validation is enabled, but a trust anchor must be manually configured using atrust-anchors
statement (or themanaged-keys
ortrusted-keys
statements, both deprecated). Iftrust-anchors
is not configured, it is a configuration error. Iftrust-anchors
does not include a valid root key, then validation does not take place for names which are not covered by any of the configured trust anchors.If set to
no
, DNSSEC validation is disabled. (Note: the resolver will still set the DO bit in outgoing queries indicating that it can accept DNSSEC responses, even ifdnssec-validation
is disabled.)The default is
auto
, unless BIND is built withconfigure --disable-auto-validation
, in which case the default isyes
.The default root trust anchor is compiled into
named
and is current as of the release date. If the root key changes, a running BIND server will detect this and roll smoothly to the new key, but newly-installed servers will be unable to start validation, so BIND must be upgraded to a newer version.
- validate-except
Grammar:
validate-except { <string>; ... };
Blocks: options, view
Tags: dnssec
Specifies a list of domain names at and beneath which DNSSEC validation should not be performed.
This specifies a list of domain names at and beneath which DNSSEC validation should not be performed, regardless of the presence of a trust anchor at or above those names. This may be used, for example, when configuring a top-level domain intended only for local use, so that the lack of a secure delegation for that domain in the root zone does not cause validation failures. (This is similar to setting a negative trust anchor except that it is a permanent configuration, whereas negative trust anchors expire and are removed after a set period of time.)
- dnssec-accept-expired
Grammar:
dnssec-accept-expired <boolean>;
Blocks: options, view
Tags: dnssec
Instructs BIND 9 to accept expired DNSSEC signatures when validating.
This accepts expired signatures when verifying DNSSEC signatures. The default is
no
. Setting this option toyes
leavesnamed
vulnerable to replay attacks.
- querylog
Grammar:
querylog <boolean>;
Blocks: options
Tags: logging, server
Specifies whether query logging should be active when
named
first starts.Query logging provides a complete log of all incoming queries and all query errors. This provides more insight into the server’s activity, but with a cost to performance which may be significant on heavily loaded servers.
The
querylog
option specifies whether query logging should be active whennamed
first starts. Ifquerylog
is not specified, then query logging is determined by the presence of the logging categoryqueries
. Please note thatrndc reconfig
andrndc reload
have no effect on this option, so it cannot be changed once the server is running. However, query logging can be activated at runtime using the commandrndc querylog on
, or deactivated withrndc querylog off
.
- responselog
Grammar:
responselog <boolean>;
Blocks: options
Tags: logging, server
Specifies whether response logging should be active when
named
first starts.Response logging complements
querylog
by logging the rcode of previous queries along with the queries’ name, type and class.Response logging can also be activated at runtime using the command
rndc responselog on
, or deactivated withrndc responselog off
.
- check-names
Grammar zone (hint, mirror, primary, secondary, stub):
check-names ( fail | warn | ignore );
Grammar options, view:
check-names ( primary | master | secondary | slave | response ) ( fail | warn | ignore ); // may occur multiple times
Blocks: options, view, zone (hint, mirror, primary, secondary, stub)
Tags: query, server
Restricts the character set and syntax of certain domain names in primary files and/or DNS responses received from the network.
This option is used to restrict the character set and syntax of certain domain names in primary files and/or DNS responses received from the network. The default varies according to usage area. For
type primary
zones the default isfail
. Fortype secondary
zones the default iswarn
. For answers received from the network (response
), the default isignore
.The rules for legal hostnames and mail domains are derived from RFC 952 and RFC 821 as modified by RFC 1123.
check-names
applies to the owner names of A, AAAA, and MX records. It also applies to the domain names in the RDATA of NS, SOA, MX, and SRV records. It further applies to the RDATA of PTR records where the owner name indicates that it is a reverse lookup of a hostname (the owner name ends in IN-ADDR.ARPA, IP6.ARPA, or IP6.INT).
- check-dup-records
Grammar:
check-dup-records ( fail | warn | ignore );
Blocks: options, view, zone (primary)
Tags: dnssec, query
Checks primary zones for records that are treated as different by DNSSEC but are semantically equal in plain DNS.
This checks primary zones for records that are treated as different by DNSSEC but are semantically equal in plain DNS. The default is to
warn
. Other possible values arefail
andignore
.
- check-mx
Grammar:
check-mx ( fail | warn | ignore );
Blocks: options, view, zone (primary)
Tags: zone
Checks whether an MX record appears to refer to an IP address.
This checks whether the MX record appears to refer to an IP address. The default is to
warn
. Other possible values arefail
andignore
.
- check-wildcard
Grammar:
check-wildcard <boolean>;
Blocks: options, view, zone (primary)
Tags: zone
Checks for non-terminal wildcards.
This option is used to check for non-terminal wildcards. The use of non-terminal wildcards is almost always as a result of a lack of understanding of the wildcard-matching algorithm (RFC 1034). This option affects primary zones. The default (
yes
) is to check for non-terminal wildcards and issue a warning.
- check-integrity
Grammar:
check-integrity <boolean>;
Blocks: options, view, zone (primary)
Tags: zone
Performs post-load zone integrity checks on primary zones.
This performs post-load zone integrity checks on primary zones. It checks that MX and SRV records refer to address (A or AAAA) records and that glue address records exist for delegated zones. For MX and SRV records, only in-zone hostnames are checked (for out-of-zone hostnames, use
named-checkzone
). For NS records, only names below top-of-zone are checked (for out-of-zone names and glue consistency checks, usenamed-checkzone
). DS records not at delegations are rejected. The default isyes
.The use of the SPF record to publish Sender Policy Framework is deprecated, as the migration from using TXT records to SPF records was abandoned. Enabling this option also checks that a TXT Sender Policy Framework record exists (starts with “v=spf1”) if there is an SPF record. Warnings are emitted if the TXT record does not exist; they can be suppressed with
check-spf
.
- check-mx-cname
Grammar:
check-mx-cname ( fail | warn | ignore );
Blocks: options, view, zone (primary)
Tags: zone
Sets the response to MX records that refer to CNAMEs.
If
check-integrity
is set, then fail, warn, or ignore MX records that refer to CNAMEs. The default is towarn
.
- check-srv-cname
Grammar:
check-srv-cname ( fail | warn | ignore );
Blocks: options, view, zone (primary)
Tags: zone
Sets the response to SRV records that refer to CNAMEs.
If
check-integrity
is set, then fail, warn, or ignore SRV records that refer to CNAMEs. The default is towarn
.
- check-sibling
Grammar:
check-sibling <boolean>;
Blocks: options, view, zone (primary)
Tags: zone
Specifies whether to check for sibling glue when performing integrity checks.
When performing integrity checks, also check that sibling glue exists. The default is
yes
.
- check-spf
Grammar:
check-spf ( warn | ignore );
Blocks: options, view, zone (primary)
Tags: zone
Specifies whether to check for a TXT Sender Policy Framework record, if an SPF record is present.
If
check-integrity
is set, check that there is a TXT Sender Policy Framework record present (starts with “v=spf1”) if there is an SPF record present. The default iswarn
.
- check-svcb
Grammar:
check-svcb <boolean>;
Blocks: options, view, zone (primary)
Tags: zone
Specifies whether to perform additional checks on SVCB records.
If
yes
, checks that SVCB records that start with a_dns
label prefixed by an optional_<port>
label (e.g._443._dns.ns1.example
), have analpn
parameter and that thedohpath
parameter exists when thealpn
indicates that it should be present. The default isyes
.
- zero-no-soa-ttl
Grammar:
zero-no-soa-ttl <boolean>;
Blocks: options, view, zone (mirror, primary, secondary)
Tags: zone, query, server
Specifies whether to set the time to live (TTL) of the SOA record to zero, when returning authoritative negative responses to SOA queries.
If
yes
, when returning authoritative negative responses to SOA queries, set the TTL of the SOA record returned in the authority section to zero. The default isyes
.
- zero-no-soa-ttl-cache
Grammar:
zero-no-soa-ttl-cache <boolean>;
Blocks: options, view
Tags: zone, query, server
Sets the time to live (TTL) to zero when caching a negative response to an SOA query.
If
yes
, when caching a negative response to an SOA query set the TTL to zero. The default isno
.
- update-check-ksk
Grammar:
update-check-ksk <boolean>; // obsolete
Blocks: options, view, zone (primary, secondary)
Tags: obsolete
This option no longer has any effect.
- dnssec-dnskey-kskonly
Grammar:
dnssec-dnskey-kskonly <boolean>; // obsolete
Blocks: options, view, zone (primary, secondary)
Tags: obsolete
This option no longer has any effect.
- try-tcp-refresh
Grammar:
try-tcp-refresh <boolean>;
Blocks: options, view, zone (mirror, secondary)
Tags: transfer
Specifies that BIND 9 should attempt to refresh a zone using TCP if UDP queries fail.
If
yes
, try to refresh the zone using TCP if UDP queries fail. The default isyes
.
- dnssec-secure-to-insecure
Grammar:
dnssec-secure-to-insecure <boolean>; // obsolete
Blocks: options, view, zone (primary)
Tags: obsolete
This option no longer has any effect.
- synth-from-dnssec
Grammar:
synth-from-dnssec <boolean>;
Blocks: options, view
Tags: dnssec
Enables support for RFC 8198, Aggressive Use of DNSSEC-Validated Cache.
This option enables support for RFC 8198, Aggressive Use of DNSSEC-Validated Cache. It allows the resolver to send a smaller number of queries when resolving queries for DNSSEC-signed domains by synthesizing answers from cached NSEC and other RRsets that have been proved to be correct using DNSSEC. The default is
yes
.Note
DNSSEC validation must be enabled for this option to be effective. This initial implementation only covers synthesis of answers from NSEC records; synthesis from NSEC3 is planned for the future. This will also be controlled by
synth-from-dnssec
.
8.2.16.2. Forwarding
The forwarding facility can be used to create a large site-wide cache on a few servers, reducing traffic over links to external name servers. 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
Grammar:
forward ( first | only );
Blocks: options, view, zone (forward, primary, secondary, static-stub, stub)
Tags: query
Allows or disallows fallback to recursion if forwarding has failed; it is always used in conjunction with the
forwarders
statement.This option is only meaningful if the forwarders list is not empty. A value of
first
is the default and causes the server to query the forwarders first; if that does not answer the question, the server then looks for the answer itself. Ifonly
is specified, the server only queries the forwarders.
- forwarders
Grammar:
forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... };
Blocks: options, view, zone (forward, primary, secondary, static-stub, stub)
Tags: query
Defines one or more hosts to which queries are forwarded.
This specifies a list of IP addresses to which queries are forwarded. The default is the empty list (no forwarding). Each address in the list can be associated with an optional port number and a TLS transport. A default port number and a TLS transport can be set for the entire list.
If a TLS configuration is specified,
named
will use DNS-over-TLS (DoT) connections when connecting to the specified IP address(es), using the TLS configuration referenced by thetls
statement.
Forwarding can also be configured on a per-domain basis, allowing for
the global forwarding options to be overridden in a variety of ways.
Particular domains can be set to use different forwarders, or have a
different forward only/first
behavior, or not forward at all; see
zone
.
8.2.16.3. Dual-stack Servers
Dual-stack servers are used as servers of last resort, to work around problems in reachability due to the lack of support for either IPv4 or IPv6 on the host machine.
- dual-stack-servers
Grammar:
dual-stack-servers [ port <integer> ] { ( <quoted_string> [ port <integer> ] | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ); ... };
Blocks: options, view
Tags: server
Specifies host names or addresses of machines with access to both IPv4 and IPv6 transports.
This specifies host names or addresses of machines with access to both IPv4 and IPv6 transports. If a hostname is used, the server must be able to resolve the name using only the transport it has. If the machine is dual-stacked, the
dual-stack-servers
parameter has no effect unless access to a transport has been disabled on the command line (e.g.,named -4
).
8.2.16.4. Access Control
Access to the server can be restricted based on the IP address of the requesting system. See Address Match Lists for details on how to specify IP address lists.
- allow-notify
Grammar:
allow-notify { <address_match_element>; ... };
Blocks: options, view, zone (mirror, secondary)
Tags: transfer
Defines an
address_match_list
that is allowed to sendNOTIFY
messages for the zone, in addition to addresses defined in theprimaries
option for the zone.This ACL specifies which hosts may send NOTIFY messages to inform this server of changes to zones for which it is acting as a secondary server. This is only applicable for secondary zones (i.e.,
type secondary
orslave
).If this option is set in
view
oroptions
, it is globally applied to all secondary zones. If set in thezone
statement, the global value is overridden.If not specified, the default is to process NOTIFY messages only from the configured
primaries
for the zone.allow-notify
can be used to expand the list of permitted hosts, not to reduce it.
- allow-proxy
Warning
This option is experimental and subject to change.
Grammar:
allow-proxy { <address_match_element>; ... }; // experimental
Blocks: options, view
Tags: server
Defines an
address_match_list
for the client addresses allowed to send PROXYv2 headers.The default
address_match_list
is none, which means that no client is allowed to do that by default for security reasons, as the PROXYv2 protocol provides an easy way to spoof both source and destination addresses.This
address_match_list
is primarily meant to have addresses and subnets of the proxies that are allowed to send PROXYv2 headers to BIND. In most cases, we do not recommend setting thisaddress_match_list
to be very allowing, in particular, to set it to any, especially in the cases when PROXYv2 headers can be accepted on publically available networking interfaces.The specified option is the only option that matches against real peer addresses when PROXYv2 headers are used. Most of the options that work with peer addresses, use the ones extracted from PROXYv2 headers.
Also, see:
allow-proxy-on
- allow-proxy-on
Warning
This option is experimental and subject to change.
Grammar:
allow-proxy-on { <address_match_element>; ... }; // experimental
Blocks: options, view
Tags: server
Defines an
address_match_list
for the interface addresses allowed to accept PROXYv2 headers. The option is mostly intended for multi-homed configurations.The default
address_match_list
is any, which means that accepting PROXYv2 is allowed on any interface.The option is useful in cases when you need to have precise control over which interfaces PROXYv2 is allowed, as it is the only one that matches against real interface addresses when PROXYv2 headers are used. Most of the options that work with interface addresses will use the ones extracted from PROXYv2 headers.
You may want to set
allow-proxy
first.
- allow-query
Grammar:
allow-query { <address_match_element>; ... };
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: query
Specifies which hosts (an IP address list) are allowed to send queries to this resolver.
allow-query
may also be specified in thezone
statement, in which case it overrides theoptions allow-query
statement. If not specified, the default is to allow queries from all hosts.Note
allow-query-cache
is used to specify access to the cache.
- allow-query-on
Grammar:
allow-query-on { <address_match_element>; ... };
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: query
Specifies which local addresses (an IP address list) are allowed to send queries to this resolver. Used in multi-homed configurations.
This makes it possible, for instance, to allow queries on internal-facing interfaces but disallow them on external-facing ones, without necessarily knowing the internal network’s addresses.
Note that
allow-query-on
is only checked for queries that are permitted byallow-query
. A query must be allowed by both ACLs, or it is refused.allow-query-on
may also be specified in thezone
statement, in which case it overrides theoptions allow-query-on
statement.If not specified, the default is to allow queries on all addresses.
Note
allow-query-cache
is used to specify access to the cache.
- allow-query-cache
Grammar:
allow-query-cache { <address_match_element>; ... };
Blocks: options, view
Tags: query
Specifies which hosts (an IP address list) can access this server’s cache and thus effectively controls recursion.
Defines an address_match_list of IP address(es) which are allowed to issue queries that access the local cache. Without access to the local cache recursive queries are effectively useless so, in effect, this statement (or its default) controls recursive behavior. This statement’s default setting depends on:
If
recursion no;
present, defaults toallow-query-cache {none;};
. No local cache access permitted.If
recursion yes;
(default) then, ifallow-recursion
present, defaults to the value ofallow-recursion
. Local cache access permitted to the same address_match_list asallow-recursion
.If
recursion yes;
(default) then, ifallow-recursion
is not present, defaults toallow-query-cache {localnets; localhost;};
. Local cache access permitted to address_match_list localnets and localhost IP addresses only.
- allow-query-cache-on
Grammar:
allow-query-cache-on { <address_match_element>; ... };
Blocks: options, view
Tags: query
Specifies which hosts (an IP address list) can access this server’s cache. Used on servers with multiple interfaces.
This specifies which local addresses can send answers from the cache. If
allow-query-cache-on
is not set, thenallow-recursion-on
is used if set. Otherwise, the default is to allow cache responses to be sent from any address. Note: bothallow-query-cache
andallow-query-cache-on
must be satisfied before a cache response can be sent; a client that is blocked by one cannot be allowed by the other.
- allow-recursion
Grammar:
allow-recursion { <address_match_element>; ... };
Blocks: options, view
Tags: query
Defines an
address_match_list
of clients that are allowed to perform recursive queries.This specifies which hosts are allowed to make recursive queries through this server. BIND checks to see if the following parameters are set, in order:
allow-query-cache
andallow-query
. If neither of those parameters is set, the default (localnets; localhost;) is used.
- allow-recursion-on
Grammar:
allow-recursion-on { <address_match_element>; ... };
Blocks: options, view
Tags: query, server
Specifies which local addresses can accept recursive queries.
This specifies which local addresses can accept recursive queries. If
allow-recursion-on
is not set, thenallow-query-cache-on
is used if set; otherwise, the default is to allow recursive queries on all addresses. Any client permitted to send recursive queries can send them to any address on whichnamed
is listening. Note: bothallow-recursion
andallow-recursion-on
must be satisfied before recursion is allowed; a client that is blocked by one cannot be allowed by the other.
- allow-update
Grammar:
allow-update { <address_match_element>; ... };
Blocks: options, view, zone (primary)
Tags: transfer
Defines an
address_match_list
of hosts that are allowed to submit dynamic updates for primary zones.A simple access control list. When set in the
zone
statement for a primary zone, this specifies which hosts are allowed to submit dynamic DNS updates to that zone. The default is to deny updates from all hosts.Note that allowing updates based on the requestor’s IP address is insecure; see Dynamic Update Security for details.
In general, this option should only be set at the
zone
level. While a default value can be set at theoptions
orview
level and inherited by zones, this could lead to some zones unintentionally allowing updates.Updates are written to the zone’s filename that is set in
file
.
- allow-update-forwarding
Grammar:
allow-update-forwarding { <address_match_element>; ... };
Blocks: options, view, zone (mirror, secondary)
Tags: transfer
Defines an
address_match_list
of hosts that are allowed to submit dynamic updates to a secondary server for transmission to a primary.When set in the
zone
statement for a secondary zone, this specifies which hosts are allowed to submit dynamic DNS updates and have them be forwarded to the primary. The default is{ none; }
, which means that no update forwarding is performed.To enable update forwarding, specify
allow-update-forwarding { any; };
in thezone
statement. Specifying values other than{ none; }
or{ any; }
is usually counterproductive; the responsibility for update access control should rest with the primary server, not the secondary.Note that enabling the update forwarding feature on a secondary server may expose primary servers to attacks if they rely on insecure IP-address-based access control; see Dynamic Update Security for more details.
In general this option should only be set at the
zone
level. While a default value can be set at theoptions
orview
level and inherited by zones, this can lead to some zones unintentionally forwarding updates.
- allow-transfer
Grammar:
allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... };
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Defines an
address_match_list
of hosts that are allowed to transfer the zone information from this server.This specifies which hosts are allowed to receive zone transfers from the server.
allow-transfer
may also be specified in thezone
statement, in which case it overrides theallow-transfer
statement set inoptions
orview
.The transport level limitations can also be specified. In particular, zone transfers can be restricted to a specific port and/or DNS transport protocol by using the options port and
transport
. Either option can be specified; if both are used, both constraints must be satisfied in order for the transfer to be allowed. Zone transfers are currently only possible via the TCP and TLS transports.For example:
allow-transfer port 853 transport tls { any; };
allows outgoing zone transfers to any host using the TLS transport over port 853.If
allow-transfer
is not specified, then the default isnone
; outgoing zone transfers are disabled.
Warning
Please note that incoming TLS connections are not authenticated at the TLS level by default. Please use TSIG to authenticate requestors or consider implementing Mutual TLS authentication.
- blackhole
Grammar:
blackhole { <address_match_element>; ... };
Blocks: options
Tags: query
Defines an
address_match_list
of hosts to ignore. The server will neither respond to queries from nor send queries to these addresses.This specifies a list of addresses which the server does not accept queries from or use to resolve a query. Queries from these addresses are not responded to. The default is
none
.
- no-case-compress
Grammar:
no-case-compress { <address_match_element>; ... };
Blocks: options, view
Tags: server
Specifies a list of addresses that require case-insensitive compression in responses.
This specifies a list of addresses which require responses to use case-insensitive compression. This ACL can be used when
named
needs to work with clients that do not comply with the requirement in RFC 1034 to use case-insensitive name comparisons when checking for matching domain names.If left undefined, the ACL defaults to
none
: case-sensitive compression is used for all clients. If the ACL is defined and matches a client, case is ignored when compressing domain names in DNS responses sent to that client.This can result in slightly smaller responses; if a response contains the names “example.com” and “example.COM”, case-insensitive compression treats the second one as a duplicate. It also ensures that the case of the query name exactly matches the case of the owner names of returned records, rather than matches the case of the records entered in the zone file. This allows responses to exactly match the query, which is required by some clients due to incorrect use of case-sensitive comparisons.
Case-insensitive compression is always used in AXFR and IXFR responses, regardless of whether the client matches this ACL.
There are circumstances in which
named
does not preserve the case of owner names of records: if a zone file defines records of different types with the same name, but the capitalization of the name is different (e.g., “www.example.com/A” and “WWW.EXAMPLE.COM/AAAA”), then all responses for that name use the first version of the name that was used in the zone file. This limitation may be addressed in a future release. However, domain names specified in the rdata of resource records (i.e., records of type NS, MX, CNAME, etc.) always have their case preserved unless the client matches this ACL.
- resolver-query-timeout
Grammar:
resolver-query-timeout <integer>;
Blocks: options, view
Tags: query
Specifies the length of time, in milliseconds, that a resolver attempts to resolve a recursive query before failing.
This is the amount of time in milliseconds that the resolver spends attempting to resolve a recursive query before failing. The default is
10000
, the minimum is301
and the maximum is30000
. Setting it to0
results in the default being used.This value was originally specified in seconds. Values less than or equal to 300 are treated as seconds and converted to milliseconds before applying the above limits.
8.2.16.5. Interfaces
The interfaces, ports, and protocols that the server can use to answer
queries may be specified using the listen-on
and listen-on-v6
options.
- listen-on
Grammar:
listen-on [ port <integer> ] [ proxy <string> ] [ tls <string> ] [ http <string> ] { <address_match_element>; ... }; // may occur multiple times
Blocks: options
Tags: server
Specifies the IPv4 addresses on which a server listens for DNS queries.
- listen-on-v6
Grammar:
listen-on-v6 [ port <integer> ] [ proxy <string> ] [ tls <string> ] [ http <string> ] { <address_match_element>; ... }; // may occur multiple times
Blocks: options
Tags: server
Specifies the IPv6 addresses on which a server listens for DNS queries.
The
listen-on
andlisten-on-v6
statements can each take an optional port, PROXYv2 support switch, TLS configuration identifier, and/or HTTP configuration identifier, in addition to an address_match_list.The address_match_list in
listen-on
specifies the IPv4 addresses on which the server will listen. (IPv6 addresses are ignored, with a logged warning.) The server listens on all interfaces allowed by the address match list. If nolisten-on
is specified, the default is to listen for standard DNS queries on port 53 of all IPv4 interfaces.listen-on-v6
takes an address_match_list of IPv6 addresses. The server listens on all interfaces allowed by the address match list. If nolisten-on-v6
is specified, the default is to listen for standard DNS queries on port 53 of all IPv6 interfaces.When specified, the PROXYv2 support switch
proxy
allows enabling the PROXYv2 protocol support. The PROXYv2 protocol provides the means for passing connection information, such as a client’s source and destination addresses and ports, across multiple layers of NAT or TCP/UDP proxies to back-end servers. The addresses passed to by the PROXYv2 protocol are then used instead of the peer and interface addresses provided by the operating system.The
proxy
switch can have the following values:plain
- accept plain PROXYv2 headers. It is the only valid option for transports that do not employ encryption. In the case of transports that employ encryption, it instructs BIND that PROXYv2 headers are sent without encryption before the TLS handshake. In that case, only PROXYv2 headers are not encrypted.encrypted
- accept encrypted PROXYv2 headers. In the case of transports that employ encryption, it instructs BIND that PROXYv2 headers are sent encrypted immediately after the TLS handshake. The option is valid only for the transports that employ encryption.
You must consult your proxying front-end software documentation to decide which value you need to use. If in doubt, use
plain
for encrypted transports, especially for DNS-over-HTTPS (DoH), but DNS-specific software is likely to needencrypted
.It should be noted that when PROXYv2 is enabled on a listener, it loses the ability to accept regular DNS queries without associated PROXYv2 headers.
In some cases, PROXYv2 headers might not contain usable source and destination addresses. In particular, that happens when the headers use
LOCAL
command or the headers that use unspecified or unsupported by BIND address types. If otherwise correct, such headers are accepted by BIND and the real endpoint addresses are used in these cases.The PROXYv2 protocol is designed to be extensible and can carry additional information in the form of type-length-values (TLVs). Many of the types are defined in the protocol specification, and for some of these, we do a reasonable amount of validation in order to detect and reject ill-formed or hand-crafted headers. Apart from that, this additional data, while accepted, is not currently used by BIND for anything else.
By default, no client is allowed to send queries that contain PROXYv2 protocol headers, even when support for the protocol is enabled in a
listen-on
statement. If you are interested in enabling the PROXYv2 protocol support, you may also want to take a look atallow-proxy
andallow-proxy-on
options to adjust the corresponding ACLs.If a TLS configuration is specified,
named
will listen for DNS-over-TLS (DoT) connections, using the key and certificate specified in the referencedtls
statement. If the nameephemeral
is used, an ephemeral key and certificate created for the currently runningnamed
process will be used.If an HTTP configuration is specified,
named
will listen for DNS-over-HTTPS (DoH) connections using the HTTP endpoint specified in the referencedhttp
statement. If the namedefault
is used, thennamed
will listen for connections at the default endpoint,/dns-query
.Use of an
http
specification requirestls
to be specified as well. If an unencrypted connection is desired (for example, on load-sharing servers behind a reverse proxy),tls none
may be used.If a port number is not specified, the default is 53 for standard DNS, 853 for DNS over TLS, 443 for DNS over HTTPS, and 80 for DNS over HTTP (unencrypted). These defaults may be overridden using the
port
,tls-port
,https-port
, andhttp-port
options.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; }; listen-on port 8853 tls ephemeral { 4.3.2.1; }; listen-on port 8453 tls ephemeral http myserver { 8.7.6.5; }; listen-on port 5300 proxy plain { !1.2.3.4; 1.2/16; }; listen-on port 8953 proxy encrypted tls ephemeral { 4.3.2.1; }; listen-on port 8553 proxy plain tls ephemeral http myserver { 8.7.6.5; };
The first two lines instruct the name server to listen for standard DNS queries on port 53 of 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. The third line instructs the server to listen for DNS-over-TLS connections on port 8853 of the IP address 4.3.2.1 using the ephemeral key and certifcate. The fourth line enables DNS-over-HTTPS connections on port 8453 of address 8.7.6.5, using the ephemeral key and certificate, and the HTTP endpoint or endpoints configured in an
http
statement with the namemyserver
.Multiple
listen-on-v6
options can be used. For example:listen-on-v6 { any; }; listen-on-v6 port 1234 { !2001:db8::/32; any; }; listen-on-v6 port 8853 tls example-tls { 2001:db8::100; }; listen-on-v6 port 8453 tls example-tls http default { 2001:db8::100; }; listen-on-v6 port 8000 tls none http myserver { 2001:db8::100; }; listen-on-v6 port 53000 proxy plain { !2001:db8::/32; any; }; listen-on-v6 port 8953 proxy encrypted tls example-tls { 2001:db8::100; }; listen-on-v6 port 8553 proxy plain tls example-tls http default { 2001:db8::100; };
The first two lines instruct the name server to listen for standard DNS queries on port 53 of any IPv6 addresses, and on port 1234 of IPv6 addresses that are not in the prefix 2001:db8::/32. The third line instructs the server to listen for for DNS-over-TLS connections on port 8853 of the address 2001:db8::100, using a TLS key and certificate specified in the a
tls
statement with the nameexample-tls
. The fourth instructs the server to listen for DNS-over-HTTPS connections, again usingexample-tls
, on the default HTTP endpoint. The fifth line, in which thetls
parameter is set tonone
, instructs the server to listen for unencrypted DNS queries over HTTP at the endpoint specified inmyserver
..To instruct the server not to listen on any IPv6 addresses, use:
listen-on-v6 { none; };
8.2.16.6. Query Address
- query-source
Grammar:
query-source [ address ] ( <ipv4_address> | * );
Blocks: options, server, view, view.server
Tags: query
Controls the IPv4 address from which queries are issued.
- query-source-v6
Grammar:
query-source-v6 [ address ] ( <ipv6_address> | * );
Blocks: options, server, view, view.server
Tags: query
Controls the IPv6 address from which queries are issued.
If the server does not know the answer to a question, it queries other name servers.
query-source
specifies the address used for such queries. For queries sent over IPv6, there is a separatequery-source-v6
option. Ifaddress
is*
(asterisk) or is omitted, a wildcard IP address (INADDR_ANY
) is used.The defaults of the
query-source
andquery-source-v6
options are:query-source address *; query-source-v6 address *;
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.
8.2.16.7. 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
Grammar:
also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... };
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Defines one or more hosts that are sent
NOTIFY
messages when zone changes occur.This option 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 quickly converge on stealth servers. Optionally, a port may be specified with each
also-notify
address to send the notify messages to a port other than the default of 53. An optional TSIG key can also be specified with each address to cause the notify messages to be signed; this can be useful when sending notifies to multiple views. In place of explicit addresses, one or more namedprimaries
lists can be used.If an
also-notify
list is given in azone
statement, it overrides theoptions also-notify
statement. When azone notify
statement is set tono
, the IP addresses in the globalalso-notify
list are not sent NOTIFY messages for that zone. The default is the empty list (no global notification list).
- max-transfer-time-in
Grammar:
max-transfer-time-in <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Specifies the number of minutes after which inbound zone transfers are terminated.
Inbound zone transfers running longer than this many minutes are terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes).
- max-transfer-idle-in
Grammar:
max-transfer-idle-in <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Specifies the number of minutes after which inbound zone transfers making no progress are terminated.
Inbound zone transfers making no progress in this many minutes are terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes).
Note
Inbound zone transfers are also affected by
tcp-idle-timeout
;max-transfer-idle-in
closes the inbound zone transfer if there is no complete AXFR or no complete IXFR chunk.tcp-idle-timeout
closes the connection if there is no progress on the TCP level.
- max-transfer-time-out
Grammar:
max-transfer-time-out <integer>;
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Specifies the number of minutes after which outbound zone transfers are terminated.
Outbound zone transfers running longer than this many minutes are terminated. The default is 120 minutes (2 hours). The maximum value is 28 days (40320 minutes).
- max-transfer-idle-out
Grammar:
max-transfer-idle-out <integer>;
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Specifies the number of minutes after which outbound zone transfers making no progress are terminated.
Outbound zone transfers making no progress in this many minutes are terminated. The default is 60 minutes (1 hour). The maximum value is 28 days (40320 minutes).
- notify-rate
Grammar:
notify-rate <integer>;
Blocks: options
Tags: transfer, zone
Specifies the rate at which NOTIFY requests are sent during normal zone maintenance operations.
This specifies the rate at which NOTIFY requests are sent during normal zone maintenance operations. (NOTIFY requests due to initial zone loading are subject to a separate rate limit; see below.) The default is 20 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one.
- startup-notify-rate
Grammar:
startup-notify-rate <integer>;
Blocks: options
Tags: transfer, zone
Specifies the rate at which NOTIFY requests are sent when the name server is first starting, or when new zones have been added.
This is the rate at which NOTIFY requests are sent when the name server is first starting up, or when zones have been newly added to the name server. The default is 20 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one.
- serial-query-rate
Grammar:
serial-query-rate <integer>;
Blocks: options
Tags: transfer
Defines an upper limit on the number of queries per second issued by the server, when querying the SOA RRs used for zone transfers.
Secondary servers periodically query primary servers to find out if zone serial numbers have changed. Each such query uses a minute amount of the secondary server’s network bandwidth. To limit the amount of bandwidth used, BIND 9 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 per second. The lowest possible rate is one per second; when set to zero, it is silently raised to one.
- transfer-format
Grammar:
transfer-format ( many-answers | one-answer );
Blocks: options, server, view, view.server
Tags: transfer
Controls whether multiple records can be packed into a message during zone transfers.
Zone transfers can be sent using two different formats,
one-answer
andmany-answers
. Thetransfer-format
option is used on the primary 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 one message.many-answers
is more efficient; the default ismany-answers
.transfer-format
may be overridden on a per-server basis by using theserver
block.
- transfer-message-size
Grammar:
transfer-message-size <integer>;
Blocks: options
Tags: transfer
Limits the uncompressed size of DNS messages used in zone transfers over TCP.
This is an upper bound on the uncompressed size of DNS messages used in zone transfers over TCP. If a message grows larger than this size, additional messages are used to complete the zone transfer. (Note, however, that this is a hint, not a hard limit; if a message contains a single resource record whose RDATA does not fit within the size limit, a larger message will be permitted so the record can be transferred.)
Valid values are between 512 and 65535 octets; any values outside that range are adjusted to the nearest value within it. The default is
20480
, which was selected to improve message compression; most DNS messages of this size will compress to less than 16536 bytes. Larger messages cannot be compressed as effectively, because 16536 is the largest permissible compression offset pointer in a DNS message.This option is mainly intended for server testing; there is rarely any benefit in setting a value other than the default.
- transfers-in
Grammar:
transfers-in <integer>;
Blocks: options
Tags: transfer
Limits the number of concurrent inbound zone transfers.
This is the maximum number of inbound zone transfers that can run concurrently. The default value is
10
. Increasingtransfers-in
may speed up the convergence of secondary zones, but it also may increase the load on the local system.
- transfers-out
Grammar:
transfers-out <integer>;
Blocks: options
Tags: transfer
Limits the number of concurrent outbound zone transfers.
This is the maximum number of outbound zone transfers that can run concurrently. Zone transfer requests in excess of the limit are refused. The default value is
10
.
- transfers-per-ns
Grammar:
transfers-per-ns <integer>;
Blocks: options
Tags: transfer
Limits the number of concurrent inbound zone transfers from a remote server.
This is the maximum number of inbound zone transfers that can concurrently transfer from a given remote name server. The default value is
2
. Increasingtransfers-per-ns
may speed up the convergence of secondary zones, but it also may increase the load on the remote name server.transfers-per-ns
may be overridden on a per-server basis by using thetransfers
phrase of theserver
statement.
- transfer-source
Grammar:
transfer-source ( <ipv4_address> | * );
Blocks: options, server, view, zone (mirror, secondary, stub), view.server
Tags: transfer
Defines which local IPv4 address(es) are bound to TCP connections used to fetch zones transferred inbound by the server.
transfer-source
determines which local address is bound to IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the source IPv4 address, used for the refresh queries and forwarded dynamic updates. If not set, it defaults to a system-controlled value which is usually the address of the interface “closest to” the remote end. This address must appear in the remote end’sallow-transfer
option for the zone being transferred, if one is specified. This statement sets thetransfer-source
for all zones, but can be overridden on a per-view or per-zone basis by including atransfer-source
statement within theview
orzone
block in the configuration file.
- transfer-source-v6
Grammar:
transfer-source-v6 ( <ipv6_address> | * );
Blocks: options, server, view, zone (mirror, secondary, stub), view.server
Tags: transfer
Defines which local IPv6 address(es) are bound to TCP connections used to fetch zones transferred inbound by the server.
This option is the same as
transfer-source
, except zone transfers are performed using IPv6.
- notify-source
Grammar:
notify-source ( <ipv4_address> | * );
Blocks: options, server, view, zone (mirror, primary, secondary), view.server
Tags: transfer
Defines the IPv4 address to be used for outgoing
NOTIFY
messages.notify-source
determines which local source address is used to send NOTIFY messages. This address must appear in the secondary server’sprimaries
zone clause or in anallow-notify
clause. This statement sets thenotify-source
for all zones, but can be overridden on a per-zone or per-view basis by including anotify-source
statement within thezone
orview
block in the configuration file.
- notify-source-v6
Grammar:
notify-source-v6 ( <ipv6_address> | * );
Blocks: options, server, view, zone (mirror, primary, secondary), view.server
Tags: transfer
Defines the IPv6 address (and optional port) to be used for outgoing
NOTIFY
messages.This option acts like
notify-source
, but applies toNOTIFY
messages sent to IPv6 addresses.
8.2.16.8. Server Resource Limits
The following options set limits on the server’s resource consumption that are enforced internally by the server rather than by the operating system.
- max-journal-size
Grammar:
max-journal-size ( default | unlimited | <sizeval> );
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer
Controls the size of journal files.
This sets a maximum size for each journal file (see The Journal File), expressed in bytes or, if followed by an optional unit suffix (‘k’, ‘m’, or ‘g’), in kilobytes, megabytes, or gigabytes. When the journal file approaches the specified size, some of the oldest transactions in the journal are automatically removed. The largest permitted value is 2 gigabytes. Very small values are rounded up to 4096 bytes. It is possible to specify
unlimited
, which also means 2 gigabytes. If the limit is set todefault
or left unset, the journal is allowed to grow up to twice as large as the zone. (There is little benefit in storing larger journals.)This option may also be set on a per-zone basis.
- max-records
Grammar:
max-records <integer>;
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: zone, server
Sets the maximum number of records permitted in a zone.
This sets the maximum number of records permitted in a zone. The default is zero, which means the maximum is unlimited.
- max-records-per-type
Grammar:
max-records-per-type <integer>;
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: server
Sets the maximum number of records that can be stored in an RRset.
This sets the maximum number of resource records that can be stored in an RRset in a database. When configured in
options
orview
, it controls the cache database; it also sets the default value for zone databases, which can be overridden by setting it at thezone
level.If set to a positive value, any attempt to cache, or to add to a zone an RRset with more than the specified number of records, will result in a failure. If set to 0, there is no cap on RRset size. The default is 100.
- max-types-per-name
Grammar:
max-types-per-name <integer>;
Blocks: options, view, zone (mirror, primary, redirect, secondary, static-stub, stub)
Tags: server
Sets the maximum number of RR types that can be stored for an owner name.
This sets the maximum number of resource record types that can be stored for a single owner name in a database. When configured in
options
orview
, it controls the cache database and sets the default value for zone databases, which can be overridden by setting it at thezone
level.An RR type and its corresponding signature are counted as two types. So, for example, a signed node containing A and AAAA records has four types: A, RRSIG(A), AAAA, and RRSIG(AAAA).
The behavior is slightly different for zone and cache databases:
In a zone, if
max-types-per-name
is set to a positive number, any attempt to add a new resource record set to a name that already has the specified number of types will fail.In a cache, if
max-types-per-name
is set to a positive number, an attempt to add a new resource record set to a name that already has the specified number of types will temporarily succeed, so that the query can be answered. However, the newly added RRset will immediately be purged.Certain high-priority types, including SOA, CNAME, DNSKEY, and their corresponding signatures, are always cached. If
max-types-per-name
is set to a very low value, then it may be ignored to allow high-priority types to be cached.When
max-types-per-name
is set to 0, there is no cap on the number of RR types. The default is 100.
- recursive-clients
Grammar:
recursive-clients <integer>;
Blocks: options
Tags: query
Specifies the maximum number of concurrent recursive queries the server can perform.
This sets the maximum number (a “hard quota”) of simultaneous recursive lookups the server performs 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 therecursive-clients
option may have to be decreased on hosts with limited memory.recursive-clients
defines a “hard quota” limit for pending recursive clients; when more clients than this are pending, new incoming requests are not accepted, and for each incoming request a previous pending request is dropped.A “soft quota” is also set. When this lower quota is exceeded, incoming requests are accepted, but for each one, a pending request is dropped. If
recursive-clients
is greater than 1000, the soft quota is set torecursive-clients
minus 100; otherwise it is set to 90% ofrecursive-clients
.
- tcp-clients
Grammar:
tcp-clients <integer>;
Blocks: options
Tags: server
Specifies the maximum number of simultaneous client TCP connections accepted by the server.
This is the maximum number of simultaneous client TCP connections that the server accepts. The default is
150
.
- clients-per-query
Grammar:
clients-per-query <integer>;
Blocks: options, view
Tags: server
Sets the initial minimum number of simultaneous recursive clients accepted by the server for any given query before the server drops additional clients.
This sets the initial value (minimum) number of simultaneous recursive clients for any given query (<qname,qtype,qclass>) that the server accepts before dropping additional clents.
named
attempts to self-tune this value and changes are logged. The default value is 10.The chosen value should reflect how many queries come in for a given name in the time it takes to resolve that name.
- max-clients-per-query
Grammar:
max-clients-per-query <integer>;
Blocks: options, view
Tags: server
Sets the maximum number of simultaneous recursive clients accepted by the server for any given query before the server drops additional clients.
This sets the maximum number of simultaneous recursive clients for any given query (<qname,qtype,qclass>) that the server accepts before dropping additional clients.
If the number of queries exceeds
clients-per-query
,named
assumes that it is dealing with a non-responsive zone and drops additional queries. If it gets a response after dropping queries, it raises the estimate, up to a limit ofmax-clients-per-query
. The estimate is then lowered after 20 minutes if it has remained unchanged.If
max-clients-per-query
is set to zero, there is no upper bound, other than that imposed byrecursive-clients
. Ifclients-per-query
is set to zero,max-clients-per-query
no longer applies and there is no upper bound, other than that imposed byrecursive-clients
.
- max-validations-per-fetch
Warning
This option is experimental and subject to change.
Grammar:
max-validations-per-fetch <integer>; // experimental
Blocks: options, view
Tags: server
Set the maximum number of DNSSEC validations that can happen in single fetch
This is an experimental setting to set the maximum number of DNSSEC validations that can happen in a single resolver fetch. The default is 16.
- max-validation-failures-per-fetch
Warning
This option is experimental and subject to change.
Grammar:
max-validation-failures-per-fetch <integer>; // experimental
Blocks: options, view
Tags: server
Set the maximum number of DNSSEC validation failures that can happen in single fetch
This is an experimental setting to set the maximum number of DNSSEC validation failures that can happen in a single resolver fetch. The default is 1.
- fetches-per-zone
Grammar:
fetches-per-zone <integer> [ ( drop | fail ) ];
Blocks: options, view
Tags: server, query
Sets the maximum number of simultaneous iterative queries allowed to any one domain before the server blocks new queries for data in or beneath that zone.
This sets the maximum number of simultaneous iterative queries to any one domain that the server permits before blocking new queries for data in or beneath that zone. This value should reflect how many fetches would normally be sent to any one zone in the time it would take to resolve them. It should be smaller than
recursive-clients
.When many clients simultaneously query for the same name and type, the clients are all attached to the same fetch, up to the
max-clients-per-query
limit, and only one iterative query is sent. However, when clients are simultaneously querying for different names or types, multiple queries are sent andmax-clients-per-query
is not effective as a limit.Optionally, this value may be followed by the keyword
drop
orfail
, indicating whether queries which exceed the fetch quota for a zone are dropped with no response, or answered with SERVFAIL. The default isdrop
.If
fetches-per-zone
is set to zero, there is no limit on the number of fetches per query and no queries are dropped. The default is zero.The current list of active fetches can be dumped by running
rndc recursing
. The list includes the number of active fetches for each domain and the number of queries that have been passed (allowed) or dropped (spilled) as a result of thefetches-per-zone
limit. (Note: these counters are not cumulative over time; whenever the number of active fetches for a domain drops to zero, the counter for that domain is deleted, and the next time a fetch is sent to that domain, it is recreated with the counters set to zero.)Note
Fetches generated automatically in the result of
prefetch
are exempt from this quota.
- fetches-per-server
Grammar:
fetches-per-server <integer> [ ( drop | fail ) ];
Blocks: options, view
Tags: server, query
Sets the maximum number of simultaneous iterative queries allowed to be sent by a server to an upstream name server before the server blocks additional queries.
This sets the maximum number of simultaneous iterative queries that the server allows to be sent to a single upstream name server before blocking additional queries. This value should reflect how many fetches would normally be sent to any one server in the time it would take to resolve them. It should be smaller than
recursive-clients
.Optionally, this value may be followed by the keyword
drop
orfail
, indicating whether queries are dropped with no response or answered with SERVFAIL, when all of the servers authoritative for a zone are found to have exceeded the per-server quota. The default isfail
.If
fetches-per-server
is set to zero, there is no limit on the number of fetches per query and no queries are dropped. The default is zero.The
fetches-per-server
quota is dynamically adjusted in response to detected congestion. As queries are sent to a server and either are answered or time out, an exponentially weighted moving average is calculated of the ratio of timeouts to responses. If the current average timeout ratio rises above a “high” threshold, thenfetches-per-server
is reduced for that server. If the timeout ratio drops below a “low” threshold, thenfetches-per-server
is increased. Thefetch-quota-params
options can be used to adjust the parameters for this calculation.Note
Fetches generated automatically in the result of
prefetch
are exempt from this quota, but they are included in the quota calculations.
- fetch-quota-params
Grammar:
fetch-quota-params <integer> <fixedpoint> <fixedpoint> <fixedpoint>;
Blocks: options, view
Tags: server, query
Sets the parameters for dynamic resizing of the
fetches-per-server
quota in response to detected congestion.This sets the parameters to use for dynamic resizing of the
fetches-per-server
quota in response to detected congestion.The first argument is an integer value indicating how frequently to recalculate the moving average of the ratio of timeouts to responses for each server. The default is 100, meaning that BIND recalculates the average ratio after every 100 queries have either been answered or timed out.
The remaining three arguments represent the “low” threshold (defaulting to a timeout ratio of 0.1), the “high” threshold (defaulting to a timeout ratio of 0.3), and the discount rate for the moving average (defaulting to 0.7). A higher discount rate causes recent events to weigh more heavily when calculating the moving average; a lower discount rate causes past events to weigh more heavily, smoothing out short-term blips in the timeout ratio. These arguments are all fixed-point numbers with precision of 1/100; at most two places after the decimal point are significant.
- max-cache-size
Grammar:
max-cache-size ( default | unlimited | <sizeval> | <percentage> );
Blocks: options, view
Tags: server
Sets the maximum amount of memory to use for an individual cache database and its associated metadata.
This sets the maximum amount of memory to use for an individual cache database and its associated metadata, in bytes or percentage of total physical memory. By default, each view has its own separate cache, which means the total amount of memory required for cache data is the sum of the cache database sizes for all views (unless the
attach-cache
option is used).When the amount of data in a cache database reaches the configured limit,
named
starts purging non-expired records (following an LRU-based strategy).The default size limit for each individual cache is:
Any positive value smaller than 2 MB is ignored and reset to 2 MB. The keyword
unlimited
, or the value0
, places no limit on the cache size; records are then purged from the cache only when they expire (according to their TTLs).Note
For configurations which define multiple views with separate caches and recursion enabled, it is recommended to set
max-cache-size
appropriately for each view, as using the default value of that option (90% of physical memory for each individual cache) may lead to memory exhaustion over time.Note
max-cache-size
does not work reliably for a maximum amount of memory of 100 MB or lower.Upon startup and reconfiguration, caches with a limited size preallocate a small amount of memory (less than 1% of
max-cache-size
for a given view). This preallocation serves as an optimization to eliminate extra latency introduced by resizing internal cache structures.On systems where detection of the amount of physical memory is not supported, percentage-based values fall back to
unlimited
. Note that the amount of physical memory available is only detected on startup, sonamed
does not adjust the cache size limits if the amount of physical memory is changed at runtime.On Linux, the system administrator can use cgroup (Control Group) mechanism to limit the amount of available memory to the process. This limit will be honoured when calculating the percentage-based values.
- tcp-listen-queue
Grammar:
tcp-listen-queue <integer>;
Blocks: options
Tags: server
Sets the listen-queue depth.
This sets the listen-queue depth. The default and minimum is 10. If the kernel supports the accept filter “dataready”, this also controls how many TCP connections are queued in kernel space waiting for some data before being passed to accept. Non-zero values less than 10 are silently raised. A value of 0 may also be used; on most platforms this sets the listen-queue length to a system-defined default value.
- tcp-initial-timeout
Grammar:
tcp-initial-timeout <integer>;
Blocks: options
Tags: server, query
Sets the amount of time (in milliseconds) that the server waits on a new TCP connection for the first message from the client.
This sets the amount of time (in units of 100 milliseconds) that the server waits on a new TCP connection for the first message from the client. The default is 300 (30 seconds), the minimum is 25 (2.5 seconds), and the maximum is 1200 (two minutes). Values above the maximum or below the minimum are adjusted with a logged warning. (Note: this value must be greater than the expected round-trip delay time; otherwise, no client will ever have enough time to submit a message.) This value can be updated at runtime by using
rndc tcp-timeouts
.
- tcp-idle-timeout
Grammar:
tcp-idle-timeout <integer>;
Blocks: options
Tags: query
Sets the amount of time (in milliseconds) that the server waits on an idle TCP connection before closing it, if the EDNS TCP keepalive option is not in use.
This sets the amount of time (in units of 100 milliseconds) that the server waits on an idle TCP connection before closing it, when the client is not using the EDNS TCP keepalive option. The default is 300 (30 seconds), the maximum is 1200 (two minutes), and the minimum is 1 (one-tenth of a second). Values above the maximum or below the minimum are adjusted with a logged warning. See
tcp-keepalive-timeout
for clients using the EDNS TCP keepalive option. This value can be updated at runtime by usingrndc tcp-timeouts
.
- tcp-keepalive-timeout
Grammar:
tcp-keepalive-timeout <integer>;
Blocks: options
Tags: query
Sets the amount of time (in milliseconds) that the server waits on an idle TCP connection before closing it, if the EDNS TCP keepalive option is in use.
This sets the amount of time (in units of 100 milliseconds) that the server waits on an idle TCP connection before closing it, when the client is using the EDNS TCP keepalive option. The default is 300 (30 seconds), the maximum is 65535 (about 1.8 hours), and the minimum is 1 (one-tenth of a second). Values above the maximum or below the minimum are adjusted with a logged warning. This value may be greater than
tcp-idle-timeout
because clients using the EDNS TCP keepalive option are expected to use TCP connections for more than one message. This value can be updated at runtime by usingrndc tcp-timeouts
.
- tcp-advertised-timeout
Grammar:
tcp-advertised-timeout <integer>;
Blocks: options
Tags: query
Sets the timeout value (in milliseconds) that the server sends in responses containing the EDNS TCP keepalive option.
This sets the timeout value (in units of 100 milliseconds) that the server sends in responses containing the EDNS TCP keepalive option, which informs a client of the amount of time it may keep the session open. The default is 300 (30 seconds), the maximum is 65535 (about 1.8 hours), and the minimum is 0, which signals that the clients must close TCP connections immediately. Ordinarily this should be set to the same value as
tcp-keepalive-timeout
. This value can be updated at runtime by usingrndc tcp-timeouts
.
- update-quota
Grammar:
update-quota <integer>;
Blocks: options
Tags: server
Specifies the maximum number of concurrent DNS UPDATE messages that can be processed by the server.
This is the maximum number of simultaneous DNS UPDATE messages that the server will accept, for updating local authoritative zones or forwarding to a primary server. The default is
100
.
- sig0checks-quota
Warning
This option is experimental and subject to change.
Grammar:
sig0checks-quota <integer>; // experimental
Blocks: options
Tags: server
Specifies the maximum number of concurrent SIG(0) signature checks that can be processed by the server.
This is the maximum number of simultaneous SIG(0)-signed messages that the server accepts. If the quota is reached, then
named
answers with a status code of REFUSED. The value of0
disables the quota. The default is1
.
- sig0checks-quota-exempt
Warning
This option is experimental and subject to change.
Grammar:
sig0checks-quota-exempt { <address_match_element>; ... }; // experimental
Blocks: options
Tags: server
Exempts specific clients or client groups from SIG(0) signature checking quota.
DNS clients can be exempted from SIG(0) signature checking quota with the
sig0checks-quota-exempt
clause using their IP and/or Network addresses. The default value is an empty list.Example:
sig0checks-quota-exempt { 10.0.0.0/8; 2001:db8::100; };
8.2.16.9. Periodic Task Intervals
- interface-interval
Grammar:
interface-interval <duration>;
Blocks: options
Tags: server
Sets the interval at which the server scans the network interface list.
The server scans the network interface list every
interface-interval
minutes. The default is 60 minutes; the maximum value is 28 days (40320 minutes). If set to 0, interface scanning only occurs when the configuration file is loaded, or whenautomatic-interface-scan
is enabled and supported by the operating system. After the scan, the server begins listening for queries on any newly discovered interfaces (provided they are allowed by thelisten-on
configuration), and stops listening on interfaces that have gone away. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.
8.2.16.10. The sortlist
Statement
The response to a DNS query may consist of multiple resource records
(RRs) forming a resource record set (RRset). The name server
normally returns the RRs within the RRset in an indeterminate order (but
see the rrset-order
statement in RRset Ordering). The client resolver code should
rearrange the RRs as appropriate: that is, 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 name servers, not
all the clients.
- sortlist
Warning
This option is deprecated and will be removed in a future version of BIND.
Grammar:
sortlist { <address_match_element>; ... }; // deprecated
Blocks: options, view
Tags: query, deprecated
Controls the ordering of RRs returned to the client, based on the client’s IP address.
This option is deprecated and will be removed in a future release.
The
sortlist
statement (see below) takes an address_match_list and interprets it in a special way. Each top-level statement in thesortlist
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. When the addresses in the first element overlap, the first rule to match is selected.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 as a topology preference list. 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 get responses preferring addresses on any of the locally connected networks. Next most preferred are 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 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 only prefer other addresses on their directly connected networks.
sortlist {
// IF the local host
// THEN first fit on the following nets
{ localhost;
{ localnets;
192.168.1/24;
{ 192.168.2/24; 192.168.3/24; }; }; };
// IF on class C 192.168.1 THEN use .1, or .2 or .3
{ 192.168.1/24;
{ 192.168.1/24;
{ 192.168.2/24; 192.168.3/24; }; }; };
// IF on class C 192.168.2 THEN use .2, or .1 or .3
{ 192.168.2/24;
{ 192.168.2/24;
{ 192.168.1/24; 192.168.3/24; }; }; };
// IF on class C 192.168.3 THEN use .3, or .1 or .2
{ 192.168.3/24;
{ 192.168.3/24;
{ 192.168.1/24; 192.168.2/24; }; }; };
// IF .4 or .5 THEN prefer that net
{ { 192.168.4/24; 192.168.5/24; };
};
};
The following example illlustrates reasonable behavior for the local host and hosts on directly connected networks. Responses sent to queries from the local host favor any of the directly connected networks. Responses sent to queries from any other hosts on a directly connected network prefer addresses on that same network. Responses to other queries are not sorted.
sortlist {
{ localhost; localnets; };
{ localnets; };
};
8.2.16.11. RRset Ordering
Note
While alternating the order of records in a DNS response between subsequent queries is a known load distribution technique, certain caveats apply (mostly stemming from caching) which usually make it a suboptimal choice for load balancing purposes when used on its own.
- rrset-order
Grammar:
rrset-order { [ class <string> ] [ type <string> ] [ name <quoted_string> ] <string> <string>; ... };
Blocks: options, view
Tags: query
Defines the order in which equal RRs (RRsets) are returned.
The
rrset-order
statement permits configuration of the ordering of the records in a multiple-record response. See also:sortlist
.Each rule in an
rrset-order
statement is defined as follows:[class <class_name>] [type <type_name>] [name "<domain_name>"] order <ordering>
The default qualifiers for each rule are:
If no
class
is specified, the default isANY
.If no
type
is specified, the default isANY
.If no
name
is specified, the default is*
(asterisk).
<domain_name> only matches the name itself, not any of its subdomains. To make a rule match all subdomains of a given name, a wildcard name (
*.<domain_name>
) must be used. Note that*.<domain_name>
does not match<domain_name>
itself; to specify RRset ordering for a name and all of its subdomains, two separate rules must be defined: one for<domain_name>
and one for*.<domain_name>
.The legal values for
<ordering>
are:fixed
Records are returned in the order they are defined in the zone file.
This value is deprecated and will be removed in a future release.
Note
The
fixed
option is only available if BIND is configured with--enable-fixed-rrset
at compile time.random
Records are returned in a random order.
cyclic
Records are returned in a cyclic round-robin order, rotating by one record per query.
none
Records are returned in the order they were retrieved from the database. This order is indeterminate, but remains consistent as long as the database is not modified.
The default RRset order used depends on whether any
rrset-order
statements are present in the configuration file used bynamed
:If no
rrset-order
statement is present in the configuration file, the implicit default is to return all records inrandom
order.If any
rrset-order
statements are present in the configuration file, but no ordering rule specified in these statements matches a given RRset, the default order for that RRset isnone
.
Note that if multiple
rrset-order
statements are present in the configuration file (at both theoptions
andview
levels), they are not combined; instead, the more-specific one (view
) replaces the less-specific one (options
).If multiple rules within a single
rrset-order
statement match a given RRset, the first matching rule is applied.Example:
rrset-order { type A name "foo.isc.org" order random; type AAAA name "foo.isc.org" order cyclic; name "bar.isc.org" order fixed; name "*.bar.isc.org" order random; name "*.baz.isc.org" order cyclic; };
With the above configuration, the following RRset ordering is used:
QNAME
QTYPE
RRset Order
foo.isc.org
A
random
foo.isc.org
AAAA
cyclic
foo.isc.org
TXT
none
sub.foo.isc.org
all
none
bar.isc.org
all
fixed
sub.bar.isc.org
all
random
baz.isc.org
all
none
sub.baz.isc.org
all
cyclic
8.2.16.12. Tuning
- lame-ttl
Grammar:
lame-ttl <duration>;
Blocks: options, view
Tags: server
Sets the resolver’s lame cache.
This is always set to 0. More information is available in the security advisory for CVE-2021-25219.
- servfail-ttl
Grammar:
servfail-ttl <duration>;
Blocks: options, view
Tags: server
Sets the length of time (in seconds) that a SERVFAIL response is cached.
This sets the number of seconds to cache a SERVFAIL response due to DNSSEC validation failure or other general server failure. If set to
0
, SERVFAIL caching is disabled. The SERVFAIL cache is not consulted if a query has the CD (Checking Disabled) bit set; this allows a query that failed due to DNSSEC validation to be retried without waiting for the SERVFAIL TTL to expire.The maximum value is
30
seconds; any higher value is silently reduced. The default is1
second.
- min-ncache-ttl
Grammar:
min-ncache-ttl <duration>;
Blocks: options, view
Tags: server
Specifies the minimum retention time (in seconds) for storage of negative answers in the server’s cache.
To reduce network traffic and increase performance, the server stores negative answers.
min-ncache-ttl
is used to set a minimum retention time for these answers in the server, in seconds. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.The default
min-ncache-ttl
is0
seconds.min-ncache-ttl
cannot exceed 90 seconds and is truncated to 90 seconds if set to a greater value.
- min-cache-ttl
Grammar:
min-cache-ttl <duration>;
Blocks: options, view
Tags: server
Specifies the minimum time (in seconds) that the server caches ordinary (positive) answers.
This sets the minimum time for which the server caches ordinary (positive) answers, in seconds. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.
The default
min-cache-ttl
is0
seconds.min-cache-ttl
cannot exceed 90 seconds and is truncated to 90 seconds if set to a greater value.
- max-ncache-ttl
Grammar:
max-ncache-ttl <duration>;
Blocks: options, view
Tags: server
Specifies the maximum retention time (in seconds) for storage of negative answers in the server’s cache.
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. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.The default
max-ncache-ttl
is 10800 seconds (3 hours).max-ncache-ttl
cannot exceed 7 days and is silently truncated to 7 days if set to a greater value.
- max-cache-ttl
Grammar:
max-cache-ttl <duration>;
Blocks: options, view
Tags: server
Specifies the maximum time (in seconds) that the server caches ordinary (positive) answers.
This sets the maximum time for which the server caches ordinary (positive) answers, in seconds. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats.
The default
max-cache-ttl
is 604800 (one week). A value of zero may cause all queries to return SERVFAIL, because of lost caches of intermediate RRsets (such as NS and glue AAAA/A records) in the resolution process.
- max-stale-ttl
Grammar:
max-stale-ttl <duration>;
Blocks: options, view
Tags: server
Specifies the maximum time that the server retains records past their normal expiry, to return them as stale records.
If retaining stale RRsets in cache is enabled, and returning of stale cached answers is also enabled,
max-stale-ttl
sets the maximum time for which the server retains records past their normal expiry to return them as stale records, when the servers for those records are not reachable. The default is 1 day. The minimum allowed is 1 second; a value of 0 is updated silently to 1 second.For stale answers to be returned, the retaining of them in cache must be enabled via the configuration option
stale-cache-enable
, and returning cached answers must be enabled, either in the configuration file using thestale-answer-enable
option or by callingrndc serve-stale on
.When
stale-cache-enable
is set tono
, setting themax-stale-ttl
has no effect, the value ofmax-cache-ttl
will be0
in such case.
- sig-validity-interval
Grammar:
sig-validity-interval <integer> [ <integer> ]; // obsolete
Blocks: options, view, zone (primary, secondary)
Tags: obsolete
This option no longer has any effect.
- dnskey-sig-validity
Grammar:
dnskey-sig-validity <integer>; // obsolete
Blocks: options, view, zone (primary, secondary)
Tags: obsolete
This option no longer has any effect.
- sig-signing-nodes
Grammar:
sig-signing-nodes <integer>;
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Specifies the maximum number of nodes to be examined in each quantum, when signing a zone with a new DNSKEY.
This specifies the maximum number of nodes to be examined in each quantum, when signing a zone with a new DNSKEY. The default is
100
.
- sig-signing-signatures
Grammar:
sig-signing-signatures <integer>;
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Specifies the threshold for the number of signatures that terminates processing a quantum, when signing a zone with a new DNSKEY.
This specifies a threshold number of signatures that terminates processing a quantum, when signing a zone with a new DNSKEY. The default is
10
.
- sig-signing-type
Grammar:
sig-signing-type <integer>;
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Specifies a private RDATA type to use when generating signing-state records.
This specifies a private RDATA type to be used when generating signing-state records. The default is
65534
.This parameter may be removed in a future version, once there is a standard type.
Signing-state records are used internally by
named
to track the current state of a zone-signing process, i.e., whether it is still active or has been completed. The records can be inspected using the commandrndc signing -list zone
. Oncenamed
has finished signing a zone with a particular key, the signing-state record associated with that key can be removed from the zone by runningrndc signing -clear keyid/algorithm zone
. To clear all of the completed signing-state records for a zone, userndc signing -clear all zone
.
- min-refresh-time
Grammar:
min-refresh-time <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Limits the zone refresh interval to no more often than the specified value, in seconds.
This option controls the server’s behavior on refreshing a zone (querying for SOA changes). Usually, the SOA refresh values for the zone are used; however, these values are set by the primary, giving secondary server administrators little control over their contents.
This option allows the administrator to set a minimum refresh time in seconds per-zone, per-view, or globally. This option is valid for secondary and stub zones, and clamps the SOA refresh time to the specified value.
The default is 300 seconds.
- max-refresh-time
Grammar:
max-refresh-time <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Limits the zone refresh interval to no less often than the specified value, in seconds.
This option controls the server’s behavior on refreshing a zone (querying for SOA changes). Usually, the SOA refresh values for the zone are used; however, these values are set by the primary, giving secondary server administrators little control over their contents.
This option allows the administrator to set a maximum refresh time in seconds per-zone, per-view, or globally. This option is valid for secondary and stub zones, and clamps the SOA refresh time to the specified value.
The default is 2419200 seconds (4 weeks).
- min-retry-time
Grammar:
min-retry-time <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Limits the zone refresh retry interval to no more often than the specified value, in seconds.
This option controls the server’s behavior on retrying failed zone transfers. Usually, the SOA retry values for the zone are used; however, these values are set by the primary, giving secondary server administrators little control over their contents.
This option allows the administrator to set a minimum retry time in seconds per-zone, per-view, or globally. This option is valid for secondary and stub zones, and clamps the SOA retry time to the specified value.
The default is 500 seconds.
- max-retry-time
Grammar:
max-retry-time <integer>;
Blocks: options, view, zone (mirror, secondary, stub)
Tags: transfer
Limits the zone refresh retry interval to no less often than the specified value, in seconds.
This option controls the server’s behavior on retrying failed zone transfers. Usually, the SOA retry values for the zone are used; however, these values are set by the primary, giving secondary server administrators little control over their contents.
This option allows the administrator to set a maximum retry time in seconds per-zone, per-view, or globally. This option is valid for secondary and stub zones, and clamps the SOA retry time to the specified value.
The default is 1209600 seconds (2 weeks).
- edns-udp-size
Grammar:
edns-udp-size <integer>;
Blocks: options, server, view, view.server
Tags: query
Sets the maximum advertised EDNS UDP buffer size to control the size of packets received from authoritative servers in response to recursive queries.
This sets the maximum advertised EDNS UDP buffer size, in bytes, to control the size of packets received from authoritative servers in response to recursive queries. Valid values are 512 to 4096; values outside this range are silently adjusted to the nearest value within it. The default value is 1232.
The usual reason for setting
edns-udp-size
to a non-default value is to get UDP answers to pass through broken firewalls that block fragmented packets and/or block UDP DNS packets that are greater than 512 bytes.When
named
first queries a remote server, it advertises a UDP buffer size of 1232.Query timeouts observed for any given server affect the buffer size advertised in queries sent to that server. Depending on observed packet dropping patterns, the query is retried over TCP. Per-server EDNS statistics are only retained in memory for the lifetime of a given server’s ADB entry.
According to measurements taken by multiple parties, the default value should not be causing the fragmentation. As most of the Internet “core” is able to cope with IP message sizes between 1400-1500 bytes, the 1232 size was chosen as a conservative minimal number that could be changed by the DNS operator to a estimated path MTU, minus the estimated header space. In practice, the smallest MTU witnessed in the operational DNS community is 1500 octets, the Ethernet maximum payload size, so a useful default for the maximum DNS/UDP payload size on reliable networks would be 1432.
Any server-specific
edns-udp-size
setting has precedence over all the above rules, i.e. configures a static value for a givenserver
block.
- max-udp-size
Grammar:
max-udp-size <integer>;
Blocks: options, server, view, view.server
Tags: query
Sets the maximum EDNS UDP message size sent by
named
.This sets the maximum EDNS UDP message size that
named
sends, in bytes. Valid values are 512 to 4096; values outside this range are silently adjusted to the nearest value within it. The default value is 1232.This value applies to responses sent by a server; to set the advertised buffer size in queries, see
edns-udp-size
.The usual reason for setting
max-udp-size
to a non-default value is to allow UDP answers to pass through broken firewalls that block fragmented packets and/or block UDP packets that are greater than 512 bytes. This is independent of the advertised receive buffer (edns-udp-size
).Setting this to a low value encourages additional TCP traffic to the name server.
- masterfile-format
Grammar:
masterfile-format ( raw | text );
Blocks: options, view, zone (mirror, primary, redirect, secondary, stub)
Tags: zone, server
Specifies the file format of zone files.
This specifies the file format of zone files (see Additional File Formats for details). The default value is
text
, which is the standard textual representation, except for secondary zones, in which the default value israw
. Files in formats other thantext
are typically expected to be generated by thenamed-compilezone
tool, or dumped bynamed
.Note that when a zone file in a format other than
text
is loaded,named
may omit some of the checks which are performed for a file intext
format. For example,check-names
only applies when loading zones intext
format. Zone files inraw
format should be generated with the same check level as that specified in thenamed
configuration file.When configured in
options
, this statement sets themasterfile-format
for all zones, but it can be overridden on a per-zone or per-view basis by including amasterfile-format
statement within thezone
orview
block in the configuration file.
- masterfile-style
Grammar:
masterfile-style ( full | relative );
Blocks: options, view, zone (mirror, primary, redirect, secondary, stub)
Tags: server
Specifies the format of zone files during a dump, when the
masterfile-format
istext
.This specifies the formatting of zone files during dump, when the
masterfile-format
istext
. This option is ignored with any othermasterfile-format
.When set to
relative
, records are printed in a multi-line format, with owner names expressed relative to a shared origin. When set tofull
, records are printed in a single-line format with absolute owner names. Thefull
format is most suitable when a zone file needs to be processed automatically by a script. Therelative
format is more human-readable, and is thus suitable when a zone is to be edited by hand. The default isrelative
.
- max-recursion-depth
Grammar:
max-recursion-depth <integer>;
Blocks: options, view
Tags: server
Sets the maximum number of levels of recursion permitted at any one time while servicing a recursive query.
This sets the maximum number of levels of recursion that are permitted at any one time while servicing a recursive query. Resolving a name may require looking up a name server address, which in turn requires resolving another name, etc.; if the number of recursions exceeds this value, the recursive query is terminated and returns SERVFAIL. The default is 7.
- max-recursion-queries
Grammar:
max-recursion-queries <integer>;
Blocks: options, view
Tags: server, query
Sets the maximum number of iterative queries while servicing a recursive query.
This sets the maximum number of iterative queries that may be sent by a resolver while looking up a single name. If more queries than this need to be sent before an answer is reached, then recursion is terminated and a SERVFAIL response is returned to the client. (Note: if the answer is a CNAME, then the subsequent lookup for the target of the CNAME is counted separately.) The default is 32.
- max-query-restarts
Grammar:
max-query-restarts <integer>;
Blocks: options, view
Tags: server, query
Sets the maximum number of chained CNAMEs to follow
This sets the maximum number of successive CNAME targets to follow when resolving a client query, before terminating the query to avoid a CNAME loop. Valid values are 1 to 255. The default is 11.
- notify-delay
Grammar:
notify-delay <integer>;
Blocks: options, view, zone (mirror, primary, secondary)
Tags: transfer, zone
Sets the delay (in seconds) between sending sets of NOTIFY messages for a zone.
This sets the delay, in seconds, between sending sets of NOTIFY messages for a zone. Whenever a NOTIFY message is sent for a zone, a timer will be set for this duration. If the zone is updated again before the timer expires, the NOTIFY for that update will be postponed. The default is 5 seconds.
The overall rate at which NOTIFY messages are sent for all zones is controlled by
notify-rate
.
- max-rsa-exponent-size
Grammar:
max-rsa-exponent-size <integer>;
Blocks: options
Tags: dnssec, query
Sets the maximum RSA exponent size (in bits) when validating.
This sets the maximum RSA exponent size, in bits, that is accepted when validating. Valid values are 35 to 4096 bits. The default, zero, is also accepted and is equivalent to 4096.
- prefetch
Grammar:
prefetch <integer> [ <integer> ];
Blocks: options, view
Tags: query
Specifies the “trigger” time-to-live (TTL) value at which prefetch of the current query takes place.
When a query is received for cached data which is to expire shortly,
named
can refresh the data from the authoritative server immediately, ensuring that the cache always has an answer available.prefetch
specifies the “trigger” TTL value at which prefetch of the current query takes place; when a cache record with an equal or lower TTL value is encountered during query processing, it is refreshed. Valid trigger TTL values are 1 to 10 seconds. Values larger than 10 seconds are silently reduced to 10. Setting a trigger TTL to zero causes prefetch to be disabled. The default trigger TTL is2
.An optional second argument specifies the “eligibility” TTL: the smallest original TTL value that is accepted for a record to be eligible for prefetching. The eligibility TTL must be at least six seconds longer than the trigger TTL; if not,
named
silently adjusts it upward. The default eligibility TTL is9
.
- v6-bias
Grammar:
v6-bias <integer>;
Blocks: options, view
Tags: server, query
Indicates the number of milliseconds of preference to give to IPv6 name servers.
When determining the next name server to try, this indicates by how many milliseconds to prefer IPv6 name servers. The default is
50
milliseconds.
- tcp-receive-buffer
Grammar:
tcp-receive-buffer <integer>;
Blocks: options
Tags: server
Sets the operating system’s receive buffer size for TCP sockets.
- udp-receive-buffer
Grammar:
udp-receive-buffer <integer>;
Blocks: options
Tags: server
Sets the operating system’s receive buffer size for UDP sockets.
These options control the operating system’s receive buffer sizes (
SO_RCVBUF
) for TCP and UDP sockets, respectively. Buffering at the operating system level can prevent packet drops during brief load spikes, but if the buffer size is set too high, a running server could get clogged with outstanding queries that have already timed out. The default is0
, which means the operating system’s default value should be used. The minimum configurable value is4096
; any nonzero value lower than that is silently raised. The maximum value is determined by the kernel, and values exceeding the maximum are silently reduced.
- tcp-send-buffer
Grammar:
tcp-send-buffer <integer>;
Blocks: options
Tags: server
Sets the operating system’s send buffer size for TCP sockets.
- udp-send-buffer
Grammar:
udp-send-buffer <integer>;
Blocks: options
Tags: server
Sets the operating system’s send buffer size for UDP sockets.
These options control the operating system’s send buffer sizes (
SO_SNDBUF
) for TCP and UDP sockets, respectively. Buffering at the operating system level can prevent packet drops during brief load spikes, but if the buffer size is set too high, a running server could get clogged with outstanding queries that have already timed out. The default is0
, which means the operating system’s default value should be used. The minimum configurable value is4096
; any nonzero value lower than that is silently raised. The maximum value is determined by the kernel, and values exceeding the maximum are silently reduced.
8.2.16.13. Built-in Server Information Zones
The server provides some helpful diagnostic information through a number
of built-in zones under the pseudo-top-level-domain bind
in the
CHAOS
class. These zones are part of a built-in view
(see view
) of class CHAOS
, which is
separate from the default view of class IN
. Most global
configuration options (allow-query
, etc.) apply to this view,
but some are locally overridden: notify
, recursion
, and
allow-new-zones
are always set to no
, and rate-limit
is set
to allow three responses per second.
To disable these zones, use the options below or hide the
built-in CHAOS
view by defining an explicit view of class CHAOS
that matches all clients.
- version
Grammar:
version ( <quoted_string> | none );
Blocks: options
Tags: server
Specifies the version number of the server to return in response to a
version.bind
query.This is the version the server should report via a query of the name
version.bind
with typeTXT
and classCHAOS
. The default is the real version number of this server. Specifyingversion none
disables processing of the queries.Setting
version
to any value (includingnone
) also disables queries forauthors.bind TXT CH
.
- hostname
Grammar:
hostname ( <quoted_string> | none );
Blocks: options
Tags: server
Specifies the hostname of the server to return in response to a
hostname.bind
query.This is the hostname the server should report via a query of the name
hostname.bind
with typeTXT
and classCHAOS
. This defaults to the hostname of the machine hosting the name server, as found by thegethostname()
function. The primary purpose of such queries is to identify which of a group of anycast servers is actually answering the queries. Specifyinghostname none;
disables processing of the queries.
- server-id
Grammar:
server-id ( <quoted_string> | none | hostname );
Blocks: options
Tags: server
Specifies the ID of the server to return in response to a
ID.SERVER
query.This is the ID the server should report when receiving a Name Server Identifier (NSID) query, or a query of the name
ID.SERVER
with typeTXT
and classCHAOS
. The primary purpose of such queries is to identify which of a group of anycast servers is actually answering the queries. Specifyingserver-id none;
disables processing of the queries. Specifyingserver-id hostname;
causesnamed
to use the hostname as found by thegethostname()
function. The defaultserver-id
isnone
.
8.2.16.14. Built-in Empty Zones
The named
server has some built-in empty zones, for SOA and NS records
only. These are for zones that should normally be answered locally and for
which queries should not be sent to the Internet’s root servers. The
official servers that cover these namespaces return NXDOMAIN responses
to these queries. In particular, these cover the reverse namespaces for
addresses from RFC 1918, RFC 4193, RFC 5737, and RFC 6598. They also
include the reverse namespace for the IPv6 local address (locally assigned),
IPv6 link local addresses, the IPv6 loopback address, and the IPv6
unknown address.
The server attempts to determine if a built-in zone already exists or is active (covered by a forward-only forwarding declaration) and does not create an empty zone if either is true.
The current list of empty zones is:
10.IN-ADDR.ARPA
16.172.IN-ADDR.ARPA
17.172.IN-ADDR.ARPA
18.172.IN-ADDR.ARPA
19.172.IN-ADDR.ARPA
20.172.IN-ADDR.ARPA
21.172.IN-ADDR.ARPA
22.172.IN-ADDR.ARPA
23.172.IN-ADDR.ARPA
24.172.IN-ADDR.ARPA
25.172.IN-ADDR.ARPA
26.172.IN-ADDR.ARPA
27.172.IN-ADDR.ARPA
28.172.IN-ADDR.ARPA
29.172.IN-ADDR.ARPA
30.172.IN-ADDR.ARPA
31.172.IN-ADDR.ARPA
168.192.IN-ADDR.ARPA
64.100.IN-ADDR.ARPA
65.100.IN-ADDR.ARPA
66.100.IN-ADDR.ARPA
67.100.IN-ADDR.ARPA
68.100.IN-ADDR.ARPA
69.100.IN-ADDR.ARPA
70.100.IN-ADDR.ARPA
71.100.IN-ADDR.ARPA
72.100.IN-ADDR.ARPA
73.100.IN-ADDR.ARPA
74.100.IN-ADDR.ARPA
75.100.IN-ADDR.ARPA
76.100.IN-ADDR.ARPA
77.100.IN-ADDR.ARPA
78.100.IN-ADDR.ARPA
79.100.IN-ADDR.ARPA
80.100.IN-ADDR.ARPA
81.100.IN-ADDR.ARPA
82.100.IN-ADDR.ARPA
83.100.IN-ADDR.ARPA
84.100.IN-ADDR.ARPA
85.100.IN-ADDR.ARPA
86.100.IN-ADDR.ARPA
87.100.IN-ADDR.ARPA
88.100.IN-ADDR.ARPA
89.100.IN-ADDR.ARPA
90.100.IN-ADDR.ARPA
91.100.IN-ADDR.ARPA
92.100.IN-ADDR.ARPA
93.100.IN-ADDR.ARPA
94.100.IN-ADDR.ARPA
95.100.IN-ADDR.ARPA
96.100.IN-ADDR.ARPA
97.100.IN-ADDR.ARPA
98.100.IN-ADDR.ARPA
99.100.IN-ADDR.ARPA
100.100.IN-ADDR.ARPA
101.100.IN-ADDR.ARPA
102.100.IN-ADDR.ARPA
103.100.IN-ADDR.ARPA
104.100.IN-ADDR.ARPA
105.100.IN-ADDR.ARPA
106.100.IN-ADDR.ARPA
107.100.IN-ADDR.ARPA
108.100.IN-ADDR.ARPA
109.100.IN-ADDR.ARPA
110.100.IN-ADDR.ARPA
111.100.IN-ADDR.ARPA
112.100.IN-ADDR.ARPA
113.100.IN-ADDR.ARPA
114.100.IN-ADDR.ARPA
115.100.IN-ADDR.ARPA
116.100.IN-ADDR.ARPA
117.100.IN-ADDR.ARPA
118.100.IN-ADDR.ARPA
119.100.IN-ADDR.ARPA
120.100.IN-ADDR.ARPA
121.100.IN-ADDR.ARPA
122.100.IN-ADDR.ARPA
123.100.IN-ADDR.ARPA
124.100.IN-ADDR.ARPA
125.100.IN-ADDR.ARPA
126.100.IN-ADDR.ARPA
127.100.IN-ADDR.ARPA
0.IN-ADDR.ARPA
127.IN-ADDR.ARPA
254.169.IN-ADDR.ARPA
2.0.192.IN-ADDR.ARPA
100.51.198.IN-ADDR.ARPA
113.0.203.IN-ADDR.ARPA
255.255.255.255.IN-ADDR.ARPA
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.0.IP6.ARPA
1.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.ARPA
8.B.D.0.1.0.0.2.IP6.ARPA
D.F.IP6.ARPA
8.E.F.IP6.ARPA
9.E.F.IP6.ARPA
A.E.F.IP6.ARPA
B.E.F.IP6.ARPA
EMPTY.AS112.ARPA
HOME.ARPA
RESOLVER.ARPA
Empty zones can be set at the view level and only apply to views of class IN. Disabled empty zones are only inherited from options if there are no disabled empty zones specified at the view level. To override the options list of disabled zones, disable the root zone at the view level. For example:
disable-empty-zone ".";
If using the address ranges covered here, reverse zones covering the addresses should already be in place. In practice this appears to not be the case, with many queries being made to the infrastructure servers for names in these spaces. So many, in fact, that sacrificial servers had to be deployed to channel the query load away from the infrastructure servers.
Note
The real parent servers for these zones should disable all empty zones under the parent zone they serve. For the real root servers, this is all built-in empty zones. This enables them to return referrals to deeper in the tree.
- empty-server
Grammar:
empty-server <string>;
Blocks: options, view
Tags: server, zone
Specifies the server name in the returned SOA record for empty zones.
This specifies the server name that appears in the returned SOA record for empty zones. If none is specified, the zone’s name is used.
- empty-contact
Grammar:
empty-contact <string>;
Blocks: options, view
Tags: server, zone
Specifies the contact name in the returned SOA record for empty zones.
This specifies the contact name that appears in the returned SOA record for empty zones. If none is specified, “.” is used.
- empty-zones-enable
Grammar:
empty-zones-enable <boolean>;
Blocks: options, view
Tags: server, zone
Enables or disables all empty zones.
This enables or disables all empty zones. By default, they are enabled.
- disable-empty-zone
Grammar:
disable-empty-zone <string>; // may occur multiple times
Blocks: options, view
Tags: server, zone
Disables individual empty zones.
This disables individual empty zones. By default, none are disabled. This option can be specified multiple times.
8.2.16.15. Content Filtering
- deny-answer-addresses
Grammar:
deny-answer-addresses { <address_match_element>; ... } [ except-from { <string>; ... } ];
Blocks: options, view
Tags: query
Rejects A or AAAA records if the corresponding IPv4 or IPv6 addresses match a given
address_match_list
.BIND 9 provides the ability to filter out responses from external DNS servers containing certain types of data in the answer section. Specifically, it can reject address (A or AAAA) records if the corresponding IPv4 or IPv6 addresses match the given address_match_list of the
deny-answer-addresses
option.In the address_match_list of the
deny-answer-addresses
option, only ip_address and netprefix are meaningful; any server_key is silently ignored.
- deny-answer-aliases
Grammar:
deny-answer-aliases { <string>; ... } [ except-from { <string>; ... } ];
Blocks: options, view
Tags: query
Rejects CNAME or DNAME records if the “alias” name matches a given list of
domain_name
elements.It can also reject CNAME or DNAME records if the “alias” name (i.e., the CNAME alias or the substituted query name due to DNAME) matches the given list of domain_name elements of the
deny-answer-aliases
option, where “match” means the alias name is a subdomain of one of the listed domain names. If the optional list is specified in theexcept-from
argument, records whose query name matches the list are accepted regardless of the filter setting. Likewise, if the alias name is a subdomain of the corresponding zone, thedeny-answer-aliases
filter does not apply; for example, even if “example.com” is specified fordeny-answer-aliases
,www.example.com. CNAME xxx.example.com.
returned by an “example.com” server is accepted.
If a response message is rejected due to the filtering, the entire message is discarded without being cached, and a SERVFAIL error is returned to the client.
This filtering is intended to prevent “DNS rebinding attacks,” in which an attacker, in response to a query for a domain name the attacker controls, returns an IP address within the user’s own network or an alias name within the user’s own domain. A naive web browser or script could then serve as an unintended proxy, allowing the attacker to get access to an internal node of the local network that could not be externally accessed otherwise. See the paper available at https://dl.acm.org/doi/10.1145/1315245.1315298 for more details about these attacks.
For example, with a domain named “example.net” and an internal network using an IPv4 prefix 192.0.2.0/24, an administrator might specify the following rules:
deny-answer-addresses { 192.0.2.0/24; } except-from { "example.net"; };
deny-answer-aliases { "example.net"; };
If an external attacker let a web browser in the local network look up an IPv4 address of “attacker.example.com”, the attacker’s DNS server would return a response like this:
attacker.example.com. A 192.0.2.1
in the answer section. Since the rdata of this record (the IPv4 address) matches the specified prefix 192.0.2.0/24, this response would be ignored.
On the other hand, if the browser looked up a legitimate internal web server “www.example.net” and the following response were returned to the BIND 9 server:
www.example.net. A 192.0.2.2
it would be accepted, since the owner name “www.example.net” matches the
except-from
element, “example.net”.
Note that this is not really an attack on the DNS per se. In fact, there is nothing wrong with having an “external” name mapped to an “internal” IP address or domain name from the DNS point of view; it might actually be provided for a legitimate purpose, such as for debugging. As long as the mapping is provided by the correct owner, it either is not possible or does not make sense to detect whether the intent of the mapping is legitimate within the DNS. The “rebinding” attack must primarily be protected at the application that uses the DNS. For a large site, however, it may be difficult to protect all possible applications at once. This filtering feature is provided only to help such an operational environment; turning it on is generally discouraged unless there is no other choice and the attack is a real threat to applications.
Care should be particularly taken if using this option for addresses within 127.0.0.0/8. These addresses are obviously “internal,” but many applications conventionally rely on a DNS mapping from some name to such an address. Filtering out DNS records containing this address spuriously can break such applications.
8.2.16.16. Response Policy Zone (RPZ) Rewriting
BIND 9 includes a limited mechanism to modify DNS responses for requests analogous to email anti-spam DNS rejection lists. Responses can be changed to deny the existence of domains (NXDOMAIN), deny the existence of IP addresses for domains (NODATA), or contain other IP addresses or data.
- response-policy
Grammar:
response-policy { zone <string> [ add-soa <boolean> ] [ log <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ policy ( cname | disabled | drop | given | no-op | nodata | nxdomain | passthru | tcp-only <quoted_string> ) ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ ede <string> ]; ... } [ add-soa <boolean> ] [ break-dnssec <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ min-ns-dots <integer> ] [ nsip-wait-recurse <boolean> ] [ nsdname-wait-recurse <boolean> ] [ qname-wait-recurse <boolean> ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ dnsrps-enable <boolean> ] [ dnsrps-options { <unspecified-text> } ];
Blocks: options, view
Tags: server, query, zone, security
Specifies response policy zones for the view or among global options.
Response policy zones are named in the
response-policy
option for the view, or among the global options if there is noresponse-policy
option for the view. Response policy zones are ordinary DNS zones containing RRsets that can be queried normally if allowed. It is usually best to restrict those queries with something likeallow-query { localhost; };
.A
response-policy
option can support multiple policy zones. To maximize performance, a radix tree is used to quickly identify response policy zones containing triggers that match the current query. This imposes an upper limit of 64 on the number of policy zones in a singleresponse-policy
option; more than that is a configuration error.
Rules encoded in response policy zones are processed after those defined in Access Control. All queries from clients which are not permitted access to the resolver are answered with a status code of REFUSED, regardless of configured RPZ rules.
Five policy triggers can be encoded in RPZ records.
RPZ-CLIENT-IP
IP records are triggered by the IP address of the DNS client. Client IP address triggers are encoded in records that have owner names that are subdomains of
rpz-client-ip
, relativized to the policy zone origin name, and that encode an address or address block. IPv4 addresses are represented asprefixlength.B4.B3.B2.B1.rpz-client-ip
. The IPv4 prefix length must be between 1 and 32. All four bytes - B4, B3, B2, and B1 - must be present. B4 is the decimal value of the least significant byte of the IPv4 address as in IN-ADDR.ARPA.IPv6 addresses are encoded in a format similar to the standard IPv6 text representation,
prefixlength.W8.W7.W6.W5.W4.W3.W2.W1.rpz-client-ip
. Each of W8,…,W1 is a one- to four-digit hexadecimal number representing 16 bits of the IPv6 address as in the standard text representation of IPv6 addresses, but reversed as in IP6.ARPA. (Note that this representation of IPv6 addresses is different from IP6.ARPA, where each hex digit occupies a label.) All 8 words must be present except when one set of consecutive zero words is replaced with.zz.
, analogous to double colons (::) in standard IPv6 text encodings. The IPv6 prefix length must be between 1 and 128.QNAME
QNAME policy records are triggered by query names of requests and targets of CNAME records resolved to generate the response. The owner name of a QNAME policy record is the query name relativized to the policy zone.
RPZ-IP
IP triggers are IP addresses in an A or AAAA record in the ANSWER section of a response. They are encoded like client-IP triggers, except as subdomains of
rpz-ip
.RPZ-NSDNAME
NSDNAME triggers match names of authoritative servers for the query name, a parent of the query name, a CNAME for the query name, or a parent of a CNAME. They are encoded as subdomains of
rpz-nsdname
, relativized to the RPZ origin name. NSIP triggers match IP addresses in A and AAAA RRsets for domains that can be checked against NSDNAME policy records. Thensdname-enable
phrase turns NSDNAME triggers off or on for a single policy zone or for all zones.If authoritative name servers for the query name are not yet known,
named
recursively looks up the authoritative servers for the query name before applying an RPZ-NSDNAME rule, which can cause a processing delay. To speed up processing at the cost of precision, thensdname-wait-recurse
option can be used; when set tono
, RPZ-NSDNAME rules are only applied when authoritative servers for the query name have already been looked up and cached. If authoritative servers for the query name are not in the cache, the RPZ-NSDNAME rule is ignored, but the authoritative servers for the query name are looked up in the background and the rule is applied to subsequent queries. The default isyes
, meaning RPZ-NSDNAME rules are always applied, even if authoritative servers for the query name need to be looked up first.RPZ-NSIP
NSIP triggers match the IP addresses of authoritative servers. They are encoded like IP triggers, except as subdomains of
rpz-nsip
. NSDNAME and NSIP triggers are checked only for names with at leastmin-ns-dots
dots. The default value ofmin-ns-dots
is 1, to exclude top-level domains. Thensip-enable
phrase turns NSIP triggers off or on for a single policy zone or for all zones.If a name server’s IP address is not yet known,
named
recursively looks up the IP address before applying an RPZ-NSIP rule, which can cause a processing delay. To speed up processing at the cost of precision, thensip-wait-recurse
option can be used; when set tono
, RPZ-NSIP rules are only applied when a name server’s IP address has already been looked up and cached. If a server’s IP address is not in the cache, the RPZ-NSIP rule is ignored, but the address is looked up in the background and the rule is applied to subsequent queries. The default isyes
, meaning RPZ-NSIP rules are always applied, even if an address needs to be looked up first.
The query response is checked against all response policy zones, so two
or more policy records can be triggered by a response. Because DNS
responses are rewritten according to at most one policy record, a single
record encoding an action (other than DISABLED
actions) must be
chosen. Triggers, or the records that encode them, are chosen for
rewriting in the following order:
Choose the triggered record in the zone that appears first in the response-policy option.
Prefer CLIENT-IP to QNAME to IP to NSDNAME to NSIP triggers in a single zone.
Among NSDNAME triggers, prefer the trigger that matches the smallest name under the DNSSEC ordering.
Among IP or NSIP triggers, prefer the trigger with the longest prefix.
Among triggers with the same prefix length, prefer the IP or NSIP trigger that matches the smallest IP address.
When the processing of a response is restarted to resolve DNAME or CNAME records and a policy record set has not been triggered, all response policy zones are again consulted for the DNAME or CNAME names and addresses.
RPZ record sets are any types of DNS record, except DNAME or DNSSEC, that
encode actions or responses to individual queries. Any of the policies
can be used with any of the triggers. For example, while the
TCP-only
policy is commonly used with client-IP
triggers, it can
be used with any type of trigger to force the use of TCP for responses
with owner names in a zone.
PASSTHRU
The auto-acceptance policy is specified by a CNAME whose target is
rpz-passthru
. It causes the response to not be rewritten and is most often used to “poke holes” in policies for CIDR blocks.DROP
The auto-rejection policy is specified by a CNAME whose target is
rpz-drop
. It causes the response to be discarded. Nothing is sent to the DNS client.TCP-Only
The “slip” policy is specified by a CNAME whose target is
rpz-tcp-only
. It changes UDP responses to short, truncated DNS responses that require the DNS client to try again with TCP. It is used to mitigate distributed DNS reflection attacks.NXDOMAIN
The “domain undefined” response is encoded by a CNAME whose target is the root domain (.).
NODATA
The empty set of resource records is specified by a CNAME whose target is the wildcard top-level domain (
*.
). It rewrites the response to NODATA or ANCOUNT=0.Local Data
A set of ordinary DNS records can be used to answer queries. Queries for record types not in the set are answered with NODATA.
A special form of local data is a CNAME whose target is a wildcard such as *.example.com. It is used as if an ordinary CNAME after the asterisk (*) has been replaced with the query name. This special form is useful for query logging in the walled garden’s authoritative DNS server.
All of the actions specified in all of the individual records in a
policy zone can be overridden with a policy
clause in the
response-policy
option. An organization using a policy zone provided
by another organization might use this mechanism to redirect domains to
its own walled garden.
GIVEN
The placeholder policy says “do not override but perform the action specified in the zone.”
DISABLED
The testing override policy causes policy zone records to do nothing but log what they would have done if the policy zone were not disabled. The response to the DNS query is written (or not) according to any triggered policy records that are not disabled. Disabled policy zones should appear first, because they are often not logged if a higher-precedence trigger is found first.
PASSTHRU
;DROP
;TCP-Only
;NXDOMAIN
;NODATA
These settings each override the corresponding per-record policy.
CNAME domain
This causes all RPZ policy records to act as if they were “cname domain” records.
By default, the actions encoded in a response policy zone are applied
only to queries that ask for recursion (RD=1). That default can be
changed for a single policy zone, or for all response policy zones in a view,
with a recursive-only no
clause. This feature is useful for serving
the same zone files both inside and outside an RFC 1918 cloud and using
RPZ to delete answers that would otherwise contain RFC 1918 values on
the externally visible name server or view.
Also by default, RPZ actions are applied only to DNS requests that
either do not request DNSSEC metadata (DO=0) or when no DNSSEC records
are available for the requested name in the original zone (not the response
policy zone). This default can be changed for all response policy zones
in a view with a break-dnssec yes
clause. In that case, RPZ actions
are applied regardless of DNSSEC. The name of the clause option reflects
the fact that results rewritten by RPZ actions cannot verify.
No DNS records are needed for a QNAME or Client-IP trigger; the name or
IP address itself is sufficient, so in principle the query name need not
be recursively resolved. However, not resolving the requested name can
leak the fact that response policy rewriting is in use, and that the name
is listed in a policy zone, to operators of servers for listed names. To
prevent that information leak, by default any recursion needed for a
request is done before any policy triggers are considered. Because
listed domains often have slow authoritative servers, this behavior can
cost significant time. The qname-wait-recurse no
option overrides
the default and enables that behavior when recursion cannot change a
non-error response. The option does not affect QNAME or client-IP
triggers in policy zones listed after other zones containing IP, NSIP,
and NSDNAME triggers, because those may depend on the A, AAAA, and NS
records that would be found during recursive resolution. It also does
not affect DNSSEC requests (DO=1) unless break-dnssec yes
is in use,
because the response would depend on whether RRSIG records were
found during resolution. Using this option can cause error responses
such as SERVFAIL to appear to be rewritten, since no recursion is being
done to discover problems at the authoritative server.
- dnsrps-enable
Grammar:
dnsrps-enable <boolean>; // obsolete
Blocks: options, view
Tags: obsolete
Turns on the DNS Response Policy Service (DNSRPS) interface.
This option no longer has any effect.
- dnsrps-library
Grammar:
dnsrps-library <quoted_string>; // obsolete
Blocks: options
Tags: obsolete
Turns on the DNS Response Policy Service (DNSRPS) interface.
This option no longer has any effect.
- dnsrps-options
Grammar:
dnsrps-options { <unspecified-text> }; // obsolete
Blocks: options, view
Tags: obsolete
Provides additional RPZ configuration settings, which are passed to the DNS Response Policy Service (DNSRPS) provider library.
This option no longer has any effect.
The TTL of a record modified by RPZ policies is set from the TTL of the
relevant record in the policy zone. It is then limited to a maximum value.
The max-policy-ttl
clause changes the maximum number of seconds from its
default of 5. For convenience, TTL-style time-unit suffixes may be used
to specify the value. It also accepts ISO 8601 duration formats.
For example, an administrator might use this option statement:
response-policy { zone "badlist"; };
and this zone statement:
zone "badlist" {type primary; file "primary/badlist"; allow-query {none;}; };
with this zone file:
$TTL 1H
@ SOA LOCALHOST. named-mgr.example.com (1 1h 15m 30d 2h)
NS LOCALHOST.
; QNAME policy records. There are no periods (.) after the owner names.
nxdomain.domain.com CNAME . ; NXDOMAIN policy
*.nxdomain.domain.com CNAME . ; NXDOMAIN policy
nodata.domain.com CNAME *. ; NODATA policy
*.nodata.domain.com CNAME *. ; NODATA policy
bad.domain.com A 10.0.0.1 ; redirect to a walled garden
AAAA 2001:2::1
bzone.domain.com CNAME garden.example.com.
; do not rewrite (PASSTHRU) OK.DOMAIN.COM
ok.domain.com CNAME rpz-passthru.
; redirect x.bzone.domain.com to x.bzone.domain.com.garden.example.com
*.bzone.domain.com CNAME *.garden.example.com.
; IP policy records that rewrite all responses containing A records in 127/8
; except 127.0.0.1
8.0.0.0.127.rpz-ip CNAME .
32.1.0.0.127.rpz-ip CNAME rpz-passthru.
; NSDNAME and NSIP policy records
ns.domain.com.rpz-nsdname CNAME .
48.zz.2.2001.rpz-nsip CNAME .
; auto-reject and auto-accept some DNS clients
112.zz.2001.rpz-client-ip CNAME rpz-drop.
8.0.0.0.127.rpz-client-ip CNAME rpz-drop.
; force some DNS clients and responses in the example.com zone to TCP
16.0.0.1.10.rpz-client-ip CNAME rpz-tcp-only.
example.com CNAME rpz-tcp-only.
*.example.com CNAME rpz-tcp-only.
Response policy zones can be configured to set an Extended DNS Error (EDE) code on the responses which have been modified by the response policy:
response-policy { zone "badlist" ede filtered; };
The following settings are supported for the ede
option:
none
No Extended DNS Error code is set (default).
forged
Extended DNS Error code 4 - Forged Answer.
blocked
Extended DNS Error code 15 - Blocked.
censored
Extended DNS Error code 16 - Censored.
filtered
Extended DNS Error code 17 - Filtered.
prohibited
Extended DNS Error code 18 - Prohibited.
See RFC 8914 for more information about the Extended DNS Error codes.
RPZ can affect server performance. Each configured response policy zone requires the server to perform one to four additional database lookups before a query can be answered. For example, a DNS server with four policy zones, each with all four kinds of response triggers (QNAME, IP, NSIP, and NSDNAME), requires a total of 17 times as many database lookups as a similar DNS server with no response policy zones. A BIND 9 server with adequate memory and one response policy zone with QNAME and IP triggers might achieve a maximum queries-per-second (QPS) rate about 20% lower. A server with four response policy zones with QNAME and IP triggers might have a maximum QPS rate about 50% lower.
Responses rewritten by RPZ are counted in the RPZRewrites
statistics.
The log
clause can be used to optionally turn off rewrite logging
for a particular response policy zone. By default, all rewrites are
logged.
The add-soa
option controls whether the RPZ’s SOA record is added to
the section for traceback of changes from this zone.
This can be set at the individual policy zone level or at the
response-policy level. The default is yes
.
Updates to RPZ zones are processed asynchronously; if there is more than
one update pending they are bundled together. If an update to a RPZ zone
(for example, via IXFR) happens less than min-update-interval
seconds after the most recent update, the changes are not
carried out until this interval has elapsed. The default is 60
seconds. For convenience, TTL-style time-unit suffixes may be used to
specify the value. It also accepts ISO 8601 duration formats.
8.2.16.17. Response Rate Limiting
- rate-limit
Grammar:
rate-limit { all-per-second <integer>; errors-per-second <integer>; exempt-clients { <address_match_element>; ... }; ipv4-prefix-length <integer>; ipv6-prefix-length <integer>; log-only <boolean>; max-table-size <integer>; min-table-size <integer>; nodata-per-second <integer>; nxdomains-per-second <integer>; qps-scale <integer>; referrals-per-second <integer>; responses-per-second <integer>; slip <integer>; window <integer>; };
Blocks: options, view
Tags: query
Controls excessive UDP responses, to prevent BIND 9 from being used to amplify reflection denial-of-service (DoS) attacks.
Excessive, almost-identical UDP responses can be controlled by configuring a
rate-limit
clause in anoptions
orview
statement. This mechanism keeps authoritative BIND 9 from being used to amplify reflection denial-of-service (DoS) attacks. Short BADCOOKIE errors or truncated (TC=1) responses can be sent to provide rate-limited responses to legitimate clients within a range of forged, attacked IP addresses. Legitimate clients react to dropped responses by retrying, to BADCOOKIE errors by including a server cookie when retrying, and to truncated responses by switching to TCP.This mechanism is intended for authoritative DNS servers. It can be used on recursive servers, but can slow applications such as SMTP servers (mail receivers) and HTTP clients (web browsers) that repeatedly request the same domains. When possible, closing “open” recursive servers is better.
Response rate limiting uses a “credit” or “token bucket” scheme. Each combination of identical response and client has a conceptual “account” that earns a specified number of credits every second. A prospective response debits its account by one. Responses are dropped or truncated while the account is negative.
- window
Grammar:
window <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Specifies the length of time during which responses are tracked.
Responses are tracked within a rolling window of time which defaults to 15 seconds, but which can be configured with the
window
option to any value from 1 to 3600 seconds (1 hour). The account cannot become more positive than the per-second limit or more negative thanwindow
times the per-second limit. When the specified number of credits for a class of responses is set to 0, those responses are not rate-limited.
- ipv4-prefix-length
Grammar:
ipv4-prefix-length <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: server
Specifies the prefix lengths of IPv4 address blocks.
- ipv6-prefix-length
Grammar:
ipv6-prefix-length <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: server
Specifies the prefix lengths of IPv6 address blocks.
The notions of “identical response” and “DNS client” for rate limiting are not simplistic. All responses to an address block are counted as if to a single client. The prefix lengths of address blocks are specified with
ipv4-prefix-length
(default 24) andipv6-prefix-length
(default 56).
- responses-per-second
Grammar:
responses-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Limits the number of non-empty responses for a valid domain name and record type.
All non-empty responses for a valid domain name (qname) and record type (qtype) are identical and have a limit specified with
responses-per-second
(default 0 or no limit). All valid wildcard domain names are interpreted as the zone’s origin name concatenated to the “*” name.
- nodata-per-second
Grammar:
nodata-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Limits the number of empty (NODATA) responses for a valid domain name.
All empty (NODATA) responses for a valid domain, regardless of query type, are identical. Responses in the NODATA class are limited by
nodata-per-second
(defaultresponses-per-second
).
- nxdomains-per-second
Grammar:
nxdomains-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Limits the number of undefined subdomains for a valid domain name.
Requests for any and all undefined subdomains of a given valid domain result in NXDOMAIN errors, and are identical regardless of query type. They are limited by
nxdomains-per-second
(defaultresponses-per-second
). This controls some attacks using random names, but can be relaxed or turned off (set to 0) on servers that expect many legitimate NXDOMAIN responses, such as from anti-spam rejection lists.
- referrals-per-second
Grammar:
referrals-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Limits the number of referrals or delegations to a server for a given domain.
Referrals or delegations to the server of a given domain are identical and are limited by
referrals-per-second
(defaultresponses-per-second
).
Responses generated from local wildcards are counted and limited as if they were for the parent domain name. This controls flooding using random.wild.example.com.
All requests that result in DNS errors other than NXDOMAIN, such as SERVFAIL and FORMERR, are identical regardless of requested name (qname) or record type (qtype). This controls attacks using invalid requests or distant, broken authoritative servers.
- errors-per-second
Grammar:
errors-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: server
Limits the number of errors for a valid domain name and record type.
By default the limit on errors is the same as the
responses-per-second
value, but it can be set separately witherrors-per-second
.
- slip
Grammar:
slip <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Sets the number of “slipped” responses to minimize the use of forged source addresses for an attack.
Many attacks using DNS involve UDP requests with forged source addresses. Rate limiting prevents the use of BIND 9 to flood a network with responses to requests with forged source addresses, but could let a third party block responses to legitimate requests. There is a mechanism that can answer some legitimate requests from a client whose address is being forged in a flood. Setting
slip
to 2 (its default) causes every other UDP request without a valid server cookie to be answered with a small response. The small size and reduced frequency, and resulting lack of amplification, of “slipped” responses make them unattractive for reflection DoS attacks.slip
must be between 0 and 10. A value of 0 does not “slip”; no small responses are sent due to rate limiting. Rather, all responses are dropped. A value of 1 causes every response to slip; values between 2 and 10 cause every nth response to slip.If the request included a client cookie, then a “slipped” response is a BADCOOKIE error with a server cookie, which allows a legitimate client to include the server cookie to be exempted from the rate limiting when it retries the request. If the request did not include a cookie, then a “slipped” response is a truncated (TC=1) response, which prompts a legitimate client to switch to TCP and thus be exempted from the rate limiting. Some error responses, including REFUSED and SERVFAIL, cannot be replaced with truncated responses and are instead leaked at the
slip
rate.(Note: dropped responses from an authoritative server may reduce the difficulty of a third party successfully forging a response to a recursive resolver. The best security against forged responses is for authoritative operators to sign their zones using DNSSEC and for resolver operators to validate the responses. When this is not an option, operators who are more concerned with response integrity than with flood mitigation may consider setting
slip
to 1, causing all rate-limited responses to be truncated rather than dropped. This reduces the effectiveness of rate-limiting against reflection attacks.)
- qps-scale
Grammar:
qps-scale <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Tightens defenses during DNS attacks by scaling back the ratio of the current query-per-second rate.
When the approximate query-per-second rate exceeds the
qps-scale
value, theresponses-per-second
,errors-per-second
,nxdomains-per-second
, andall-per-second
values are reduced by the ratio of the current rate to theqps-scale
value. This feature can tighten defenses during attacks. For example, withqps-scale 250; responses-per-second 20;
and a total query rate of 1000 queries/second for all queries from all DNS clients including via TCP, then the effective responses/second limit changes to (250/1000)*20, or 5. Responses to requests that included a valid server cookie, and responses sent via TCP, are not limited but are counted to compute the query-per-second rate.
- exempt-clients
Grammar:
exempt-clients { <address_match_element>; ... };
Blocks: options.rate-limit, view.rate-limit
Tags: query
Exempts specific clients or client groups from rate limiting.
Communities of DNS clients can be given their own parameters or no rate limiting by putting
rate-limit
statements inview
statements instead of in the globaloption
statement. Arate-limit
statement in a view replaces, rather than supplements, arate-limit
statement among the main options.DNS clients within a view can be exempted from rate limits with the
exempt-clients
clause.
- all-per-second
Grammar:
all-per-second <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Limits UDP responses of all kinds.
UDP responses of all kinds can be limited with the
all-per-second
phrase. This rate limiting is unlike the rate limiting provided byresponses-per-second
,errors-per-second
, andnxdomains-per-second
on a DNS server, which are often invisible to the victim of a DNS reflection attack. Unless the forged requests of the attack are the same as the legitimate requests of the victim, the victim’s requests are not affected. Responses affected by anall-per-second
limit are always dropped; theslip
value has no effect. Anall-per-second
limit should be at least 4 times as large as the other limits, because single DNS clients often send bursts of legitimate requests. For example, the receipt of a single mail message can prompt requests from an SMTP server for NS, PTR, A, and AAAA records as the incoming SMTP/TCP/IP connection is considered. The SMTP server can need additional NS, A, AAAA, MX, TXT, and SPF records as it considers the SMTPMail From
command. Web browsers often repeatedly resolve the same names that are duplicated in HTML <IMG> tags in a page.all-per-second
is similar to the rate limiting offered by firewalls but is often inferior. Attacks that justify ignoring the contents of DNS responses are likely to be attacks on the DNS server itself. They usually should be discarded before the DNS server spends resources making TCP connections or parsing DNS requests, but that rate limiting must be done before the DNS server sees the requests.
- max-table-size
Grammar:
max-table-size <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: server
Sets the maximum size of the table used to track requests and rate-limit responses.
- min-table-size
Grammar:
min-table-size <integer>;
Blocks: options.rate-limit, view.rate-limit
Tags: query
Sets the minimum size of the table used to track requests and rate-limit responses.
The maximum size of the table used to track requests and rate-limit responses is set with
max-table-size
. Each entry in the table is between 40 and 80 bytes. The table needs approximately as many entries as the number of requests received per second. The default is 20,000. To reduce the cold start of growing the table,min-table-size
(default 500) can set the minimum table size. Enablerate-limit
category logging to monitor expansions of the table and inform choices for the initial and maximum table size.
- log-only
Grammar:
log-only <boolean>;
Blocks: options.rate-limit, view.rate-limit
Tags: logging, query
Tests rate-limiting parameters without actually dropping any requests.
Use
log-only yes
to test rate-limiting parameters without actually dropping any requests.
Responses dropped by rate limits are included in the
RateDropped
andQryDropped
statistics. Responses that are truncated by rate limits are included inRateSlipped
andRespTruncated
.
8.2.16.18. NXDOMAIN Redirection
named
supports NXDOMAIN redirection via two methods:
Redirect namespace
With either method, when named
gets an NXDOMAIN response it examines a
separate namespace to see if the NXDOMAIN response should be replaced
with an alternative response.
With a redirect zone (zone "." { type redirect; };
), the data used
to replace the NXDOMAIN is held in a single zone which is not part of
the normal namespace. All the redirect information is contained in the
zone; there are no delegations.
- nxdomain-redirect
Grammar:
nxdomain-redirect <string>;
Blocks: options, view
Tags: query
Appends the specified suffix to the original query name, when replacing an NXDOMAIN with a redirect namespace.
With a redirect namespace (
option { nxdomain-redirect <suffix> };
), the data used to replace the NXDOMAIN is part of the normal namespace and is looked up by appending the specified suffix to the original query name. This roughly doubles the cache required to process NXDOMAIN responses, as both the original NXDOMAIN response and the replacement data (or an NXDOMAIN indicating that there is no replacement) must be stored.
If both a redirect zone and a redirect namespace are configured, the redirect zone is tried first.
8.2.17. server
Block Grammar
- server
Grammar:
server <netprefix> { bogus <boolean>; edns <boolean>; edns-udp-size <integer>; edns-version <integer>; keys <server_key>; max-udp-size <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); padding <integer>; provide-ixfr <boolean>; query-source [ address ] ( <ipv4_address> | * ); query-source-v6 [ address ] ( <ipv6_address> | * ); request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; request-nsid <boolean>; require-cookie <boolean>; send-cookie <boolean>; tcp-keepalive <boolean>; tcp-only <boolean>; transfer-format ( many-answers | one-answer ); transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); transfers <integer>; }; // may occur multiple times
Blocks: topmost, view
Tags: server
Defines characteristics to be associated with a remote name server.
8.2.18. server
Block Definition and Usage
The server
statement defines characteristics to be associated with a
remote name server. If a prefix length is specified, then a range of
servers is covered. Only the most specific server clause applies,
regardless of the order in named.conf
.
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.
- bogus
Grammar:
bogus <boolean>;
Blocks: server, view.server
Tags: server
Allows a remote server to be ignored.
If a remote server is giving out bad data, marking it as bogus prevents further queries to it. The default value of
bogus
isno
.
- edns
Grammar:
edns <boolean>;
Blocks: server, view.server
Tags: server
Controls the use of the EDNS0 (RFC 2671) feature.
The
edns
clause determines whether the local server attempts to use EDNS when communicating with the remote server. The default isyes
.
- edns-version
Grammar:
edns-version <integer>;
Blocks: server, view.server
Tags: server
Sets the maximum EDNS VERSION that is sent to the server(s) by the resolver.
The
edns-version
option sets the maximum EDNS VERSION that is sent to the server(s) by the resolver. The actual EDNS version sent is still subject to normal EDNS version-negotiation rules (see RFC 6891), the maximum EDNS version supported by the server, and any other heuristics that indicate that a lower version should be sent. This option is intended to be used when a remote server reacts badly to a given EDNS version or higher; it should be set to the highest version the remote server is known to support. Valid values are 0 to 255; higher values are silently adjusted. This option is not needed until higher EDNS versions than 0 are in use.
- padding
Grammar:
padding <integer>;
Blocks: server, view.server
Tags: server
Adds EDNS Padding options to outgoing messages to increase the packet size.
The option adds EDNS Padding options to outgoing messages, increasing the packet size to a multiple of the specified block size. Valid block sizes range from 0 (the default, which disables the use of EDNS Padding) to 512 bytes. Larger values are reduced to 512, with a logged warning. Note: this option is not currently compatible with no TSIG or SIG(0), as the EDNS OPT record containing the padding would have to be added to the packet after it had already been signed.
- tcp-only
Grammar:
tcp-only <boolean>;
Blocks: server, view.server
Tags: server
Sets the transport protocol to TCP.
The option sets the transport protocol to TCP. The default is to use the UDP transport and to fallback on TCP only when a truncated response is received.
- tcp-keepalive
Grammar:
tcp-keepalive <boolean>;
Blocks: server, view.server
Tags: server
Adds EDNS TCP keepalive to messages sent over TCP.
The option adds EDNS TCP keepalive to messages sent over TCP. Note that currently idle timeouts in responses are ignored.
- transfers
Grammar:
transfers <integer>;
Blocks: server, view.server
Tags: server
Limits the number of concurrent inbound zone transfers from a server.
transfers
is used to limit the number of concurrent inbound zone transfers from the specified server. If notransfers
clause is specified, the limit is set according to thetransfers-per-ns
option.
- keys
Blocks: dnssec-policy, server, view.server
Tags: server, security
Specifies one or more
server_key
s to be used with a remote server.Warning
Not to be confused with
keys
indnssec-policy
specification. Although statements with the same name exist in both contexts, they refer to fundamentally incompatible concepts.In the context of a
server
block, the option identifies a server_key defined by thekey
statement, to be used for transaction security (see TSIG) when talking to the remote server. When a request is sent to the remote server, a request signature is 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.Only a single key per server is currently supported.
It is possible to override the following values defined in view
and options
blocks:
8.2.19. statistics-channels
Block Grammar
- statistics-channels
Grammar:
statistics-channels { inet ( <ipv4_address> | <ipv6_address> | * ) [ port ( <integer> | * ) ] [ allow { <address_match_element>; ... } ]; // may occur multiple times }; // may occur multiple times
Blocks: topmost
Tags: logging
Specifies the communication channels to be used by system administrators to access statistics information on the name server.
8.2.20. statistics-channels
Block Definition and Usage
The statistics-channels
statement declares communication channels to
be used by system administrators to get access to statistics information
on the name server.
This statement is intended to be flexible to support multiple communication
protocols in the future, but currently only HTTP access is supported. It
requires that BIND 9 be compiled with libxml2 and/or json-c (also known
as libjson0); the statistics-channels
statement is still accepted
even if it is built without the library, but any HTTP access fails
with an error.
An inet
control channel is a TCP socket listening at the specified
port on the specified ip_address, which can be an IPv4 or IPv6
address. An ip_address of *
(asterisk) is interpreted as the IPv4
wildcard address; connections are accepted on any of the system’s
IPv4 addresses. To listen on the IPv6 wildcard address, use an
ip_address of ::
.
If no port is specified, port 80 is used for HTTP channels. The asterisk
(*
) cannot be used for port.
Attempts to open a statistics channel are restricted by the
optional allow
clause. Connections to the statistics channel are
permitted based on the address_match_list. If no allow
clause is
present, named
accepts connection attempts from any address. Since
the statistics may contain sensitive internal information, the source of
connection requests must be restricted appropriately so that only
trusted parties can access the statistics channel.
Gathering data exposed by the statistics channel locks various subsystems in
named
, which could slow down query processing if statistics data is
requested too often.
An issue in the statistics channel would be considered a security issue
only if it could be exploited by unprivileged users circumventing the access
control list. In other words, any issue in the statistics channel that could be
used to access information unavailable otherwise, or to crash named
, is
not considered a security issue if it can be avoided through the
use of a secure configuration.
If no statistics-channels
statement is present, named
does not
open any communication channels.
The statistics are available in various formats and views, depending on the URI used to access them. For example, if the statistics channel is configured to listen on 127.0.0.1 port 8888, then the statistics are accessible in XML format at http://127.0.0.1:8888/ or http://127.0.0.1:8888/xml. A CSS file is included, which can format the XML statistics into tables when viewed with a stylesheet-capable browser, and into charts and graphs using the Google Charts API when using a JavaScript-capable browser.
Broken-out subsets of the statistics can be viewed at http://127.0.0.1:8888/xml/v3/status (server uptime and last reconfiguration time), http://127.0.0.1:8888/xml/v3/server (server and resolver statistics), http://127.0.0.1:8888/xml/v3/zones (zone statistics), http://127.0.0.1:8888/xml/v3/xfrins (incoming zone transfer statistics), http://127.0.0.1:8888/xml/v3/net (network status and socket statistics), http://127.0.0.1:8888/xml/v3/mem (memory manager statistics), and http://127.0.0.1:8888/xml/v3/traffic (traffic sizes).
The full set of statistics can also be read in JSON format at http://127.0.0.1:8888/json, with the broken-out subsets at http://127.0.0.1:8888/json/v1/status (server uptime and last reconfiguration time), http://127.0.0.1:8888/json/v1/server (server and resolver statistics), http://127.0.0.1:8888/json/v1/zones (zone statistics), http://127.0.0.1:8888/json/v1/xfrins (incoming zone transfer statistics), http://127.0.0.1:8888/json/v1/net (network status and socket statistics), http://127.0.0.1:8888/json/v1/mem (memory manager statistics), and http://127.0.0.1:8888/json/v1/traffic (traffic sizes).
8.2.21. tls
Block Grammar
- tls
Grammar:
tls <string> { ca-file <quoted_string>; cert-file <quoted_string>; cipher-suites <string>; ciphers <string>; dhparam-file <quoted_string>; key-file <quoted_string>; prefer-server-ciphers <boolean>; protocols { <string>; ... }; remote-hostname <quoted_string>; session-tickets <boolean>; }; // may occur multiple times
Blocks: topmost
Tags: security
Configures a TLS connection.
8.2.22. tls
Block Definition and Usage
The tls
statement is used to configure a TLS connection; this
configuration can then be referenced by a listen-on
or listen-on-v6
statement to cause named
to listen for incoming requests via TLS,
or in the primaries
statement for a zone of type secondary
to
cause zone transfer requests to be sent via TLS.
tls
can only be set at the top level of named.conf
.
The following options can be specified in a tls
statement:
- key-file
Grammar:
key-file <quoted_string>;
Blocks: tls
Tags: server, security
Specifies the path to a file containing the private TLS key for a connection.
Path to a file containing the private TLS key to be used for the connection.
- cert-file
Grammar:
cert-file <quoted_string>;
Blocks: tls
Tags: server, security
Specifies the path to a file containing the TLS certificate for a connection.
Path to a file containing the TLS certificate to be used for the connection.
- ca-file
Grammar:
ca-file <quoted_string>;
Blocks: tls
Tags: server, security
Specifies the path to a file containing TLS certificates for trusted CA authorities, used to verify remote peer certificates.
Path to a file containing trusted CA authorities’ TLS certificates used to verify remote peer certificates. Specifying this option enables remote peer certificates’ verification. For incoming connections, specifying this option makes BIND require a valid TLS certificate from a client. In the case of outgoing connections, if
remote-hostname
is not specified, then the remote server IP address is used instead.
- dhparam-file
Grammar:
dhparam-file <quoted_string>;
Blocks: tls
Tags: server, security
Specifies the path to a file containing Diffie-Hellman parameters, for enabling cipher suites.
Path to a file containing Diffie-Hellman parameters, which is needed to enable the cipher suites depending on the Diffie-Hellman ephemeral key exchange (DHE). Having these parameters specified is essential for enabling perfect forward secrecy capable ciphers in TLSv1.2.
- remote-hostname
Grammar:
remote-hostname <quoted_string>;
Blocks: tls
Tags: security
Specifies the expected hostname in the TLS certificate of the remote server.
The expected hostname in the TLS certificate of the remote server. This option enables a remote server certificate verification. If
ca-file
is not specified, then the platform-specific certificates store is used for verification. This option is used when connecting to a remote peer only and, thus, is ignored whentls
statements are referenced bylisten-on
orlisten-on-v6
statements.
- protocols
Grammar:
protocols { <string>; ... };
Blocks: tls
Tags: security
Specifies the allowed versions of the TLS protocol.
Allowed versions of the TLS protocol. TLS version 1.2 and higher are supported, depending on the cryptographic library in use. Multiple versions might be specified (e.g.
protocols { TLSv1.2; TLSv1.3; };
).
- cipher-suites
Grammar:
cipher-suites <string>;
Blocks: tls
Tags: security
Specifies a list of allowed cipher suites in the order of preference for TLSv1.3 only.
Cipher suites list which defines allowed cipher suites, such as
TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
. The string must be formed according to the rules specified in the OpenSSL documentation (see https://www.openssl.org/docs/man1.1.1/man1/ciphers.html, section “TLS v1.3 cipher suites” for details).
- ciphers
Grammar:
ciphers <string>;
Blocks: tls
Tags: security
Specifies a list of allowed ciphers in the order of preference for TLSv1.2 only.
Cipher list which defines allowed ciphers, such as
HIGH:!aNULL:!MD5:!SHA1:!SHA256:!SHA384
. The string must be formed according to the rules specified in the OpenSSL documentation (see https://www.openssl.org/docs/man1.1.1/man1/ciphers.html for details).
- prefer-server-ciphers
Grammar:
prefer-server-ciphers <boolean>;
Blocks: tls
Tags: server, security
Specifies that server ciphers should be preferred over client ones.
Specifies that server ciphers should be preferred over client ones.
- session-tickets
Grammar:
session-tickets <boolean>;
Blocks: tls
Tags: security
Enables or disables session resumption through TLS session tickets.
Enables or disables session resumption through TLS session tickets, as defined in RFC 5077. Disabling the stateless session tickets might be required in the cases when forward secrecy is needed, or the TLS certificate and key pair is planned to be used across multiple BIND instances.
Warning
TLS configuration is subject to change and incompatible changes might be introduced in the future. Users of TLS are encouraged to carefully read release notes when upgrading.
The options described above are used to control different aspects of TLS functioning. Thus, most of them have no well-defined default values, as these depend on the cryptographic library version in use and system-wide cryptographic policy. On the other hand, by specifying the needed options one could have a uniform configuration deployable across a range of platforms.
An example of privacy-oriented, perfect forward secrecy enabled configuration can be found below. It can be used as a starting point.
tls local-tls {
key-file "/path/to/key.pem";
cert-file "/path/to/fullchain_cert.pem";
dhparam-file "/path/to/dhparam.pem";
ciphers "HIGH:!kRSA:!aNULL:!eNULL:!RC4:!3DES:!MD5:!EXP:!PSK:!SRP:!DSS:!SHA1:!SHA256:!SHA384";
prefer-server-ciphers yes;
session-tickets no;
};
A Diffie-Hellman parameters file can be generated using e.g. OpenSSL, like follows:
openssl dhparam -out /path/to/dhparam.pem <3072_or_4096>
Ensure that it gets generated on a machine with enough entropy from external sources (e.g. the computer you work on should be fine, the remote virtual machine or server might be not). These files do not contain any sensitive data and can be shared if required.
There are two built-in TLS connection configurations: ephemeral
,
uses a temporary key and certificate created for the current named
session only, and none
, which can be used when setting up an HTTP
listener with no encryption.
The main motivation behind having the ephemeral
configuration is
to aid in testing, as trusted certificate authorities do not issue the
certificates associated with this configuration. Thus, these
certificates will never be trusted by any clients that verify TLS
certificates; they provide encryption of the traffic but no
authentication of the transmission channel. That might be enough in
the case of deployment in a controlled environment.
It should be noted that on reconfiguration, the ephemeral
TLS key
and the certificate are recreated, and all TLS certificates and keys,
as well as associated data, are reloaded from the disk. In that case,
listening sockets associated with TLS remain intact.
Please keep in mind that performing a reconfiguration can cause a short interruption in BIND’s ability to process inbound client packets. The length of interruption is environment- and configuration-specific. A good example of when reconfiguration is necessary is when TLS keys and certificates are updated on the disk.
BIND supports the following TLS authentication mechanisms described in the RFC 9103, Section 9.3: Opportunistic TLS, Strict TLS, and Mutual TLS.
Opportunistic TLS provides encryption for data but does not provide
any authentication for the channel. This mode is the default one and
it is used whenever remote-hostname
and ca-file
options are not set
in tls
statements in use. RFC 9103 allows optional fallback to
clear-text DNS in the cases when TLS is not available. Still, BIND
intentionally does not support that in order to protect from
unexpected data leaks due to misconfiguration. Both BIND and its
complementary tools either successfully establish a secure channel via
TLS when instructed to do so or fail to establish a connection
otherwise.
Strict TLS provides server authentication via a pre-configured
hostname for outgoing connections. This mechanism offers both channel
confidentiality and channel authentication (of the server). In order
to achieve Strict TLS, one needs to use remote-hostname
and, optionally,
ca-file
options in the tls
statements used for establishing
outgoing connections (e.g. the ones used to download zone from
primaries via TLS). Providing any of the mentioned options will enable
server authentication. If remote-hostname
is provided but ca-file
is
missing, then the platform-specific certificate authority certificates
are used for authentication. The set roughly corresponds to the one
used by WEB-browsers to authenticate HTTPS hosts. On the other hand,
if ca-file
is provided but remote-hostname
is missing, then the
remote side’s IP address is used instead.
Mutual TLS is an extension to Strict TLS that provides channel
confidentiality and mutual channel authentication. It builds up upon
the clients offering client certificates when establishing connections
and them doing the server authentication as in the case of Strict
TLS. The server verifies the provided client certificates and accepts
the TLS connection in case of successful verification or rejects it
otherwise. In order to instruct the server to require and verify
client TLS certificates, one needs to specify the ca-file
option
in tls
configurations used to configure server listeners. The
provided file must contain certificate authority certificates used to
issue client certificates. In most cases, one should build one’s own
TLS certificate authority specifically to issue client certificates
and include the certificate authority certificate into the file.
For authenticating zone transfers over TLS, Mutual TLS might be considered a standalone solution, while Strict TLS paired with TSIG-based authentication and, optionally, IP-based access lists, might be considered acceptable for most practical purposes. Mutual TLS has the advantage of not requiring TSIG and thus, not having security issues related to shared cryptographic secrets.
8.2.23. http
Block Grammar
- http
Grammar:
http <string> { endpoints { <quoted_string>; ... }; listener-clients <integer>; streams-per-connection <integer>; }; // may occur multiple times
Blocks: topmost
Tags: server, query
Configures HTTP endpoints on which to listen for DNS-over-HTTPS (DoH) queries.
8.2.24. http
Block Definition and Usage
The http
statement is used to configure HTTP endpoints on which
to listen for DNS-over-HTTPS (DoH) queries. This configuration can
then be referenced by a listen-on
or listen-on-v6
statement to
cause named
to listen for incoming requests over HTTPS.
http
can only be set at the top level of named.conf
.
The following options can be specified in an http
statement:
- endpoints
Grammar:
endpoints { <quoted_string>; ... };
Blocks: http
Tags: server, query
Specifies a list of HTTP query paths on which to listen.
A list of HTTP query paths on which to listen. This is the portion of an RFC 3986-compliant URI following the hostname; it must be an absolute path, beginning with “/”. The default value is
"/dns-query"
, if omitted.
- listener-clients
Grammar:
listener-clients <integer>;
Blocks: http
Tags: server, query
Specifies a per-listener quota for active connections.
The option specifies a per-listener quota for active connections.
- streams-per-connection
Grammar:
streams-per-connection <integer>;
Blocks: http
Tags: server, query
Specifies the maximum number of concurrent HTTP/2 streams over an HTTP/2 connection.
The option specifies the hard limit on the number of concurrent HTTP/2 streams over an HTTP/2 connection.
Any of the options above could be omitted. In such a case, a global value
specified in the options
statement is used
(see http-listener-clients
, http-streams-per-connection
.
For example, the following configuration enables DNS-over-HTTPS queries on all local addresses:
http local {
endpoints { "/dns-query"; };
};
options {
....
listen-on tls ephemeral http local { any; };
listen-on-v6 tls ephemeral http local { any; };
};
8.2.25. trust-anchors
Block Grammar
8.2.26. trust-anchors
Block Definition and Usage
The trust-anchors
statement defines DNSSEC trust anchors. DNSSEC is
described in DNSSEC.
A trust anchor is defined when the public key or public key digest for a non-authoritative zone is known but cannot be securely obtained through DNS, either because it is the DNS root zone or because its parent zone is unsigned. Once a key or digest has been configured as a trust anchor, it is treated as if it has been validated and proven secure.
The resolver attempts DNSSEC validation on all DNS data in subdomains of
configured trust anchors. Validation below specified names can be
temporarily disabled by using rndc nta
, or permanently disabled with
the validate-except
option.
All keys listed in trust-anchors
, and their corresponding zones, are
deemed to exist regardless of what parent zones say. Only keys
configured as trust anchors are used to validate the DNSKEY RRset for
the corresponding name. The parent’s DS RRset is not used.
trust-anchors
may be set at the top level of named.conf
or within
a view. If it is set in both places, the configurations are additive;
keys defined at the top level are inherited by all views, but keys
defined in a view are only used within that view.
The trust-anchors
statement can contain
multiple trust-anchor entries, each consisting of a
domain name, followed by an “anchor type” keyword indicating
the trust anchor’s format, followed by the key or digest data.
If the anchor type is static-key
or
initial-key
, then it is followed with the
key’s flags, protocol, and algorithm, plus the Base64 representation
of the public key data. This is identical to the text
representation of a DNSKEY record. Spaces, tabs, newlines, and
carriage returns are ignored in the key data, so the
configuration may be split into multiple lines.
If the anchor type is static-ds
or
initial-ds
, it is followed with the
key tag, algorithm, digest type, and the hexadecimal
representation of the key digest. This is identical to the
text representation of a DS record. Spaces, tabs, newlines,
and carriage returns are ignored.
Trust anchors configured with the
static-key
or static-ds
anchor types are immutable, while keys configured with
initial-key
or initial-ds
can be kept up-to-date automatically, without intervention from the resolver operator.
(static-key
keys are identical to keys configured using the
deprecated trusted-keys
statement.)
Suppose, for example, that a zone’s key-signing key was compromised, and
the zone owner had to revoke and replace the key. A resolver which had
the original key
configured using static-key
or
static-ds
would be unable to validate
this zone any longer; it would reply with a SERVFAIL response
code. This would continue until the resolver operator had
updated the trust-anchors
statement with
the new key.
If, however, the trust anchor had been configured using
initial-key
or initial-ds
instead, the zone owner could add a “stand-by” key to
the zone in advance. named
would store
the stand-by key, and when the original key was revoked,
named
would be able to transition smoothly
to the new key. It would also recognize that the old key had
been revoked and cease using that key to validate answers,
minimizing the damage that the compromised key could do.
This is the process used to keep the ICANN root DNSSEC key
up-to-date.
Whereas static-key
and
static-ds
trust anchors continue
to be trusted until they are removed from
named.conf
, an
initial-key
or initial-ds
is only trusted once: for as long as it
takes to load the managed key database and start the
RFC 5011 key maintenance process.
It is not possible to mix static with initial trust anchors for the same domain name.
The first time named
runs with an
initial-key
or initial-ds
configured in named.conf
, it fetches the
DNSKEY RRset directly from the zone apex,
and validates it
using the trust anchor specified in trust-anchors
.
If the DNSKEY RRset is validly signed by a key matching
the trust anchor, then it is used as the basis for a new
managed-keys database.
From that point on, whenever named
runs, it sees the initial-key
or initial-ds
listed in trust-anchors
, checks to make sure RFC 5011 key maintenance
has already been initialized for the specified domain, and if so,
simply moves on. The key specified in the trust-anchors
statement is
not used to validate answers; it is superseded by the key or keys stored
in the managed-keys database.
The next time named
runs after an initial-key
or
initial-ds
has been removed from the trust-anchors
statement
(or changed to a static-key
or static-ds
), the corresponding zone
is removed from the managed-keys database, and RFC 5011 key maintenance
is no longer used for that domain.
In the current implementation, the managed-keys database is stored as a master-format zone file.
On servers which do not use views, this file is named
managed-keys.bind
. When views are in use, there is a separate
managed-keys database for each view; the filename is the view name
(or, if a view name contains characters which would make it illegal as a
filename, a hash of the view name), followed by the suffix .mkeys
.
When the key database is changed, the zone is updated. As with any other
dynamic zone, changes are written into a journal file, e.g.,
managed-keys.bind.jnl
or internal.mkeys.jnl
. Changes are
committed to the primary file as soon as possible afterward,
usually within 30 seconds. Whenever named
is using
automatic key maintenance, the zone file and journal file can be
expected to exist in the working directory. (For this reason, among
others, the working directory should be always be writable by
named
.)
If the dnssec-validation
option is set to auto
, named
automatically sets up an initial-key
for the root zone. This
initializing key is built in to named
, and is current as of the
release date. When the root zone key changes, a running server will detect
the change and roll to the new key, but newly-installed servers being run
for the first time will need to be from a recent enough version of BIND to
have been built with the current key.
8.2.27. dnssec-policy
Block Grammar
- dnssec-policy
Grammar options, view, zone (primary, secondary):
dnssec-policy <string>;
Grammar topmost:
dnssec-policy <string> { cdnskey <boolean>; cds-digest-types { <string>; ... }; dnskey-ttl <duration>; inline-signing <boolean>; keys { ( csk | ksk | zsk ) [ key-directory | key-store <string> ] lifetime <duration_or_unlimited> algorithm <string> [ tag-range <integer> <integer> ] [ <integer> ]; ... }; max-zone-ttl <duration>; nsec3param [ iterations <integer> ] [ optout <boolean> ] [ salt-length <integer> ]; offline-ksk <boolean>; parent-ds-ttl <duration>; parent-propagation-delay <duration>; publish-safety <duration>; purge-keys <duration>; retire-safety <duration>; signatures-jitter <duration>; signatures-refresh <duration>; signatures-validity <duration>; signatures-validity-dnskey <duration>; zone-propagation-delay <duration>; }; // may occur multiple times
Blocks: topmost, options, view, zone (primary, secondary)
Tags: dnssec
Defines a key and signing policy (KASP) for zones.
8.2.28. dnssec-policy
Block Definition and Usage
The dnssec-policy
statement defines a key and signing policy (KASP)
for zones.
A KASP determines how one or more zones are signed with DNSSEC. For example, it specifies how often keys should roll, which cryptographic algorithms to use, and how often RRSIG records need to be refreshed. Multiple key and signing policies can be configured with unique policy names.
A policy for a zone is selected using a dnssec-policy
statement in the
zone
block, specifying the name of the policy that should be
used.
- There are three built-in policies:
default
, which uses the default policy,insecure
, to be used when you want to gracefully unsign your zone,none
, which means no DNSSEC policy (the same as not selectingdnssec-policy
at all; the zone is not signed.)
Keys are not shared among zones, which means that one set of keys per zone is generated even if they have the same policy. If multiple views are configured with different versions of the same zone, each separate version uses the same set of signing keys.
The dnssec-policy
statement requires dynamic DNS to be set up, or
inline-signing
to be enabled (which is the default for DNSSEC zones).
If inline-signing
is enabled, this means that a signed version of the
zone is maintained separately and is written out to a different file on disk
(the zone’s filename plus a .signed
extension).
If inline-signing
is disabled, the zone needs to be configured with
an update-policy
or allow-update
. In such case, the DNSSEC
records are written to the filename set in the original zone’s file
.
Key rollover timing is computed for each key according to the key
lifetime defined in the KASP. The lifetime may be modified by zone TTLs
and propagation delays, to prevent validation failures. When a key
reaches the end of its lifetime, named
generates and publishes a new
key automatically, then deactivates the old key and activates the new
one; finally, the old key is retired according to a computed schedule.
Zone-signing key (ZSK) rollovers require no operator input. Key-signing key (KSK) and combined-signing key (CSK) rollovers require action to be taken to submit a DS record to the parent. Rollover timing for KSKs and CSKs is adjusted to take into account delays in processing and propagating DS updates.
The policy default
causes the zone to be signed with a single combined-signing
key (CSK) using the algorithm ECDSAP256SHA256; this key has an unlimited
lifetime. This policy can be displayed using the command named -C
.
Note
The default signing policy may change in future releases.
This could require changes to a signing policy when upgrading to a
new version of BIND. Check the release notes carefully when
upgrading to be informed of such changes. To prevent policy changes
on upgrade, use an explicitly defined dnssec-policy
, rather than
default
.
If a dnssec-policy
statement is modified and the server restarted or
reconfigured, named
attempts to change the policy smoothly from the
old one to the new. For example, if the key algorithm is changed, then
a new key is generated with the new algorithm, and the old algorithm is
retired when the existing key’s lifetime ends.
Note
Rolling to a new policy while another key rollover is already in progress is not yet supported, and may result in unexpected behavior.
The following options can be specified in a dnssec-policy
statement:
- cdnskey
Grammar:
cdnskey <boolean>;
Blocks: dnssec-policy
Tags: dnssec
Specifies whether a CDNSKEY record should be published during KSK rollover.
When set to the default value of
yes
, a CDNSKEY record is published during KSK rollovers when the DS of the successor key may be submitted to the parent.
- cds-digest-types
Grammar:
cds-digest-types { <string>; ... };
Blocks: dnssec-policy
Tags: dnssec
Specifies the digest types to use for CDS resource records.
This indicates the digest types to use when generating CDS resource records. The default is SHA-256 only.
- dnskey-ttl
Grammar:
dnskey-ttl <duration>;
Blocks: dnssec-policy
Tags: dnssec
Specifies the time to live (TTL) for DNSKEY resource records.
This indicates the TTL to use when generating DNSKEY resource records. The default is 1 hour (3600 seconds).
- inline-signing
- tags:
dnssec
- short:
Specifies whether BIND 9 maintains a separate signed version of a zone.
If
yes
, BIND 9 maintains a separate signed version of the zone. An unsigned zone is transferred in or loaded from disk and the signed version of the zone is served with, possibly, a different serial number. The signed version of the zone is stored in a file that is the zone’s filename (set infile
) with a.signed
extension.This behavior is enabled by default.
- keys
- tags:
dnssec
- short:
Specifies the type of keys to be used for DNSSEC signing.
This is a list specifying the algorithms and roles to use when generating keys and signing the zone. Entries in this list do not represent specific DNSSEC keys, which may be changed on a regular basis, but the roles that keys play in the signing policy. For example, configuring a KSK of algorithm RSASHA256 ensures that the DNSKEY RRset always includes a key-signing key for that algorithm.
Here is an example (for illustration purposes only) of some possible entries in a
keys
list:keys { ksk key-directory lifetime unlimited algorithm rsasha256 2048; zsk lifetime 30d algorithm 8 tag-range 0 32767; csk key-store "hsm" lifetime P6MT12H3M15S algorithm ecdsa256; };
This example specifies that three keys should be used in the zone. The first token determines which role the key plays in signing RRsets. If set to
ksk
, then this is a key-signing key; it has the KSK flag set and is only used to sign DNSKEY, CDS, and CDNSKEY RRsets. If set tozsk
, this is a zone-signing key; the KSK flag is unset, and the key signs all RRsets except DNSKEY, CDS, and CDNSKEY. If set tocsk
, the key has the KSK flag set and is used to sign all RRsets.An optional second token determines where the key is stored. The two available options are
key-store <string>
andkey-directory
.When using
key-store
, the referencedkey-store
describes how the key should be be stored. This can be as a file, or it can be inside a PKCS#11 token.When using
key-directory
, the key is stored in the zone’s configuredkey-directory
. This is also the default.When using
tag-range
, valid key tags for managed keys are restricted to this range [tag-min
tag-max
]. The optionaltag-range
is intended to be used in multi-signer scenarios. The default is unlimited ([0..65535]).The
lifetime
parameter specifies how long a key may be used before rolling over. For convenience, TTL-style time-unit suffixes can be used to specify the key lifetime. It also accepts ISO 8601 duration formats.In the example above, the first key has an unlimited lifetime, the second key may be used for 30 days, and the third key has a rather peculiar lifetime of 6 months, 12 hours, 3 minutes, and 15 seconds. A lifetime of 0 seconds is the same as
unlimited
.Note that the lifetime of a key may be extended if retiring it too soon would cause validation failures. The key lifetime must be longer than the time it takes to do a rollover; that is, the lifetime must be more than the publication interval (which is the sum of
dnskey-ttl
,publish-safety
, andzone-propagation-delay
). It must also be more than the retire interval (which is the sum ofmax-zone-ttl
,retire-safety
,zone-propagation-delay
, and signing delay (signatures-validity
minussignatures-refresh
) for ZSKs, and the sum ofparent-ds-ttl
,retire-safety
, andparent-propagation-delay
for KSKs and CSKs). BIND 9 treats a key lifetime that is too short as an error.The
algorithm
parameter specifies the key’s algorithm, expressed either as a string (“rsasha256”, “ecdsa384”, etc.) or as a decimal number. An optional second parameter specifies the key’s size in bits. If it is omitted, as shown in the example for the second and third keys, an appropriate default size for the algorithm is used. Each KSK/ZSK pair must have the same algorithm. A CSK combines the functionality of a ZSK and a KSK.
Note
When changing the key-directory
or the key-store
, BIND will
be unable to find existing key files. Make sure you copy key files to the
new directory before changing the path used in the configuration file.
This is also true when changing to a built-in policy, for example to
insecure
. In this specific case you should move the existing key files
to the zone’s key-directory
from the new configuration.
- offline-ksk
Grammar:
offline-ksk <boolean>;
Blocks: dnssec-policy
Tags: dnssec
Specifies whether the DNSKEY, CDS, and CDNSKEY RRsets are being signed offline.
If enabled, BIND 9 does not generate signatures for the DNSKEY, CDS, and CDNSKEY RRsets. Instead, the signed DNSKEY, CDS and CDNSKEY RRsets are looked up from Signed Key Response (SKR) files.
Any existing DNSKEY, CDS, and CDNSKEY RRsets in the unsigned version of the zone are filtered and replaced with RRsets from the SKR file.
This feature is off by default. Configuring
offline-ksk
in conjunction with a CSK is a configuration error.
- purge-keys
Grammar:
purge-keys <duration>;
Blocks: dnssec-policy
Tags: dnssec
Specifies the amount of time after which DNSSEC keys that have been deleted from the zone can be removed from disk.
This is the amount of time after which DNSSEC keys that have been deleted from the zone can be removed from disk. If a key still determined to have presence (for example in some resolver cache),
named
will not remove the key files.The default is
P90D
(90 days). Set this option to0
to never purge deleted keys.
- publish-safety
Grammar:
publish-safety <duration>;
Blocks: dnssec-policy
Tags: dnssec
Increases the amount of time between when keys are published and when they become active, to allow for unforeseen events.
This is a margin that is added to the pre-publication interval in rollover timing calculations, to give some extra time to cover unforeseen events. This increases the time between when keys are published and when they become active. The default is
PT1H
(1 hour).
- retire-safety
Grammar:
retire-safety <duration>;
Blocks: dnssec-policy
Tags: dnssec
Increases the amount of time a key remains published after it is no longer active, to allow for unforeseen events.
This is a margin that is added to the post-publication interval in rollover timing calculations, to give some extra time to cover unforeseen events. This increases the time a key remains published after it is no longer active. The default is
PT1H
(1 hour).
- signatures-jitter
Grammar:
signatures-jitter <duration>;
Blocks: dnssec-policy
Tags: dnssec
Specifies a range for signature expirations.
To prevent all signatures from expiring at the same moment, BIND 9 may vary the validity interval of individual signatures. The validity of a newly generated signature is in the range between
signatures-validity
(maximum) andsignatures-validity
, minussignatures-jitter
(minimum). The default jitter is 12 hours, and the configured value must be lower than bothsignatures-validity
andsignatures-validity-dnskey
.
- signatures-refresh
Grammar:
signatures-refresh <duration>;
Blocks: dnssec-policy
Tags: dnssec
Specifies how frequently an RRSIG record is refreshed.
This determines how frequently an RRSIG record needs to be refreshed. The signature is renewed when the time until the expiration time is less than the specified interval. The default is
P5D
(5 days), meaning signatures that expire in 5 days or sooner are refreshed. Thesignatures-refresh
value must be less than 90% of the minimum value ofsignatures-validity
andsignatures-validity-dnskey
.
- signatures-validity
Grammar:
signatures-validity <duration>;
Blocks: dnssec-policy
Tags: dnssec
Indicates the validity period of an RRSIG record.
This indicates the validity period of an RRSIG record (subject to inception offset and jitter). The default is
P2W
(2 weeks).The
signatures-validity
should be at least several multiples of the SOA expire interval, to allow for reasonable interaction between the various timer and expiry dates.
- signatures-validity-dnskey
Grammar:
signatures-validity-dnskey <duration>;
Blocks: dnssec-policy
Tags: dnssec
Indicates the validity period of DNSKEY records.
This is similar to
signatures-validity
, but for DNSKEY records. The default isP2W
(2 weeks).
- max-zone-ttl
- tags:
zone, query
- short:
Specifies a maximum permissible time-to-live (TTL) value, in seconds.
This specifies the maximum permissible TTL value for the zone. When a zone file is loaded, any record encountered with a TTL higher than
max-zone-ttl
causes the zone to be rejected.This ensures that when rolling to a new DNSKEY, the old key will remain available until RRSIG records have expired from caches. The
max-zone-ttl
option guarantees that the largest TTL in the zone is no higher than a known and predictable value.The default value
PT24H
(24 hours). A value of zero is treated as if the default value were in use.
- nsec3param
Grammar:
nsec3param [ iterations <integer> ] [ optout <boolean> ] [ salt-length <integer> ];
Blocks: dnssec-policy
Tags: dnssec
Specifies the use of NSEC3 instead of NSEC, and sets NSEC3 parameters.
Use NSEC3 instead of NSEC, and optionally set the NSEC3 parameters.
Here is an example of an
nsec3
configuration:nsec3param iterations 0 optout no salt-length 0;
The default is to use NSEC. The
iterations
,optout
, andsalt-length
parts are optional, but if not set, the values in the example above are the default NSEC3 parameters. Note that the specific salt string is not specified by the user;named
creates a salt of the indicated length.Warning
Do not use extra iterations, salt, and opt-out unless their implications are fully understood. A higher number of iterations causes interoperability problems and opens servers to CPU-exhausting DoS attacks. See RFC 9276.
- zone-propagation-delay
Grammar:
zone-propagation-delay <duration>;
Blocks: dnssec-policy
Tags: dnssec, zone
Sets the propagation delay from the time a zone is first updated to when the new version of the zone is served by all secondary servers.
This is the expected propagation delay from the time when a zone is first updated to the time when the new version of the zone is served by all secondary servers. The default is
PT5M
(5 minutes).
- parent-ds-ttl
Grammar:
parent-ds-ttl <duration>;
Blocks: dnssec-policy
Tags: dnssec
Sets the time to live (TTL) of the DS RRset used by the parent zone.
This is the TTL of the DS RRset that the parent zone uses. The default is
P1D
(1 day).
- parent-propagation-delay
Grammar:
parent-propagation-delay <duration>;
Blocks: dnssec-policy
Tags: dnssec, zone
Sets the propagation delay from the time the parent zone is updated to when the new version is served by all of the parent zone’s name servers.
This is the expected propagation delay from the time when the parent zone is updated to the time when the new version is served by all of the parent zone’s name servers. The default is
PT1H
(1 hour).
8.2.28.1. Automated KSK Rollovers
BIND has mechanisms in place to facilitate automated KSK rollovers. It publishes CDS and CDNSKEY records that can be used by the parent zone to publish or withdraw the zone’s DS records. BIND will query the parental agents to see if the new DS is actually published before withdrawing the old DNSSEC key.
Note
The DS response is not validated so it is recommended to set up a trust relationship with the parental agent. For example, use TSIG to authenticate the parental agent, or point to a validating resolver.
The following options apply to DS queries sent to parental-agents
:
- checkds
Grammar:
checkds ( explicit | <boolean> );
Blocks: zone (primary, secondary)
Tags: dnssec
Controls whether
DS
queries are sent to parental agents.If set to
yes
, DS queries are sent when a KSK rollover is in progress. The queries are sent to the servers listed in the parent zone’s NS records. This is the default if there are noparental-agents
configured for the zone.If set to
explicit
, DS queries are sent only to servers explicitly listed usingparental-agents
. This is the default if there are parental agents configured.If set to
no
, no DS queries are sent. Users should manually runrndc dnssec -checkds
with the appropriate parameters to signal that specific DS records are published and/or withdrawn.
- parental-source
Grammar:
parental-source ( <ipv4_address> | * );
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Specifies which local IPv4 source address is used to send parental DS queries.
parental-source
determines which local source address is used to send parental DS queries. This statement sets theparental-source
for all zones, but can be overridden on a per-zone or per-view basis by including aparental-source
statement within thezone
orview
block in the configuration file.
- parental-source-v6
Grammar:
parental-source-v6 ( <ipv6_address> | * );
Blocks: options, view, zone (primary, secondary)
Tags: dnssec
Specifies which local IPv6 source address is used to send parental DS queries.
This option acts like
parental-source
, but applies to parental DS queries sent to IPv6 addresses.
8.2.29. managed-keys
Block Grammar
- managed-keys
Warning
This option is deprecated and will be removed in a future version of BIND.
Grammar:
managed-keys { <string> ( static-key | initial-key | static-ds | initial-ds ) <integer> <integer> <integer> <quoted_string>; ... }; // may occur multiple times, deprecated
Blocks: topmost, view
Tags: deprecated
8.2.30. managed-keys
Block Definition and Usage
The managed-keys
statement has been
deprecated in favor of trust-anchors
with the initial-key
keyword.
8.2.31. trusted-keys
Block Grammar
- trusted-keys
Warning
This option is deprecated and will be removed in a future version of BIND.
Grammar:
trusted-keys { <string> <integer> <integer> <integer> <quoted_string>; ... }; // may occur multiple times, deprecated
Blocks: topmost, view
Tags: deprecated
8.2.32. trusted-keys
Block Definition and Usage
The trusted-keys
statement has been deprecated in favor of
trust-anchors
with the static-key
keyword.
8.2.33. view
Block Grammar
- view
Grammar:
view <string> [ <class> ] { allow-new-zones <boolean>; allow-notify { <address_match_element>; ... }; allow-proxy { <address_match_element>; ... }; // experimental allow-proxy-on { <address_match_element>; ... }; // experimental allow-query { <address_match_element>; ... }; allow-query-cache { <address_match_element>; ... }; allow-query-cache-on { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-recursion { <address_match_element>; ... }; allow-recursion-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; attach-cache <string>; auth-nxdomain <boolean>; catalog-zones { zone <string> [ default-primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... } ] [ zone-directory <quoted_string> ] [ in-memory <boolean> ] [ min-update-interval <duration> ]; ... }; check-dup-records ( fail | warn | ignore ); check-integrity <boolean>; check-mx ( fail | warn | ignore ); check-mx-cname ( fail | warn | ignore ); check-names ( primary | master | secondary | slave | response ) ( fail | warn | ignore ); // may occur multiple times check-sibling <boolean>; check-spf ( warn | ignore ); check-srv-cname ( fail | warn | ignore ); check-svcb <boolean>; check-wildcard <boolean>; clients-per-query <integer>; deny-answer-addresses { <address_match_element>; ... } [ except-from { <string>; ... } ]; deny-answer-aliases { <string>; ... } [ except-from { <string>; ... } ]; disable-algorithms <string> { <string>; ... }; // may occur multiple times disable-ds-digests <string> { <string>; ... }; // may occur multiple times disable-empty-zone <string>; // may occur multiple times dlz <string> { database <string>; search <boolean>; }; // may occur multiple times dns64 <netprefix> { break-dnssec <boolean>; clients { <address_match_element>; ... }; exclude { <address_match_element>; ... }; mapped { <address_match_element>; ... }; recursive-only <boolean>; suffix <ipv6_address>; }; // may occur multiple times dns64-contact <string>; dns64-server <string>; dnskey-sig-validity <integer>; // obsolete dnsrps-enable <boolean>; // obsolete dnsrps-options { <unspecified-text> }; // obsolete dnssec-accept-expired <boolean>; dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-must-be-secure <string> <boolean>; // may occur multiple times, deprecated dnssec-policy <string>; dnssec-secure-to-insecure <boolean>; // obsolete dnssec-update-mode ( maintain | no-resign ); // obsolete dnssec-validation ( yes | no | auto ); dnstap { ( all | auth | client | forwarder | resolver | update ) [ ( query | response ) ]; ... }; dual-stack-servers [ port <integer> ] { ( <quoted_string> [ port <integer> ] | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ); ... }; dyndb <string> <quoted_string> { <unspecified-text> }; // may occur multiple times edns-udp-size <integer>; empty-contact <string>; empty-server <string>; empty-zones-enable <boolean>; fetch-quota-params <integer> <fixedpoint> <fixedpoint> <fixedpoint>; fetches-per-server <integer> [ ( drop | fail ) ]; fetches-per-zone <integer> [ ( drop | fail ) ]; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; ipv4only-contact <string>; ipv4only-enable <boolean>; ipv4only-server <string>; ixfr-from-differences ( primary | master | secondary | slave | <boolean> ); key <string> { algorithm <string>; secret <string>; }; // may occur multiple times key-directory <quoted_string>; lame-ttl <duration>; lmdb-mapsize <sizeval>; managed-keys { <string> ( static-key | initial-key | static-ds | initial-ds ) <integer> <integer> <integer> <quoted_string>; ... }; // may occur multiple times, deprecated masterfile-format ( raw | text ); masterfile-style ( full | relative ); match-clients { <address_match_element>; ... }; match-destinations { <address_match_element>; ... }; match-recursive-only <boolean>; max-cache-size ( default | unlimited | <sizeval> | <percentage> ); max-cache-ttl <duration>; max-clients-per-query <integer>; max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-ncache-ttl <duration>; max-query-restarts <integer>; max-records <integer>; max-records-per-type <integer>; max-recursion-depth <integer>; max-recursion-queries <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-stale-ttl <duration>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; max-udp-size <integer>; max-validation-failures-per-fetch <integer>; // experimental max-validations-per-fetch <integer>; // experimental max-zone-ttl ( unlimited | <duration> ); // deprecated message-compression <boolean>; min-cache-ttl <duration>; min-ncache-ttl <duration>; min-refresh-time <integer>; min-retry-time <integer>; minimal-any <boolean>; minimal-responses ( no-auth | no-auth-recursive | <boolean> ); multi-master <boolean>; new-zones-directory <quoted_string>; no-case-compress { <address_match_element>; ... }; nocookie-udp-size <integer>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only nta-lifetime <duration>; nta-recheck <duration>; nxdomain-redirect <string>; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); plugin ( query ) <string> [ { <unspecified-text> } ]; // may occur multiple times preferred-glue <string>; prefetch <integer> [ <integer> ]; provide-ixfr <boolean>; qname-minimization ( strict | relaxed | disabled | off ); query-source [ address ] ( <ipv4_address> | * ); query-source-v6 [ address ] ( <ipv6_address> | * ); rate-limit { all-per-second <integer>; errors-per-second <integer>; exempt-clients { <address_match_element>; ... }; ipv4-prefix-length <integer>; ipv6-prefix-length <integer>; log-only <boolean>; max-table-size <integer>; min-table-size <integer>; nodata-per-second <integer>; nxdomains-per-second <integer>; qps-scale <integer>; referrals-per-second <integer>; responses-per-second <integer>; slip <integer>; window <integer>; }; recursion <boolean>; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; request-nsid <boolean>; require-server-cookie <boolean>; resolver-query-timeout <integer>; resolver-use-dns64 <boolean>; response-padding { <address_match_element>; ... } block-size <integer>; response-policy { zone <string> [ add-soa <boolean> ] [ log <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ policy ( cname | disabled | drop | given | no-op | nodata | nxdomain | passthru | tcp-only <quoted_string> ) ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ ede <string> ]; ... } [ add-soa <boolean> ] [ break-dnssec <boolean> ] [ max-policy-ttl <duration> ] [ min-update-interval <duration> ] [ min-ns-dots <integer> ] [ nsip-wait-recurse <boolean> ] [ nsdname-wait-recurse <boolean> ] [ qname-wait-recurse <boolean> ] [ recursive-only <boolean> ] [ nsip-enable <boolean> ] [ nsdname-enable <boolean> ] [ dnsrps-enable <boolean> ] [ dnsrps-options { <unspecified-text> } ]; root-key-sentinel <boolean>; rrset-order { [ class <string> ] [ type <string> ] [ name <quoted_string> ] <string> <string>; ... }; send-cookie <boolean>; serial-update-method ( date | increment | unixtime ); server <netprefix> { bogus <boolean>; edns <boolean>; edns-udp-size <integer>; edns-version <integer>; keys <server_key>; max-udp-size <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); padding <integer>; provide-ixfr <boolean>; query-source [ address ] ( <ipv4_address> | * ); query-source-v6 [ address ] ( <ipv6_address> | * ); request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; request-nsid <boolean>; require-cookie <boolean>; send-cookie <boolean>; tcp-keepalive <boolean>; tcp-only <boolean>; transfer-format ( many-answers | one-answer ); transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); transfers <integer>; }; // may occur multiple times servfail-ttl <duration>; sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete sortlist { <address_match_element>; ... }; // deprecated stale-answer-client-timeout ( disabled | off | <integer> ); stale-answer-enable <boolean>; stale-answer-ttl <duration>; stale-cache-enable <boolean>; stale-refresh-time <duration>; synth-from-dnssec <boolean>; transfer-format ( many-answers | one-answer ); transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); trust-anchor-telemetry <boolean>; trust-anchors { <string> ( static-key | initial-key | static-ds | initial-ds ) <integer> <integer> <integer> <quoted_string>; ... }; // may occur multiple times trusted-keys { <string> <integer> <integer> <integer> <quoted_string>; ... }; // may occur multiple times, deprecated try-tcp-refresh <boolean>; update-check-ksk <boolean>; // obsolete v6-bias <integer>; validate-except { <string>; ... }; zero-no-soa-ttl <boolean>; zero-no-soa-ttl-cache <boolean>; zone <string> [ <class> ] { in-view <string>; }; zone <string> [ <class> ] { type forward; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; }; zone <string> [ <class> ] { type hint; check-names ( fail | warn | ignore ); file <quoted_string>; }; zone <string> [ <class> ] { type mirror; allow-notify { <address_match_element>; ... }; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-names ( fail | warn | ignore ); database <string>; file <quoted_string>; ixfr-from-differences <boolean>; journal <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); try-tcp-refresh <boolean>; zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); }; zone <string> [ <class> ] { type primary; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-dup-records ( fail | warn | ignore ); check-integrity <boolean>; check-mx ( fail | warn | ignore ); check-mx-cname ( fail | warn | ignore ); check-names ( fail | warn | ignore ); check-sibling <boolean>; check-spf ( warn | ignore ); check-srv-cname ( fail | warn | ignore ); check-svcb <boolean>; check-wildcard <boolean>; checkds ( explicit | <boolean> ); database <string>; dlz <string>; dnskey-sig-validity <integer>; // obsolete dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-policy <string>; dnssec-secure-to-insecure <boolean>; // obsolete dnssec-update-mode ( maintain | no-resign ); // obsolete file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; inline-signing <boolean>; ixfr-from-differences <boolean>; journal <quoted_string>; key-directory <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-transfer-idle-out <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; max-zone-ttl ( unlimited | <duration> ); // deprecated notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only parental-agents [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); serial-update-method ( date | increment | unixtime ); sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete update-check-ksk <boolean>; // obsolete update-policy ( local | { ( deny | grant ) <string> ( 6to4-self | external | krb5-self | krb5-selfsub | krb5-subdomain | krb5-subdomain-self-rhs | ms-self | ms-selfsub | ms-subdomain | ms-subdomain-self-rhs | name | self | selfsub | selfwild | subdomain | tcp-self | wildcard | zonesub ) [ <string> ] <rrtypelist>; ... } ); zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); }; zone <string> [ <class> ] { type redirect; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; dlz <string>; file <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-records <integer>; max-records-per-type <integer>; max-types-per-name <integer>; max-zone-ttl ( unlimited | <duration> ); // deprecated primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; zone-statistics ( full | terse | none | <boolean> ); }; zone <string> [ <class> ] { type secondary; allow-notify { <address_match_element>; ... }; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-names ( fail | warn | ignore ); checkds ( explicit | <boolean> ); database <string>; dlz <string>; dnskey-sig-validity <integer>; // obsolete dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-policy <string>; dnssec-update-mode ( maintain | no-resign ); // obsolete file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; inline-signing <boolean>; ixfr-from-differences <boolean>; journal <quoted_string>; key-directory <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only parental-agents [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); try-tcp-refresh <boolean>; update-check-ksk <boolean>; // obsolete zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); }; zone <string> [ <class> ] { type static-stub; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; max-records <integer>; max-records-per-type <integer>; max-types-per-name <integer>; server-addresses { ( <ipv4_address> | <ipv6_address> ); ... }; server-names { <string>; ... }; zone-statistics ( full | terse | none | <boolean> ); }; zone <string> [ <class> ] { type stub; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; check-names ( fail | warn | ignore ); database <string>; file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-time-in <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); zone-statistics ( full | terse | none | <boolean> ); }; zone-statistics ( full | terse | none | <boolean> ); }; // may occur multiple times
Blocks: topmost
Tags: view
Allows a name server to answer a DNS query differently depending on who is asking.
view view_name [ class ] {
match-clients { address_match_list } ;
match-destinations { address_match_list } ;
match-recursive-only <boolean> ;
[ view_option ; ... ]
[ zone_statement ; ... ]
} ;
8.2.34. view
Block Definition and Usage
The view
statement is a powerful feature of BIND 9 that 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.
- match-clients
Grammar:
match-clients { <address_match_element>; ... };
Blocks: view
Tags: view
Specifies a view of DNS namespace for a given subset of client IP addresses.
- match-destinations
Grammar:
match-destinations { <address_match_element>; ... };
Blocks: view
Tags: view
Specifies a view of DNS namespace for a given subset of destination IP addresses.
Each
view
statement defines a view of the DNS namespace that is seen by a subset of clients. A client matches a view if its source IP address matches the address_match_list of the view’smatch-clients
clause, and its destination IP address matches the address_match_list of the view’smatch-destinations
clause. If not specified, bothmatch-clients
andmatch-destinations
default to matching all addresses. In addition to checking IP addresses,match-clients
andmatch-destinations
can also take the name of a TSIGkey
, which provides a mechanism for the client to select the view.
- match-recursive-only
Grammar:
match-recursive-only <boolean>;
Blocks: view
Tags: view
Specifies that only recursive requests can match this view of the DNS namespace.
A view can also be specified as
match-recursive-only
, which means that only recursive requests from matching clients match that view. The order of theview
statements is significant; a client request is resolved in the context of the firstview
that it matches.
Zones defined within a view
statement are only 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. Any
zone
statements specified on the top level of the configuration file
are considered to be part of this default view, and the options
statement applies to the 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 primary;
file "example-internal.db";
};
};
view "external" {
// Match all clients not matched by the
// previous view.
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 primary;
file "example-external.db";
};
};
8.2.35. zone
Block Grammar
- zone
Blocks: topmost, view
Tags: zone
Specifies the zone in a BIND 9 configuration.
8.2.36. zone
Block Definition and Usage
8.2.36.1. Zone Types
- type
Blocks: zone (forward, hint, mirror, primary, redirect, secondary, static-stub, stub)
Tags: zone
Specifies the kind of zone in a given configuration.
The
type
keyword is required for thezone
configuration unless it is anin-view
configuration. Its acceptable values are:primary
(ormaster
),secondary
(orslave
),mirror
,hint
,stub
,static-stub
,forward
, orredirect
.
- type primary
Grammar:
zone <string> [ <class> ] { type primary; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-dup-records ( fail | warn | ignore ); check-integrity <boolean>; check-mx ( fail | warn | ignore ); check-mx-cname ( fail | warn | ignore ); check-names ( fail | warn | ignore ); check-sibling <boolean>; check-spf ( warn | ignore ); check-srv-cname ( fail | warn | ignore ); check-svcb <boolean>; check-wildcard <boolean>; checkds ( explicit | <boolean> ); database <string>; dlz <string>; dnskey-sig-validity <integer>; // obsolete dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-policy <string>; dnssec-secure-to-insecure <boolean>; // obsolete dnssec-update-mode ( maintain | no-resign ); // obsolete file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; inline-signing <boolean>; ixfr-from-differences <boolean>; journal <quoted_string>; key-directory <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-transfer-idle-out <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; max-zone-ttl ( unlimited | <duration> ); // deprecated notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only parental-agents [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); serial-update-method ( date | increment | unixtime ); sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete update-check-ksk <boolean>; // obsolete update-policy ( local | { ( deny | grant ) <string> ( 6to4-self | external | krb5-self | krb5-selfsub | krb5-subdomain | krb5-subdomain-self-rhs | ms-self | ms-selfsub | ms-subdomain | ms-subdomain-self-rhs | name | self | selfsub | selfwild | subdomain | tcp-self | wildcard | zonesub ) [ <string> ] <rrtypelist>; ... } ); zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains the main copy of the data for a zone.
A primary zone has a master copy of the data for the zone and is able to provide authoritative answers for it. Type
master
is a synonym forprimary
.
- type secondary
Grammar:
zone <string> [ <class> ] { type secondary; allow-notify { <address_match_element>; ... }; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-names ( fail | warn | ignore ); checkds ( explicit | <boolean> ); database <string>; dlz <string>; dnskey-sig-validity <integer>; // obsolete dnssec-dnskey-kskonly <boolean>; // obsolete dnssec-loadkeys-interval <integer>; dnssec-policy <string>; dnssec-update-mode ( maintain | no-resign ); // obsolete file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; inline-signing <boolean>; ixfr-from-differences <boolean>; journal <quoted_string>; key-directory <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); notify-to-soa <boolean>; nsec3-test-zone <boolean>; // test only parental-agents [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; parental-source ( <ipv4_address> | * ); parental-source-v6 ( <ipv6_address> | * ); primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; sig-signing-nodes <integer>; sig-signing-signatures <integer>; sig-signing-type <integer>; sig-validity-interval <integer> [ <integer> ]; // obsolete transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); try-tcp-refresh <boolean>; update-check-ksk <boolean>; // obsolete zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains a duplicate of the data for a zone that has been transferred from a primary server.
A secondary zone is a replica of a primary zone. Type
slave
is a synonym forsecondary
. Theprimaries
list specifies one or more IP addresses of primary servers that the secondary contacts to update its copy of the zone. Primaries list elements can also be names of other primaries lists. 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 primary can also be done with per-server TSIG keys. If a file is specified, then the replica is 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 startup and eliminates a needless waste of bandwidth. Note that for large numbers (in the tens or hundreds of thousands) of zones per server, it is best to use a two-level naming scheme for zone filenames. For example, a secondary server for the zoneexample.com
might place the zone contents into a file calledex/example.com
, whereex/
is just the first two letters of the zone name. (Most operating systems behave very slowly if there are 100,000 files in a single directory.)
- type mirror
Grammar:
zone <string> [ <class> ] { type mirror; allow-notify { <address_match_element>; ... }; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; allow-transfer [ port <integer> ] [ transport <string> ] { <address_match_element>; ... }; allow-update-forwarding { <address_match_element>; ... }; also-notify [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; check-names ( fail | warn | ignore ); database <string>; file <quoted_string>; ixfr-from-differences <boolean>; journal <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-ixfr-ratio ( unlimited | <percentage> ); max-journal-size ( default | unlimited | <sizeval> ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-idle-out <integer>; max-transfer-time-in <integer>; max-transfer-time-out <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; notify ( explicit | master-only | primary-only | <boolean> ); notify-delay <integer>; notify-source ( <ipv4_address> | * ); notify-source-v6 ( <ipv6_address> | * ); primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; request-expire <boolean>; request-ixfr <boolean>; request-ixfr-max-diffs <integer>; transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); try-tcp-refresh <boolean>; zero-no-soa-ttl <boolean>; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains a DNSSEC-validated duplicate of the main data for a zone.
A mirror zone is similar to a zone of
type secondary
, except its data is subject to DNSSEC validation before being used in answers. Validation is applied to the entire zone during the zone transfer process, and again when the zone file is loaded from disk upon restartingnamed
. If validation of a new version of a mirror zone fails, a retransfer is scheduled; in the meantime, the most recent correctly validated version of that zone is used until it either expires or a newer version validates correctly. If no usable zone data is available for a mirror zone, due to either transfer failure or expiration, traditional DNS recursion is used to look up the answers instead. Mirror zones cannot be used in a view that does not have recursion enabled.Answers coming from a mirror zone look almost exactly like answers from a zone of
type secondary
, with the notable exceptions that the AA bit (“authoritative answer”) is not set, and the AD bit (“authenticated data”) is.Mirror zones are intended to be used to set up a fast local copy of the root zone (see RFC 8806). A default list of primary servers for the IANA root zone is built into
named
, so its mirroring can be enabled using the following configuration:zone "." { type mirror; };
Mirror zone validation always happens for the entire zone contents. This ensures that each version of the zone used by the resolver is fully self-consistent with respect to DNSSEC. For incoming mirror zone IXFRs, every revision of the zone contained in the IXFR sequence is validated independently, in the order in which the zone revisions appear on the wire. For this reason, it might be useful to force use of AXFR for mirror zones by setting
request-ixfr no;
for the relevant zone (or view). Other, more efficient zone verification methods may be added in the future.To make mirror zone contents persist between
named
restarts, use thefile
option.Mirroring a zone other than root requires an explicit list of primary servers to be provided using the
primaries
option (seeprimaries
for details), and a key-signing key (KSK) for the specified zone to be explicitly configured as a trust anchor (seetrust-anchors
).When configuring NOTIFY for a mirror zone, only
notify no;
andnotify explicit;
can be used at the zone level; any othernotify
setting at the zone level is a configuration error. Using any othernotify
setting at theoptions
orview
level causes that setting to be overridden withnotify explicit;
for the mirror zone. The global default for thenotify
option isyes
, so mirror zones are by default configured withnotify explicit;
.Outgoing transfers of mirror zones are disabled by default but may be enabled using
allow-transfer
.Note
Use of this zone type with any zone other than the root should be considered experimental and may cause performance issues, especially for zones that are large and/or frequently updated.
- type hint
Grammar:
zone <string> [ <class> ] { type hint; check-names ( fail | warn | ignore ); file <quoted_string>; };
Blocks: zone, view.zone
Tags: zone
Contains the initial set of root name servers to be used at BIND 9 startup.
The initial set of root name servers is specified using a hint zone. When the server starts, it uses the root hints to find a root name server and get the most recent list of root name servers. 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 default hints.
- type stub
Grammar:
zone <string> [ <class> ] { type stub; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; check-names ( fail | warn | ignore ); database <string>; file <quoted_string>; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-records <integer>; max-records-per-type <integer>; max-refresh-time <integer>; max-retry-time <integer>; max-transfer-idle-in <integer>; max-transfer-time-in <integer>; max-types-per-name <integer>; min-refresh-time <integer>; min-retry-time <integer>; multi-master <boolean>; primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; transfer-source ( <ipv4_address> | * ); transfer-source-v6 ( <ipv6_address> | * ); zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains a duplicate of the NS records of a primary zone.
A stub zone is similar to a secondary zone, except that it replicates only the NS records of a primary 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 a 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 supports it only in a limited way. If a BIND 9 primary, serving a parent zone, has child stub zones configured, all the secondary servers for the parent zone also need to have the same child stub zones configured.Stub zones can also be used as a way 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 RFC 1918 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.
- type static-stub
Grammar:
zone <string> [ <class> ] { type static-stub; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; max-records <integer>; max-records-per-type <integer>; max-types-per-name <integer>; server-addresses { ( <ipv4_address> | <ipv6_address> ); ... }; server-names { <string>; ... }; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains a duplicate of the NS records of a primary zone, but statically configured rather than transferred from a primary server.
A static-stub zone is similar to a stub zone, with the following exceptions: the zone data is statically configured, rather than transferred from a primary server; and when recursion is necessary for a query that matches a static-stub zone, the locally configured data (name server names and glue addresses) is always used, even if different authoritative information is cached.
Zone data is configured via the
server-addresses
andserver-names
zone options.The zone data is maintained in the form of NS and (if necessary) glue A or AAAA RRs internally, which can be seen by dumping zone databases with
rndc dumpdb -all
. The configured RRs are considered local configuration parameters rather than public data. Non-recursive queries (i.e., those with the RD bit off) to a static-stub zone are therefore prohibited and are responded to with REFUSED.Since the data is statically configured, no zone maintenance action takes place for a static-stub zone. For example, there is no periodic refresh attempt, and an incoming notify message is rejected with an rcode of NOTAUTH.
Each static-stub zone is configured with internally generated NS and (if necessary) glue A or AAAA RRs.
- type forward
Grammar:
zone <string> [ <class> ] { type forward; forward ( first | only ); forwarders [ port <integer> ] [ tls <string> ] { ( <ipv4_address> | <ipv6_address> ) [ port <integer> ] [ tls <string> ]; ... }; };
Blocks: zone, view.zone
Tags: zone
Contains forwarding statements that apply to queries within a given domain.
A forward zone is a way to configure forwarding on a per-domain basis. A
zone
statement of typeforward
can contain aforward
and/orforwarders
statement, which applies to queries within the domain given by the zone name. If noforwarders
statement is present, or an empty list forforwarders
is given, then no forwarding is done for the domain, canceling the effects of any forwarders in theoptions
statement. Thus, to use this type of zone to change the behavior of the globalforward
option (that is, “forward first” to, then “forward only”, or vice versa), but use the same servers as set globally, re-specify the global forwarders.
- type redirect
Grammar:
zone <string> [ <class> ] { type redirect; allow-query { <address_match_element>; ... }; allow-query-on { <address_match_element>; ... }; dlz <string>; file <quoted_string>; masterfile-format ( raw | text ); masterfile-style ( full | relative ); max-records <integer>; max-records-per-type <integer>; max-types-per-name <integer>; max-zone-ttl ( unlimited | <duration> ); // deprecated primaries [ port <integer> ] [ source ( <ipv4_address> | * ) ] [ source-v6 ( <ipv6_address> | * ) ] { ( <remote-servers> | <ipv4_address> [ port <integer> ] | <ipv6_address> [ port <integer> ] ) [ key <string> ] [ tls <string> ]; ... }; zone-statistics ( full | terse | none | <boolean> ); };
Blocks: zone, view.zone
Tags: zone
Contains information to answer queries when normal resolution would return NXDOMAIN.
Redirect zones are used to provide answers to queries when normal resolution would result in NXDOMAIN being returned. Only one redirect zone is supported per view.
allow-query
can be used to restrict which clients see these answers.If the client has requested DNSSEC records (DO=1) and the NXDOMAIN response is signed, no substitution occurs.
To redirect all NXDOMAIN responses to 100.100.100.2 and 2001:ffff:ffff::100.100.100.2, configure a type
redirect
zone named “.”, with the zone file containing wildcard records that point to the desired addresses:*. IN A 100.100.100.2
and*. IN AAAA 2001:ffff:ffff::100.100.100.2
.As another example, to redirect all Spanish names (under .ES), use similar entries but with the names
*.ES.
instead of*.
. To redirect all commercial Spanish names (under COM.ES), use wildcard entries called*.COM.ES.
.Note that the redirect zone supports all possible types; it is not limited to A and AAAA records.
If a redirect zone is configured with a
primaries
option, then it is transferred in as if it were a secondary zone. Otherwise, it is loaded from a file as if it were a primary zone.Because redirect zones are not referenced directly by name, they are not kept in the zone lookup table with normal primary and secondary zones. To reload a redirect zone, use
rndc reload -redirect
; to retransfer a redirect zone configured as a secondary, userndc retransfer -redirect
. When usingrndc reload
without specifying a zone name, redirect zones are reloaded along with other zones.
- in-view
Grammar zone, view.zone:
zone <string> [ <class> ] { in-view <string>; };
Grammar zone (in-view):
in-view <string>;
Blocks: zone, zone (in-view), view.zone
Tags: view, zone
Specifies the view in which a given zone is defined.
When using multiple views, a
type primary
ortype secondary
zone configured in one view can be referenced in a subsequent view. This allows both views to use the same zone without the overhead of loading it more than once. This is configured using azone
statement, with anin-view
option specifying the view in which the zone is defined. Azone
statement containingin-view
does not need to specify a type, since that is part of the zone definition in the other view.See Multiple Views for more information.
8.2.36.2. 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 was 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.
8.2.36.3. Zone Options
allow-notify
See the description of
allow-notify
in Access Control.allow-query
See the description of
allow-query
in Access Control.allow-query-on
See the description of
allow-query-on
in Access Control.allow-transfer
8.1.1. Comment Syntax
The BIND 9 comment syntax allows comments to appear anywhere that whitespace may appear in a BIND configuration file. To appeal to programmers of all kinds, they can be written in the C, C++, or shell/Perl style.
8.1.1.1. Syntax
8.1.1.2. Definition and Usage
Comments can be inserted anywhere that whitespace may appear in a BIND configuration file.
C-style comments start with the two characters /* (slash, star) and end with */ (star, slash). Because they are completely delimited with these characters, they can be used to comment only a portion of a line or to span multiple lines.
C-style comments cannot be nested. For example, the following is not valid because the entire comment ends with the first */:
C++-style comments start with the two characters // (slash, slash) and continue to the end of the physical line. They cannot be continued across multiple physical lines; to have one logical comment span multiple lines, each line must use the // pair. For example:
Shell-style (or Perl-style) comments start with the character
#
(number/pound sign) and continue to the end of the physical line, as in C++ comments. For example:Warning
The semicolon (
;
) character cannot start a comment, unlike in a zone file. The semicolon indicates the end of a configuration statement.