1<!-- 2Copyright (C) Internet Systems Consortium, Inc. ("ISC") 3 4SPDX-License-Identifier: MPL-2.0 5 6This Source Code Form is subject to the terms of the Mozilla Public 7License, v. 2.0. If a copy of the MPL was not distributed with this 8file, you can obtain one at https://mozilla.org/MPL/2.0/. 9 10See the COPYRIGHT file distributed with this work for additional 11information regarding copyright ownership. 12--> 13# BIND 9 14 15### Contents 16 171. [Introduction](#intro) 181. [Reporting bugs and getting help](#help) 191. [Contributing to BIND](#contrib) 201. [BIND 9.16 features](#features) 211. [Building BIND](#build) 221. [macOS](#macos) 231. [Dependencies](#dependencies) 241. [Compile-time options](#opts) 251. [Automated testing](#testing) 261. [Documentation](#doc) 271. [Change log](#changes) 281. [Acknowledgments](#ack) 29 30### <a name="intro"/> Introduction 31 32BIND (Berkeley Internet Name Domain) is a complete, highly portable 33implementation of the DNS (Domain Name System) protocol. 34 35The BIND name server, `named`, is able to serve as an authoritative name 36server, recursive resolver, DNS forwarder, or all three simultaneously. It 37implements views for split-horizon DNS, automatic DNSSEC zone signing and 38key management, catalog zones to facilitate provisioning of zone data 39throughout a name server constellation, response policy zones (RPZ) to 40protect clients from malicious data, response rate limiting (RRL) and 41recursive query limits to reduce distributed denial of service attacks, 42and many other advanced DNS features. BIND also includes a suite of 43administrative tools, including the `dig` and `delv` DNS lookup tools, 44`nsupdate` for dynamic DNS zone updates, `rndc` for remote name server 45administration, and more. 46 47BIND 9 began as a complete re-write of the BIND architecture that was 48used in versions 4 and 8. Internet Systems Consortium 49([https://www.isc.org](https://www.isc.org)), a 501(c)(3) public benefit 50corporation dedicated to providing software and services in support of the 51Internet infrastructure, developed BIND 9 and is responsible for its 52ongoing maintenance and improvement. BIND is open source software 53licensed under the terms of the Mozilla Public License, version 2.0. 54 55For a summary of features introduced in past major releases of BIND, 56see the file [HISTORY](HISTORY.md). 57 58For a detailed list of changes made throughout the history of BIND 9, see 59the file [CHANGES](CHANGES). See [below](#changes) for details on the 60CHANGES file format. 61 62For up-to-date versions and release notes, see 63[https://www.isc.org/download/](https://www.isc.org/download/). 64 65For information about supported platforms, see the 66["Supported Platforms"](doc/arm/platforms.rst) section in the BIND 9 67Administrator Reference Manual. 68 69### <a name="help"/> Reporting bugs and getting help 70 71To report non-security-sensitive bugs or request new features, you may 72open an Issue in the BIND 9 project on the 73[ISC GitLab server](https://gitlab.isc.org) at 74[https://gitlab.isc.org/isc-projects/bind9](https://gitlab.isc.org/isc-projects/bind9). 75 76Please note that, unless you explicitly mark the newly created Issue as 77"confidential", it will be publicly readable. Please do not include any 78information in bug reports that you consider to be confidential unless 79the issue has been marked as such. In particular, if submitting the 80contents of your configuration file in a non-confidential Issue, it is 81advisable to obscure key secrets: this can be done automatically by 82using `named-checkconf -px`. 83 84If the bug you are reporting is a potential security issue, such as an 85assertion failure or other crash in `named`, please do *NOT* use GitLab to 86report it. Instead, send mail to 87[security-officer@isc.org](mailto:security-officer@isc.org) using our 88OpenPGP key to secure your message. (Information about OpenPGP and links 89to our key can be found at 90[https://www.isc.org/pgpkey](https://www.isc.org/pgpkey).) Please do not 91discuss the bug on any public mailing list. 92 93For a general overview of ISC security policies, read the Knowledge Base 94article at [https://kb.isc.org/docs/aa-00861](https://kb.isc.org/docs/aa-00861). 95 96Professional support and training for BIND are available from 97ISC at [https://www.isc.org/support](https://www.isc.org/support). 98 99To join the __BIND Users__ mailing list, or view the archives, visit 100[https://lists.isc.org/mailman/listinfo/bind-users](https://lists.isc.org/mailman/listinfo/bind-users). 101 102If you're planning on making changes to the BIND 9 source code, you 103may also want to join the __BIND Workers__ mailing list, at 104[https://lists.isc.org/mailman/listinfo/bind-workers](https://lists.isc.org/mailman/listinfo/bind-workers). 105 106### <a name="contrib"/> Contributing to BIND 107 108ISC maintains a public git repository for BIND; details can be found 109at [http://www.isc.org/git/](http://www.isc.org/git/). 110 111Information for BIND contributors can be found in the following files: 112- General information: [CONTRIBUTING.md](CONTRIBUTING.md) 113- Code of Conduct: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) 114- BIND 9 code style: [doc/dev/style.md](doc/dev/style.md) 115- BIND architecture and developer guide: [doc/dev/dev.md](doc/dev/dev.md) 116 117Patches for BIND may be submitted as 118[merge requests](https://gitlab.isc.org/isc-projects/bind9/merge_requests) 119in the [ISC GitLab server](https://gitlab.isc.org) at 120at [https://gitlab.isc.org/isc-projects/bind9/merge_requests](https://gitlab.isc.org/isc-projects/bind9/merge_requests). 121 122By default, external contributors don't have ability to fork BIND in the 123GitLab server, but if you wish to contribute code to BIND, you may request 124permission to do so. Thereafter, you can create git branches and directly 125submit requests that they be reviewed and merged. 126 127If you prefer, you may also submit code by opening a 128[GitLab Issue](https://gitlab.isc.org/isc-projects/bind9/issues) and 129including your patch as an attachment, preferably generated by 130`git format-patch`. 131 132### <a name="features"/> BIND 9.16 features 133 134BIND 9.16 is the current stable branch of BIND 9. It includes all 135changes from the 9.15 development branch, updating the previous stable 136branch, 9.14. New features include: 137 138* New `dnssec-policy` statement to configure a key and signing policy 139 for zones, enabling automatic key regeneration and rollover. 140* New network manager based on `libuv`. 141* Added support for the new GeoIP2 geolocation API, `libmaxminddb`. 142* Improved DNSSEC trust anchor configuration using the `trust-anchors` 143 statement, permitting configuration of trust anchors in DS as well as 144 DNSKEY format. 145* YAML output for `dig`, `mdig`, and `delv`. 146 147### <a name="build"/> Building BIND 148 149For information about building BIND 9, see the 150["Building BIND 9"](doc/arm/build.rst) section in the BIND 9 151Administrator Reference Manual. 152 153### <a name="testing"/> Automated testing 154 155A system test suite can be run with `make test`. The system tests require 156you to configure a set of virtual IP addresses on your system (this allows 157multiple servers to run locally and communicate with one another). These 158IP addresses can be configured by running the command 159`bin/tests/system/ifconfig.sh up` as root. 160 161Some tests require Perl and the `Net::DNS` and/or `IO::Socket::INET6` modules, 162and will be skipped if these are not available. Some tests require Python 163and the `dnspython` module and will be skipped if these are not available. 164See bin/tests/system/README for further details. 165 166Unit tests are implemented using the [CMocka unit testing framework](https://cmocka.org/). 167To build them, use `configure --with-cmocka`. Execution of tests is done 168by the [Kyua test execution engine](https://github.com/jmmv/kyua); if the 169`kyua` command is available, then unit tests can be run via `make test` 170or `make unit`. 171 172### <a name="doc"/> Documentation 173 174The *BIND 9 Administrator Reference Manual* is included with the source 175distribution, in DocBook XML, HTML, and PDF format, in the `doc/arm` 176directory. 177 178Some of the programs in the BIND 9 distribution have man pages in their 179directories. In particular, the command line options of `named` are 180documented in `bin/named/named.8`. 181 182Frequently (and not-so-frequently) asked questions and their answers 183can be found in the ISC Knowledge Base at 184[https://kb.isc.org](https://kb.isc.org). 185 186Additional information on various subjects can be found in other 187`README` files throughout the source tree. 188 189### <a name="changes"/> Change log 190 191A detailed list of all changes that have been made throughout the 192development BIND 9 is included in the file CHANGES, with the most recent 193changes listed first. Change notes include tags indicating the category of 194the change that was made; these categories are: 195 196|Category |Description | 197|-------------- |-----------------------------------------------| 198| [func] | New feature | 199| [bug] | General bug fix | 200| [security] | Fix for a significant security flaw | 201| [experimental] | Used for new features when the syntax or other aspects of the design are still in flux and may change | 202| [port] | Portability enhancement | 203| [maint] | Updates to built-in data such as root server addresses and keys | 204| [tuning] | Changes to built-in configuration defaults and constants to improve performance | 205| [performance] | Other changes to improve server performance | 206| [protocol] | Updates to the DNS protocol such as new RR types | 207| [test] | Changes to the automatic tests, not affecting server functionality | 208| [cleanup] | Minor corrections and refactoring | 209| [doc] | Documentation | 210| [contrib] | Changes to the contributed tools and libraries in the 'contrib' subdirectory | 211| [placeholder] | Used in the main development branch to reserve change numbers for use in other branches, e.g., when fixing a bug that only exists in older releases | 212 213In general, [func] and [experimental] tags will only appear in new-feature 214releases (i.e., those with version numbers ending in zero). Some new 215functionality may be backported to older releases on a case-by-case basis. 216All other change types may be applied to all currently-supported releases. 217 218#### Bug report identifiers 219 220Most notes in the CHANGES file include a reference to a bug report or 221issue number. Prior to 2018, these were usually of the form `[RT #NNN]` 222and referred to entries in the "bind9-bugs" RT database, which was not open 223to the public. More recent entries use the form `[GL #NNN]` or, less often, 224`[GL !NNN]`, which, respectively, refer to issues or merge requests in the 225GitLab database. Most of these are publicly readable, unless they include 226information which is confidential or security sensitive. 227 228To look up a GitLab issue by its number, use the URL 229[https://gitlab.isc.org/isc-projects/bind9/issues/NNN](https://gitlab.isc.org/isc-projects/bind9/issues). 230To look up a merge request, use 231[https://gitlab.isc.org/isc-projects/bind9/merge_requests/NNN](https://gitlab.isc.org/isc-projects/bind9/merge_requests). 232 233In rare cases, an issue or merge request number may be followed with the 234letter "P". This indicates that the information is in the private ISC 235GitLab instance, which is not visible to the public. 236 237### <a name="ack"/> Acknowledgments 238 239* The original development of BIND 9 was underwritten by the 240 following organizations: 241 242 Sun Microsystems, Inc. 243 Hewlett Packard 244 Compaq Computer Corporation 245 IBM 246 Process Software Corporation 247 Silicon Graphics, Inc. 248 Network Associates, Inc. 249 U.S. Defense Information Systems Agency 250 USENIX Association 251 Stichting NLnet - NLnet Foundation 252 Nominum, Inc. 253 254* This product includes software developed by the OpenSSL Project for use 255 in the OpenSSL Toolkit. 256 [http://www.OpenSSL.org/](http://www.OpenSSL.org/) 257* This product includes cryptographic software written by Eric Young 258 (eay@cryptsoft.com) 259* This product includes software written by Tim Hudson (tjh@cryptsoft.com) 260