Go to file
Nicki Křížek ced011f05a Merge branch 'tkrizek/pytest-conf-cleanup' into 'main'
Define environment variables in pytest instead of conf.sh

See merge request isc-projects/bind9!8800
2024-05-09 16:26:26 +00:00
.github/workflows Update github actions to trigger on correct branches 2023-03-27 17:09:09 +02:00
.gitlab/issue_templates Move Release issue template to BIND QA repo 2024-04-11 15:15:32 +00:00
.reuse Use a dedicated file for each autoconf variable 2024-05-09 17:08:10 +02:00
LICENSES Change exception SPDX to Autoconf-exception-generic 2024-04-24 09:46:58 +00:00
bin Ensure OPENSSL_CONF is a file if it exists 2024-05-09 17:08:11 +02:00
cocci Add coccinelle rule to favor DNS_SIGTYPE 2024-02-14 09:00:27 +01:00
conftools/perllib/dnsconf Mark setting operating system limits from named.conf as ancient 2022-12-07 19:40:00 +01:00
contrib Reformat shell scripts with shfmt 2023-10-26 10:23:50 +02:00
doc Update reference for Catalog Zones spec to RFC9432 2024-05-07 13:38:40 +02:00
fuzz add a compile-time option to select default zone and cache DB 2024-03-06 10:49:02 +01:00
lib Stop processing catalog zone changes when shutting down 2024-05-09 08:17:44 +10:00
m4 Print the used jemalloc version in autoconf and named -V output 2023-09-05 18:47:21 +02:00
tests Only check SVBC alias forms at higher levels 2024-05-07 11:20:49 +10:00
util Check for atomic operations consistency in checklibs.sh 2024-01-03 17:04:31 +00:00
.clang-format Add ISC_LIST_FOREACH_REV(_SAFE) macros 2023-10-25 12:36:13 +02:00
.clang-format.headers Build with liburcu, Userspace RCU 2023-03-10 17:31:28 +01:00
.dir-locals.el Remove trailing whitespace from all text files 2023-06-13 15:05:40 +02:00
.editorconfig Add editorconfig file for shell style 2023-10-26 10:23:52 +02:00
.git-blame-ignore-revs Ignore clang-format reformat 2023-11-13 16:56:10 +01:00
.gitattributes Add previously detected dns_rdata_fromwire_text failures 2020-08-13 23:16:18 +10:00
.gitignore Introduce new DNSSEC tool dnssec-ksr 2024-04-19 10:41:04 +02:00
.gitlab-ci.yml Use a dedicated file for each autoconf variable 2024-05-09 17:08:10 +02:00
.pylintrc Disable pylint check for too-few-public-methods 2023-05-22 14:11:40 +02:00
.readthedocs.yaml Add configuration for readthedocs.org 2023-07-18 15:30:27 +02:00
.tsan-suppress Change images for TSAN jobs 2023-05-30 20:13:19 +02:00
.uncrustify.cfg fix spelling errors reported by Fossies. 2020-02-21 15:05:08 +11:00
AUTHORS Modify AUTHORS 2022-12-20 22:13:53 +02:00
CHANGES Add CHANGES for [GL #4502] 2024-05-09 08:17:44 +10:00
CODE_OF_CONDUCT.md Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
CONTRIBUTING.md Remove PDF-related bits from the build system 2023-10-12 14:24:42 +02:00
COPYING Complete rewrite the BIND 9 build system 2020-04-21 14:19:48 +02:00
COPYRIGHT Remove trailing whitespace from all text files 2023-06-13 15:05:40 +02:00
ChangeLog Complete rewrite the BIND 9 build system 2020-04-21 14:19:48 +02:00
LICENSE Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
Makefile.am Add support for User Statically Defined Tracing (USDT) probes 2023-08-21 18:39:53 +02:00
Makefile.docs Remove PDF-related bits from the build system 2023-10-12 14:24:42 +02:00
Makefile.dtrace Regenerate the DTrace generated files on configure change 2023-08-23 07:40:20 +02:00
Makefile.tests Link jemalloc again for testing unit build order 2024-01-18 09:34:36 +01:00
Makefile.top Add workaround for jemalloc linking order 2024-01-18 09:34:36 +01:00
NEWS Complete rewrite the BIND 9 build system 2020-04-21 14:19:48 +02:00
OPTIONS.md Document -DOPENSSL_API_COMPAT=10100 in OPTIONS.md 2022-09-23 13:17:55 +10:00
README.md Remove PDF-related bits from the build system 2023-10-12 14:24:42 +02:00
SECURITY.md Move security-related information to SECURITY.md 2023-09-04 11:54:57 +02:00
bind.keys Update the copyright information in all files in the repository 2022-01-11 09:05:02 +01:00
configure.ac Use a dedicated file for each autoconf variable 2024-05-09 17:08:10 +02:00
dangerfile.py Warn if security fixes are not marked for testing 2024-03-21 17:38:57 +01:00
sonar-project.properties Add SonarCloud GitHub Action 2023-02-24 08:53:41 +00:00
suppr-lsan.txt Supress the leak detection in xmlNewGlobalState 2024-05-06 19:35:36 +02:00

README.md

BIND 9

Contents

  1. Introduction
  2. Reporting bugs and getting help
  3. Contributing to BIND
  4. Building BIND
  5. Automated testing
  6. Documentation
  7. Change log
  8. Acknowledgments

Introduction

BIND (Berkeley Internet Name Domain) is a complete, highly portable implementation of the Domain Name System (DNS) protocol.

The BIND name server, named, can act as an authoritative name server, recursive resolver, DNS forwarder, or all three simultaneously. It implements views for split-horizon DNS, automatic DNSSEC zone signing and key management, catalog zones to facilitate provisioning of zone data throughout a name server constellation, response policy zones (RPZ) to protect clients from malicious data, response rate limiting (RRL) and recursive query limits to reduce distributed denial of service attacks, and many other advanced DNS features. BIND also includes a suite of administrative tools, including the dig and delv DNS lookup tools, nsupdate for dynamic DNS zone updates, rndc for remote name server administration, and more.

BIND 9 began as a complete rewrite of the BIND architecture that was used in versions 4 and 8. Internet Systems Consortium (https://www.isc.org), a 501(c)(3) US public benefit corporation dedicated to providing software and services in support of the Internet infrastructure, developed BIND 9 and is responsible for its ongoing maintenance and improvement. BIND is open source software licensed under the terms of the Mozilla Public License, version 2.0.

For a detailed list of changes made throughout the history of BIND 9, see the file CHANGES. See below for details on the CHANGES file format.

For up-to-date versions and release notes, see https://www.isc.org/download/.

For information about supported platforms, see the "Supported Platforms" section in the BIND 9 Administrator Reference Manual.

Reporting bugs and getting help

To report non-security-sensitive bugs or request new features, you may open an issue in the BIND 9 project on the ISC GitLab server at https://gitlab.isc.org/isc-projects/bind9.

Please note that, unless you explicitly mark the newly created issue as "confidential," it will be publicly readable. Please do not include any information in bug reports that you consider to be confidential unless the issue has been marked as such. In particular, if submitting the contents of your configuration file in a non-confidential issue, it is advisable to obscure key secrets; this can be done automatically by using named-checkconf -px.

For information about ISC's Security Vulnerability Disclosure Policy and information about reporting potential security issues, please see SECURITY.md.

Professional support and training for BIND are available from ISC. Contact us at https://www.isc.org/contact for more information.

To join the BIND Users mailing list, or view the archives, visit https://lists.isc.org/mailman/listinfo/bind-users.

If you're planning on making changes to the BIND 9 source code, you may also want to join the BIND Workers mailing list, at https://lists.isc.org/mailman/listinfo/bind-workers.

Contributing to BIND

ISC maintains a public git repository for BIND; details can be found at https://www.isc.org/sourceaccess/.

Information for BIND contributors can be found in the following files:

Patches for BIND may be submitted as merge requests on the ISC GitLab server.

By default, external contributors do not have the ability to fork BIND on the GitLab server; if you wish to contribute code to BIND, you may request permission to do so. Thereafter, you can create git branches and directly submit requests that they be reviewed and merged.

If you prefer, you may also submit code by opening a GitLab issue and including your patch as an attachment, preferably generated by git format-patch.

Building BIND 9

For information about building BIND 9, see the "Building BIND 9" section in the BIND 9 Administrator Reference Manual.

Automated testing

A system test suite can be run with make check. The system tests require you to configure a set of virtual IP addresses on your system (this allows multiple servers to run locally and communicate with each other). These IP addresses can be configured by running the command bin/tests/system/ifconfig.sh up as root.

Some tests require Perl and the Net::DNS and/or IO::Socket::IP modules, and are skipped if these are not available. Some tests require Python and the dnspython module and are skipped if these are not available. See bin/tests/system/README for further details.

Unit tests are implemented using the CMocka unit testing framework. To build them, use configure --with-cmocka. Execution of tests is done by the automake parallel test driver; unit tests are also run by make check.

Documentation

The BIND 9 Administrator Reference Manual (ARM) is included with the source distribution, and in .rst format, in the doc/arm directory. The HTML version is automatically generated and can be viewed at https://bind9.readthedocs.io/en/latest/index.html.

The PDF version can be built by running:

cd doc/arm/
sphinx-build -b latex . pdf/
make -C pdf/ all-pdf

The above requires TeX Live in order to work. The PDF will be written to doc/arm/pdf/Bv9ARM.pdf.

Man pages for some of the programs in the BIND 9 distribution are also included in the BIND ARM.

Frequently (and not-so-frequently) asked questions and their answers can be found in the ISC Knowledgebase at https://kb.isc.org.

Additional information on various subjects can be found in other README files throughout the source tree.

Change log

A detailed list of all changes that have been made throughout the development of BIND 9 is included in the file CHANGES, with the most recent changes listed first. Change notes include tags indicating the category of the change that was made; these categories are:

Category Description
[func] New feature
[bug] General bug fix
[security] Fix for a significant security flaw
[experimental] Used for new features when the syntax or other aspects of the design are still in flux and may change
[port] Portability enhancement
[maint] Updates to built-in data such as root server addresses and keys
[tuning] Changes to built-in configuration defaults and constants to improve performance
[performance] Other changes to improve server performance
[protocol] Updates to the DNS protocol such as new RR types
[test] Changes to the automatic tests, not affecting server functionality
[cleanup] Minor corrections and refactoring
[doc] Documentation
[contrib] Changes to the contributed tools and libraries in the 'contrib' subdirectory
[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

In general, [func] and [experimental] tags only appear in new-feature releases (i.e., those with version numbers ending in zero). Some new functionality may be backported to older releases on a case-by-case basis. All other change types may be applied to all currently supported releases.

Bug report identifiers

Most notes in the CHANGES file include a reference to a bug report or issue number. Prior to 2018, these were usually of the form [RT #NNN] and referred to entries in the "bind9-bugs" RT database, which was not open to the public. More recent entries use the form [GL #NNN] or, less often, [GL !NNN], which, respectively, refer to issues or merge requests in the GitLab database. Most of these are publicly readable, unless they include information which is confidential or security-sensitive.

To look up a GitLab issue by its number, use the URL https://gitlab.isc.org/isc-projects/bind9/issues/NNN. To look up a merge request, use https://gitlab.isc.org/isc-projects/bind9/merge_requests/NNN.

In rare cases, an issue or merge request number may be followed with the letter "P". This indicates that the information is in the private ISC GitLab instance, which is not visible to the public.

Acknowledgments