From 55636ab5105bfd980405d05cad3381f409bf1342 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Mon, 8 Jun 2020 15:33:45 +0000 Subject: [PATCH] Various text edits and fixes to the documentation (cherry picked from commit 5aa5ad5abcb61bef7f2da8f619cab57485255441) --- doc/arm/advanced.rst | 71 ++-- doc/arm/catz.rst | 42 +-- doc/arm/configuration.rst | 72 ++-- doc/arm/dlz.rst | 13 +- doc/arm/dnssec.rst | 50 ++- doc/arm/dyndb.rst | 16 +- doc/arm/general.rst | 10 - doc/arm/history.rst | 10 - doc/arm/introduction.rst | 126 +++---- doc/arm/logging-categories.rst | 16 +- doc/arm/managed-keys.rst | 24 +- doc/arm/manpages.rst | 52 +-- doc/arm/pkcs11.rst | 161 +++++---- doc/arm/plugins.rst | 26 +- doc/arm/reference.rst | 589 +++++++++++++++++---------------- doc/arm/requirements.rst | 24 +- doc/arm/security.rst | 10 - 17 files changed, 577 insertions(+), 735 deletions(-) diff --git a/doc/arm/advanced.rst b/doc/arm/advanced.rst index 9cbd7e06b1..9c5f6aff57 100644 --- a/doc/arm/advanced.rst +++ b/doc/arm/advanced.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. Advanced: Advanced DNS Features @@ -42,7 +32,7 @@ The ``NOTIFY`` protocol is specified in :rfc:`1996`. As a secondary zone can also be a primary to other secondaries, ``named``, by default, sends ``NOTIFY`` messages for every zone it loads. - Specifying ``notify master-only;`` causes ``named`` to only send + Specifying ``notify primary-only;`` causes ``named`` to only send ``NOTIFY`` for primary zones that it loads. .. _dynamic_update: @@ -108,8 +98,8 @@ that the zone file of a dynamic zone is up-to-date is to run ``rndc stop``. To make changes to a dynamic zone manually, follow these steps: -First, disable dynamic updates to the zone using -``rndc freeze zone``; this updates the zone's master file with the +first, disable dynamic updates to the zone using +``rndc freeze zone``. This updates the zone file with the changes stored in its ``.jnl`` file. Then, edit the zone file. Finally, run ``rndc thaw zone`` to reload the changed zone and re-enable dynamic updates. @@ -156,21 +146,21 @@ Split DNS --------- Setting up different views of the DNS space to internal -and external resolvers is usually referred to as a Split DNS setup. -There are several reasons an organization would want to set up its DNS +and external resolvers is usually referred to as a *split DNS* setup. +There are several reasons an organization might want to set up its DNS this way. -One common reason to use Split DNS is to hide +One common reason to use split DNS is to hide "internal" DNS information from "external" clients on the Internet. There is some debate as to whether this is actually useful. Internal DNS information leaks out in many ways (via email headers, for example) and most savvy "attackers" can find the information they need using other means. However, since listing addresses of internal servers that external clients cannot possibly reach can result in connection -delays and other annoyances, an organization may choose to use Split +delays and other annoyances, an organization may choose to use split DNS to present a consistent view of itself to the outside world. -Another common reason for setting up a Split DNS system is to allow +Another common reason for setting up a split DNS system is to allow internal networks that are behind filters or in :rfc:`1918` space (reserved IP space, as documented in :rfc:`1918`) to resolve DNS on the Internet. Split DNS can also be used to allow mail from outside back into the @@ -295,7 +285,7 @@ Internal DNS server config: // sample primary zone zone "site1.example.com" { - type master; + type primary; file "m/site1.example.com"; // do normal iterative resolution (do not forward) forwarders { }; @@ -305,16 +295,16 @@ Internal DNS server config: // sample secondary zone zone "site2.example.com" { - type slave; + type secondary; file "s/site2.example.com"; - masters { 172.16.72.3; }; + primaries { 172.16.72.3; }; forwarders { }; allow-query { internals; externals; }; allow-transfer { internals; }; }; zone "site1.internal" { - type master; + type primary; file "m/site1.internal"; forwarders { }; allow-query { internals; }; @@ -322,9 +312,9 @@ Internal DNS server config: }; zone "site2.internal" { - type slave; + type secondary; file "s/site2.internal"; - masters { 172.16.72.3; }; + primaries { 172.16.72.3; }; forwarders { }; allow-query { internals }; allow-transfer { internals; } @@ -355,13 +345,13 @@ External (bastion host) DNS server configuration: // sample secondary zone zone "site1.example.com" { - type master; + type primary; file "m/site1.foo.com"; allow-transfer { internals; externals; }; }; zone "site2.example.com" { - type slave; + type secondary; file "s/site2.foo.com"; masters { another_bastion_host_maybe; }; allow-transfer { internals; externals; } @@ -398,8 +388,8 @@ configuration syntax and the process of creating TSIG keys. the tools included with BIND support it for sending messages to ``named``: - * :ref:`man_nsupdate` supports TSIG via the ``-k``, ``-l`` and ``-y`` command line options, or via the ``key`` command when running interactively. - * :ref:`man_dig` supports TSIG via the ``-k`` and ``-y`` command line options. + * :ref:`man_nsupdate` supports TSIG via the ``-k``, ``-l``, and ``-y`` command-line options, or via the ``key`` command when running interactively. + * :ref:`man_dig` supports TSIG via the ``-k`` and ``-y`` command-line options. Generating a Shared Key ~~~~~~~~~~~~~~~~~~~~~~~ @@ -407,12 +397,12 @@ Generating a Shared Key TSIG keys can be generated using the ``tsig-keygen`` command; the output of the command is a ``key`` directive suitable for inclusion in ``named.conf``. The key name, algorithm, and size can be specified by -command line parameters; the defaults are "tsig-key", HMAC-SHA256, and +command-line parameters; the defaults are "tsig-key", HMAC-SHA256, and 256 bits, respectively. Any string which is a valid DNS name can be used as a key name. For example, a key to be shared between servers called ``host1`` and ``host2`` -could be called "host1-host2.", and this key could be generated using: +could be called "host1-host2.", and this key can be generated using: :: @@ -463,7 +453,7 @@ Instructing the Server to Use a Key A server sending a request to another server must be told whether to use a key, and if so, which key to use. -For example, a key may be specified for each server in the ``masters`` +For example, a key may be specified for each server in the ``primaries`` statement in the definition of a secondary zone; in this case, all SOA QUERY messages, NOTIFY messages, and zone transfer requests (AXFR or IXFR) are signed using the specified key. Keys may also be specified in @@ -499,7 +489,7 @@ TSIG keys may be specified in ACL definitions and ACL directives such as ``allow-query``, ``allow-transfer``, and ``allow-update``. The above key would be denoted in an ACL element as ``key host1-host2.`` -Here's an example of an ``allow-update`` directive using a TSIG key: +Here is an example of an ``allow-update`` directive using a TSIG key: :: @@ -566,7 +556,7 @@ SIG(0) BIND partially supports DNSSEC SIG(0) transaction signatures as specified in :rfc:`2535` and :rfc:`2931`. SIG(0) uses public/private keys to -authenticate messages. Access control is performed in the same manner as +authenticate messages. Access control is performed in the same manner as with TSIG keys; privileges can be granted or denied in ACL directives based on the key name. @@ -594,8 +584,7 @@ which must be followed. BIND 9 ships with several tools that are used in this process, which are explained in more detail below. In all cases, the ``-h`` option prints a full list of parameters. Note that the DNSSEC tools require the keyset files to be in the working directory or the -directory specified by the ``-d`` option, and that the tools shipped -with BIND 9.2.x and earlier are not compatible with the current versions. +directory specified by the ``-d`` option. There must also be communication with the administrators of the parent and/or child zone to transmit keys. A zone's security status must be @@ -603,8 +592,8 @@ indicated by the parent zone for a DNSSEC-capable resolver to trust its data. This is done through the presence or absence of a ``DS`` record at the delegation point. -For other servers to trust data in this zone, they must either be -statically configured with this zone's zone key or the zone key of +For other servers to trust data in this zone, they must be +statically configured with either this zone's zone key or the zone key of another zone above this one in the DNS tree. .. _generating_dnssec_keys: @@ -640,7 +629,7 @@ To generate another key with the same properties but with a different key tag, repeat the above command. The ``dnssec-keyfromlabel`` program is used to get a key pair from a -crypto hardware and build the key files. Its usage is similar to +crypto hardware device and build the key files. Its usage is similar to ``dnssec-keygen``. The public keys should be inserted into the zone file by including the @@ -668,7 +657,7 @@ it is in a file called ``zone.child.example``: One output file is produced: ``zone.child.example.signed``. This file should be referenced by ``named.conf`` as the input file for the zone. -``dnssec-signzone`` also produces a keyset and dsset files. These are used +``dnssec-signzone`` also produces keyset and dsset files. These are used to provide the parent zone administrators with the ``DNSKEYs`` (or their corresponding ``DS`` records) that are the secure entry point to the zone. @@ -829,7 +818,7 @@ Address Lookups Using AAAA Records The IPv6 AAAA record is a parallel to the IPv4 A record, and, unlike the deprecated A6 record, specifies the entire IPv6 address in a single -record. For example, +record. For example: :: @@ -846,7 +835,7 @@ Address-to-Name Lookups Using Nibble Format When looking up an address in nibble format, the address components are simply reversed, just as in IPv4, and ``ip6.arpa.`` is appended to the resulting name. For example, the following would provide reverse name -lookup for a host with address ``2001:db8::1``. +lookup for a host with address ``2001:db8::1``: :: diff --git a/doc/arm/catz.rst b/doc/arm/catz.rst index ca90fb15ba..cd3ee30adf 100644 --- a/doc/arm/catz.rst +++ b/doc/arm/catz.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _catz-info: Catalog Zones @@ -37,7 +27,7 @@ standard AXFR/IXFR zone transfer mechanism. Catalog zones' format and behavior are specified as an Internet draft for interoperability among DNS implementations. The latest revision of the DNS catalog zones draft can be found here: -https://datatracker.ietf.org/doc/draft-toorop-dnsop-dns-catalog-zones/. +https://datatracker.ietf.org/doc/draft-toorop-dnsop-dns-catalog-zones/ . Principle of Operation ~~~~~~~~~~~~~~~~~~~~~~ @@ -68,14 +58,14 @@ To use the catalog zone feature to serve a new member zone: ``rndc addzone``. - Add an entry to the catalog zone for the new member zone. This can - be done by editing the catalog zone's master file and running + be done by editing the catalog zone's zone file and running ``rndc reload``, or by updating the zone using ``nsupdate``. The change to the catalog zone is propagated from the primary to all secondaries using the normal AXFR/IXFR mechanism. When the secondary receives the update to the catalog zone, it detects the entry for the new member zone, creates an instance of that zone on the secondary server, and points -that instance to the ``masters`` specified in the catalog zone data. The +that instance to the ``primaries`` specified in the catalog zone data. The newly created member zone is a normal secondary zone, so BIND immediately initiates a transfer of zone contents from the primary. Once complete, the secondary starts serving the member zone. @@ -100,7 +90,7 @@ Catalog zones are configured with a ``catalog-zones`` statement in the catalog-zones { zone "catalog.example" - default-masters { 10.53.0.1; } + default-primaries { 10.53.0.1; } in-memory no zone-directory "catzones" min-update-interval 10; @@ -129,7 +119,7 @@ specified in any order. ``zone-directory`` This option causes local copies of member zones' - master files to be stored in + zone files to be stored in the specified directory, if ``in-memory`` is not set to ``yes``. The default is to store zone files in the server's working directory. A non-absolute pathname in ``zone-directory`` is assumed to be relative to the working directory. @@ -165,7 +155,7 @@ then a catalog zone may not be used by that server. version.catalog.example. IN TXT "1" Note that this record must have the domain name -version.catalog-zone-name. The data +``version.catalog-zone-name``. The data stored in a catalog zone is indicated by the domain name label immediately before the catalog zone domain. @@ -178,27 +168,27 @@ Global options are set at the apex of the catalog zone, e.g.: :: - masters.catalog.example. IN AAAA 2001:db8::1 + primaries.catalog.example. IN AAAA 2001:db8::1 BIND currently supports the following options: -- A simple ``masters`` definition: +- A simple ``primaries`` definition: :: - masters.catalog.example. IN A 192.0.2.1 + primaries.catalog.example. IN A 192.0.2.1 - This option defines a primary server for the member zones - it can be + This option defines a primary server for the member zones, which can be either an A or AAAA record. If multiple primaries are set, the order in which they are used is random. -- A ``masters`` with a TSIG key defined: +- A ``primaries`` with a TSIG key defined: :: - label.masters.catalog.example. IN A 192.0.2.2 - label.masters.catalog.example. IN TXT "tsig_key_name" + label.primaries.catalog.example. IN A 192.0.2.2 + label.primaries.catalog.example. IN TXT "tsig_key_name" This option defines a primary server for the member zone with a TSIG @@ -235,9 +225,9 @@ options, but in the member zone subdomain: :: - masters.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN A 192.0.2.2 - label.masters.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN AAAA 2001:db8::2 - label.masters.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN TXT "tsig_key" + primaries.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN A 192.0.2.2 + label.primaries.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN AAAA 2001:db8::2 + label.primaries.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN TXT "tsig_key" allow-query.5960775ba382e7a4e09263fc06e7c00569b6a05c.zones.catalog.example. IN APL 1:10.0.0.0/24 Options defined for a specific zone override the diff --git a/doc/arm/configuration.rst b/doc/arm/configuration.rst index 6d2d982e87..00f9f6b49b 100644 --- a/doc/arm/configuration.rst +++ b/doc/arm/configuration.rst @@ -8,22 +8,12 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. Configuration: Name Server Configuration ========================= -In this chapter we provide some suggested configurations along with +In this chapter we provide some suggested configurations, along with guidelines for their use. We suggest reasonable values for certain option settings. @@ -40,7 +30,7 @@ A Caching-only Name Server The following sample configuration is appropriate for a caching-only name server for use by clients internal to a corporation. All queries from outside clients are refused using the ``allow-query`` option. -Alternatively, the same effect could be achieved using suitable firewall +The same effect can be achieved using suitable firewall rules. :: @@ -56,7 +46,7 @@ rules. // Provide a reverse mapping for the loopback // address 127.0.0.1 zone "0.0.127.in-addr.arpa" { - type master; + type primary; file "localhost.rev"; notify no; }; @@ -67,7 +57,7 @@ An Authoritative-only Name Server ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This sample configuration is for an authoritative-only server that is -the primary (master) server for ``example.com`` and a secondary (slave) server for the subdomain +the primary server for ``example.com`` and a secondary server for the subdomain ``eng.example.com``. :: @@ -86,26 +76,26 @@ the primary (master) server for ``example.com`` and a secondary (slave) server f // Provide a reverse mapping for the loopback // address 127.0.0.1 zone "0.0.127.in-addr.arpa" { - type master; + type primary; file "localhost.rev"; notify no; }; - // We are the master server for example.com + // We are the primary server for example.com zone "example.com" { - type master; + type primary; file "example.com.db"; - // IP addresses of slave servers allowed to + // IP addresses of secondary servers allowed to // transfer example.com allow-transfer { 192.168.4.14; 192.168.5.53; }; }; - // We are a slave server for eng.example.com + // We are a secondary server for eng.example.com zone "eng.example.com" { - type slave; + type secondary; file "eng.example.com.bk"; - // IP address of eng.example.com master server + // IP address of eng.example.com primary server masters { 192.168.4.12; }; }; @@ -118,8 +108,8 @@ A primitive form of load balancing can be achieved in the DNS by using multiple records (such as multiple A records) for one name. For example, assuming three HTTP servers with network addresses of -10.0.0.1, 10.0.0.2 and 10.0.0.3, a set of records such as the following -means that clients will connect to each machine one third of the time: +10.0.0.1, 10.0.0.2, and 10.0.0.3, a set of records such as the following +means that clients will connect to each machine one-third of the time: +-----------+------+----------+----------+----------------------------+ | Name | TTL | CLASS | TYPE | Resource Record (RR) Data | @@ -166,12 +156,12 @@ output format. ``dig`` ``dig`` is the most versatile and complete of these lookup tools. It has two modes: simple interactive mode for a single query, and batch - mode which executes a query for each in a list of several query + mode, which executes a query for each in a list of several query lines. All query options are accessible from the command line. ``dig [@server] domain [query-type][query-class][+query-option][-dig-option][%comment]`` - The usual simple use of ``dig`` will take the form + The usual simple use of ``dig`` takes the form ``dig @server domain query-type query-class`` @@ -183,7 +173,8 @@ output format. default, it converts between host names and Internet addresses, but its functionality can be extended with the use of options. - ``host [-aCdlnrsTwv][-c class][-N ndots][-t type][-W timeout][-R retries][-m flag][-4][-6] hostname [server]`` + ``host [-aCdlnrsTwv][-c class][-N ndots][-t type][-W timeout][-R retries] + [-m flag][-4][-6] hostname [server]`` For more information and a list of available commands and options, see the ``host`` man page. @@ -191,7 +182,7 @@ output format. ``nslookup`` ``nslookup`` has two modes: interactive and non-interactive. Interactive mode allows the user to query name servers for - information about various hosts and domains or to print a list of + information about various hosts and domains, or to print a list of hosts in a domain. Non-interactive mode is used to print just the name and requested information for a host or domain. @@ -225,10 +216,11 @@ server. ``named-checkconf [-jvz][-t directory][filename]`` ``named-checkzone`` - The ``named-checkzone`` program checks a master file for syntax and + The ``named-checkzone`` program checks a zone file for syntax and consistency. - ``named-checkzone [-djqvD][-c class][-o output][-t directory][-w directory][-k (ignore|warn|fail)][-n (ignore|warn|fail)][-W (ignore|warn)] zone [filename]`` + ``named-checkzone [-djqvD][-c class][-o output][-t directory][-w directory] + [-k (ignore|warn|fail)][-n (ignore|warn|fail)][-W (ignore|warn)] zone [filename]`` ``named-compilezone`` This tool is similar to ``named-checkzone,`` but it always dumps the zone content @@ -237,7 +229,7 @@ server. ``rndc`` The remote name daemon control (``rndc``) program allows the system administrator to control the operation of a name server. If ``rndc`` is run - without any options, it will display a usage message as + without any options, it displays a usage message as follows: ``rndc [-c config][-s server][-p port][-y key] command [command...]`` @@ -251,7 +243,7 @@ server. with a configuration file. The default location for the ``rndc`` configuration file is ``/etc/rndc.conf``, but an alternate location can be specified with the ``-c`` option. If the configuration file is - not found, ``rndc`` will also look in ``/etc/rndc.key`` (or whatever + not found, ``rndc`` also looks in ``/etc/rndc.key`` (or whatever ``sysconfdir`` was defined when the BIND build was configured). The ``rndc.key`` file is generated by running ``rndc-confgen -a`` as described in :ref:`controls_statement_definition_and_usage`. @@ -264,7 +256,7 @@ server. The ``options`` statement has three clauses: ``default-server``, ``default-key``, and ``default-port``. ``default-server`` takes a - host name or address argument and represents the server that will be + host name or address argument and represents the server that is contacted if no ``-s`` option is provided on the command line. ``default-key`` takes the name of a key as its argument, as defined by a ``key`` statement. ``default-port`` specifies the port to which @@ -275,13 +267,13 @@ server. authenticating with ``named``. Its syntax is identical to the ``key`` statement in ``named.conf``. The keyword ``key`` is followed by a key name, which must be a valid domain name, though it need not actually - be hierarchical; thus, a string like "``rndc_key``" is a valid name. + be hierarchical; thus, a string like ``rndc_key`` is a valid name. The ``key`` statement has two clauses: ``algorithm`` and ``secret``. - While the configuration parser will accept any string as the argument - to the algorithm, currently only the strings ``hmac-md5``, + While the configuration parser accepts any string as the argument + to ``algorithm``, currently only the strings ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, and ``hmac-sha512`` have any meaning. The secret - is a Base64 encoded string as specified in :rfc:`3548`. + is a Base64-encoded string as specified in :rfc:`3548`. The ``server`` statement associates a key defined using the ``key`` statement with a server. The keyword ``server`` is followed by a host @@ -309,7 +301,7 @@ server. ``$ rndc reload`` - to connect to 127.0.0.1 port 953 and cause the name server to reload, + to connect to 127.0.0.1 port 953 and causes the name server to reload, if a name server on the local machine is running with the following controls statements: @@ -322,16 +314,16 @@ server. and it has an identical key statement for ``rndc_key``. - Running the ``rndc-confgen`` program conveniently creates a + Running the ``rndc-confgen`` program conveniently creates an ``rndc.conf`` file, and also displays the corresponding ``controls`` statement needed to add to ``named.conf``. - Alternatively, it is possible to run ``rndc-confgen -a`` to set up a + Alternatively, it is possible to run ``rndc-confgen -a`` to set up an ``rndc.key`` file and not modify ``named.conf`` at all. Signals ~~~~~~~ -Certain UNIX signals cause the name server to take specific actions, as +Certain Unix signals cause the name server to take specific actions, as described in the following table. These signals can be sent using the ``kill`` command. diff --git a/doc/arm/dlz.rst b/doc/arm/dlz.rst index 6dde624559..c1c8da1df8 100644 --- a/doc/arm/dlz.rst +++ b/doc/arm/dlz.rst @@ -8,13 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _dlz-info: Dynamically Loadable Zones (DLZ) @@ -37,7 +30,7 @@ dynamically at runtime, via the DLZ "dlopen" driver, which acts as a generic wrapper around a shared object implementing the DLZ API. The "dlopen" driver is linked into ``named`` by default, so configure options are no longer necessary when using these dynamically linkable -drivers, but are still needed for the older drivers in +drivers; they are still needed for the older drivers in ``contrib/dlz/drivers``. The DLZ module provides data to ``named`` in text @@ -45,7 +38,7 @@ format, which is then converted to DNS wire format by ``named``. This conversion, and the lack of any internal caching, places significant limits on the query performance of DLZ modules. Consequently, DLZ is not recommended for use on high-volume servers. However, it can be used in a -hidden primary (master) configuration, with secondaries retrieving zone updates via +hidden primary configuration, with secondaries retrieving zone updates via AXFR. Note, however, that DLZ has no built-in support for DNS notify; secondary servers are not automatically informed of changes to the zones in the database. @@ -129,7 +122,7 @@ querying client and alter its response on the basis of this information. To demonstrate this feature, the example driver responds to queries for "source-addr.``zonename``>/TXT" with the source address of the query. Note, however, that this record will *not* be included in -AXFR or ANY responses. Normally, this feature would be used to alter +AXFR or ANY responses. Normally, this feature is used to alter responses in some other fashion, e.g., by providing different address records for a particular name depending on the network from which the query arrived. diff --git a/doc/arm/dnssec.rst b/doc/arm/dnssec.rst index 67d01da364..2e1c178afe 100644 --- a/doc/arm/dnssec.rst +++ b/doc/arm/dnssec.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _dnssec.dynamic.zones: DNSSEC, Dynamic Zones, and Automatic Signing @@ -26,7 +16,7 @@ DNSSEC, Dynamic Zones, and Automatic Signing Converting From Insecure to Secure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Changing a zone from insecure to secure can be done in three ways: using a +A zone can be changed from insecure to secure in three ways: using a dynamic DNS update, via the ``auto-dnssec`` zone option, or by setting a DNSSEC policy for the zone with ``dnssec-policy``. @@ -40,7 +30,7 @@ key-directory, as specified in ``named.conf``: :: zone example.net { - type master; + type primary; update-policy local; file "dynamic/example.net/example.net"; key-directory "dynamic/example.net"; @@ -77,7 +67,7 @@ To insert the keys via dynamic update: > send While the update request completes almost immediately, the zone is -not completely signed until ``named`` has had time to walk the zone +not completely signed until ``named`` has had time to "walk" the zone and generate the NSEC and RRSIG records. The NSEC record at the apex is added last, to signal that there is a complete NSEC chain. @@ -128,9 +118,9 @@ policy, ignoring existing DNSSEC ``named.conf`` options. ``named`` periodically searches the key directory for keys matching the zone; if the keys' metadata indicates that any change should be -made to the zone, such as adding, removing, or revoking a key, then that +made to the zone - such as adding, removing, or revoking a key - then that action is carried out. By default, the key directory is checked for -changes every 60 minutes; this period can be adjusted with the +changes every 60 minutes; this period can be adjusted with ``dnssec-loadkeys-interval``, up to a maximum of 24 hours. The ``rndc loadkeys`` command forces ``named`` to check for key updates immediately. @@ -157,34 +147,34 @@ allow dynamic updates, by adding an ``allow-update`` or ``update-policy`` statement to the zone configuration. If this has not been done, the configuration fails. -Private-type Records +Private Type Records ~~~~~~~~~~~~~~~~~~~~ -The state of the signing process is signaled by private-type records +The state of the signing process is signaled by private type records (with a default type value of 65534). When signing is complete, those -records with a nonzero initial octet have a nonzero value for the final octet. +records with a non-zero initial octet have a non-zero value for the final octet. -If the first octet of a private-type record is non-zero, the +If the first octet of a private type record is non-zero, the record indicates either that the zone needs to be signed with the key matching the record, or that all signatures that match the record should be -removed. +removed. Here are the meanings of the different values of the first octet: - algorithm (octet 1) + - algorithm (octet 1) - key id in network order (octet 2 and 3) + - key id in network order (octet 2 and 3) - removal flag (octet 4) + - removal flag (octet 4) - complete flag (octet 5) + - complete flag (octet 5) -Only records flagged as "complete" can be removed via dynamic update. -Attempts to remove other private type records are silently ignored. +Only records flagged as "complete" can be removed via dynamic update; attempts +to remove other private type records are silently ignored. If the first octet is zero (this is a reserved algorithm number that -should never appear in a DNSKEY record), the record indicates +should never appear in a DNSKEY record), the record indicates that changes to the NSEC3 chains are in progress. The rest of the record contains an NSEC3PARAM record, while the flag field tells what operation to -perform based on the flag bits. +perform based on the flag bits: 0x01 OPTOUT @@ -208,7 +198,7 @@ To perform key rollovers via dynamic update, the ``K*`` files for the new keys must be added so that ``named`` can find them. The new DNSKEY RRs can then be added via dynamic update. ``named`` then causes the zone to be signed with the new keys; when the signing is complete, the -private-type records are updated so that the last octet is non-zero. +private type records are updated so that the last octet is non-zero. If this is for a KSK, the parent and any trust anchor repositories of the new KSK must be informed. @@ -227,7 +217,7 @@ Automatic Key Rollovers ~~~~~~~~~~~~~~~~~~~~~~~ When a new key reaches its activation date (as set by ``dnssec-keygen`` -or ``dnssec-settime``), if the ``auto-dnssec`` zone option is set to +or ``dnssec-settime``), and if the ``auto-dnssec`` zone option is set to ``maintain``, ``named`` automatically carries out the key rollover. If the key's algorithm has not previously been used to sign the zone, then the zone is fully signed as quickly as possible. However, if diff --git a/doc/arm/dyndb.rst b/doc/arm/dyndb.rst index 9a68828ee2..fa8d538757 100644 --- a/doc/arm/dyndb.rst +++ b/doc/arm/dyndb.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _dyndb-info: Dynamic Database (DynDB) @@ -77,8 +67,8 @@ arguments in the ``dyndb`` statement: dyndb sample "sample.so" { example.nil. arpa. }; -In the above example, the module is configured to create a zone -"example.nil" which can answer queries and AXFR requests and accept +In the above example, the module is configured to create a zone, +"example.nil", which can answer queries and AXFR requests and accept DDNS updates. At runtime, prior to any updates, the zone contains an SOA, NS, and a single A record at the apex: @@ -92,7 +82,7 @@ SOA, NS, and a single A record at the apex: When the zone is updated dynamically, the DynDB module determines -whether the updated RR is an address (i.e., type A or AAAA) and if so, +whether the updated RR is an address (i.e., type A or AAAA); if so, it automatically updates the corresponding PTR record in a reverse zone. Note that updates are not stored permanently; all updates are lost when the server is restarted. diff --git a/doc/arm/general.rst b/doc/arm/general.rst index 2c265d2e61..b3ec59a1d8 100644 --- a/doc/arm/general.rst +++ b/doc/arm/general.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. General: General DNS Reference Information diff --git a/doc/arm/history.rst b/doc/arm/history.rst index 718bb06843..a86a5d94aa 100644 --- a/doc/arm/history.rst +++ b/doc/arm/history.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. History: A Brief History of the DNS and BIND diff --git a/doc/arm/introduction.rst b/doc/arm/introduction.rst index 4804977fed..e6bc650457 100644 --- a/doc/arm/introduction.rst +++ b/doc/arm/introduction.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _Introduction: Introduction @@ -65,41 +55,29 @@ information related to BIND and the Domain Name System. Conventions Used in This Document --------------------------------- -In this document, we use the following general typographic conventions: +In this document, we generally use ``Fixed Width`` text to indicate the +following types of information: -+-------------------------------------+--------------------------------+ -| *To describe:* | *We use the style:* | -+-------------------------------------+--------------------------------+ -| a pathname, filename, URL, | ``Fixed width`` | -| hostname, mailing list name, or new | | -| term or concept | | -+-------------------------------------+--------------------------------+ -| literal user input | ``Fixed Width Bold`` | -+-------------------------------------+--------------------------------+ -| program output | ``Fixed Width`` | -+-------------------------------------+--------------------------------+ +- pathnames +- filenames +- URLs +- hostnames +- mailing list names +- new terms or concepts +- literal user input +- program output +- keywords +- variables -The following conventions are used in descriptions of the BIND -configuration file: - -+-------------------------------------+--------------------------------+ -| *To describe:* | *We use the style:* | -+-------------------------------------+--------------------------------+ -| keywords | ``Fixed Width`` | -+-------------------------------------+--------------------------------+ -| variables | ``Fixed Width`` | -+-------------------------------------+--------------------------------+ -| Optional input | [Text is enclosed in square | -| | brackets] | -+-------------------------------------+--------------------------------+ +Text in "quotes," **bold**, or *italics* is also used for emphasis or clarity. .. _dns_overview: The Domain Name System (DNS) ---------------------------- -The purpose of this document is to explain the installation and upkeep -of the BIND (Berkeley Internet Name Domain) software package, and we +This document explains the installation and upkeep +of the BIND (Berkeley Internet Name Domain) software package. We begin by reviewing the fundamentals of the Domain Name System (DNS) as they relate to BIND. @@ -132,12 +110,12 @@ written form as a string of labels listed from right to left and separated by dots. A label need only be unique within its parent domain. For example, a domain name for a host at the company *Example, Inc.* -could be ``ourhost.example.com``, where ``com`` is the top level domain +could be ``ourhost.example.com``, where ``com`` is the top-level domain to which ``ourhost.example.com`` belongs, ``example`` is a subdomain of ``com``, and ``ourhost`` is the name of the host. For administrative purposes, the name space is partitioned into areas -called *zones*, each starting at a node and extending down to the leaf +called *zones*, each starting at a node and extending down to the "leaf" nodes or to nodes where other zones start. The data for each zone is stored in a *name server*, which answers queries about the zone using the *DNS protocol*. @@ -163,8 +141,8 @@ tree except those which are delegated to other zones. A delegation point is marked by one or more *NS records* in the parent zone, which should be matched by equivalent NS records at the root of the delegated zone. -For instance, consider the ``example.com`` domain which includes names -such as ``host.aaa.example.com`` and ``host.bbb.example.com`` even +For instance, consider the ``example.com`` domain, which includes names +such as ``host.aaa.example.com`` and ``host.bbb.example.com``, even though the ``example.com`` zone includes only delegations for the ``aaa.example.com`` and ``bbb.example.com`` zones. A zone can map exactly to a single domain, but could also include only part of a @@ -172,14 +150,14 @@ domain, the rest of which could be delegated to other name servers. Every name in the DNS tree is a *domain*, even if it is *terminal*, that is, has no *subdomains*. Every subdomain is a domain and every domain except the root is also a subdomain. The terminology is not intuitive -and we suggest that you read :rfc:`1033`, :rfc:`1034` and :rfc:`1035` to gain a complete +and we suggest reading :rfc:`1033`, :rfc:`1034`, and :rfc:`1035` to gain a complete understanding of this difficult and subtle topic. -Though BIND is called a "domain name server", it deals primarily in -terms of zones. The master and slave declarations in the ``named.conf`` -file specify zones, not domains. When you ask some other site if it is -willing to be a slave server for your *domain*, you are actually asking -for slave service for some collection of zones. +Though BIND 9 is called a "domain name server," it deals primarily in +terms of zones. The primary and secondary declarations in the ``named.conf`` +file specify zones, not domains. When BIND asks some other site if it is +willing to be a secondary server for a *domain*, it is actually asking +for secondary service for some collection of *zones*. .. _auth_servers: @@ -197,11 +175,11 @@ when debugging DNS configurations using tools like ``dig`` (:ref:`diagnostic_too .. _primary_master: -The Primary Master +The Primary Server ^^^^^^^^^^^^^^^^^^ -The authoritative server where the master copy of the zone data is -maintained is called the *primary master* server, or simply the +The authoritative server, where the main copy of the zone data is +maintained, is called the *primary* (formerly *master*) server, or simply the *primary*. Typically it loads the zone contents from some local file edited by humans or perhaps generated mechanically from some other local file which is edited by humans. This file is called the *zone file* or @@ -212,19 +190,19 @@ all, but may instead be the result of *dynamic update* operations. .. _slave_server: -Slave Servers -^^^^^^^^^^^^^ +Secondary Servers +^^^^^^^^^^^^^^^^^ -The other authoritative servers, the *slave* servers (also known as -*secondary* servers) load the zone contents from another server using a -replication process known as a *zone transfer*. Typically the data are -transferred directly from the primary master, but it is also possible to -transfer it from another slave. In other words, a slave server may -itself act as a master to a subordinate slave server. +The other authoritative servers, the *secondary* servers (formerly known as +*slave* servers) load the zone contents from another server using a +replication process known as a *zone transfer*. Typically the data is +transferred directly from the primary, but it is also possible to +transfer it from another secondary. In other words, a secondary server may +itself act as a primary to a subordinate secondary server. -Periodically, the slave server must send a refresh query to determine +Periodically, the secondary server must send a refresh query to determine whether the zone contents have been updated. This is done by sending a -query for the zone's SOA record and checking whether the SERIAL field +query for the zone's Start of Authority (SOA) record and checking whether the SERIAL field has been updated; if so, a new transfer request is initiated. The timing of these refresh queries is controlled by the SOA REFRESH and RETRY fields, but can be overridden with the ``max-refresh-time``, @@ -232,32 +210,32 @@ fields, but can be overridden with the ``max-refresh-time``, options. If the zone data cannot be updated within the time specified by the SOA -EXPIRE option (up to a hard-coded maximum of 24 weeks) then the slave -zone expires and will no longer respond to queries. +EXPIRE option (up to a hard-coded maximum of 24 weeks), the secondary +zone expires and no longer responds to queries. .. _stealth_server: Stealth Servers ^^^^^^^^^^^^^^^ -Usually all of the zone's authoritative servers are listed in NS records +Usually, all of the zone's authoritative servers are listed in NS records in the parent zone. These NS records constitute a *delegation* of the zone from the parent. The authoritative servers are also listed in the -zone file itself, at the *top level* or *apex* of the zone. You can list -servers in the zone's top-level NS records that are not in the parent's -NS delegation, but you cannot list servers in the parent's delegation -that are not present at the zone's top level. +zone file itself, at the *top level* or *apex* of the zone. +Servers that are not in the parent's +NS delegation can be listed in the zone's top-level NS records, but servers that are not present at the zone's top level +cannot be listed in the parent's delegation. A *stealth server* is a server that is authoritative for a zone but is not listed in that zone's NS records. Stealth servers can be used for -keeping a local copy of a zone to speed up access to the zone's records +keeping a local copy of a zone, to speed up access to the zone's records or to make sure that the zone is available even if all the "official" servers for the zone are inaccessible. -A configuration where the primary master server itself is a stealth +A configuration where the primary server itself is a stealth server is often referred to as a "hidden primary" configuration. One use -for this configuration is when the primary master is behind a firewall -and therefore unable to communicate directly with the outside world. +for this configuration is when the primary is behind a firewall +and is therefore unable to communicate directly with the outside world. .. _cache_servers: @@ -278,7 +256,7 @@ intimately connected, the terms *recursive server* and *caching server* are often used synonymously. The length of time for which a record may be retained in the cache of a -caching name server is controlled by the Time To Live (TTL) field +caching name server is controlled by the Time-To-Live (TTL) field associated with each resource record. .. _forwarder: @@ -317,8 +295,8 @@ This permits changes in behavior based on server responsiveness. Name Servers in Multiple Roles ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The BIND name server can simultaneously act as a master for some zones, -a slave for other zones, and as a caching (recursive) server for a set +The BIND name server can simultaneously act as a primary for some zones, +a secondary for other zones, and as a caching (recursive) server for a set of local clients. However, since the functions of authoritative name service and diff --git a/doc/arm/logging-categories.rst b/doc/arm/logging-categories.rst index fa7f329cec..12aac739f0 100644 --- a/doc/arm/logging-categories.rst +++ b/doc/arm/logging-categories.rst @@ -8,21 +8,11 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - ``client`` Processing of client requests. ``cname`` - Nameservers that are skipped due to them being a CNAME rather than A / AAAA records. + Name servers that are skipped for being a CNAME rather than A/AAAA records. ``config`` Configuration file parsing and processing. @@ -79,13 +69,13 @@ ``client ::1#62537 (www.example.net):`` ``query: www.example.net IN AAAA -SE`` - (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.) + 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 1 level and higher. + 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. diff --git a/doc/arm/managed-keys.rst b/doc/arm/managed-keys.rst index 42aa722e28..ac6424c689 100644 --- a/doc/arm/managed-keys.rst +++ b/doc/arm/managed-keys.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _rfc5011.support: Dynamic Trust Anchor Management @@ -49,14 +39,14 @@ RFC 5011-managed trust anchor takes note of the stand-by KSKs in the zone's DNSKEY RRset, and stores them for future reference. The resolver rechecks the zone periodically; after 30 days, if the new key is still there, the key is accepted by the resolver as a valid -trust anchor for the zone. Any time after this 30-day acceptance timer +trust anchor for the zone. Anytime after this 30-day acceptance timer has completed, the active KSK can be revoked, and the zone can be "rolled over" to the newly accepted key. The easiest way to place a stand-by key in a zone is to use the "smart signing" features of ``dnssec-keygen`` and ``dnssec-signzone``. If a key exists with a publication date in the past, but an activation date which is -unset or in the future, " ``dnssec-signzone -S``" includes the +unset or in the future, ``dnssec-signzone -S`` includes the DNSKEY record in the zone but does not sign with it: :: @@ -64,7 +54,7 @@ DNSKEY record in the zone but does not sign with it: $ dnssec-keygen -K keys -f KSK -P now -A now+2y example.net $ dnssec-signzone -S -K keys example.net -To revoke a key, the command ``dnssec-revoke`` has been added. This +To revoke a key, use the command ``dnssec-revoke``. This adds the REVOKED bit to the key flags and regenerates the ``K*.key`` and ``K*.private`` files. @@ -86,12 +76,12 @@ wrapping around at 65535. So, for example, the key If two keys have IDs exactly 128 apart and one is revoked, the two key IDs will collide, causing several problems. To prevent this, -``dnssec-keygen`` does not generate a new key if another key is present -which may collide. This checking only occurs if the new keys are -written to the same directory which holds all other keys in use for that +``dnssec-keygen`` does not generate a new key if another key +which may collide is present. This checking only occurs if the new keys are +written to the same directory that holds all other keys in use for that zone. -Older versions of BIND 9 did not have this precaution. Exercise caution +Older versions of BIND 9 did not have this protection. Exercise caution if using key revocation on keys that were generated by previous releases, or if using keys stored in multiple directories or on multiple machines. diff --git a/doc/arm/manpages.rst b/doc/arm/manpages.rst index ba7ec13067..c820625a81 100644 --- a/doc/arm/manpages.rst +++ b/doc/arm/manpages.rst @@ -13,39 +13,39 @@ Manual Pages ============ -.. include:: ../../bin/rndc/rndc.conf.rst -.. include:: ../../bin/rndc/rndc.rst -.. include:: ../../bin/tools/nsec3hash.rst -.. include:: ../../bin/tools/dnstap-read.rst -.. include:: ../../bin/tools/named-nzd2nzf.rst -.. include:: ../../bin/tools/named-journalprint.rst -.. include:: ../../bin/tools/mdig.rst -.. include:: ../../bin/tools/named-rrchecker.rst .. include:: ../../bin/tools/arpaname.rst -.. include:: ../../bin/dnssec/dnssec-revoke.rst +.. include:: ../../bin/confgen/ddns-confgen.rst +.. include:: ../../bin/delv/delv.rst +.. include:: ../../bin/dig/dig.rst .. include:: ../../bin/dnssec/dnssec-cds.rst -.. include:: ../../bin/dnssec/dnssec-keygen.rst -.. include:: ../../bin/dnssec/dnssec-keyfromlabel.rst -.. include:: ../../bin/dnssec/dnssec-verify.rst -.. include:: ../../bin/dnssec/dnssec-settime.rst -.. include:: ../../bin/dnssec/dnssec-importkey.rst -.. include:: ../../bin/dnssec/dnssec-signzone.rst .. include:: ../../bin/dnssec/dnssec-dsfromkey.rst +.. include:: ../../bin/dnssec/dnssec-importkey.rst .. include:: ../../bin/python/dnssec-checkds.rst .. include:: ../../bin/python/dnssec-coverage.rst .. include:: ../../bin/python/dnssec-keymgr.rst +.. include:: ../../bin/dnssec/dnssec-keyfromlabel.rst +.. include:: ../../bin/dnssec/dnssec-keygen.rst +.. include:: ../../bin/dnssec/dnssec-revoke.rst +.. include:: ../../bin/dnssec/dnssec-settime.rst +.. include:: ../../bin/dnssec/dnssec-signzone.rst +.. include:: ../../bin/dnssec/dnssec-verify.rst +.. include:: ../../bin/tools/dnstap-read.rst .. include:: ../../bin/plugins/filter-aaaa.rst -.. include:: ../../bin/confgen/ddns-confgen.rst -.. include:: ../../bin/confgen/rndc-confgen.rst -.. include:: ../../bin/delv/delv.rst -.. include:: ../../bin/nsupdate/nsupdate.rst .. include:: ../../bin/dig/host.rst -.. include:: ../../bin/dig/dig.rst -.. include:: ../../bin/dig/nslookup.rst -.. include:: ../../bin/named/named.rst -.. include:: ../../bin/pkcs11/pkcs11-keygen.rst -.. include:: ../../bin/pkcs11/pkcs11-tokens.rst -.. include:: ../../bin/pkcs11/pkcs11-list.rst -.. include:: ../../bin/pkcs11/pkcs11-destroy.rst +.. include:: ../../bin/tools/mdig.rst .. include:: ../../bin/check/named-checkconf.rst .. include:: ../../bin/check/named-checkzone.rst +.. include:: ../../bin/tools/named-journalprint.rst +.. include:: ../../bin/tools/named-nzd2nzf.rst +.. include:: ../../bin/tools/named-rrchecker.rst +.. include:: ../../bin/named/named.rst +.. include:: ../../bin/tools/nsec3hash.rst +.. include:: ../../bin/dig/nslookup.rst +.. include:: ../../bin/nsupdate/nsupdate.rst +.. include:: ../../bin/pkcs11/pkcs11-destroy.rst +.. include:: ../../bin/pkcs11/pkcs11-keygen.rst +.. include:: ../../bin/pkcs11/pkcs11-list.rst +.. include:: ../../bin/pkcs11/pkcs11-tokens.rst +.. include:: ../../bin/confgen/rndc-confgen.rst +.. include:: ../../bin/rndc/rndc.conf.rst +.. include:: ../../bin/rndc/rndc.rst diff --git a/doc/arm/pkcs11.rst b/doc/arm/pkcs11.rst index c4494d16ae..ac6ebc5e00 100644 --- a/doc/arm/pkcs11.rst +++ b/doc/arm/pkcs11.rst @@ -8,66 +8,56 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _pkcs11: -PKCS#11 (Cryptoki) support +PKCS#11 (Cryptoki) Support -------------------------- -PKCS#11 (Public Key Cryptography Standard #11) defines a +Public Key Cryptography Standard #11 (PKCS#11) defines a platform-independent API for the control of hardware security modules (HSMs) and other cryptographic support devices. BIND 9 is known to work with three HSMs: The AEP Keyper, which has been -tested with Debian Linux, Solaris x86 and Windows Server 2003; the +tested with Debian Linux, Solaris x86, and Windows Server 2003; the Thales nShield, tested with Debian Linux; and the Sun SCA 6000 cryptographic acceleration board, tested with Solaris x86. In addition, BIND can be used with all current versions of SoftHSM, a software-based HSM simulator library produced by the OpenDNSSEC project. -PKCS#11 makes use of a "provider library": a dynamically loadable +PKCS#11 uses a "provider library": a dynamically loadable library which provides a low-level PKCS#11 interface to drive the HSM hardware. The PKCS#11 provider library comes from the HSM vendor, and it is specific to the HSM to be controlled. There are two available mechanisms for PKCS#11 support in BIND 9: -OpenSSL-based PKCS#11 and native PKCS#11. When using the first -mechanism, BIND uses a modified version of OpenSSL, which loads the +OpenSSL-based PKCS#11 and native PKCS#11. With OpenSSL-based PKCS#11, +BIND uses a modified version of OpenSSL, which loads the provider library and operates the HSM indirectly; any cryptographic operations not supported by the HSM can be carried out by OpenSSL -instead. The second mechanism enables BIND to bypass OpenSSL completely; +instead. Native PKCS#11 enables BIND to bypass OpenSSL completely; BIND loads the provider library itself, and uses the PKCS#11 API to drive the HSM directly. Prerequisites ~~~~~~~~~~~~~ -See the documentation provided by your HSM vendor for information about -installing, initializing, testing and troubleshooting the HSM. +See the documentation provided by the HSM vendor for information about +installing, initializing, testing, and troubleshooting the HSM. Native PKCS#11 ~~~~~~~~~~~~~~ -Native PKCS#11 mode will only work with an HSM capable of carrying out +Native PKCS#11 mode only works with an HSM capable of carrying out *every* cryptographic operation BIND 9 may need. The HSM's provider library must have a complete implementation of the PKCS#11 API, so that all these functions are accessible. As of this writing, only the Thales nShield HSM and SoftHSMv2 can be used in this fashion. For other HSMs, -including the AEP Keyper, Sun SCA 6000 and older versions of SoftHSM, +including the AEP Keyper, Sun SCA 6000, and older versions of SoftHSM, use OpenSSL-based PKCS#11. (Note: Eventually, when more HSMs become capable of supporting native PKCS#11, it is expected that OpenSSL-based PKCS#11 will be deprecated.) -To build BIND with native PKCS#11, configure as follows: +To build BIND with native PKCS#11, configure it as follows: :: @@ -90,13 +80,13 @@ https://github.com/opendnssec/SoftHSMv2. It is a software library developed by the OpenDNSSEC project (https://www.opendnssec.org) which provides a PKCS#11 interface to a virtual HSM, implemented in the form of a SQLite3 database on the local filesystem. It provides less security -than a true HSM, but it allows you to experiment with native PKCS#11 +than a true HSM, but it allows users to experiment with native PKCS#11 when an HSM is not available. SoftHSMv2 can be configured to use either OpenSSL or the Botan library to perform cryptographic functions, but when using it for native PKCS#11 in BIND, OpenSSL is required. -By default, the SoftHSMv2 configuration file is prefix/etc/softhsm2.conf -(where prefix is configured at compile time). This location can be +By default, the SoftHSMv2 configuration file is ``prefix/etc/softhsm2.conf`` +(where ``prefix`` is configured at compile time). This location can be overridden by the SOFTHSM2_CONF environment variable. The SoftHSMv2 cryptographic store must be installed and initialized before using it with BIND. @@ -123,11 +113,11 @@ There are two "flavors" of PKCS#11 support provided by the patched OpenSSL, one of which must be chosen at configuration time. The correct choice depends on the HSM hardware: -- Use 'crypto-accelerator' with HSMs that have hardware cryptographic +- Use "crypto-accelerator" with HSMs that have hardware cryptographic acceleration features, such as the SCA 6000 board. This causes OpenSSL to run all supported cryptographic operations in the HSM. -- Use 'sign-only' with HSMs that are designed to function primarily as +- Use "sign-only" with HSMs that are designed to function primarily as secure key storage devices, but lack hardware acceleration. These devices are highly secure, but are not necessarily any faster at cryptography than the system CPU MDASH often, they are slower. It is @@ -145,14 +135,13 @@ methods work with OpenSSL 1.0.0 through 1.0.2. .. note:: - The OpenSSL patches as of this writing (January 2016) support - versions 0.9.8zh, 1.0.0t, 1.0.1q and 1.0.2f. ISC will provide updated + ISC provides updated patches as new versions of OpenSSL are released. The version number in the following examples is expected to change. -Before building BIND 9 with PKCS#11 support, it will be necessary to +Before building BIND 9 with PKCS#11 support, it is necessary to build OpenSSL with the patch in place, and configure it with the path to -your HSM's PKCS#11 provider library. +the HSM's PKCS#11 provider library. Patching OpenSSL ^^^^^^^^^^^^^^^^ @@ -180,7 +169,7 @@ Apply the patch from the BIND 9 release: .. note:: The patch file may not be compatible with the "patch" utility on all - operating systems. You may need to install GNU patch. + operating systems; a GNU patch may need to be installed. When building OpenSSL, place it in a non-standard location so that it does not interfere with OpenSSL libraries elsewhere on the system. In @@ -195,8 +184,8 @@ Building OpenSSL for the AEP Keyper on Linux The AEP Keyper is a highly secure key storage device, but does not provide hardware cryptographic acceleration. It can carry out -cryptographic operations, but it is probably slower than your system's -CPU. Therefore, we choose the 'sign-only' flavor when building OpenSSL. +cryptographic operations, but it is probably slower than the system's +CPU. Therefore, we choose the "sign-only" flavor when building OpenSSL. The Keyper-specific PKCS#11 provider library is delivered with the Keyper software. In this example, we place it /opt/pkcs11/usr/lib: @@ -241,8 +230,8 @@ SoftHSM (version 1) is a software library developed by the OpenDNSSEC project (http://www.opendnssec.org) which provides a PKCS#11 interface to a virtual HSM, implemented in the form of a SQLite3 database on the local filesystem. SoftHSM uses the Botan library to perform -cryptographic functions. Though less secure than a true HSM, it can -allow you to experiment with PKCS#11 when an HSM is not available. +cryptographic functions. Though less secure than a true HSM, it +allows users to experiment with PKCS#11 when an HSM is not available. The SoftHSM cryptographic store must be installed and initialized before using it with OpenSSL, and the SOFTHSM_CONF environment variable must @@ -259,8 +248,8 @@ always point to the SoftHSM configuration file: $ /opt/pkcs11/usr/bin/softhsm --init-token 0 --slot 0 --label softhsm SoftHSM can perform all cryptographic operations, but since it only uses -your system CPU, there is no advantage to using it for anything but -signing. Therefore, we choose the 'sign-only' flavor when building +the system CPU, there is no advantage to using it for anything but +signing. Therefore, we choose the "sign-only" flavor when building OpenSSL. :: @@ -271,10 +260,10 @@ OpenSSL. --pk11-flavor=sign-only \ --prefix=/opt/pkcs11/usr -After configuring, run "``make``" and "``make test``". +After configuring, run ``make`` and ``make test``. -Once you have built OpenSSL, run "``apps/openssl engine pkcs11``" to -confirm that PKCS#11 support was compiled in correctly. The output +Once OpenSSL is built, run ``apps/openssl engine pkcs11`` to +confirm that PKCS#11 support was compiled correctly. The output should be one of the following lines, depending on the flavor selected: :: @@ -287,11 +276,11 @@ Or: (pkcs11) PKCS #11 engine support (crypto accelerator) -Next, run "``apps/openssl engine pkcs11 -t``". This will attempt to +Next, run ``apps/openssl engine pkcs11 -t``. This attempts to initialize the PKCS#11 engine. If it is able to do so successfully, it -will report “``[ available ]``”. +reports ``[ available ]``. -If the output is correct, run "``make install``" which will install the +If the output is correct, run ``make install`` to install the modified OpenSSL suite to ``/opt/pkcs11/usr``. Configuring BIND 9 for Linux with the AEP Keyper @@ -316,9 +305,9 @@ Configuring BIND 9 for Solaris with the SCA 6000 (For a 32-bit build, omit CC="cc -xarch=amd64".) -If configure complains about OpenSSL not working, you may have a -32/64-bit architecture mismatch. Or, you may have incorrectly specified -the path to OpenSSL (it should be the same as the --prefix argument to +If configure complains about OpenSSL not working, there may be a +32/64-bit architecture mismatch, or +the path to OpenSSL may have been incorrectly specified; it should be the same as the --prefix argument to the OpenSSL Configure). Configuring BIND 9 for SoftHSM @@ -331,11 +320,11 @@ Configuring BIND 9 for SoftHSM --with-openssl=/opt/pkcs11/usr \ --with-pkcs11=/opt/pkcs11/usr/lib/libsofthsm.so -After configuring, run "``make``", "``make test``" and -"``make install``". +After configuring, run ``make``, ``make test``, and +``make install``. -(Note: If "make test" fails in the "pkcs11" system test, you may have -forgotten to set the SOFTHSM_CONF environment variable.) +(Note: If ``make test`` fails in the "pkcs11" system test, +the SOFTHSM_CONF environment variable may not have been set.) PKCS#11 Tools ~~~~~~~~~~~~~ @@ -346,16 +335,16 @@ BIND 9 includes a minimal set of tools to operate the HSM, including to remove objects, and ``pkcs11-tokens`` to list available tokens. In UNIX/Linux builds, these tools are built only if BIND 9 is configured -with the --with-pkcs11 option. (Note: If --with-pkcs11 is set to "yes", -rather than to the path of the PKCS#11 provider, then the tools will be -built but the provider will be left undefined. Use the -m option or the +with the ``--with-pkcs11`` option. (Note: If ``--with-pkcs11`` is set to ``yes``, +rather than to the path of the PKCS#11 provider, the tools are +built but the provider is left undefined. Use the -m option or the PKCS11_PROVIDER environment variable to specify the path to the provider.) Using the HSM ~~~~~~~~~~~~~ -For OpenSSL-based PKCS#11, we must first set up the runtime environment +For OpenSSL-based PKCS#11, the runtime environment must first be set up so the OpenSSL and PKCS#11 libraries can be loaded: :: @@ -363,7 +352,7 @@ so the OpenSSL and PKCS#11 libraries can be loaded: $ export LD_LIBRARY_PATH=/opt/pkcs11/usr/lib:${LD_LIBRARY_PATH} This causes ``named`` and other binaries to load the OpenSSL library -from ``/opt/pkcs11/usr/lib`` rather than from the default location. This +from ``/opt/pkcs11/usr/lib``, rather than from the default location. This step is not necessary when using native PKCS#11. Some HSMs require other environment variables to be set. For example, @@ -381,8 +370,8 @@ uses the HSM, including ``pkcs11-keygen``, ``pkcs11-list``, ``pkcs11-destroy``, ``dnssec-keyfromlabel``, ``dnssec-signzone``, ``dnssec-keygen``, and ``named``. -We can now create and use keys in the HSM. In this case, we will create -a 2048 bit key and give it the label "sample-ksk": +We can now create and use keys in the HSM. In this case, we are creating +a 2048-bit key and giving it the label "sample-ksk": :: @@ -399,7 +388,7 @@ To confirm that the key exists: Before using this key to sign a zone, we must create a pair of BIND 9 key files. The "dnssec-keyfromlabel" utility does this. In this case, we -will be using the HSM key "sample-ksk" as the key-signing key for +are using the HSM key "sample-ksk" as the key-signing key for "example.net": :: @@ -408,16 +397,16 @@ will be using the HSM key "sample-ksk" as the key-signing key for The resulting K*.key and K*.private files can now be used to sign the zone. Unlike normal K\* files, which contain both public and private key -data, these files will contain only the public key data, plus an +data, these files contain only the public key data, plus an identifier for the private key which remains stored within the HSM. Signing with the private key takes place inside the HSM. -If you wish to generate a second key in the HSM for use as a +To generate a second key in the HSM for use as a zone-signing key, follow the same procedure above, using a different -keylabel, a smaller key size, and omitting "-f KSK" from the -dnssec-keyfromlabel arguments: +keylabel, a smaller key size, and omitting ``-f KSK`` from the +``dnssec-keyfromlabel`` arguments: -(Note: When using OpenSSL-based PKCS#11 the label is an arbitrary string +(Note: When using OpenSSL-based PKCS#11, the label is an arbitrary string which identifies the key. With native PKCS#11, the label is a PKCS#11 URI string which may include other details about the key and the HSM, including its PIN. See :ref:`man_dnssec-keyfromlabel` for details.) @@ -427,8 +416,8 @@ including its PIN. See :ref:`man_dnssec-keyfromlabel` for details.) $ pkcs11-keygen -b 1024 -l sample-zsk $ dnssec-keyfromlabel -l sample-zsk example.net -Alternatively, you may prefer to generate a conventional on-disk key, -using dnssec-keygen: +Alternatively, it may be preferable to generate a conventional on-disk key, +using ``dnssec-keygen``: :: @@ -437,13 +426,13 @@ using dnssec-keygen: This provides less security than an HSM key, but since HSMs can be slow or cumbersome to use for security reasons, it may be more efficient to reserve HSM keys for use in the less frequent key-signing operation. The -zone-signing key can be rolled more frequently, if you wish, to +zone-signing key can be rolled more frequently, if desired, to compensate for a reduction in key security. (Note: When using native PKCS#11, there is no speed advantage to using on-disk keys, as -cryptographic operations will be done by the HSM regardless.) +cryptographic operations are done by the HSM regardless.) -Now you can sign the zone. (Note: If not using the -S option to -``dnssec-signzone``, it will be necessary to add the contents of both +Now the zone can be signed. (Note: If not using the -S option to +``dnssec-signzone``, it is necessary to add the contents of both ``K*.key`` files to the zone master file before signing it.) :: @@ -456,18 +445,18 @@ Now you can sign the zone. (Note: If not using the -S option to Algorithm: NSEC3RSASHA1: ZSKs: 1, KSKs: 1 active, 0 revoked, 0 stand-by example.net.signed -Specifying the engine on the command line +Specifying the Engine on the Command Line ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When using OpenSSL-based PKCS#11, the "engine" to be used by OpenSSL can be specified in ``named`` and all of the BIND ``dnssec-*`` tools by -using the "-E " command line option. If BIND 9 is built with the ---with-pkcs11 option, this option defaults to "pkcs11". Specifying the -engine will generally not be necessary unless for some reason you wish -to use a different OpenSSL engine. +using the "-E " command-line option. If BIND 9 is built with the +``--with-pkcs11`` option, this option defaults to "pkcs11". Specifying the +engine is generally not necessary unless +using a different OpenSSL engine. -If you wish to disable use of the "pkcs11" engine MDASH for -troubleshooting purposes, or because the HSM is unavailable MDASH set +To disable use of the "pkcs11" engine - for +troubleshooting purposes, or because the HSM is unavailable - set the engine to the empty string. For example: :: @@ -475,16 +464,16 @@ the engine to the empty string. For example: $ dnssec-signzone -E '' -S example.net This causes ``dnssec-signzone`` to run as if it were compiled without -the --with-pkcs11 option. +the ``--with-pkcs11`` option. When built with native PKCS#11 mode, the "engine" option has a different meaning: it specifies the path to the PKCS#11 provider library. This may be useful when testing a new provider library. -Running named with automatic zone re-signing -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Running ``named`` with Automatic Zone Re-signing +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you want ``named`` to dynamically re-sign zones using HSM keys, +For ``named`` to dynamically re-sign zones using HSM keys, and/or to to sign new records inserted via nsupdate, then ``named`` must have access to the HSM PIN. In OpenSSL-based PKCS#11, this is accomplished by placing the PIN into the openssl.cnf file (in the above @@ -505,9 +494,9 @@ Sample openssl.cnf: [ pkcs11_section ] PIN = -This will also allow the dnssec-\* tools to access the HSM without PIN -entry. (The pkcs11-\* tools access the HSM directly, not via OpenSSL, so -a PIN will still be required to use them.) +This also allows the ``dnssec-\*`` tools to access the HSM without PIN +entry. (The ``pkcs11-\*`` tools access the HSM directly, not via OpenSSL, so +a PIN is still required to use them.) In native PKCS#11 mode, the PIN can be provided in a file specified as an attribute of the key's label. For example, if a key had the label @@ -517,5 +506,5 @@ be read from the file ``/etc/hsmpin``. .. warning:: Placing the HSM's PIN in a text file in this manner may reduce the - security advantage of using an HSM. Be sure this is what you want to - do before configuring the system in this way. + security advantage of using an HSM. Use caution + before configuring the system in this way. diff --git a/doc/arm/plugins.rst b/doc/arm/plugins.rst index e7f11988cc..dcd769aacd 100644 --- a/doc/arm/plugins.rst +++ b/doc/arm/plugins.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. _module-info: Plugins @@ -60,32 +50,32 @@ Multiple ``plugin`` statements can be specified, to load different plugins or multiple instances of the same plugin. ``parameters`` are passed as an opaque string to the plugin's initialization -routine. Configuration syntax will differ depending on the module. +routine. Configuration syntax differs depending on the module. Developing Plugins ~~~~~~~~~~~~~~~~~~ Each plugin implements four functions: -- plugin_register +- ``plugin_register`` to allocate memory, configure a plugin instance, and attach to hook points within - named + ``named`` , -- plugin_destroy +- ``plugin_destroy`` to tear down the plugin instance and free memory, -- plugin_version +- ``plugin_version`` to check that the plugin is compatible with the current version of the plugin API, -- plugin_check +- ``plugin_check`` to test syntactic correctness of the plugin parameters. At various locations within the ``named`` source code, there are "hook points" at which a plugin may register itself. When a hook point is reached while ``named`` is running, it is checked to see whether any plugins have registered themselves there; if so, the associated "hook -action" is called - this is a function within the plugin library. Hook -actions may examine the runtime state and make changes - for example, +action" - a function within the plugin library - is called. Hook +actions may examine the runtime state and make changes: for example, modifying the answers to be sent back to a client or forcing a query to be aborted. More details can be found in the file ``lib/ns/include/ns/hooks.h``. diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 10d2231676..3706397b7c 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -37,25 +37,25 @@ file documentation: The name of an ``address_match_list`` as defined by the ``acl`` statement. ``address_match_list`` - A list of one or more ``ip_addr``, ``ip_prefix``, ``key_id``, or ``acl_name`` elements, see :ref:`address_match_lists`. + A list of one or more ``ip_addr``, ``ip_prefix``, ``key_id``, or ``acl_name`` elements; see :ref:`address_match_lists`. ``primaries_list`` - A named list of one or more ``ip_addr`` with optional ``key_id`` and/or ``ip_port``. A ``primaries_list`` may include other ``primaries_lists``. + A named list of one or more ``ip_addr`` with optional ``key_id`` and/or ``ip_port``. A ``primaries_list`` may include other ``primaries_list``. ``domain_name`` - A quoted string which is used as a DNS name, for example "``my.test.domain``". + A quoted string which is used as a DNS name; for example. ``my.test.domain``. ``namelist`` A list of one or more ``domain_name`` elements. ``dotted_decimal`` - One to four integers valued 0 through 255 separated by dots ('.'), such as ``123``, ``45.67`` or ``89.123.45.67``. + One to four integers valued 0 through 255 separated by dots (``.``), such as ``123.45.67`` or ``89.123.45.67``. ``ip4_addr`` An IPv4 address with exactly four elements in ``dotted_decimal`` notation. ``ip6_addr`` - An IPv6 address, such as ``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 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, currently only interface names as link identifiers are supported, assuming one-to-one mapping between interfaces and links. For example, a link-local address ``fe80::1`` on the link attached to the interface ``ne0`` can be specified as ``fe80::1%ne0``. Note that on most systems link-local addresses always have ambiguity and need to be disambiguated. + 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 address ``fe80::1`` on the link attached to the interface ``ne0`` can be specified as ``fe80::1%ne0``. Note that on most systems link-local addresses always have ambiguity and need to be disambiguated. ``ip_addr`` An ``ip4_addr`` or ``ip6_addr``. @@ -67,14 +67,14 @@ file documentation: An IP port ``number``. The ``number`` 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. ``ip_prefix`` - An IP network specified as an ``ip_addr``, followed by a slash ('/') and then the number of bits in the netmask. Trailing zeros in an``ip_addr`` may omitted. For example, ``127/8`` is the network ``127.0.0.0`` with network ``1.2.3.0`` with netmask ``255.255.255.240``. - When specifying a prefix involving a IPv6 scoped address the scope may be omitted. In that case the prefix matches packets from any scope. + An IP network specified as an ``ip_addr``, followed by a slash (``/``) and then the number of bits in the netmask. Trailing zeros in an``ip_addr`` may be omitted. For example, ``127/8`` is the network ``127.0.0.0``with netmask ``255.0.0.0`` and ``1.2.3.0/28`` is network ``1.2.3.0`` with netmask ``255.255.255.240``. + When specifying a prefix involving a IPv6-scoped address, the scope may be omitted. In that case, the prefix matches packets from any scope. ``key_id`` A ``domain_name`` representing the name of a shared key, to be used for transaction security. ``key_list`` - A list of one or more ``key_id``\ s, separated by semicolons and ending with a semicolon. + A list of one or more ``key_id``, separated by semicolons and ending with a semicolon. ``number`` 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. @@ -86,15 +86,15 @@ file documentation: A quoted string which is used as a pathname, such as ``zones/master/my.test.domain``. ``port_list`` - A list of an ``ip_port`` or a port range. A port range is specified in the form of ``range`` followed by two ``ip_port``\ s, ``port_low`` and ``port_high``, which represents port numbers from ``port_low`` through ``port_high``, inclusive. ``port_low`` must not be larger than ``port_high``. For example, ``range 1024 65535`` represents ports from 1024 through 65535. In either case an asterisk ('\*') character is not allowed as a valid ``ip_port``. + A list of an ``ip_port`` or a port range. A port range is specified in the form of ``range`` followed by two ``ip_port``s, ``port_low`` and ``port_high``, which represents port numbers from ``port_low`` through ``port_high``, inclusive. ``port_low`` must not be larger than ``port_high``. For example, ``range 1024 65535`` represents ports from 1024 through 65535. In either case an asterisk (``*``) character is not allowed as a valid ``ip_port``. ``size_spec`` - A 64-bit unsigned integer, or the keywords ``unlimited`` or ``default``. 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 use ``size_spec`` for details on how they interpret its use. Numeric values can optionally be followed by a scaling factor: ``K`` or ``k`` for kilobytes, ``M`` or ``m`` for megabytes, and ``G`` or ``g`` for gigabytes, which scale by 1024, 1024*1024, and 1024*1024*1024 respectively. + A 64-bit unsigned integer, or the keywords ``unlimited`` or ``default``. 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 use ``size_spec`` for details on how they interpret its use. Numeric values can optionally be followed by a scaling factor: ``K`` or ``k`` for kilobytes, ``M`` or ``m`` for megabytes, and ``G`` or ``g`` for gigabytes, which scale by 1024, 1024*1024, and 1024*1024*1024 respectively. ``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. ``size_or_percent`` - A ``size_spec`` or integer value followed by '%' to represent percent. The behavior is exactly the same as ``size_spec``, but ``size_or_percent`` also allows specifying a positive integer value followed by the '%' sign to represent percent. + A ``size_spec`` or integer value followed by ``%`` to represent percent. The behavior is exactly the same as ``size_spec``, but ``size_or_percent`` also allows specifying a positive integer value followed by the ``%`` sign to represent percent. ``yes_or_no`` Either ``yes`` or ``no``. The words ``true`` and ``false`` are also accepted, as are the numbers ``1`` and ``0``. @@ -127,7 +127,7 @@ list can be any of the following: - an IP address (IPv4 or IPv6) -- an IP prefix (in '/' notation) +- an IP prefix (in ``/`` notation) - a key ID, as defined by the ``key`` statement @@ -172,15 +172,15 @@ 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 having 1.2.3.13 blocked -by the negation, but all other 1.2.3.\* hosts pass through. +``! 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. .. _comment_syntax: Comment Syntax ~~~~~~~~~~~~~~ -The BIND 9 comment syntax allows for comments to appear anywhere that +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. @@ -233,7 +233,7 @@ multiple lines, each line must use the // pair. For example: // is a new comment, even though it is logically // part of the previous comment. -Shell-style (or perl-style, if you prefer) comments start with the +Shell-style (or perl-style) comments start with the character ``#`` (number sign) and continue to the end of the physical line, as in C++ comments. For example: @@ -279,7 +279,7 @@ The following statements are supported: Specifies key information for use in authentication and authorization using TSIG. ``logging`` - Specifies what the server logs, and where the log messages are sent. + Specifies what information the server logs and where the log messages are sent. ``masters`` Synonym for ``primaries``. @@ -327,7 +327,7 @@ configuration. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``acl`` statement assigns a symbolic name to an address match list. -It gets its name from a primary use of address match lists: Access +It gets its name from one of the primary uses of address match lists: Access Control Lists (ACLs). The following ACLs are built-in: @@ -342,7 +342,7 @@ The following ACLs are built-in: 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 a case, ``localnets`` only matches the local IPv6 addresses, just like ``localhost``. + 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 like ``localhost``. .. _controls_grammar: @@ -357,7 +357,7 @@ The following ACLs are built-in: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``controls`` statement declares control channels to be used by -system administrators to control the operation of the name server. These +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. @@ -370,7 +370,7 @@ IPv4 addresses. To listen on the IPv6 wildcard address, use an 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 +If no port is specified, port 953 is used. The asterisk ``*`` cannot be used for ``ip_port``. The ability to issue commands over the control channel is restricted by @@ -386,7 +386,7 @@ the ``perm``, ``owner``, and ``group`` clauses. Note that on some platforms directory as the permissions on the socket itself are ignored. The primary authorization mechanism of the command channel is the -``key_list``, which contains a list of ``key_id``\ s. Each ``key_id`` in +``key_list``, which contains a list of ``key_id``s. Each ``key_id`` in the ``key_list`` is authorized to execute commands over the control channel. See :ref:`admin_tools` for information about configuring keys in ``rndc``. @@ -402,8 +402,8 @@ 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 ``rndc.key`` in ``/etc`` -(or whatever ``sysconfdir`` was specified as when BIND was built). To -create a ``rndc.key`` file, run ``rndc-confgen -a``. +(or whatever ``sysconfdir`` was specified when BIND was built). To +create an ``rndc.key`` file, run ``rndc-confgen -a``. To disable the command channel, use an empty ``controls`` statement: ``controls { };``. @@ -450,19 +450,19 @@ statements can be used in all views. Keys intended for use in a ``controls`` statement (see :ref:`controls_statement_definition_and_usage`) must be defined at the top level. -The key_id, also known as the key name, is a domain name uniquely -identifying the key. It can be used in a ``server`` statement to cause +The ``key_id``, 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. -The algorithm_id is a string that specifies a security/authentication +The ``algorithm_id`` is a string that specifies a security/authentication algorithm. The ``named`` server supports ``hmac-md5``, ``hmac-sha1``, ``hmac-sha224``, ``hmac-sha256``, ``hmac-sha384``, and ``hmac-sha512`` TSIG authentication. Truncated hashes are supported by appending the minimum number of required bits preceded by a dash, e.g., -``hmac-sha1-80``. The secret_string is the secret to be used by the -algorithm, and is treated as a Base64 encoded string. +``hmac-sha1-80``. The ``secret_string`` is the secret to be used by the +algorithm, and is treated as a Base64-encoded string. .. _logging_grammar: @@ -523,7 +523,7 @@ 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 severity level +``named``-generated time stamp, the category name, and/or the severity level (the default is not to include any). The ``null`` destination clause causes all messages sent to the channel @@ -562,7 +562,7 @@ suffixes; older files are renamed when rolling. For example, if is renamed to ``filename.log.1``, and ``filename.log`` is renamed to ``filename.log.0``, whereupon a new ``filename.log`` is opened. -Example usage of the ``size``, ``versions``, and ``suffix`` options: +Here is an example using the ``size``, ``versions``, and ``suffix`` options: :: @@ -581,12 +581,12 @@ page. Known facilities are ``kern``, ``user``, ``mail``, ``daemon``, facilities are supported on all operating systems. How ``syslog`` handles messages sent to this facility is described in the ``syslog.conf`` man page. On a system which uses a very old -version of ``syslog``, that only uses two arguments to the ``openlog()`` +version of ``syslog``, which only uses two arguments to the ``openlog()`` function, this clause is silently ignored. -On Windows machines syslog messages are directed to the EventViewer. +On Windows machines, syslog messages are directed to the EventViewer. -The ``severity`` clause works like ``syslog``'s "priorities", except +The ``severity`` clause works like ``syslog``'s "priorities," except that they can also be used when writing straight to a file rather than using ``syslog``. Messages which are not at least of the severity level given are not selected for the channel; messages of higher @@ -602,8 +602,8 @@ then ``syslogd`` would print all messages it received from the channel. The ``stderr`` destination clause directs the channel to the server's standard error stream. This is intended for use when the server is -running as a foreground process, for example when debugging a -configuration. +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, @@ -632,7 +632,7 @@ specifier, which may be one of ``local``, ``iso8601``, or ``iso8601-utc``. If set to ``no``, the date and time are not logged. If set to ``yes`` or ``local``, the date and time are logged in a human-readable format, using the local time zone. If set to -``iso8601`` the local time is logged in ISO 8601 format. If set to +``iso8601``, the local time is logged in ISO 8601 format. If set to ``iso8601-utc``, the date and time are logged in ISO 8601 format, with time zone set to UTC. The default is ``no``. @@ -652,8 +652,8 @@ 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 ``-L`` then a fifth -channel ``default_logfile`` is added. How they are used is described in +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 :ref:`the_category_phrase`. :: @@ -696,13 +696,13 @@ channel ``default_logfile`` is added. How they are used is described in }; The ``default_debug`` channel has the special property that it only -produces output when the server's debug level is nonzero. It normally +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 +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 up -and still running as root is discarded. To capture this +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. @@ -726,7 +726,7 @@ default category is specified, the following "default default" is used: category default { default_syslog; default_debug; }; -If ``named`` is started with the ``-L`` option then the default category +If ``named`` is started with the ``-L`` option, the default category is: :: @@ -756,7 +756,7 @@ To discard all messages in a category, specify the ``null`` channel: category xfer-out { null; }; category notify { null; }; -Following are the available categories and brief descriptions of the +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. @@ -772,7 +772,7 @@ 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`` levels of 1 or higher - or at ``info`` when query logging is +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`` @@ -812,7 +812,7 @@ meaning of the other fields is summarized in the following list. 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 the ``domain`` zone. + 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 the ``domain`` zone. ``qrysent`` The number of queries the resolver sent at the ``domain`` zone. @@ -827,7 +827,7 @@ meaning of the other fields is summarized in the following list. 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 the remote server is unreachable and the resolver receives an ICMP unreachable error message. + 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 the ``domain`` zone. @@ -836,7 +836,7 @@ meaning of the other fields is summarized in the following list. 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 of resolving remote server addresses. This is a total number of failures throughout the eesolution process. + 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 in ``domain``. @@ -853,14 +853,14 @@ responses such as NXDOMAIN. .. _primaries_grammar: ``primaries`` Statement Grammar -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. include:: ../misc/primaries.grammar.rst .. _primaries_statement: ``primaries`` Statement 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 @@ -899,18 +899,18 @@ default is used. statements, in which case it overrides the global ``attach-cache`` option. - The cache_name specifies the cache to be shared. When the ``named`` + The ``cache_name`` specifies the cache to be shared. When the ``named`` 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 would be to allow all views - to share a single cache. This can be done by specifying the + 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 to retain their own caches. For example, if + 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: @@ -943,7 +943,7 @@ default is used. 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 configuration differences in + administrator's responsibility to ensure that configuration differences in different views do not cause disruption with a shared cache. ``directory`` @@ -1029,7 +1029,7 @@ default is used. - ``fstrm-set-reopen-interval``: 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 + 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 @@ -1158,17 +1158,17 @@ default is used. 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 keytab file can be - overridden using the tkey-gssapi-keytab option. Normally this + file, normally ``/etc/krb5.keytab``. The location of the keytab file can be + overridden using the ``tkey-gssapi-keytab`` option. Normally this principal is of the form ``DNS/server.domain``. To use GSS-TSIG, ``tkey-domain`` must also be set if a specific keytab is - not set with tkey-gssapi-keytab. + not set with ``tkey-gssapi-keytab``. ``tkey-domain`` This domain is appended to the names of all shared keys generated with ``TKEY``. When a client requests a ``TKEY`` exchange, it may or may not specify the desired name for the key. If present, the name of the - shared key is ``client specified part`` + ``tkey-domain``. + shared key is ``client-specified part`` + ``tkey-domain``. Otherwise, the name of the shared key is ``random hex digits`` + ``tkey-domain``. In most cases, the ``domainname`` should be the server's domain name, or an otherwise nonexistent @@ -1197,7 +1197,7 @@ default is used. ``lock-file`` This is the pathname of a file on which ``named`` attempts to acquire a - file lock when starting up for the first time; if unsuccessful, the + file lock when starting for the first time; if unsuccessful, the server terminates, under the assumption that another server is already running. If not specified, the default is ``none``. @@ -1218,7 +1218,7 @@ default is used. enclosed in double quotes. ``recursing-file`` - This is the pathname of the file the server dumps the queries that are + 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 is ``named.recursing``. @@ -1255,7 +1255,7 @@ default is used. hmac-md5. If not specified, the default is hmac-sha256. ``port`` - This is the UDP/TCP port number the server uses for receiving and sending DNS + 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. @@ -1299,8 +1299,8 @@ default is used. This turns on enforcement of delegation-only in TLDs (top-level domains) and root zones with an optional exclude list. - DS queries are expected to be made to and be answered by delegation - only zones. Such queries and responses are treated as an exception to + DS queries are expected to be made to and be answered by delegation-only + zones. Such queries and responses are treated as an exception to delegation-only processing and are not converted to NXDOMAIN responses, provided a CNAME is not discovered at the query name. @@ -1313,13 +1313,13 @@ default is used. authority section is examined to see if there is evidence that the answer is from the child zone. Answers that are determined to be from a child zone are not converted to NXDOMAIN responses. Despite - all these checks there is still a possibility of false negatives when + all these checks, there is still a possibility of false negatives when a child zone is being served. Similarly, false positives can arise from empty nodes (no records at the name) in the delegation-only zone when the query type is not ``ANY``. - Note that some TLDs are not delegation-only; e.g., "DE", "LV", "US" and + Note that some TLDs are not delegation-only; e.g., "DE", "LV", "US", and "MUSEUM". This list is not exhaustive. :: @@ -1331,23 +1331,23 @@ default is used. ``disable-algorithms`` This disables the specified DNSSEC algorithms at and below the specified name. Multiple ``disable-algorithms`` statements are allowed. Only - the best match ``disable-algorithms`` clause is used to - determine which algorithms are used. + the best-match ``disable-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`` (or ``managed-keys`` or ``trusted-keys``) that match a disabled algorithm are ignored and treated - as if they were not configured at all. + as if they were not configured. ``disable-ds-digests`` This disables the specified DS digest types at and below the specified name. Multiple ``disable-ds-digests`` statements are allowed. Only - the best match ``disable-ds-digests`` clause is used to + the best-match ``disable-ds-digests`` clause is used to determine the digest types. - If all supported digest types are disabled, the zones covered by the + If all supported digest types are disabled, the zones covered by ``disable-ds-digests`` are treated as insecure. ``dnssec-must-be-secure`` @@ -1365,7 +1365,7 @@ default is used. 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 + :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 @@ -1395,10 +1395,10 @@ default is used. ``::``. The bits matching the prefix and mapped IPv4 address must be zero. - If ``recursive-only`` is set to ``yes`` the DNS64 synthesis only + If ``recursive-only`` is set to ``yes``, the DNS64 synthesis only happens for recursive queries. The default is ``no``. - If ``break-dnssec`` is set to ``yes`` the DNS64 synthesis happens + If ``break-dnssec`` is set to ``yes``, the DNS64 synthesis happens even if the result, if validated, would cause a DNSSEC validation failure. If this option is set to ``no`` (the default), the DO is set on the incoming query, and there are RRSIGs on the applicable @@ -1416,7 +1416,7 @@ default is used. }; ``dnssec-loadkeys-interval`` - When a zone is configured with ``auto-dnssec maintain;`` its key + When a zone is configured with ``auto-dnssec maintain;``, its key repository must be checked periodically to see if any new keys have been added or any existing keys' timing metadata has been updated (see :ref:`man_dnssec-keygen` and :ref:`man_dnssec-settime`). @@ -1436,7 +1436,7 @@ default is used. ``dnssec-update-mode`` If this option is set to its default value of ``maintain`` in a zone - of type ``master`` which is DNSSEC-signed and configured to allow + of type ``primary`` which is DNSSEC-signed and configured to allow dynamic updates (see :ref:`dynamic_update_policies`), and if ``named`` has access to the private signing key(s) for the zone, then ``named`` automatically signs all new or changed records and maintains signatures @@ -1465,7 +1465,7 @@ default is used. rather than bogus. This continues until the NTA's lifetime has elapsed. NTAs persist across ``named`` restarts. - For convenience, TTL-style time unit suffixes can be used to specify the NTA + 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. @@ -1486,7 +1486,7 @@ default is used. Validity checks can be disabled for an individual NTA by using ``rndc nta -f``, or for all NTAs by setting ``nta-recheck`` to zero. - For convenience, TTL-style time unit suffixes can be used to specify the NTA + 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. @@ -1495,7 +1495,7 @@ default is used. ``max-zone-ttl`` This specifies a maximum permissible TTL value in seconds. For - convenience, TTL-style time unit suffixes may be used to specify the + convenience, TTL-style time-unit suffixes may be used to specify the maximum value. When loading a zone file using a ``masterfile-format`` of ``text`` or ``raw``, any record encountered with a TTL higher than ``max-zone-ttl`` causes the zone to be rejected. @@ -1505,7 +1505,7 @@ default is used. have expired from caches. The ``max-zone-ttl`` option guarantees that the largest TTL in the zone is no higher than the set value. - (NOTE: Because ``map``-format files load directly into memory, this + (Note: because ``map``-format files load directly into memory, this option cannot be used with them.) The default value is ``unlimited``. A ``max-zone-ttl`` of zero is @@ -1572,7 +1572,7 @@ Boolean Options 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 has to + network interface discovery; therefore, the operating system must support the routing sockets for this feature to work. ``allow-new-zones`` @@ -1596,8 +1596,7 @@ Boolean Options ``auth-nxdomain`` If ``yes``, then the ``AA`` bit is always set on NXDOMAIN responses, even if the server is not actually authoritative. The default is - ``no``. If using very old DNS software, this may need to be set - to ``yes``. + ``no``. ``deallocate-on-exit`` This option was used in BIND 8 to enable checking for memory leaks on @@ -1605,8 +1604,8 @@ Boolean Options ``memstatistics`` This writes memory statistics to the file specified by - ``memstatistics-file`` at exit. The default is ``no`` unless '-m - record' is specified on the command line, in which case it is ``yes``. + ``memstatistics-file`` at exit. The default is ``no`` unless ``-m + record`` is specified on the command line, in which case it is ``yes``. ``dialup`` If ``yes``, then the server treats all zones as if they are doing @@ -1638,7 +1637,7 @@ Boolean Options NOTIFY messages; ``notify-passive``, which sends NOTIFY messages and suppresses the normal refresh queries; ``refresh``, which suppresses normal refresh processing and sends refresh queries when the - ``heartbeat-interval`` expires; and ``passive``, which just disables + ``heartbeat-interval`` expires; and ``passive``, which disables normal refresh processing. +--------------------+-----------------+-----------------+-----------------+ @@ -1664,7 +1663,7 @@ Boolean Options ``flush-zones-on-shutdown`` 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``. + ``flush-zones-on-shutdown no``. ``geoip-use-ecs`` This option was part of an experimental implementation of the EDNS @@ -1725,8 +1724,8 @@ Boolean Options ``minimal-any`` If set to ``yes``, the server replies with only one of - the RRsets for the query name when generating a positive response to a - query of type ANY over UDP, and its covering RRSIGs if any, + 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 @@ -1888,7 +1887,7 @@ Boolean Options ``response-padding`` The EDNS Padding option is intended to improve confidentiality when - DNS queries are sent over an encrypted channel by reducing the + DNS queries are sent over an encrypted channel, by reducing the variability in packet sizes. If a query: 1. contains an EDNS Padding option, @@ -1939,13 +1938,13 @@ Boolean Options See the description of ``request-expire`` in :ref:`server_statement_definition_and_usage`. ``match-mapped-addresses`` - If ``yes``, then an IPv4-mapped IPv6 address matches any address - match list entries that match the corresponding IPv4 address. + 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. + 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. @@ -1965,8 +1964,8 @@ Boolean Options 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 accepts ``master`` (or ``primary``) - and ``slave`` (or ``secondary``) at the view and options levels, + ``ixfr-from-differences`` also accepts ``primary`` + and ``secondary`` at the view and options levels, which causes ``ixfr-from-differences`` to be enabled for all primary or secondary zones, respectively. It is off for all zones by default. @@ -2064,7 +2063,7 @@ Boolean Options ``querylog`` 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. + cost to performance which may be significant on heavily loaded servers. The ``querylog`` option specifies whether query logging should be active when ``named`` first starts. If ``querylog`` is not specified, then query logging @@ -2074,7 +2073,7 @@ Boolean Options ``check-names`` This option is used to restrict the character set and syntax of - certain domain names in master files and/or DNS responses received + certain domain names in primary files and/or DNS responses received from the network. The default varies according to usage area. For ``primary`` zones the default is ``fail``. For ``secondary`` zones the default is ``warn``. For answers received from the network @@ -2085,7 +2084,7 @@ Boolean Options ``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 also applies to the RDATA of PTR records where the + 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). @@ -2110,9 +2109,9 @@ Boolean Options 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 + 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 use + are checked (for out-of-zone names and glue consistency checks, use ``named-checkzone``). The default is ``yes``. The use of the SPF record to publish Sender Policy Framework is @@ -2145,7 +2144,7 @@ Boolean Options The default is ``yes``. ``zero-no-soa-ttl-cache`` - If ``yes``, when caching a negative response to a SOA query set the TTL to zero. + If ``yes``, when caching a negative response to an SOA query set the TTL to zero. The default is ``no``. ``update-check-ksk`` @@ -2159,7 +2158,7 @@ Boolean Options apex. However, if this option is set to ``no``, then the KSK bit is ignored; KSKs are treated as if they were ZSKs and are used to sign the entire zone. This is similar to the ``dnssec-signzone -z`` - command line option. + command-line option. When this option is set to ``yes``, there must be at least two active keys for every algorithm represented in the DNSKEY RRset: at least @@ -2173,7 +2172,7 @@ Boolean Options used to sign the DNSKEY, CDNSKEY, and CDS RRsets at the zone apex. Zone-signing keys (keys without the KSK bit set) are used to sign the remainder of the zone, but not the DNSKEY RRset. This is similar - to the ``dnssec-signzone -x`` command line option. + to the ``dnssec-signzone -x`` command-line option. The default is ``no``. If ``update-check-ksk`` is set to ``no``, this option is ignored. @@ -2313,7 +2312,7 @@ for details on how to specify IP address lists. This specifies which local addresses can send answers from the cache. If ``allow-query-cache-on`` is not set, then ``allow-recursion-on`` is used if set. Otherwise, the default is to allow cache responses to be - sent from any address. Note: Both ``allow-query-cache`` and + sent from any address. Note: both ``allow-query-cache`` and ``allow-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. @@ -2321,7 +2320,7 @@ for details on how to specify IP address lists. ``allow-recursion`` 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 and allow-query. If neither of those parameters + order: ``allow-query-cache`` and ``allow-query``. If neither of those parameters is set, the default (localnets; localhost;) is used. ``allow-recursion-on`` @@ -2329,7 +2328,7 @@ for details on how to specify IP address lists. ``allow-recursion-on`` is not set, then ``allow-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 which ``named`` is listening. Note: Both + send them to any address on which ``named`` is listening. Note: both ``allow-recursion`` and ``allow-recursion-on`` must be satisfied before recursion is allowed; a client that is blocked by one cannot be allowed by the other. @@ -2342,7 +2341,7 @@ for details on how to specify IP address lists. Note that allowing updates based on the requestor's IP address is insecure; see :ref:`dynamic_update_security` for details. - In general this option should only be set at the ``zone`` level. + In general, this option should only be set at the ``zone`` level. While a default value can be set at the ``options`` or ``view`` level and inherited by zones, this could lead to some zones unintentionally allowing updates. @@ -2386,7 +2385,7 @@ for details on how to specify IP address lists. ``blackhole`` 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 - be responded to. The default is ``none``. + responded to. The default is ``none``. ``keep-response-order`` This specifies a list of addresses to which the server sends responses @@ -2403,14 +2402,14 @@ for details on how to specify IP address lists. If left undefined, the ACL defaults to ``none``: case-insensitive compression is used for all clients. If the ACL is defined and - matches a client, then case is ignored when compressing domain + 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 matching 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. @@ -2426,7 +2425,7 @@ for details on how to specify IP address lists. 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 + type NS, MX, CNAME, etc.) always have their case preserved unless the client matches this ACL. ``resolver-query-timeout`` @@ -2449,7 +2448,7 @@ addresses are ignored, with a logged warning.) The server listens on all interfaces allowed by the address match list. If a port is not specified, port 53 is used. -Multiple ``listen-on`` statements are allowed. For example, +Multiple ``listen-on`` statements are allowed. For example: :: @@ -2468,7 +2467,7 @@ ports on which the server listens for incoming queries sent using IPv6. If not specified, the server listens on port 53 on all IPv6 interfaces. -Multiple ``listen-on-v6`` options can be used. For example, +Multiple ``listen-on-v6`` options can be used. For example: :: @@ -2480,7 +2479,7 @@ single wildcard socket), and on port 1234 of IPv6 addresses that are not in the prefix 2001:db8::/32 (with separate sockets for each matched address). -To make the server not listen on any IPv6 address, use +To instruct the server not to listen on any IPv6 address, use: :: @@ -2524,18 +2523,18 @@ system default range; otherwise, it uses its own defaults: use-v6-udp-ports { range 1024 65535; }; .. note:: Make sure the ranges are sufficiently large for security. A - desirable size depends on various parameters, but we generally recommend + desirable size depends on several parameters, but we generally recommend it contain at least 16384 ports (14 bits of entropy). Note also that the system's default range when used may be too small for this purpose, and that the range may even be changed while ``named`` is running; the new range is automatically applied when ``named`` is reloaded. Explicit - configuration of use-v4-udp-ports and use-v6-udp-ports is encouraged, + configuration of ``use-v4-udp-ports`` and ``use-v6-udp-ports`` is encouraged, so that the ranges are sufficiently large and are reasonably independent from the ranges used by other applications. .. note:: The operational configuration where ``named`` runs may prohibit the use of some ports. For example, Unix systems do not allow - ``named``, if run without a root privilege, to use ports less than 1024. + ``named``, if run without root privilege, to use ports less than 1024. If such ports are included in the specified (or detected) set of query ports, the corresponding query attempts will fail, resulting in resolution failures or delay. It is therefore important to configure the @@ -2650,7 +2649,7 @@ options apply to zone transfers. ``one-answer`` and ``many-answers``. The ``transfer-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 a + ``many-answers`` packs as many resource records as possible into one message. ``many-answers`` is more efficient; the default is ``many-answers``. ``transfer-format`` may be overridden on a per-server basis by using the ``server`` statement. @@ -2676,19 +2675,19 @@ options apply to zone transfers. any benefit in setting a value other than the default. ``transfers-in`` - This is the maximum number of inbound zone transfers that can be running + This is the maximum number of inbound zone transfers that can run concurrently. The default value is ``10``. Increasing ``transfers-in`` may speed up the convergence of secondary zones, but it also may increase the load on the local system. ``transfers-out`` - This is the maximum number of outbound zone transfers that can be running + 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`` - This is the maximum number of inbound zone transfers that can be concurrently - transferring from a given remote name server. The default value is + This is the maximum number of inbound zone transfers that can concurrently + transfer from a given remote name server. The default value is ``2``. Increasing ``transfers-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 @@ -2699,7 +2698,7 @@ options apply to zone transfers. IPv4 TCP connections used to fetch zones transferred inbound by the server. It also determines the source IPv4 address, and optionally the UDP port, used for the refresh queries and forwarded dynamic - updates. If not set, it defaults to a system controlled value which + 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's ``allow-transfer`` option for the zone being transferred, if one is specified. This @@ -2771,7 +2770,7 @@ following ranges: 32768 to 39999, 40001 to 49999, and 60001 to 65535. ``named`` from choosing as its random source port a port that is blocked by a firewall or a port that is used by other applications; if a query went out with a source port blocked by a firewall, the answer -would not get by the firewall and the name server would have to query +would not pass through the firewall and the name server would have to query again. Note: the desired range can also be represented only with ``use-v4-udp-ports`` and ``use-v6-udp-ports``, and the ``avoid-`` options are redundant in that sense; they are provided for backward @@ -2868,7 +2867,7 @@ system. .. _clients-per-query: -``clients-per-query``; \ ``max-clients-per-query`` +``clients-per-query``; ``max-clients-per-query`` These set the initial value (minimum) and maximum number of recursive simultaneous clients for any given query () that the server accepts before dropping additional clients. ``named`` @@ -2909,7 +2908,7 @@ system. a zone are dropped with no response, or answered with SERVFAIL. The default is ``drop``. - If ``fetches-per-zone`` is set to zero, then there is no limit on the + 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. @@ -2932,11 +2931,11 @@ system. Optionally, this value may be followed by the keyword ``drop`` or ``fail``, indicating whether queries are dropped with no - response, or answered with SERVFAIL, when all of the servers + 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 is ``fail``. - If ``fetches-per-server`` is set to zero, then there is no limit on + 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. @@ -2967,7 +2966,7 @@ system. 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 + arguments are all fixed-point numbers with precision of 1/100; at most two places after the decimal point are significant. ``reserved-sockets`` @@ -2985,7 +2984,7 @@ system. This sets the maximum amount of memory to use for the server's cache, in bytes or percentage of total physical memory. When the amount of data in the cache reaches this limit, the server causes records to expire - prematurely based on an LRU-based strategy so that the limit is not + prematurely, following an LRU-based strategy, so that the limit is not exceeded. The keyword ``unlimited``, or the value 0, places no limit on the cache size; records are purged from the cache only when their TTLs expire. Any positive values less than 2MB are ignored @@ -2998,19 +2997,19 @@ system. memory is changed during runtime. ``tcp-listen-queue`` - This sets the listen queue depth. The default and minimum is 10. If the kernel + 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 that are queued in kernel space waiting for some - data before being passed to accept. Nonzero values less than 10 are + 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. + this sets the listen-queue length to a system-defined default value. ``tcp-initial-timeout`` 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 + 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``. @@ -3069,7 +3068,7 @@ Periodic Task Intervals by the operating system. After the scan, the server begins listening for queries on any newly discovered interfaces (provided they are allowed by the ``listen-on`` configuration), and stops listening on interfaces that have - gone away. For convenience, TTL-style time unit suffixes may be used to + gone away. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats. .. _the_sortlist_statement: @@ -3079,9 +3078,9 @@ 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 returna the RRs within the RRset in an indeterminate order (but +normally returns the RRs within the RRset in an indeterminate order (but see the ``rrset-order`` statement in :ref:`rrset_ordering`). The client resolver code should -rearrange the RRs as appropriate; that is, using any addresses on the +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 @@ -3096,7 +3095,7 @@ first element (which may be an IP address, an IP prefix, an ACL name, or a neste 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 +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 @@ -3106,14 +3105,14 @@ address in the response with the minimum distance is moved to the beginning of the response. In the following example, any queries received from any of the addresses -of the host itself will get responses preferring addresses on any of the +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 will +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 will only prefer other addresses on their +or the 192.168.5/24 network only prefer other addresses on their directly connected networks. :: @@ -3284,8 +3283,8 @@ Tuning ``min-ncache-ttl`` 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 + 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`` is ``0`` seconds. ``min-ncache-ttl`` cannot @@ -3294,7 +3293,7 @@ Tuning ``min-cache-ttl`` 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 + 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`` is ``0`` seconds. ``min-cache-ttl`` cannot @@ -3304,8 +3303,8 @@ Tuning ``max-ncache-ttl`` To reduce network traffic and increase performance, the server stores negative answers. ``max-ncache-ttl`` is used to set a maximum retention time - for these answers in the server in seconds. For convenience, TTL-style time - unit suffixes may be used to specify the value. It also accepts ISO 8601 + 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`` @@ -3314,7 +3313,7 @@ Tuning ``max-cache-ttl`` 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 + 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 @@ -3345,8 +3344,8 @@ Tuning This sets the base retry interval in milliseconds. The default is ``800``. ``sig-validity-interval`` - This specifies the number of days into the future when DNSSEC signatures - automatically generated as a result of dynamic updates + This specifies the number of days into the future that DNSSEC signatures + that are automatically generated as a result of dynamic updates (:ref:`dynamic_update`) will expire. There is an optional second field which specifies how long before expiry the signatures are regenerated. If not specified, the signatures are regenerated @@ -3375,32 +3374,32 @@ Tuning years), and higher values are rejected. ``sig-signing-nodes`` - This specifies the maximum number of nodes to be examined in each quantum + 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`` This specifies a threshold number of signatures that terminates - processing a quantum when signing a zone with a new DNSKEY. The + processing a quantum, when signing a zone with a new DNSKEY. The default is ``10``. ``sig-signing-type`` - This specifies a private RDATA type to be used when generating signing state + This specifies a private RDATA type to be used when generating signing-state records. The default is ``65534``. - It is expected that this parameter may be removed in a future version + This parameter may be removed in a future version, once there is a standard type. - Signing state records are used to internally by ``named`` to track + 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 command ``rndc signing -list zone``. Once ``named`` has - finished signing a zone with a particular key, the signing state + finished signing a zone with a particular key, the signing-state record associated with that key can be removed from the zone by running ``rndc signing -clear keyid/algorithm zone``. To clear all of - the completed signing state records for a zone, use + the completed signing-state records for a zone, use ``rndc signing -clear all zone``. -``min-refresh-time``; \ ``max-refresh-time``; \ ``min-retry-time``; \ ``max-retry-time`` +``min-refresh-time``; ``max-refresh-time``; ``min-retry-time``; ``max-retry-time`` These options control the server's behavior on refreshing a zone (querying for SOA changes) or retrying failed transfers. Usually the SOA values for the zone are used, up to a hard-coded maximum expiry @@ -3417,7 +3416,7 @@ Tuning 500 seconds, and ``max-retry-time`` 1209600 seconds (2 weeks). ``edns-udp-size`` - This sets the maximum advertised EDNS UDP buffer size in bytes, to control + 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. @@ -3439,12 +3438,12 @@ Tuning The default buffer sizes used by ``named`` are 512, 1232, 1432, and 4096, but never exceeding ``edns-udp-size``. (The values 1232 and - 1432 are chosen to allow for an IPv4/IPv6 encapsulated UDP message to - be sent without fragmentation at the minimum MTU sizes for Ethernet - and IPv6 networks.) + 1432 are chosen to allow for an IPv4-/IPv6-encapsulated UDP message + to be sent without fragmentation at the minimum MTU sizes for + Ethernet and IPv6 networks.) ``max-udp-size`` - This sets the maximum EDNS UDP message size that ``named`` sends in bytes. + 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. @@ -3453,7 +3452,7 @@ Tuning advertised buffer size in queries, see ``edns-udp-size``. The usual reason for setting ``max-udp-size`` to a non-default value - is to get UDP answers to pass through broken firewalls that block + 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``). @@ -3471,7 +3470,7 @@ Tuning 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 in the ``text`` format. In particular, + performed for a file in ``text`` format. In particular, ``check-names`` checks do not apply for the ``raw`` format. This means a zone file in the ``raw`` format must be generated with the same check level as that specified in the ``named`` configuration @@ -3484,7 +3483,7 @@ Tuning in the configuration file. ``masterfile-style`` - This specifies the formatting of zone files during dump when the + This specifies the formatting of zone files during dump, when the ``masterfile-format`` is ``text``. This option is ignored with any other ``masterfile-format``. @@ -3500,7 +3499,7 @@ Tuning 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 recursion exceeds + resolving another name, etc.; if the number of recursions exceeds this value, the recursive query is terminated and returns SERVFAIL. The default is 7. @@ -3510,10 +3509,10 @@ Tuning query is terminated and returns SERVFAIL. The default is 100. ``notify-delay`` - This sets the delay, in seconds, between sending sets of notify messages for a + This sets the delay, in seconds, between sending sets of NOTIFY messages for a zone. The default is 5 seconds. - The overall rate that NOTIFY messages are sent for all zones is + The overall rate at which NOTIFY messages are sent for all zones is controlled by ``serial-query-rate``. ``max-rsa-exponent-size`` @@ -3526,7 +3525,7 @@ Tuning ``named`` can refresh the data from the authoritative server immediately, ensuring that the cache always has an answer available. - The ``prefetch`` specifies the "trigger" TTL value at which prefetch + ``prefetch`` specifies the "trigger" TTL value at which prefetch of the current query takes place; when a cache record with a lower TTL value is encountered during query processing, it is refreshed. Valid trigger TTL values are 1 to 10 seconds. Values @@ -3553,7 +3552,7 @@ 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 :ref:`view_statement_grammar`) of class ``CHAOS`` which is +(see :ref:`view_statement_grammar`) 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 @@ -3577,7 +3576,7 @@ that matches all clients. This is the hostname the server should report via a query of the name ``hostname.bind`` with type ``TXT`` and class ``CHAOS``. This defaults to the hostname of the machine hosting the name server, as found by - the gethostname() function. The primary purpose of such queries is to + the ``gethostname()`` function. The primary purpose of such queries is to identify which of a group of anycast servers is actually answering the queries. Specifying ``hostname none;`` disables processing of the queries. @@ -3589,7 +3588,7 @@ that matches all clients. to identify which of a group of anycast servers is actually answering the queries. Specifying ``server-id none;`` disables processing of the queries. Specifying ``server-id hostname;`` causes ``named`` - to use the hostname as found by the gethostname() function. The + to use the hostname as found by the ``gethostname()`` function. The default ``server-id`` is ``none``. .. _empty: @@ -3609,7 +3608,7 @@ 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 in that case. +not create an empty zone if either is true. The current list of empty zones is: @@ -3757,7 +3756,7 @@ away from the infrastructure servers. Content Filtering ^^^^^^^^^^^^^^^^^ -BIND 9 provides the ability to filter out DNS responses from external +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 @@ -3777,7 +3776,7 @@ for example, even if "example.com" is specified for www.example.com. CNAME xxx.example.com. -returned by an "example.com" server will be accepted. +returned by an "example.com" server is accepted. In the ``address_match_list`` of the ``deny-answer-addresses`` option, only ``ip_addr`` and ``ip_prefix`` are meaningful; any ``key_id`` is @@ -3795,7 +3794,7 @@ 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 the attacks. +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 @@ -3839,7 +3838,7 @@ 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; it is generally discouraged to turn it on +operational environment; turning it on is generally discouraged unless there is no other choice and the attack is a real threat to applications. @@ -3860,7 +3859,7 @@ deny the existence of domains (NXDOMAIN), deny the existence of IP addresses for domains (NODATA), or contain other IP addresses or data. Response policy zones are named in the ``response-policy`` option for -the view, or among the global options if there is no response-policy +the view, or among the global options if there is no ``response-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 like @@ -3883,7 +3882,7 @@ 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 + 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 as ``prefixlength.B4.B3.B2.B1.rpz-client-ip``. The IPv4 prefix length must be between 1 and 32. All four bytes - B4, B3, @@ -3910,13 +3909,13 @@ Five policy triggers can be encoded in RPZ records. ``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 + 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 query name, or a parent of a CNAME. - They are encoded as subdomains of ``rpz-nsdname`` relativized + 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. The ``nsdname-enable`` phrase turns NSDNAME triggers off or on for a single @@ -3924,7 +3923,7 @@ Five policy triggers can be encoded in RPZ records. 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. This can cause a processing delay. To speed up + applying an RPZ-NSDNAME rule, which can cause a processing delay. To speed up processing at the cost of precision, the ``nsdname-wait-recurse`` option can be used; when set to ``no``, RPZ-NSDNAME rules are only applied when authoritative servers for the query name have already been looked up and @@ -3932,7 +3931,7 @@ Five policy triggers can be encoded in RPZ records. 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 is ``yes``, - meaning RPZ-NSDNAME rules are always applied even if authoritative + meaning RPZ-NSDNAME rules are always applied, even if authoritative servers for the query name need to be looked up first. ``RPZ-NSIP`` @@ -3944,15 +3943,15 @@ Five policy triggers can be encoded in RPZ records. 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. - This can cause a processing delay. To speed up processing at the cost + 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, the ``nsip-wait-recurse`` option can be used; when set to ``no``, 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 is ``yes``, - meaning RPZ-NSIP rules are always applied even if an address + 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 @@ -3986,12 +3985,12 @@ be used with any type of trigger to force the use of TCP for responses with owner names in a zone. ``PASSTHRU`` - The policy is specified by a CNAME whose target is + 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 policy is specified by a CNAME whose target is + 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. @@ -4002,7 +4001,7 @@ with owner names in a zone. used to mitigate distributed DNS reflection attacks. ``NXDOMAIN`` - The domain undefined response is encoded by a CNAME whose target is + The "domain undefined" response is encoded by a CNAME whose target is the root domain (.). ``NODATA`` @@ -4038,7 +4037,7 @@ its own walled garden. 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`` +``PASSTHRU``; ``DROP``; ``TCP-Only``; ``NXDOMAIN``; ``NODATA`` These settings each override the corresponding per-record policy. ``CNAME domain`` @@ -4088,12 +4087,12 @@ The ``dnsrps-enable yes`` option turns on the DNS Response Policy Service The ``dnsrps-options`` block provides additional RPZ configuration settings, which are passed through to the DNSRPS provider library. Multiple DNSRPS settings in an ``dnsrps-options`` string should be -separated with semi-colons. The DNSRPS provider, librpz, is passed a +separated with semi-colons (;). The DNSRPS provider, librpz, is passed a configuration string consisting of the ``dnsrps-options`` text, concatenated with settings derived from the ``response-policy`` statement. -Note: The ``dnsrps-options`` text should only include configuration +Note: the ``dnsrps-options`` text should only include configuration settings that are specific to the DNSRPS provider. For example, the DNSRPS provider from Farsight Security takes options such as ``dnsrpzd-conf``, ``dnsrpzd-sock``, and ``dnzrpzd-args`` (for details of @@ -4104,8 +4103,8 @@ but if ``named`` were switched back to traditional RPZ by setting 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 seconds from its -default of 5. For convenience, TTL-style time unit suffixes may be used +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: @@ -4118,7 +4117,7 @@ and this zone statement: :: - zone "badlist" {type master; file "master/badlist"; allow-query {none;}; }; + zone "badlist" {type primary; file "primary/badlist"; allow-query {none;}; }; with this zone file: @@ -4152,7 +4151,7 @@ with this zone file: ns.domain.com.rpz-nsdname CNAME . 48.zz.2.2001.rpz-nsip CNAME . - ; disapprove and approve some DNS clients + ; 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. @@ -4168,7 +4167,7 @@ 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 rate about 20% +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. @@ -4189,7 +4188,7 @@ 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 +seconds. For convenience, TTL-style time-unit suffixes may be used to specify the value. It also accepts ISO 8601 duration formats. .. _rrl: @@ -4197,14 +4196,14 @@ specify the value. It also accepts ISO 8601 duration formats. Response Rate Limiting ^^^^^^^^^^^^^^^^^^^^^^ -Excessive almost-identical UDP *responses* can be controlled by +Excessive, almost-identical UDP *responses* can be controlled by configuring a ``rate-limit`` clause in an ``options`` or ``view`` -statement. This mechanism keeps authoritative BIND 9 from being used in -amplifying reflection denial-of-service (DoS) attacks. Short, truncated +statement. This mechanism keeps authoritative BIND 9 from being used to +amplify reflection denial-of-service (DoS) attacks. Short, 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 or truncated response by retrying -with UDP or with TCP respectively. +Legitimate clients react to dropped or truncated responses by retrying +with UDP or with TCP, respectively. This mechanism is intended for authoritative DNS servers. It can be used on recursive servers, but can slow applications such as SMTP servers @@ -4213,20 +4212,20 @@ 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 +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. Responses are tracked within a rolling -window of time which defaults to 15 seconds, but can be configured with +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 than ``window`` 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. -The notions of "identical response" and "DNS client" for rate-limiting +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 addresses blocks are specified +to a single client. The prefix lengths of address blocks are specified with ``ipv4-prefix-length`` (default 24) and ``ipv6-prefix-length`` (default 56). @@ -4252,27 +4251,27 @@ 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. By default the limit on errors is +distant, broken authoritative servers. By default the limit on errors is the same as the ``responses-per-second`` value, but it can be set separately with ``errors-per-second``. Many attacks using DNS involve UDP requests with forged source -addresses. Rate-limiting prevents the use of BIND 9 to flood a network +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 to be answered with a small truncated (TC=1) -response. The small size and reduced frequency, and so lack of +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 truncated responses are sent due to rate-limiting, rather, +does not "slip"; no truncated 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. 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 +(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 @@ -4289,19 +4288,19 @@ the ratio of the current rate to the ``qps-scale`` value. This feature can tighten defenses during attacks. For example, with ``qps-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 +TCP, then the effective responses/second limit changes to (250/1000)*20, or 5. Responses sent via TCP are not limited but are counted to compute -the query per second rate. +the query-per-second rate. Communities of DNS clients can be given their own parameters or no -rate-limiting by putting ``rate-limit`` statements in ``view`` statements -instead of the global ``option`` statement. A ``rate-limit`` statement +rate limiting by putting ``rate-limit`` statements in ``view`` statements +instead of in the global ``option`` statement. A ``rate-limit`` statement in a view replaces, rather than supplements, a ``rate-limit`` statement among the main options. DNS clients within a view can be exempted from rate limits with the ``exempt-clients`` clause. UDP responses of all kinds can be limited with the ``all-per-second`` -phrase. This rate-limiting is unlike the rate-limiting provided by +phrase. This rate limiting is unlike the rate limiting provided by ``responses-per-second``, ``errors-per-second``, and ``nxdomains-per-second`` on a DNS server, which are often invisible to the victim of a DNS reflection attack. Unless the forged requests of the @@ -4315,20 +4314,20 @@ 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 SMTP ``Mail From`` command. Web browsers often repeatedly -resolve the same names that are repeated in HTML tags in a page. -``all-per-second`` is similar to the rate-limiting offered by firewalls -but often inferior. Attacks that justify ignoring the contents of DNS +resolve the same names that are duplicated in HTML 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 +TCP connections or parsing DNS requests, but that rate limiting must be done before the DNS server sees the requests. 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. Enable ``rate-limit`` category +reduce the cold start of growing the table, ``min-table-size`` (default 500) +can set the minimum table size. Enable ``rate-limit`` category logging to monitor expansions of the table and inform choices for the initial and maximum table size. @@ -4339,12 +4338,15 @@ Responses dropped by rate limits are included in the ``RateDropped`` and ``QryDropped`` statistics. Responses that are truncated by rate limits are included in ``RateSlipped`` and ``RespTruncated``. +NXDOMAIN Redirection +^^^^^^^^^^^^^^^^^^^^ + ``named`` supports NXDOMAIN redirection via two methods: - Redirect zone (:ref:`zone_statement_grammar`) - Redirect namespace -With either method, when ``named`` gets a NXDOMAIN response it examines a +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. @@ -4353,7 +4355,7 @@ 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. -With a redirect namespace (``option { nxdomain-redirect };``) +With a redirect namespace (``option { nxdomain-redirect };``), 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 @@ -4392,7 +4394,7 @@ as bogus prevents further queries to it. The default value of ``bogus`` is ``no``. The ``provide-ixfr`` clause determines whether the local server, acting -as master, responds with an incremental zone transfer when the given +as primary, responds with an incremental zone transfer when the given remote server, a secondary, requests it. If set to ``yes``, incremental transfer is provided whenever possible. If set to ``no``, all transfers to the remote server are non-incremental. If not set, the @@ -4433,16 +4435,16 @@ by ``named`` when querying the remote server. Valid values are 512 to nearest value within it. This option is useful when advertising a different value to this server than the value advertised globally: for example, when there is a firewall at the remote site that -is blocking large replies. (Note: Currently, this sets a single UDP size +is blocking large replies. Note: currently, this sets a single UDP size for all packets sent to the server; ``named`` does not deviate from this value. This differs from the behavior of ``edns-udp-size`` in ``options`` or ``view`` statements, where it specifies a maximum value. The ``server`` statement behavior may be brought into conformance with -the ``options``/``view`` behavior in future releases.) +the ``options``/``view`` behavior in future releases. 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`), +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 @@ -4461,7 +4463,7 @@ The ``padding`` 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 +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. @@ -4474,7 +4476,7 @@ over TCP. Note that currently idle timeouts in responses are ignored. The server supports two zone transfer methods. The first, ``one-answer``, uses one DNS message per resource record transferred. -``many-answers`` packs as many resource records as possible into a +``many-answers`` packs as many resource records as possible into a single message, which is more efficient. It is possible to specify which method to use for a server via the ``transfer-format`` option; if not set there, the @@ -4495,27 +4497,27 @@ server is not required to be signed by this key. Only a single key per server is currently supported. The ``transfer-source`` and ``transfer-source-v6`` clauses specify the -IPv4 and IPv6 source address to be used for zone transfer with the -remote server, respectively. For an IPv4 remote server, only +IPv4 and IPv6 source address, respectively, to be used for zone transfer with the +remote server. For an IPv4 remote server, only ``transfer-source`` can be specified. Similarly, for an IPv6 remote server, only ``transfer-source-v6`` can be specified. For more details, see the description of ``transfer-source`` and ``transfer-source-v6`` in :ref:`zone_transfers`. The ``notify-source`` and ``notify-source-v6`` clauses specify the IPv4 -and IPv6 source address to be used for notify messages sent to remote -servers, respectively. For an IPv4 remote server, only ``notify-source`` +and IPv6 source address, respectively, to be used for notify messages sent to remote +servers. For an IPv4 remote server, only ``notify-source`` can be specified. Similarly, for an IPv6 remote server, only ``notify-source-v6`` can be specified. The ``query-source`` and ``query-source-v6`` clauses specify the IPv4 -and IPv6 source address to be used for queries sent to remote servers, -respectively. For an IPv4 remote server, only ``query-source`` can be +and IPv6 source address, respectively, to be used for queries sent to remote servers. +For an IPv4 remote server, only ``query-source`` can be specified. Similarly, for an IPv6 remote server, only ``query-source-v6`` can be specified. The ``request-nsid`` clause determines whether the local server adds -a NSID EDNS option to requests sent to the server. This overrides +an NSID EDNS option to requests sent to the server. This overrides ``request-nsid`` set at the view or option level. The ``send-cookie`` clause determines whether the local server adds @@ -4538,7 +4540,7 @@ add a COOKIE EDNS option to requests. The ``statistics-channels`` statement declares communication channels to be used by system administrators to get access to statistics information -of the name server. +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 @@ -4567,7 +4569,7 @@ recommended to restrict the source of connection requests appropriately. 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 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 @@ -4604,8 +4606,8 @@ statistics), and http://127.0.0.1:8888/json/v1/traffic (traffic sizes). .. _trust-anchors: -``dnssec-keys`` Statement Definition and Usage -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +``trust-anchors`` Statement Definition and Usage +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The ``trust-anchors`` statement defines DNSSEC trust anchors. DNSSEC is described in :ref:`DNSSEC`. @@ -4614,7 +4616,7 @@ A trust anchor is defined when the public key or public key digest for a non-aut 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 -had been validated and proven secure. +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 @@ -4627,18 +4629,18 @@ 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: +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 +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, algorithm, and the Base64 representation +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 @@ -4671,12 +4673,12 @@ the new key. If, however, the trust anchor had been configured using ``initial-key`` or ``initial-ds`` -instead, then the zone owner could add a "stand-by" key to -their zone in advance. ``named`` would store +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, +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. @@ -4701,34 +4703,34 @@ 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. +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. +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 +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 +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 +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; this -usually occurs within 30 seconds. Whenever ``named`` is using +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 @@ -4736,7 +4738,7 @@ others, the working directory should be always be writable by If the ``dnssec-validation`` option is set to ``auto``, ``named`` automatically initializes an ``initial-key`` for the root zone. The key -that is used to initialize the key maintenance process is stored in +that is used to initialize the key-maintenance process is stored in ``bind.keys``; the location of this file can be overridden with the ``bindkeys-file`` option. As a fallback in the event no ``bind.keys`` can be found, the initializing key is also compiled directly into @@ -5005,8 +5007,8 @@ to matching all addresses. In addition to checking IP addresses, ``match-clients`` and ``match-destinations`` can also take ``keys`` which provide an mechanism for the client to select the view. A view can also be specified as ``match-recursive-only``, which means that only -recursive requests from matching clients will match that view. The order -of the ``view`` statements is significant — a client request is +recursive requests from matching clients match that view. The order +of the ``view`` statements is significant; a client request is resolved in the context of the first ``view`` that it matches. Zones defined within a ``view`` statement are only accessible to @@ -5049,7 +5051,7 @@ Here is an example of a typical split DNS setup implemented using // Provide a complete view of the example.com // zone including addresses of internal hosts. zone "example.com" { - type master; + type primary; file "example-internal.db"; }; }; @@ -5065,7 +5067,7 @@ Here is an example of a typical split DNS setup implemented using // Provide a restricted view of the example.com // zone containing only publicly accessible hosts. zone "example.com" { - type master; + type primary; file "example-external.db"; }; }; @@ -5136,27 +5138,7 @@ it is an ``in-view`` configuration. Its acceptable values include: letters of the zone name. (Most operating systems behave very slowly if there are 100000 files in a single directory.) -``stub`` - 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 of forcing 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. - ``mirror`` - 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 @@ -5211,6 +5193,32 @@ it is an ``in-view`` configuration. Its acceptable values include: be considered *experimental* and may cause performance issues, especially for zones which are large and/or frequently updated. +``hint`` + 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. + +``stub`` + 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 of forcing 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. + ``static-stub`` A static-stub zone is similar to a stub zone, with the following exceptions: the zone data is statically configured, rather than @@ -5249,13 +5257,6 @@ it is an ``in-view`` configuration. Its acceptable values include: then "forward only", or vice versa), but using the same servers as set globally, re-specify the global forwarders. -``hint`` - 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. - ``redirect`` Redirect zones are used to provide answers to queries when normal resolution would result in NXDOMAIN being returned. Only one redirect zone @@ -5401,7 +5402,7 @@ Zone Options the database to be interpreted in a way specific to the database type. - The default is ``"rbt"``, BIND 9's native in-memory red-black-tree + The default is ``"rbt"``, BIND 9's native in-memory red-black tree database. This database does not take arguments. Other values are possible if additional database drivers have been diff --git a/doc/arm/requirements.rst b/doc/arm/requirements.rst index d2b6fc56ac..f2dbf62c35 100644 --- a/doc/arm/requirements.rst +++ b/doc/arm/requirements.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. Requirements: BIND Resource Requirements @@ -32,7 +22,7 @@ DNS hardware requirements have traditionally been quite modest. For many installations, servers that have been retired from active duty have performed admirably as DNS servers. -However, the DNSSEC features of BIND 9 may prove to be quite CPU intensive, +However, the DNSSEC features of BIND 9 may be quite CPU-intensive, so organizations that make heavy use of these features may wish to consider larger systems for these applications. BIND 9 is fully multithreaded, allowing full utilization of multiprocessor systems for @@ -54,27 +44,27 @@ Memory Requirements ------------------- Server memory must be sufficient to hold both the cache and the -zones loaded from disk. The ``max-cache-size`` option can be used to +zones loaded from disk. The ``max-cache-size`` option can limit the amount of memory used by the cache, at the expense of reducing cache hit rates and causing more DNS traffic. It is still good practice to have enough memory to load all zone and cache data into memory; unfortunately, the best way to determine this for a given installation -is to watch the name server in operation. After a few weeks the server +is to watch the name server in operation. After a few weeks, the server process should reach a relatively stable size where entries are expiring from the cache as fast as they are being inserted. .. _intensive_env: -Name Server Intensive Environment Issues +Name Server-Intensive Environment Issues ---------------------------------------- -For name server intensive environments, there are two alternative +For name server-intensive environments, there are two configurations that may be used. The first is one where clients and any second-level internal name servers query a main name server, which has enough memory to build a large cache; this approach minimizes the bandwidth used by external name lookups. The second alternative is to set up second-level internal name servers to make queries independently. -In this configuration, none of the individual machines needs to have as +In this configuration, none of the individual machines need to have as much memory or CPU power as in the first alternative, but this has the disadvantage of making many more external queries, as none of the name servers share their cached data. @@ -84,7 +74,7 @@ servers share their cached data. Supported Operating Systems --------------------------- -ISC BIND 9 compiles and runs on a large number of Unix-like operating +ISC BIND 9 compiles and runs on many Unix-like operating systems and on Microsoft Windows Server 2012 R2, 2016, and Windows 10. For an up-to-date list of supported systems, see the PLATFORMS.md file in the top-level directory of the BIND 9 source distribution. diff --git a/doc/arm/security.rst b/doc/arm/security.rst index 4a853595d4..0137e87425 100644 --- a/doc/arm/security.rst +++ b/doc/arm/security.rst @@ -8,16 +8,6 @@ See the COPYRIGHT file distributed with this work for additional information regarding copyright ownership. -.. - Copyright (C) Internet Systems Consortium, Inc. ("ISC") - - This Source Code Form is subject to the terms of the Mozilla Public - License, v. 2.0. If a copy of the MPL was not distributed with this - file, You can obtain one at http://mozilla.org/MPL/2.0/. - - See the COPYRIGHT file distributed with this work for additional - information regarding copyright ownership. - .. Security: BIND 9 Security Considerations